1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #define BLOCKINPUT_INLINE EXTERN_INLINE
24 #define KEYBOARD_INLINE EXTERN_INLINE
32 #include "termhooks.h"
37 #include "character.h"
40 #include "dispextern.h"
42 #include "intervals.h"
44 #include "blockinput.h"
58 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #if defined USABLE_FIONREAD && defined USG5_4
62 # include <sys/filio.h>
65 #include "syssignal.h"
67 #include <sys/types.h>
71 #ifdef HAVE_WINDOW_SYSTEM
73 #endif /* HAVE_WINDOW_SYSTEM */
75 /* Variables for blockinput.h: */
77 /* Positive if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* True means an input interrupt or alarm signal has arrived.
81 The QUIT macro checks this. */
82 volatile bool pending_signals
;
84 #define KBD_BUFFER_SIZE 4096
86 KBOARD
*initial_kboard
;
87 KBOARD
*current_kboard
;
90 /* True in the single-kboard state, false in the any-kboard state. */
91 static bool single_kboard
;
93 /* Non-nil disable property on a command means
94 do not execute it; call disabled-command-function's value instead. */
95 Lisp_Object Qdisabled
;
96 static Lisp_Object Qdisabled_command_function
;
98 #define NUM_RECENT_KEYS (300)
100 /* Index for storing next element into recent_keys. */
101 static int recent_keys_index
;
103 /* Total number of elements stored into recent_keys. */
104 static int total_keys
;
106 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
107 static Lisp_Object recent_keys
;
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 ptrdiff_t this_command_key_count
;
117 /* True after calling Freset_this_command_lengths.
118 Usually it is false. */
119 static bool this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static ptrdiff_t before_command_key_count
;
137 static ptrdiff_t before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static sys_jmp_buf getcjmp
;
143 /* True while doing kbd input. */
144 bool waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* True means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 EMACS_INT command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static ptrdiff_t last_non_minibuf_size
;
203 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
204 uintmax_t num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 /* The timestamp of the last input event we received from the X server.
225 X Windows wants this for selection ownership. */
226 Time last_event_timestamp
;
228 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
229 static Lisp_Object Qhandle_select_window
;
230 Lisp_Object QPRIMARY
;
232 static Lisp_Object Qself_insert_command
;
233 static Lisp_Object Qforward_char
;
234 static Lisp_Object Qbackward_char
;
235 Lisp_Object Qundefined
;
236 static Lisp_Object Qtimer_event_handler
;
238 /* read_key_sequence stores here the command definition of the
239 key sequence that it reads. */
240 static Lisp_Object read_key_sequence_cmd
;
241 static Lisp_Object read_key_sequence_remapped
;
243 static Lisp_Object Qinput_method_function
;
245 static Lisp_Object Qdeactivate_mark
;
247 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
249 static Lisp_Object Qecho_area_clear_hook
;
251 /* Hooks to run before and after each command. */
252 static Lisp_Object Qpre_command_hook
;
253 static Lisp_Object Qpost_command_hook
;
255 static Lisp_Object Qdeferred_action_function
;
257 static Lisp_Object Qdelayed_warnings_hook
;
259 static Lisp_Object Qinput_method_exit_on_first_char
;
260 static Lisp_Object Qinput_method_use_echo_area
;
262 static Lisp_Object Qhelp_form_show
;
264 /* File in which we write all commands we read. */
265 static FILE *dribble
;
267 /* Nonzero if input is available. */
270 /* Circular buffer for pre-read keyboard input. */
272 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
274 /* Pointer to next available character in kbd_buffer.
275 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
276 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
277 next available char is in kbd_buffer[0]. */
278 static struct input_event
*kbd_fetch_ptr
;
280 /* Pointer to next place to store character in kbd_buffer. This
281 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
282 character should go in kbd_buffer[0]. */
283 static struct input_event
* volatile kbd_store_ptr
;
285 /* The above pair of variables forms a "queue empty" flag. When we
286 enqueue a non-hook event, we increment kbd_store_ptr. When we
287 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
288 there is input available if the two pointers are not equal.
290 Why not just have a flag set and cleared by the enqueuing and
291 dequeuing functions? Such a flag could be screwed up by interrupts
292 at inopportune times. */
294 /* Symbols to head events. */
295 static Lisp_Object Qmouse_movement
;
296 static Lisp_Object Qscroll_bar_movement
;
297 Lisp_Object Qswitch_frame
;
298 static Lisp_Object Qdelete_frame
;
299 static Lisp_Object Qiconify_frame
;
300 static Lisp_Object Qmake_frame_visible
;
301 static Lisp_Object Qselect_window
;
302 Lisp_Object Qhelp_echo
;
304 static Lisp_Object Qmouse_fixup_help_message
;
306 /* Symbols to denote kinds of events. */
307 static Lisp_Object Qfunction_key
;
308 Lisp_Object Qmouse_click
;
310 Lisp_Object Qlanguage_change
;
312 Lisp_Object Qfile_w32notify
;
315 static Lisp_Object Qdrag_n_drop
;
316 static Lisp_Object Qsave_session
;
318 static Lisp_Object Qdbus_event
;
321 static Lisp_Object Qfile_inotify
;
322 #endif /* HAVE_INOTIFY */
323 static Lisp_Object Qconfig_changed_event
;
325 /* Lisp_Object Qmouse_movement; - also an event header */
327 /* Properties of event headers. */
328 Lisp_Object Qevent_kind
;
329 static Lisp_Object Qevent_symbol_elements
;
331 /* Menu and tool bar item parts. */
332 static Lisp_Object Qmenu_enable
;
333 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
334 Lisp_Object QCfilter
;
336 /* Non-nil disable property on a command means
337 do not execute it; call disabled-command-function's value instead. */
338 Lisp_Object QCtoggle
, QCradio
;
339 static Lisp_Object QCbutton
, QClabel
;
341 static Lisp_Object QCvert_only
;
343 /* An event header symbol HEAD may have a property named
344 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
345 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
346 mask of modifiers applied to it. If present, this is used to help
347 speed up parse_modifiers. */
348 Lisp_Object Qevent_symbol_element_mask
;
350 /* An unmodified event header BASE may have a property named
351 Qmodifier_cache, which is an alist mapping modifier masks onto
352 modified versions of BASE. If present, this helps speed up
354 static Lisp_Object Qmodifier_cache
;
356 /* Symbols to use for parts of windows. */
357 Lisp_Object Qmode_line
;
358 Lisp_Object Qvertical_line
;
359 static Lisp_Object Qvertical_scroll_bar
;
360 Lisp_Object Qmenu_bar
;
362 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
363 static Lisp_Object
command_loop (void);
364 static Lisp_Object Qcommand_execute
;
365 EMACS_TIME
timer_check (void);
367 static void echo_now (void);
368 static ptrdiff_t echo_length (void);
370 static Lisp_Object Qpolling_period
;
372 /* Incremented whenever a timer is run. */
375 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
377 EMACS_TIME
*input_available_clear_time
;
379 /* True means use SIGIO interrupts; false means use CBREAK mode.
380 Default is true if INTERRUPT_INPUT is defined. */
381 bool interrupt_input
;
383 /* Nonzero while interrupts are temporarily deferred during redisplay. */
384 bool interrupts_deferred
;
386 /* If we support a window system, turn on the code to poll periodically
387 to detect C-g. It isn't actually used when doing interrupt input. */
388 #ifdef HAVE_WINDOW_SYSTEM
389 #define POLL_FOR_INPUT
392 /* The time when Emacs started being idle. */
394 static EMACS_TIME timer_idleness_start_time
;
396 /* After Emacs stops being idle, this saves the last value
397 of timer_idleness_start_time from when it was idle. */
399 static EMACS_TIME timer_last_idleness_start_time
;
402 /* Global variable declarations. */
404 /* Flags for readable_events. */
405 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
406 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
407 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
409 /* Function for init_keyboard to call with no args (if nonzero). */
410 static void (*keyboard_init_hook
) (void);
412 static bool get_input_pending (int);
413 static bool readable_events (int);
414 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
415 Lisp_Object
, bool *);
416 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
417 static Lisp_Object
make_lispy_event (struct input_event
*);
418 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
419 enum scroll_bar_part
,
420 Lisp_Object
, Lisp_Object
,
422 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
423 Lisp_Object
, const char *const *,
424 Lisp_Object
*, ptrdiff_t);
425 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
426 static bool help_char_p (Lisp_Object
);
427 static void save_getcjmp (sys_jmp_buf
);
428 static void restore_getcjmp (sys_jmp_buf
);
429 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
430 static void clear_event (struct input_event
*);
431 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
433 static void deliver_input_available_signal (int signo
);
435 static void handle_interrupt (bool);
436 static _Noreturn
void quit_throw_to_read_char (bool);
437 static void process_special_events (void);
438 static void timer_start_idle (void);
439 static void timer_stop_idle (void);
440 static void timer_resume_idle (void);
441 static void deliver_user_signal (int);
442 static char *find_user_signal_name (int);
443 static void store_user_signal_events (void);
445 /* These setters are used only in this file, so they can be private. */
447 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
449 kb
->INTERNAL_FIELD (echo_string
) = val
;
452 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
454 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
457 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
459 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
462 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
464 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
467 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
469 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
472 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
474 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
477 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
482 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
484 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
487 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
489 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
493 /* Add C to the echo string, without echoing it immediately. C can be
494 a character, which is pretty-printed, or a symbol, whose name is
498 echo_add_key (Lisp_Object c
)
500 int size
= KEY_DESCRIPTION_SIZE
+ 100;
501 char *buffer
= alloca (size
);
503 Lisp_Object echo_string
;
505 echo_string
= KVAR (current_kboard
, echo_string
);
507 /* If someone has passed us a composite event, use its head symbol. */
511 ptr
= push_key_description (XINT (c
), ptr
);
512 else if (SYMBOLP (c
))
514 Lisp_Object name
= SYMBOL_NAME (c
);
515 int nbytes
= SBYTES (name
);
517 if (size
- (ptr
- buffer
) < nbytes
)
519 int offset
= ptr
- buffer
;
520 size
= max (2 * size
, size
+ nbytes
);
521 buffer
= alloca (size
);
522 ptr
= buffer
+ offset
;
525 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
526 STRING_MULTIBYTE (name
), 1);
529 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
532 const char *text
= " (Type ? for further options)";
533 int len
= strlen (text
);
535 if (size
- (ptr
- buffer
) < len
)
537 int offset
= ptr
- buffer
;
539 buffer
= alloca (size
);
540 ptr
= buffer
+ offset
;
543 memcpy (ptr
, text
, len
);
547 /* Replace a dash from echo_dash with a space, otherwise add a space
548 at the end as a separator between keys. */
549 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
551 Lisp_Object last_char
, prev_char
, idx
;
553 idx
= make_number (SCHARS (echo_string
) - 2);
554 prev_char
= Faref (echo_string
, idx
);
556 idx
= make_number (SCHARS (echo_string
) - 1);
557 last_char
= Faref (echo_string
, idx
);
559 /* We test PREV_CHAR to make sure this isn't the echoing of a
561 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
562 Faset (echo_string
, idx
, make_number (' '));
564 echo_string
= concat2 (echo_string
, build_string (" "));
566 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
567 echo_string
= concat2 (echo_string
, build_string (" "));
571 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
574 /* Add C to the echo string, if echoing is going on. C can be a
575 character or a symbol. */
578 echo_char (Lisp_Object c
)
580 if (current_kboard
->immediate_echo
)
587 /* Temporarily add a dash to the end of the echo string if it's not
588 empty, so that it serves as a mini-prompt for the very next
594 /* Do nothing if not echoing at all. */
595 if (NILP (KVAR (current_kboard
, echo_string
)))
598 if (this_command_key_count
== 0)
601 if (!current_kboard
->immediate_echo
602 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
605 /* Do nothing if we just printed a prompt. */
606 if (current_kboard
->echo_after_prompt
607 == SCHARS (KVAR (current_kboard
, echo_string
)))
610 /* Do nothing if we have already put a dash at the end. */
611 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
613 Lisp_Object last_char
, prev_char
, idx
;
615 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
616 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
618 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
619 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
621 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
625 /* Put a dash at the end of the buffer temporarily,
626 but make it go away when the next character is added. */
629 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
633 /* Display the current echo string, and begin echoing if not already
639 if (!current_kboard
->immediate_echo
)
642 current_kboard
->immediate_echo
= 1;
644 for (i
= 0; i
< this_command_key_count
; i
++)
648 /* Set before_command_echo_length to the value that would
649 have been saved before the start of this subcommand in
650 command_loop_1, if we had already been echoing then. */
651 if (i
== this_single_command_key_start
)
652 before_command_echo_length
= echo_length ();
654 c
= AREF (this_command_keys
, i
);
655 if (! (EVENT_HAS_PARAMETERS (c
)
656 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
660 /* Set before_command_echo_length to the value that would
661 have been saved before the start of this subcommand in
662 command_loop_1, if we had already been echoing then. */
663 if (this_command_key_count
== this_single_command_key_start
)
664 before_command_echo_length
= echo_length ();
666 /* Put a dash at the end to invite the user to type more. */
671 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
672 message3_nolog (KVAR (current_kboard
, echo_string
));
675 /* Record in what buffer we echoed, and from which kboard. */
676 echo_message_buffer
= echo_area_buffer
[0];
677 echo_kboard
= current_kboard
;
679 if (waiting_for_input
&& !NILP (Vquit_flag
))
680 quit_throw_to_read_char (0);
683 /* Turn off echoing, for the start of a new command. */
686 cancel_echoing (void)
688 current_kboard
->immediate_echo
= 0;
689 current_kboard
->echo_after_prompt
= -1;
690 kset_echo_string (current_kboard
, Qnil
);
691 ok_to_echo_at_next_pause
= NULL
;
693 echo_message_buffer
= Qnil
;
696 /* Return the length of the current echo string. */
701 return (STRINGP (KVAR (current_kboard
, echo_string
))
702 ? SCHARS (KVAR (current_kboard
, echo_string
))
706 /* Truncate the current echo message to its first LEN chars.
707 This and echo_char get used by read_key_sequence when the user
708 switches frames while entering a key sequence. */
711 echo_truncate (ptrdiff_t nchars
)
713 if (STRINGP (KVAR (current_kboard
, echo_string
)))
714 kset_echo_string (current_kboard
,
715 Fsubstring (KVAR (current_kboard
, echo_string
),
716 make_number (0), make_number (nchars
)));
717 truncate_echo_area (nchars
);
721 /* Functions for manipulating this_command_keys. */
723 add_command_key (Lisp_Object key
)
725 #if 0 /* Not needed after we made Freset_this_command_lengths
726 do the job immediately. */
727 /* If reset-this-command-length was called recently, obey it now.
728 See the doc string of that function for an explanation of why. */
729 if (before_command_restore_flag
)
731 this_command_key_count
= before_command_key_count_1
;
732 if (this_command_key_count
< this_single_command_key_start
)
733 this_single_command_key_start
= this_command_key_count
;
734 echo_truncate (before_command_echo_length_1
);
735 before_command_restore_flag
= 0;
739 if (this_command_key_count
>= ASIZE (this_command_keys
))
740 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
742 ASET (this_command_keys
, this_command_key_count
, key
);
743 ++this_command_key_count
;
748 recursive_edit_1 (void)
750 ptrdiff_t count
= SPECPDL_INDEX ();
753 if (command_loop_level
> 0)
755 specbind (Qstandard_output
, Qt
);
756 specbind (Qstandard_input
, Qt
);
759 #ifdef HAVE_WINDOW_SYSTEM
760 /* The command loop has started an hourglass timer, so we have to
761 cancel it here, otherwise it will fire because the recursive edit
762 can take some time. Do not check for display_hourglass_p here,
763 because it could already be nil. */
767 /* This function may have been called from a debugger called from
768 within redisplay, for instance by Edebugging a function called
769 from fontification-functions. We want to allow redisplay in
770 the debugging session.
772 The recursive edit is left with a `(throw exit ...)'. The `exit'
773 tag is not caught anywhere in redisplay, i.e. when we leave the
774 recursive edit, the original redisplay leading to the recursive
775 edit will be unwound. The outcome should therefore be safe. */
776 specbind (Qinhibit_redisplay
, Qnil
);
779 val
= command_loop ();
781 Fsignal (Qquit
, Qnil
);
782 /* Handle throw from read_minibuf when using minibuffer
783 while it's active but we're in another window. */
785 xsignal1 (Qerror
, val
);
787 return unbind_to (count
, Qnil
);
790 /* When an auto-save happens, record the "time", and don't do again soon. */
793 record_auto_save (void)
795 last_auto_save
= num_nonmacro_input_events
;
798 /* Make an auto save happen as soon as possible at command level. */
802 force_auto_save_soon (void)
804 last_auto_save
= - auto_save_interval
- 1;
806 record_asynch_buffer_change ();
810 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
811 doc
: /* Invoke the editor command loop recursively.
812 To get out of the recursive edit, a command can do `(throw 'exit nil)';
813 that tells this function to return.
814 Alternatively, `(throw 'exit t)' makes this function signal an error.
815 This function is called by the editor initialization to begin editing. */)
818 ptrdiff_t count
= SPECPDL_INDEX ();
821 /* If we enter while input is blocked, don't lock up here.
822 This may happen through the debugger during redisplay. */
823 if (input_blocked_p ())
826 command_loop_level
++;
827 update_mode_lines
= 1;
829 if (command_loop_level
830 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
831 buffer
= Fcurrent_buffer ();
835 /* If we leave recursive_edit_1 below with a `throw' for instance,
836 like it is done in the splash screen display, we have to
837 make sure that we restore single_kboard as command_loop_1
838 would have done if it were left normally. */
839 if (command_loop_level
> 0)
840 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
841 record_unwind_protect (recursive_edit_unwind
, buffer
);
844 return unbind_to (count
, Qnil
);
848 recursive_edit_unwind (Lisp_Object buffer
)
850 if (BUFFERP (buffer
))
851 Fset_buffer (buffer
);
853 command_loop_level
--;
854 update_mode_lines
= 1;
859 #if 0 /* These two functions are now replaced with
860 temporarily_switch_to_single_kboard. */
864 #if 0 /* Theory: if there's anything in Vunread_command_events,
865 it will right away be read by read_key_sequence,
866 and then if we do switch KBOARDS, it will go into the side
867 queue then. So we don't need to do anything special here -- rms. */
868 if (CONSP (Vunread_command_events
))
870 current_kboard
->kbd_queue
871 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
872 current_kboard
->kbd_queue_has_data
= 1;
874 Vunread_command_events
= Qnil
;
879 /* Switch to the single-kboard state, making current_kboard
880 the only KBOARD from which further input is accepted. */
883 single_kboard_state ()
889 /* If we're in single_kboard state for kboard KBOARD,
893 not_single_kboard_state (KBOARD
*kboard
)
895 if (kboard
== current_kboard
)
899 /* Maintain a stack of kboards, so other parts of Emacs
900 can switch temporarily to the kboard of a given frame
901 and then revert to the previous status. */
906 struct kboard_stack
*next
;
909 static struct kboard_stack
*kboard_stack
;
912 push_kboard (struct kboard
*k
)
914 struct kboard_stack
*p
= xmalloc (sizeof *p
);
916 p
->next
= kboard_stack
;
917 p
->kboard
= current_kboard
;
927 struct kboard_stack
*p
= kboard_stack
;
929 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
931 if (t
->kboard
== p
->kboard
)
933 current_kboard
= p
->kboard
;
940 /* The terminal we remembered has been deleted. */
941 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
944 kboard_stack
= p
->next
;
948 /* Switch to single_kboard mode, making current_kboard the only KBOARD
949 from which further input is accepted. If F is non-nil, set its
950 KBOARD as the current keyboard.
952 This function uses record_unwind_protect to return to the previous
955 If Emacs is already in single_kboard mode, and F's keyboard is
956 locked, then this function will throw an error. */
959 temporarily_switch_to_single_kboard (struct frame
*f
)
961 bool was_locked
= single_kboard
;
964 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
965 /* We can not switch keyboards while in single_kboard mode.
966 In rare cases, Lisp code may call `recursive-edit' (or
967 `read-minibuffer' or `y-or-n-p') after it switched to a
968 locked frame. For example, this is likely to happen
969 when server.el connects to a new terminal while Emacs is in
970 single_kboard mode. It is best to throw an error instead
971 of presenting the user with a frozen screen. */
972 error ("Terminal %d is locked, cannot read from it",
973 FRAME_TERMINAL (f
)->id
);
975 /* This call is unnecessary, but helps
976 `restore_kboard_configuration' discover if somebody changed
977 `current_kboard' behind our back. */
978 push_kboard (current_kboard
);
981 current_kboard
= FRAME_KBOARD (f
);
983 record_unwind_protect (restore_kboard_configuration
,
984 (was_locked
? Qt
: Qnil
));
987 #if 0 /* This function is not needed anymore. */
989 record_single_kboard_state ()
992 push_kboard (current_kboard
);
993 record_unwind_protect (restore_kboard_configuration
,
994 (single_kboard
? Qt
: Qnil
));
999 restore_kboard_configuration (Lisp_Object was_locked
)
1001 if (NILP (was_locked
))
1005 struct kboard
*prev
= current_kboard
;
1008 /* The pop should not change the kboard. */
1009 if (single_kboard
&& current_kboard
!= prev
)
1016 /* Handle errors that are not handled at inner levels
1017 by printing an error message and returning to the editor command loop. */
1020 cmd_error (Lisp_Object data
)
1022 Lisp_Object old_level
, old_length
;
1023 char macroerror
[sizeof "After..kbd macro iterations: "
1024 + INT_STRLEN_BOUND (EMACS_INT
)];
1026 #ifdef HAVE_WINDOW_SYSTEM
1027 if (display_hourglass_p
)
1028 cancel_hourglass ();
1031 if (!NILP (executing_kbd_macro
))
1033 if (executing_kbd_macro_iterations
== 1)
1034 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1036 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1037 executing_kbd_macro_iterations
);
1042 Vstandard_output
= Qt
;
1043 Vstandard_input
= Qt
;
1044 Vexecuting_kbd_macro
= Qnil
;
1045 executing_kbd_macro
= Qnil
;
1046 kset_prefix_arg (current_kboard
, Qnil
);
1047 kset_last_prefix_arg (current_kboard
, Qnil
);
1050 /* Avoid unquittable loop if data contains a circular list. */
1051 old_level
= Vprint_level
;
1052 old_length
= Vprint_length
;
1053 XSETFASTINT (Vprint_level
, 10);
1054 XSETFASTINT (Vprint_length
, 10);
1055 cmd_error_internal (data
, macroerror
);
1056 Vprint_level
= old_level
;
1057 Vprint_length
= old_length
;
1060 Vinhibit_quit
= Qnil
;
1062 return make_number (0);
1065 /* Take actions on handling an error. DATA is the data that describes
1068 CONTEXT is a C-string containing ASCII characters only which
1069 describes the context in which the error happened. If we need to
1070 generalize CONTEXT to allow multibyte characters, make it a Lisp
1074 cmd_error_internal (Lisp_Object data
, const char *context
)
1076 struct frame
*sf
= SELECTED_FRAME ();
1078 /* The immediate context is not interesting for Quits,
1079 since they are asynchronous. */
1080 if (EQ (XCAR (data
), Qquit
))
1081 Vsignaling_function
= Qnil
;
1086 /* Use user's specified output function if any. */
1087 if (!NILP (Vcommand_error_function
))
1088 call3 (Vcommand_error_function
, data
,
1089 context
? build_string (context
) : empty_unibyte_string
,
1090 Vsignaling_function
);
1091 /* If the window system or terminal frame hasn't been initialized
1092 yet, or we're not interactive, write the message to stderr and exit. */
1093 else if (!sf
->glyphs_initialized_p
1094 /* The initial frame is a special non-displaying frame. It
1095 will be current in daemon mode when there are no frames
1096 to display, and in non-daemon mode before the real frame
1097 has finished initializing. If an error is thrown in the
1098 latter case while creating the frame, then the frame
1099 will never be displayed, so the safest thing to do is
1100 write to stderr and quit. In daemon mode, there are
1101 many other potential errors that do not prevent frames
1102 from being created, so continuing as normal is better in
1104 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1107 print_error_message (data
, Qexternal_debugging_output
,
1108 context
, Vsignaling_function
);
1109 Fterpri (Qexternal_debugging_output
);
1110 Fkill_emacs (make_number (-1));
1114 clear_message (1, 0);
1116 message_log_maybe_newline ();
1119 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1122 Vsignaling_function
= Qnil
;
1125 static Lisp_Object
command_loop_2 (Lisp_Object
);
1126 static Lisp_Object
top_level_1 (Lisp_Object
);
1128 /* Entry to editor-command-loop.
1129 This level has the catches for exiting/returning to editor command loop.
1130 It returns nil to exit recursive edit, t to abort it. */
1135 if (command_loop_level
> 0 || minibuf_level
> 0)
1138 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1139 executing_kbd_macro
= Qnil
;
1145 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1146 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1147 executing_kbd_macro
= Qnil
;
1149 /* End of file in -batch run causes exit here. */
1155 /* Here we catch errors in execution of commands within the
1156 editing loop, and reenter the editing loop.
1157 When there is an error, cmd_error runs and returns a non-nil
1158 value to us. A value of nil means that command_loop_1 itself
1159 returned due to end of file (or end of kbd macro). */
1162 command_loop_2 (Lisp_Object ignore
)
1164 register Lisp_Object val
;
1167 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1168 while (!NILP (val
));
1176 return Feval (Vtop_level
, Qnil
);
1180 top_level_1 (Lisp_Object ignore
)
1182 /* On entry to the outer level, run the startup file. */
1183 if (!NILP (Vtop_level
))
1184 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1185 else if (!NILP (Vpurify_flag
))
1186 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1188 message1 ("Bare Emacs (standard Lisp code not loaded)");
1192 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1193 doc
: /* Exit all recursive editing levels.
1194 This also exits all active minibuffers. */)
1197 #ifdef HAVE_WINDOW_SYSTEM
1198 if (display_hourglass_p
)
1199 cancel_hourglass ();
1202 /* Unblock input if we enter with input blocked. This may happen if
1203 redisplay traps e.g. during tool-bar update with input blocked. */
1204 totally_unblock_input ();
1206 Fthrow (Qtop_level
, Qnil
);
1209 static _Noreturn
void
1210 user_error (const char *msg
)
1212 xsignal1 (Quser_error
, build_string (msg
));
1216 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1217 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1220 if (command_loop_level
> 0 || minibuf_level
> 0)
1221 Fthrow (Qexit
, Qnil
);
1223 user_error ("No recursive edit is in progress");
1227 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1228 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1231 if (command_loop_level
> 0 || minibuf_level
> 0)
1234 user_error ("No recursive edit is in progress");
1237 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1238 of this function. */
1241 tracking_off (Lisp_Object old_value
)
1243 do_mouse_tracking
= old_value
;
1244 if (NILP (old_value
))
1246 /* Redisplay may have been preempted because there was input
1247 available, and it assumes it will be called again after the
1248 input has been processed. If the only input available was
1249 the sort that we have just disabled, then we need to call
1251 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1253 redisplay_preserve_echo_area (6);
1254 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1260 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1261 doc
: /* Evaluate BODY with mouse movement events enabled.
1262 Within a `track-mouse' form, mouse motion generates input events that
1263 you can read with `read-event'.
1264 Normally, mouse motion is ignored.
1265 usage: (track-mouse BODY...) */)
1268 ptrdiff_t count
= SPECPDL_INDEX ();
1271 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1273 do_mouse_tracking
= Qt
;
1275 val
= Fprogn (args
);
1276 return unbind_to (count
, val
);
1279 /* If mouse has moved on some frame, return one of those frames.
1283 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1284 after resizing the tool-bar window. */
1286 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1289 bool ignore_mouse_drag_p
;
1292 some_mouse_moved (void)
1294 Lisp_Object tail
, frame
;
1296 if (ignore_mouse_drag_p
)
1298 /* ignore_mouse_drag_p = 0; */
1302 FOR_EACH_FRAME (tail
, frame
)
1304 if (XFRAME (frame
)->mouse_moved
)
1305 return XFRAME (frame
);
1312 /* This is the actual command reading loop,
1313 sans error-handling encapsulation. */
1315 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1317 void safe_run_hooks (Lisp_Object
);
1318 static void adjust_point_for_property (ptrdiff_t, bool);
1320 /* Cancel hourglass from protect_unwind.
1322 #ifdef HAVE_WINDOW_SYSTEM
1324 cancel_hourglass_unwind (Lisp_Object arg
)
1326 cancel_hourglass ();
1331 /* The last boundary auto-added to buffer-undo-list. */
1332 Lisp_Object last_undo_boundary
;
1334 /* FIXME: This is wrong rather than test window-system, we should call
1335 a new set-selection, which will then dispatch to x-set-selection, or
1336 tty-set-selection, or w32-set-selection, ... */
1339 command_loop_1 (void)
1342 Lisp_Object keybuf
[30];
1344 EMACS_INT prev_modiff
= 0;
1345 struct buffer
*prev_buffer
= NULL
;
1346 bool already_adjusted
= 0;
1348 kset_prefix_arg (current_kboard
, Qnil
);
1349 kset_last_prefix_arg (current_kboard
, Qnil
);
1350 Vdeactivate_mark
= Qnil
;
1351 waiting_for_input
= 0;
1354 this_command_key_count
= 0;
1355 this_command_key_count_reset
= 0;
1356 this_single_command_key_start
= 0;
1358 if (NILP (Vmemory_full
))
1360 /* Make sure this hook runs after commands that get errors and
1361 throw to top level. */
1362 /* Note that the value cell will never directly contain nil
1363 if the symbol is a local variable. */
1364 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1365 safe_run_hooks (Qpost_command_hook
);
1367 /* If displaying a message, resize the echo area window to fit
1368 that message's size exactly. */
1369 if (!NILP (echo_area_buffer
[0]))
1370 resize_echo_area_exactly ();
1372 /* If there are warnings waiting, process them. */
1373 if (!NILP (Vdelayed_warnings_list
))
1374 safe_run_hooks (Qdelayed_warnings_hook
);
1376 if (!NILP (Vdeferred_action_list
))
1377 safe_run_hooks (Qdeferred_action_function
);
1380 /* Do this after running Vpost_command_hook, for consistency. */
1381 kset_last_command (current_kboard
, Vthis_command
);
1382 kset_real_last_command (current_kboard
, Vreal_this_command
);
1383 if (!CONSP (last_command_event
))
1384 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1388 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1391 /* Make sure the current window's buffer is selected. */
1392 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1394 /* Display any malloc warning that just came out. Use while because
1395 displaying one warning can cause another. */
1397 while (pending_malloc_warning
)
1398 display_malloc_warning ();
1400 Vdeactivate_mark
= Qnil
;
1402 /* Don't ignore mouse movements for more than a single command
1403 loop. (This flag is set in xdisp.c whenever the tool bar is
1404 resized, because the resize moves text up or down, and would
1405 generate false mouse drag events if we don't ignore them.) */
1406 ignore_mouse_drag_p
= 0;
1408 /* If minibuffer on and echo area in use,
1409 wait a short time and redraw minibuffer. */
1412 && !NILP (echo_area_buffer
[0])
1413 && EQ (minibuf_window
, echo_area_window
)
1414 && NUMBERP (Vminibuffer_message_timeout
))
1416 /* Bind inhibit-quit to t so that C-g gets read in
1417 rather than quitting back to the minibuffer. */
1418 ptrdiff_t count
= SPECPDL_INDEX ();
1419 specbind (Qinhibit_quit
, Qt
);
1421 sit_for (Vminibuffer_message_timeout
, 0, 2);
1423 /* Clear the echo area. */
1425 safe_run_hooks (Qecho_area_clear_hook
);
1427 unbind_to (count
, Qnil
);
1429 /* If a C-g came in before, treat it as input now. */
1430 if (!NILP (Vquit_flag
))
1433 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1437 /* If it has changed current-menubar from previous value,
1438 really recompute the menubar from the value. */
1439 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1440 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1441 call0 (Qrecompute_lucid_menubar
);
1443 before_command_key_count
= this_command_key_count
;
1444 before_command_echo_length
= echo_length ();
1446 Vthis_command
= Qnil
;
1447 Vreal_this_command
= Qnil
;
1448 Vthis_original_command
= Qnil
;
1449 Vthis_command_keys_shift_translated
= Qnil
;
1451 /* Read next key sequence; i gets its length. */
1452 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1455 /* A filter may have run while we were reading the input. */
1456 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1458 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1462 /* Now we have read a key sequence of length I,
1463 or else I is 0 and we found end of file. */
1465 if (i
== 0) /* End of file -- happens only in */
1466 return Qnil
; /* a kbd macro, at the end. */
1467 /* -1 means read_key_sequence got a menu that was rejected.
1468 Just loop around and read another command. */
1472 this_command_key_count
= 0;
1473 this_command_key_count_reset
= 0;
1474 this_single_command_key_start
= 0;
1478 last_command_event
= keybuf
[i
- 1];
1480 /* If the previous command tried to force a specific window-start,
1481 forget about that, in case this command moves point far away
1482 from that position. But also throw away beg_unchanged and
1483 end_unchanged information in that case, so that redisplay will
1484 update the whole window properly. */
1485 if (XWINDOW (selected_window
)->force_start
)
1488 XWINDOW (selected_window
)->force_start
= 0;
1489 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1490 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1493 cmd
= read_key_sequence_cmd
;
1494 if (!NILP (Vexecuting_kbd_macro
))
1496 if (!NILP (Vquit_flag
))
1498 Vexecuting_kbd_macro
= Qt
;
1499 QUIT
; /* Make some noise. */
1500 /* Will return since macro now empty. */
1504 /* Do redisplay processing after this command except in special
1505 cases identified below. */
1506 prev_buffer
= current_buffer
;
1507 prev_modiff
= MODIFF
;
1508 last_point_position
= PT
;
1510 /* By default, we adjust point to a boundary of a region that
1511 has such a property that should be treated intangible
1512 (e.g. composition, display). But, some commands will set
1513 this variable differently. */
1514 Vdisable_point_adjustment
= Qnil
;
1516 /* Process filters and timers may have messed with deactivate-mark.
1517 reset it before we execute the command. */
1518 Vdeactivate_mark
= Qnil
;
1520 /* Remap command through active keymaps. */
1521 Vthis_original_command
= cmd
;
1522 if (!NILP (read_key_sequence_remapped
))
1523 cmd
= read_key_sequence_remapped
;
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 Vreal_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1535 /* nil means key is undefined. */
1536 Lisp_Object keys
= Fvector (i
, keybuf
);
1537 keys
= Fkey_description (keys
, Qnil
);
1539 message_with_string ("%s is undefined", keys
, 0);
1540 kset_defining_kbd_macro (current_kboard
, Qnil
);
1541 update_mode_lines
= 1;
1542 /* If this is a down-mouse event, don't reset prefix-arg;
1543 pass it to the command run by the up event. */
1544 if (EVENT_HAS_PARAMETERS (last_command_event
))
1546 Lisp_Object breakdown
1547 = parse_modifiers (EVENT_HEAD (last_command_event
));
1548 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1549 if (!(modifiers
& down_modifier
))
1550 kset_prefix_arg (current_kboard
, Qnil
);
1553 kset_prefix_arg (current_kboard
, Qnil
);
1557 /* Here for a command that isn't executed directly. */
1559 #ifdef HAVE_WINDOW_SYSTEM
1560 ptrdiff_t scount
= SPECPDL_INDEX ();
1562 if (display_hourglass_p
1563 && NILP (Vexecuting_kbd_macro
))
1565 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1570 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1572 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1575 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1576 ? Qnil
: BVAR (current_buffer
, undo_list
));
1578 call1 (Qcommand_execute
, Vthis_command
);
1580 #ifdef HAVE_WINDOW_SYSTEM
1581 /* Do not check display_hourglass_p here, because
1582 `command-execute' could change it, but we should cancel
1583 hourglass cursor anyway.
1584 But don't cancel the hourglass within a macro
1585 just because a command in the macro finishes. */
1586 if (NILP (Vexecuting_kbd_macro
))
1587 unbind_to (scount
, Qnil
);
1590 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1592 safe_run_hooks (Qpost_command_hook
);
1594 /* If displaying a message, resize the echo area window to fit
1595 that message's size exactly. */
1596 if (!NILP (echo_area_buffer
[0]))
1597 resize_echo_area_exactly ();
1599 /* If there are warnings waiting, process them. */
1600 if (!NILP (Vdelayed_warnings_list
))
1601 safe_run_hooks (Qdelayed_warnings_hook
);
1603 safe_run_hooks (Qdeferred_action_function
);
1605 /* If there is a prefix argument,
1606 1) We don't want Vlast_command to be ``universal-argument''
1607 (that would be dumb), so don't set Vlast_command,
1608 2) we want to leave echoing on so that the prefix will be
1609 echoed as part of this key sequence, so don't call
1611 3) we want to leave this_command_key_count non-zero, so that
1612 read_char will realize that it is re-reading a character, and
1613 not echo it a second time.
1615 If the command didn't actually create a prefix arg,
1616 but is merely a frame event that is transparent to prefix args,
1617 then the above doesn't apply. */
1618 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1619 || CONSP (last_command_event
))
1621 kset_last_command (current_kboard
, Vthis_command
);
1622 kset_real_last_command (current_kboard
, Vreal_this_command
);
1623 if (!CONSP (last_command_event
))
1624 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1626 this_command_key_count
= 0;
1627 this_command_key_count_reset
= 0;
1628 this_single_command_key_start
= 0;
1631 if (!NILP (BVAR (current_buffer
, mark_active
))
1632 && !NILP (Vrun_hooks
))
1634 /* In Emacs 22, setting transient-mark-mode to `only' was a
1635 way of turning it on for just one command. This usage is
1636 obsolete, but support it anyway. */
1637 if (EQ (Vtransient_mark_mode
, Qidentity
))
1638 Vtransient_mark_mode
= Qnil
;
1639 else if (EQ (Vtransient_mark_mode
, Qonly
))
1640 Vtransient_mark_mode
= Qidentity
;
1642 if (!NILP (Vdeactivate_mark
))
1643 /* If `select-active-regions' is non-nil, this call to
1644 `deactivate-mark' also sets the PRIMARY selection. */
1645 call0 (Qdeactivate_mark
);
1648 /* Even if not deactivating the mark, set PRIMARY if
1649 `select-active-regions' is non-nil. */
1650 if (!NILP (Fwindow_system (Qnil
))
1651 /* Even if mark_active is non-nil, the actual buffer
1652 marker may not have been set yet (Bug#7044). */
1653 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1654 && (EQ (Vselect_active_regions
, Qonly
)
1655 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1656 : (!NILP (Vselect_active_regions
)
1657 && !NILP (Vtransient_mark_mode
)))
1658 && NILP (Fmemq (Vthis_command
,
1659 Vselection_inhibit_update_commands
)))
1662 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1665 call2 (Qx_set_selection
, QPRIMARY
,
1666 make_buffer_string (beg
, end
, 0));
1668 call2 (Qx_set_selection
, QPRIMARY
,
1669 make_buffer_string (end
, beg
, 0));
1670 /* Don't set empty selections. */
1673 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1675 Lisp_Object hook
= intern ("activate-mark-hook");
1676 Frun_hooks (1, &hook
);
1680 Vsaved_region_selection
= Qnil
;
1685 if (current_buffer
== prev_buffer
1686 && last_point_position
!= PT
1687 && NILP (Vdisable_point_adjustment
)
1688 && NILP (Vglobal_disable_point_adjustment
))
1690 if (last_point_position
> BEGV
1691 && last_point_position
< ZV
1692 && (composition_adjust_point (last_point_position
,
1693 last_point_position
)
1694 != last_point_position
))
1695 /* The last point was temporarily set within a grapheme
1696 cluster to prevent automatic composition. To recover
1697 the automatic composition, we must update the
1699 windows_or_buffers_changed
++;
1700 if (!already_adjusted
)
1701 adjust_point_for_property (last_point_position
,
1702 MODIFF
!= prev_modiff
);
1705 /* Install chars successfully executed in kbd macro. */
1707 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1708 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1709 finalize_kbd_macro_chars ();
1713 /* Adjust point to a boundary of a region that has such a property
1714 that should be treated intangible. For the moment, we check
1715 `composition', `display' and `invisible' properties.
1716 LAST_PT is the last position of point. */
1719 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1722 Lisp_Object val
, overlay
, tmp
;
1723 /* When called after buffer modification, we should temporarily
1724 suppress the point adjustment for automatic composition so that a
1725 user can keep inserting another character at point or keep
1726 deleting characters around point. */
1727 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1728 ptrdiff_t orig_pt
= PT
;
1730 /* FIXME: cycling is probably not necessary because these properties
1731 can't be usefully combined anyway. */
1732 while (check_composition
|| check_display
|| check_invisible
)
1734 /* FIXME: check `intangible'. */
1735 if (check_composition
1736 && PT
> BEGV
&& PT
< ZV
1737 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1740 check_display
= check_invisible
= 1;
1742 check_composition
= 0;
1744 && PT
> BEGV
&& PT
< ZV
1745 && !NILP (val
= get_char_property_and_overlay
1746 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1747 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1748 && (!OVERLAYP (overlay
)
1749 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1750 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1751 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1752 && (beg
< PT
/* && end > PT <- It's always the case. */
1753 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1756 SET_PT (PT
< last_pt
1757 ? (STRINGP (val
) && SCHARS (val
) == 0
1758 ? max (beg
- 1, BEGV
)
1761 check_composition
= check_invisible
= 1;
1764 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1770 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1773 /* FIXME: We should stop if we find a spot between
1774 two runs of `invisible' where inserted text would
1775 be visible. This is important when we have two
1776 invisible boundaries that enclose an area: if the
1777 area is empty, we need this test in order to make
1778 it possible to place point in the middle rather
1779 than skip both boundaries. However, this code
1780 also stops anywhere in a non-sticky text-property,
1781 which breaks (e.g.) Org mode. */
1782 && (val
= get_pos_property (make_number (end
),
1784 TEXT_PROP_MEANS_INVISIBLE (val
))
1786 && !NILP (val
= get_char_property_and_overlay
1787 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1788 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1790 ellipsis
= ellipsis
|| inv
> 1
1791 || (OVERLAYP (overlay
)
1792 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1793 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1794 tmp
= Fnext_single_char_property_change
1795 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1796 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1800 && (val
= get_pos_property (make_number (beg
),
1802 TEXT_PROP_MEANS_INVISIBLE (val
))
1804 && !NILP (val
= get_char_property_and_overlay
1805 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1806 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1808 ellipsis
= ellipsis
|| inv
> 1
1809 || (OVERLAYP (overlay
)
1810 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1811 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1812 tmp
= Fprevious_single_char_property_change
1813 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1814 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1817 /* Move away from the inside area. */
1818 if (beg
< PT
&& end
> PT
)
1820 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1821 /* We haven't moved yet (so we don't need to fear
1822 infinite-looping) and we were outside the range
1823 before (so either end of the range still corresponds
1824 to a move in the right direction): pretend we moved
1825 less than we actually did, so that we still have
1826 more freedom below in choosing which end of the range
1828 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1829 /* We either have moved already or the last point
1830 was already in the range: we don't get to choose
1831 which end of the range we have to go to. */
1832 : (PT
< last_pt
? beg
: end
));
1833 check_composition
= check_display
= 1;
1835 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1836 the point to something other than its argument, due to
1837 point-motion hooks, intangibility, etc. */
1838 eassert (PT
== beg
|| PT
== end
);
1841 /* Pretend the area doesn't exist if the buffer is not
1843 if (!modified
&& !ellipsis
&& beg
< end
)
1845 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1846 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1847 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1848 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1849 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1850 /* We've already moved as far as we can. Trying to go
1851 to the other end would mean moving backwards and thus
1852 could lead to an infinite loop. */
1854 else if (val
= get_pos_property (make_number (PT
),
1856 TEXT_PROP_MEANS_INVISIBLE (val
)
1857 && (val
= get_pos_property
1858 (make_number (PT
== beg
? end
: beg
),
1860 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1861 (check_composition
= check_display
= 1,
1862 SET_PT (PT
== beg
? end
: beg
));
1865 check_invisible
= 0;
1869 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1872 safe_run_hooks_1 (void)
1874 eassert (CONSP (Vinhibit_quit
));
1875 return call0 (XCDR (Vinhibit_quit
));
1878 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1882 safe_run_hooks_error (Lisp_Object error_data
)
1885 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1886 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1887 Lisp_Object args
[4];
1888 args
[0] = build_string ("Error in %s (%s): %S");
1891 args
[3] = error_data
;
1897 Lisp_Object newval
= Qnil
;
1898 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1899 if (EQ (fun
, XCAR (val
)))
1902 newval
= Fcons (XCAR (val
), newval
);
1904 return Fset (hook
, Fnreverse (newval
));
1905 /* Not found in the local part of the hook. Let's look at the global
1908 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1909 : Fdefault_value (hook
));
1910 CONSP (val
); val
= XCDR (val
))
1911 if (EQ (fun
, XCAR (val
)))
1914 newval
= Fcons (XCAR (val
), newval
);
1916 return Fset_default (hook
, Fnreverse (newval
));
1922 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1924 eassert (nargs
== 1);
1925 if (CONSP (Vinhibit_quit
))
1926 XSETCDR (Vinhibit_quit
, args
[0]);
1928 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1930 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1934 /* If we get an error while running the hook, cause the hook variable
1935 to be nil. Also inhibit quits, so that C-g won't cause the hook
1936 to mysteriously evaporate. */
1939 safe_run_hooks (Lisp_Object hook
)
1941 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1942 to its body or to its handlers other than via globals such as
1943 dynamically-bound variables ;-) */
1944 ptrdiff_t count
= SPECPDL_INDEX ();
1945 specbind (Qinhibit_quit
, hook
);
1947 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1949 unbind_to (count
, Qnil
);
1953 /* Nonzero means polling for input is temporarily suppressed. */
1955 int poll_suppress_count
;
1958 #ifdef POLL_FOR_INPUT
1960 /* Asynchronous timer for polling. */
1962 static struct atimer
*poll_timer
;
1964 /* Poll for input, so that we catch a C-g if it comes in. This
1965 function is called from x_make_frame_visible, see comment
1969 poll_for_input_1 (void)
1971 if (! input_blocked_p ()
1972 && !waiting_for_input
)
1976 /* Timer callback function for poll_timer. TIMER is equal to
1980 poll_for_input (struct atimer
*timer
)
1982 if (poll_suppress_count
== 0)
1983 pending_signals
= 1;
1986 #endif /* POLL_FOR_INPUT */
1988 /* Begin signals to poll for input, if they are appropriate.
1989 This function is called unconditionally from various places. */
1992 start_polling (void)
1994 #ifdef POLL_FOR_INPUT
1995 /* XXX This condition was (read_socket_hook && !interrupt_input),
1996 but read_socket_hook is not global anymore. Let's pretend that
1998 if (!interrupt_input
)
2000 /* Turn alarm handling on unconditionally. It might have
2001 been turned off in process.c. */
2002 turn_on_atimers (1);
2004 /* If poll timer doesn't exist, are we need one with
2005 a different interval, start a new one. */
2006 if (poll_timer
== NULL
2007 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2009 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2010 EMACS_TIME interval
= make_emacs_time (period
, 0);
2013 cancel_atimer (poll_timer
);
2015 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2016 poll_for_input
, NULL
);
2019 /* Let the timer's callback function poll for input
2020 if this becomes zero. */
2021 --poll_suppress_count
;
2026 /* True if we are using polling to handle input asynchronously. */
2029 input_polling_used (void)
2031 #ifdef POLL_FOR_INPUT
2032 /* XXX This condition was (read_socket_hook && !interrupt_input),
2033 but read_socket_hook is not global anymore. Let's pretend that
2035 return !interrupt_input
;
2041 /* Turn off polling. */
2046 #ifdef POLL_FOR_INPUT
2047 /* XXX This condition was (read_socket_hook && !interrupt_input),
2048 but read_socket_hook is not global anymore. Let's pretend that
2050 if (!interrupt_input
)
2051 ++poll_suppress_count
;
2055 /* Set the value of poll_suppress_count to COUNT
2056 and start or stop polling accordingly. */
2059 set_poll_suppress_count (int count
)
2061 #ifdef POLL_FOR_INPUT
2062 if (count
== 0 && poll_suppress_count
!= 0)
2064 poll_suppress_count
= 1;
2067 else if (count
!= 0 && poll_suppress_count
== 0)
2071 poll_suppress_count
= count
;
2075 /* Bind polling_period to a value at least N.
2076 But don't decrease it. */
2079 bind_polling_period (int n
)
2081 #ifdef POLL_FOR_INPUT
2082 EMACS_INT
new = polling_period
;
2087 stop_other_atimers (poll_timer
);
2089 specbind (Qpolling_period
, make_number (new));
2090 /* Start a new alarm with the new period. */
2095 /* Apply the control modifier to CHARACTER. */
2098 make_ctrl_char (int c
)
2100 /* Save the upper bits here. */
2101 int upper
= c
& ~0177;
2103 if (! ASCII_BYTE_P (c
))
2104 return c
|= ctrl_modifier
;
2108 /* Everything in the columns containing the upper-case letters
2109 denotes a control character. */
2110 if (c
>= 0100 && c
< 0140)
2114 /* Set the shift modifier for a control char
2115 made from a shifted letter. But only for letters! */
2116 if (oc
>= 'A' && oc
<= 'Z')
2117 c
|= shift_modifier
;
2120 /* The lower-case letters denote control characters too. */
2121 else if (c
>= 'a' && c
<= 'z')
2124 /* Include the bits for control and shift
2125 only if the basic ASCII code can't indicate them. */
2129 /* Replace the high bits. */
2130 c
|= (upper
& ~ctrl_modifier
);
2135 /* Display the help-echo property of the character after the mouse pointer.
2136 Either show it in the echo area, or call show-help-function to display
2137 it by other means (maybe in a tooltip).
2139 If HELP is nil, that means clear the previous help echo.
2141 If HELP is a string, display that string. If HELP is a function,
2142 call it with OBJECT and POS as arguments; the function should
2143 return a help string or nil for none. For all other types of HELP,
2144 evaluate it to obtain a string.
2146 WINDOW is the window in which the help was generated, if any.
2147 It is nil if not in a window.
2149 If OBJECT is a buffer, POS is the position in the buffer where the
2150 `help-echo' text property was found.
2152 If OBJECT is an overlay, that overlay has a `help-echo' property,
2153 and POS is the position in the overlay's buffer under the mouse.
2155 If OBJECT is a string (an overlay string or a string displayed with
2156 the `display' property). POS is the position in that string under
2159 Note: this function may only be called with HELP nil or a string
2160 from X code running asynchronously. */
2163 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2166 if (!NILP (help
) && !STRINGP (help
))
2168 if (FUNCTIONP (help
))
2169 help
= safe_call (4, help
, window
, object
, pos
);
2171 help
= safe_eval (help
);
2173 if (!STRINGP (help
))
2177 if (!noninteractive
&& STRINGP (help
))
2179 /* The mouse-fixup-help-message Lisp function can call
2180 mouse_position_hook, which resets the mouse_moved flags.
2181 This causes trouble if we are trying to read a mouse motion
2182 event (i.e., if we are inside a `track-mouse' form), so we
2183 restore the mouse_moved flag. */
2184 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2185 help
= call1 (Qmouse_fixup_help_message
, help
);
2190 if (STRINGP (help
) || NILP (help
))
2192 if (!NILP (Vshow_help_function
))
2193 call1 (Vshow_help_function
, help
);
2194 help_echo_showing_p
= STRINGP (help
);
2200 /* Input of single characters from keyboard */
2202 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2203 EMACS_TIME
*end_time
);
2204 static void record_char (Lisp_Object c
);
2206 static Lisp_Object help_form_saved_window_configs
;
2208 read_char_help_form_unwind (Lisp_Object arg
)
2210 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2211 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2212 if (!NILP (window_config
))
2213 Fset_window_configuration (window_config
);
2217 #define STOP_POLLING \
2218 do { if (! polling_stopped_here) stop_polling (); \
2219 polling_stopped_here = 1; } while (0)
2221 #define RESUME_POLLING \
2222 do { if (polling_stopped_here) start_polling (); \
2223 polling_stopped_here = 0; } while (0)
2225 /* Read a character from the keyboard; call the redisplay if needed. */
2226 /* commandflag 0 means do not autosave, but do redisplay.
2227 -1 means do not redisplay, but do autosave.
2230 /* The arguments MAP is for menu prompting. MAP is a keymap.
2232 PREV_EVENT is the previous input event, or nil if we are reading
2233 the first event of a key sequence (or not reading a key sequence).
2234 If PREV_EVENT is t, that is a "magic" value that says
2235 not to run input methods, but in other respects to act as if
2236 not reading a key sequence.
2238 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2239 if we used a mouse menu to read the input, or false otherwise. If
2240 USED_MOUSE_MENU is null, don't dereference it.
2242 Value is -2 when we find input on another keyboard. A second call
2243 to read_char will read it.
2245 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2246 specifying the maximum time to wait until. If no input arrives by
2247 that time, stop waiting and return nil.
2249 Value is t if we showed a menu and the user rejected it. */
2252 read_char (int commandflag
, Lisp_Object map
,
2253 Lisp_Object prev_event
,
2254 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2258 sys_jmp_buf local_getcjmp
;
2259 sys_jmp_buf save_jump
;
2260 Lisp_Object tem
, save
;
2261 volatile Lisp_Object previous_echo_area_message
;
2262 volatile Lisp_Object also_record
;
2263 volatile bool reread
;
2264 struct gcpro gcpro1
, gcpro2
;
2265 bool volatile polling_stopped_here
= 0;
2266 struct kboard
*orig_kboard
= current_kboard
;
2270 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2271 before_command_key_count
= this_command_key_count
;
2272 before_command_echo_length
= echo_length ();
2275 previous_echo_area_message
= Qnil
;
2277 GCPRO2 (c
, previous_echo_area_message
);
2282 if (CONSP (Vunread_post_input_method_events
))
2284 c
= XCAR (Vunread_post_input_method_events
);
2285 Vunread_post_input_method_events
2286 = XCDR (Vunread_post_input_method_events
);
2288 /* Undo what read_char_x_menu_prompt did when it unread
2289 additional keys returned by Fx_popup_menu. */
2291 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2299 if (CONSP (Vunread_command_events
))
2301 bool was_disabled
= 0;
2303 c
= XCAR (Vunread_command_events
);
2304 Vunread_command_events
= XCDR (Vunread_command_events
);
2308 /* Undo what sit-for did when it unread additional keys
2309 inside universal-argument. */
2312 && EQ (XCAR (c
), Qt
))
2318 /* Undo what read_char_x_menu_prompt did when it unread
2319 additional keys returned by Fx_popup_menu. */
2321 && EQ (XCDR (c
), Qdisabled
)
2322 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2328 /* If the queued event is something that used the mouse,
2329 set used_mouse_menu accordingly. */
2331 /* Also check was_disabled so last-nonmenu-event won't return
2332 a bad value when submenus are involved. (Bug#447) */
2333 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2334 *used_mouse_menu
= 1;
2336 goto reread_for_input_method
;
2339 if (CONSP (Vunread_input_method_events
))
2341 c
= XCAR (Vunread_input_method_events
);
2342 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2344 /* Undo what read_char_x_menu_prompt did when it unread
2345 additional keys returned by Fx_popup_menu. */
2347 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2351 goto reread_for_input_method
;
2354 this_command_key_count_reset
= 0;
2356 if (!NILP (Vexecuting_kbd_macro
))
2358 /* We set this to Qmacro; since that's not a frame, nobody will
2359 try to switch frames on us, and the selected window will
2362 Since this event came from a macro, it would be misleading to
2363 leave internal_last_event_frame set to wherever the last
2364 real event came from. Normally, a switch-frame event selects
2365 internal_last_event_frame after each command is read, but
2366 events read from a macro should never cause a new frame to be
2368 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2370 /* Exit the macro if we are at the end.
2371 Also, some things replace the macro with t
2372 to force an early exit. */
2373 if (EQ (Vexecuting_kbd_macro
, Qt
)
2374 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2380 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2381 if (STRINGP (Vexecuting_kbd_macro
)
2382 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2383 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2385 executing_kbd_macro_index
++;
2390 if (!NILP (unread_switch_frame
))
2392 c
= unread_switch_frame
;
2393 unread_switch_frame
= Qnil
;
2395 /* This event should make it into this_command_keys, and get echoed
2396 again, so we do not set `reread'. */
2400 /* If redisplay was requested. */
2401 if (commandflag
>= 0)
2403 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2405 /* If there is pending input, process any events which are not
2406 user-visible, such as X selection_request events. */
2408 || detect_input_pending_run_timers (0))
2409 swallow_events (0); /* May clear input_pending. */
2411 /* Redisplay if no pending input. */
2412 while (!input_pending
)
2414 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2415 redisplay_preserve_echo_area (5);
2420 /* Normal case: no input arrived during redisplay. */
2423 /* Input arrived and pre-empted redisplay.
2424 Process any events which are not user-visible. */
2426 /* If that cleared input_pending, try again to redisplay. */
2429 /* Prevent the redisplay we just did
2430 from messing up echoing of the input after the prompt. */
2431 if (commandflag
== 0 && echo_current
)
2432 echo_message_buffer
= echo_area_buffer
[0];
2436 /* Message turns off echoing unless more keystrokes turn it on again.
2438 The code in 20.x for the condition was
2440 1. echo_area_glyphs && *echo_area_glyphs
2441 2. && echo_area_glyphs != current_kboard->echobuf
2442 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2444 (1) means there's a current message displayed
2446 (2) means it's not the message from echoing from the current
2449 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2450 is set to a non-null value. This is done in read_char and it is
2451 set to echo_area_glyphs after a call to echo_char. That means
2452 ok_to_echo_at_next_pause is either null or
2453 current_kboard->echobuf with the appropriate current_kboard at
2456 So, condition (3) means in clear text ok_to_echo_at_next_pause
2457 must be either null, or the current message isn't from echoing at
2458 all, or it's from echoing from a different kboard than the
2461 if (/* There currently is something in the echo area. */
2462 !NILP (echo_area_buffer
[0])
2463 && (/* And it's either not from echoing. */
2464 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2465 /* Or it's an echo from a different kboard. */
2466 || echo_kboard
!= current_kboard
2467 /* Or we explicitly allow overwriting whatever there is. */
2468 || ok_to_echo_at_next_pause
== NULL
))
2473 /* Try reading a character via menu prompting in the minibuf.
2474 Try this before the sit-for, because the sit-for
2475 would do the wrong thing if we are supposed to do
2476 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2477 after a mouse event so don't try a minibuf menu. */
2479 if (KEYMAPP (map
) && INTERACTIVE
2480 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2481 /* Don't bring up a menu if we already have another event. */
2482 && NILP (Vunread_command_events
)
2483 && !detect_input_pending_run_timers (0))
2485 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2487 if (INTEGERP (c
) && XINT (c
) == -2)
2488 return c
; /* wrong_kboard_jmpbuf */
2494 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2495 We will do that below, temporarily for short sections of code,
2496 when appropriate. local_getcjmp must be in effect
2497 around any call to sit_for or kbd_buffer_get_event;
2498 it *must not* be in effect when we call redisplay. */
2500 jmpcount
= SPECPDL_INDEX ();
2501 if (sys_setjmp (local_getcjmp
))
2503 /* Handle quits while reading the keyboard. */
2504 /* We must have saved the outer value of getcjmp here,
2505 so restore it now. */
2506 restore_getcjmp (save_jump
);
2507 unbind_to (jmpcount
, Qnil
);
2508 XSETINT (c
, quit_char
);
2509 internal_last_event_frame
= selected_frame
;
2510 Vlast_event_frame
= internal_last_event_frame
;
2511 /* If we report the quit char as an event,
2512 don't do so more than once. */
2513 if (!NILP (Vinhibit_quit
))
2517 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2518 if (kb
!= current_kboard
)
2520 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2521 /* We shouldn't get here if we were in single-kboard mode! */
2526 while (CONSP (XCDR (last
)))
2528 if (!NILP (XCDR (last
)))
2532 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2534 XSETCDR (last
, Fcons (c
, Qnil
));
2535 kb
->kbd_queue_has_data
= 1;
2536 current_kboard
= kb
;
2537 /* This is going to exit from read_char
2538 so we had better get rid of this frame's stuff. */
2540 return make_number (-2); /* wrong_kboard_jmpbuf */
2546 /* Start idle timers if no time limit is supplied. We don't do it
2547 if a time limit is supplied to avoid an infinite recursion in the
2548 situation where an idle timer calls `sit-for'. */
2551 timer_start_idle ();
2553 /* If in middle of key sequence and minibuffer not active,
2554 start echoing if enough time elapses. */
2556 if (minibuf_level
== 0
2558 && !current_kboard
->immediate_echo
2559 && this_command_key_count
> 0
2561 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2562 && NILP (Fzerop (Vecho_keystrokes
))
2563 && (/* No message. */
2564 NILP (echo_area_buffer
[0])
2565 /* Or empty message. */
2566 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2567 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2568 /* Or already echoing from same kboard. */
2569 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2570 /* Or not echoing before and echoing allowed. */
2571 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2573 /* After a mouse event, start echoing right away.
2574 This is because we are probably about to display a menu,
2575 and we don't want to delay before doing so. */
2576 if (EVENT_HAS_PARAMETERS (prev_event
))
2582 save_getcjmp (save_jump
);
2583 restore_getcjmp (local_getcjmp
);
2584 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2585 restore_getcjmp (save_jump
);
2587 && ! CONSP (Vunread_command_events
))
2592 /* Maybe auto save due to number of keystrokes. */
2594 if (commandflag
!= 0
2595 && auto_save_interval
> 0
2596 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2597 && !detect_input_pending_run_timers (0))
2599 Fdo_auto_save (Qnil
, Qnil
);
2600 /* Hooks can actually change some buffers in auto save. */
2604 /* Try reading using an X menu.
2605 This is never confused with reading using the minibuf
2606 because the recursive call of read_char in read_char_minibuf_menu_prompt
2607 does not pass on any keymaps. */
2609 if (KEYMAPP (map
) && INTERACTIVE
2610 && !NILP (prev_event
)
2611 && EVENT_HAS_PARAMETERS (prev_event
)
2612 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2613 && !EQ (XCAR (prev_event
), Qtool_bar
)
2614 /* Don't bring up a menu if we already have another event. */
2615 && NILP (Vunread_command_events
))
2617 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2619 /* Now that we have read an event, Emacs is not idle. */
2626 /* Maybe autosave and/or garbage collect due to idleness. */
2628 if (INTERACTIVE
&& NILP (c
))
2631 ptrdiff_t buffer_size
;
2633 /* Slow down auto saves logarithmically in size of current buffer,
2634 and garbage collect while we're at it. */
2635 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2636 last_non_minibuf_size
= Z
- BEG
;
2637 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2639 while (buffer_size
> 64)
2640 delay_level
++, buffer_size
-= buffer_size
>> 2;
2641 if (delay_level
< 4) delay_level
= 4;
2642 /* delay_level is 4 for files under around 50k, 7 at 100k,
2643 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2645 /* Auto save if enough time goes by without input. */
2646 if (commandflag
!= 0
2647 && num_nonmacro_input_events
> last_auto_save
2648 && INTEGERP (Vauto_save_timeout
)
2649 && XINT (Vauto_save_timeout
) > 0)
2652 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2654 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2655 timeout
= delay_level
* timeout
/ 4;
2656 save_getcjmp (save_jump
);
2657 restore_getcjmp (local_getcjmp
);
2658 tem0
= sit_for (make_number (timeout
), 1, 1);
2659 restore_getcjmp (save_jump
);
2662 && ! CONSP (Vunread_command_events
))
2664 Fdo_auto_save (Qnil
, Qnil
);
2669 /* If there is still no input available, ask for GC. */
2670 if (!detect_input_pending_run_timers (0))
2674 /* Notify the caller if an autosave hook, or a timer, sentinel or
2675 filter in the sit_for calls above have changed the current
2676 kboard. This could happen if they use the minibuffer or start a
2677 recursive edit, like the fancy splash screen in server.el's
2678 filter. If this longjmp wasn't here, read_key_sequence would
2679 interpret the next key sequence using the wrong translation
2680 tables and function keymaps. */
2681 if (NILP (c
) && current_kboard
!= orig_kboard
)
2684 return make_number (-2); /* wrong_kboard_jmpbuf */
2687 /* If this has become non-nil here, it has been set by a timer
2688 or sentinel or filter. */
2689 if (CONSP (Vunread_command_events
))
2691 c
= XCAR (Vunread_command_events
);
2692 Vunread_command_events
= XCDR (Vunread_command_events
);
2695 /* Read something from current KBOARD's side queue, if possible. */
2699 if (current_kboard
->kbd_queue_has_data
)
2701 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2703 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2704 kset_kbd_queue (current_kboard
,
2705 XCDR (KVAR (current_kboard
, kbd_queue
)));
2706 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2707 current_kboard
->kbd_queue_has_data
= 0;
2708 input_pending
= readable_events (0);
2709 if (EVENT_HAS_PARAMETERS (c
)
2710 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2711 internal_last_event_frame
= XCAR (XCDR (c
));
2712 Vlast_event_frame
= internal_last_event_frame
;
2716 /* If current_kboard's side queue is empty check the other kboards.
2717 If one of them has data that we have not yet seen here,
2718 switch to it and process the data waiting for it.
2720 Note: if the events queued up for another kboard
2721 have already been seen here, and therefore are not a complete command,
2722 the kbd_queue_has_data field is 0, so we skip that kboard here.
2723 That's to avoid an infinite loop switching between kboards here. */
2724 if (NILP (c
) && !single_kboard
)
2727 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2728 if (kb
->kbd_queue_has_data
)
2730 current_kboard
= kb
;
2731 /* This is going to exit from read_char
2732 so we had better get rid of this frame's stuff. */
2734 return make_number (-2); /* wrong_kboard_jmpbuf */
2742 /* Finally, we read from the main queue,
2743 and if that gives us something we can't use yet, we put it on the
2744 appropriate side queue and try again. */
2748 KBOARD
*kb
IF_LINT (= NULL
);
2750 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2753 /* Actually read a character, waiting if necessary. */
2754 save_getcjmp (save_jump
);
2755 restore_getcjmp (local_getcjmp
);
2757 timer_start_idle ();
2758 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2759 restore_getcjmp (save_jump
);
2761 if (! NILP (c
) && (kb
!= current_kboard
))
2763 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2766 while (CONSP (XCDR (last
)))
2768 if (!NILP (XCDR (last
)))
2772 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2774 XSETCDR (last
, Fcons (c
, Qnil
));
2775 kb
->kbd_queue_has_data
= 1;
2779 current_kboard
= kb
;
2780 /* This is going to exit from read_char
2781 so we had better get rid of this frame's stuff. */
2783 return make_number (-2);
2787 /* Terminate Emacs in batch mode if at eof. */
2788 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2789 Fkill_emacs (make_number (1));
2793 /* Add in any extra modifiers, where appropriate. */
2794 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2795 || ((extra_keyboard_modifiers
& 0177) < ' '
2796 && (extra_keyboard_modifiers
& 0177) != 0))
2797 XSETINT (c
, make_ctrl_char (XINT (c
)));
2799 /* Transfer any other modifier bits directly from
2800 extra_keyboard_modifiers to c. Ignore the actual character code
2801 in the low 16 bits of extra_keyboard_modifiers. */
2802 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2813 if (commandflag
>= 0
2814 && !input_pending
&& !detect_input_pending_run_timers (0))
2820 /* Buffer switch events are only for internal wakeups
2821 so don't show them to the user.
2822 Also, don't record a key if we already did. */
2826 /* Process special events within read_char
2827 and loop around to read another event. */
2830 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2835 struct buffer
*prev_buffer
= current_buffer
;
2836 last_input_event
= c
;
2837 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2839 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2840 /* We stopped being idle for this event; undo that. This
2841 prevents automatic window selection (under
2842 mouse_autoselect_window from acting as a real input event, for
2843 example banishing the mouse under mouse-avoidance-mode. */
2844 timer_resume_idle ();
2846 if (current_buffer
!= prev_buffer
)
2848 /* The command may have changed the keymaps. Pretend there
2849 is input in another keyboard and return. This will
2850 recalculate keymaps. */
2851 c
= make_number (-2);
2858 /* Handle things that only apply to characters. */
2861 /* If kbd_buffer_get_event gave us an EOF, return that. */
2865 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2866 && UNSIGNED_CMP (XFASTINT (c
), <,
2867 SCHARS (KVAR (current_kboard
,
2868 Vkeyboard_translate_table
))))
2869 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2870 && UNSIGNED_CMP (XFASTINT (c
), <,
2871 ASIZE (KVAR (current_kboard
,
2872 Vkeyboard_translate_table
))))
2873 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2877 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2878 /* nil in keyboard-translate-table means no translation. */
2884 /* If this event is a mouse click in the menu bar,
2885 return just menu-bar for now. Modify the mouse click event
2886 so we won't do this twice, then queue it up. */
2887 if (EVENT_HAS_PARAMETERS (c
)
2889 && CONSP (EVENT_START (c
))
2890 && CONSP (XCDR (EVENT_START (c
))))
2894 posn
= POSN_POSN (EVENT_START (c
));
2895 /* Handle menu-bar events:
2896 insert the dummy prefix event `menu-bar'. */
2897 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2899 /* Change menu-bar to (menu-bar) as the event "position". */
2900 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2903 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2908 /* Store these characters into recent_keys, the dribble file if any,
2909 and the keyboard macro being defined, if any. */
2911 if (! NILP (also_record
))
2912 record_char (also_record
);
2914 /* Wipe the echo area.
2915 But first, if we are about to use an input method,
2916 save the echo area contents for it to refer to. */
2918 && ! NILP (Vinput_method_function
)
2919 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2921 previous_echo_area_message
= Fcurrent_message ();
2922 Vinput_method_previous_message
= previous_echo_area_message
;
2925 /* Now wipe the echo area, except for help events which do their
2926 own stuff with the echo area. */
2928 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2929 && !(EQ (Qswitch_frame
, XCAR (c
)))
2930 /* Don't wipe echo area for select window events: These might
2931 get delayed via `mouse-autoselect-window' (Bug#11304). */
2932 && !(EQ (Qselect_window
, XCAR (c
)))))
2934 if (!NILP (echo_area_buffer
[0]))
2936 safe_run_hooks (Qecho_area_clear_hook
);
2937 clear_message (1, 0);
2941 reread_for_input_method
:
2943 /* Pass this to the input method, if appropriate. */
2945 && ! NILP (Vinput_method_function
)
2946 /* Don't run the input method within a key sequence,
2947 after the first event of the key sequence. */
2948 && NILP (prev_event
)
2949 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2952 ptrdiff_t key_count
;
2953 bool key_count_reset
;
2954 struct gcpro gcpro1
;
2955 ptrdiff_t count
= SPECPDL_INDEX ();
2957 /* Save the echo status. */
2958 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2959 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2960 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2961 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2964 if (before_command_restore_flag
)
2966 this_command_key_count
= before_command_key_count_1
;
2967 if (this_command_key_count
< this_single_command_key_start
)
2968 this_single_command_key_start
= this_command_key_count
;
2969 echo_truncate (before_command_echo_length_1
);
2970 before_command_restore_flag
= 0;
2974 /* Save the this_command_keys status. */
2975 key_count
= this_command_key_count
;
2976 key_count_reset
= this_command_key_count_reset
;
2979 keys
= Fcopy_sequence (this_command_keys
);
2984 /* Clear out this_command_keys. */
2985 this_command_key_count
= 0;
2986 this_command_key_count_reset
= 0;
2988 /* Now wipe the echo area. */
2989 if (!NILP (echo_area_buffer
[0]))
2990 safe_run_hooks (Qecho_area_clear_hook
);
2991 clear_message (1, 0);
2994 /* If we are not reading a key sequence,
2995 never use the echo area. */
2998 specbind (Qinput_method_use_echo_area
, Qt
);
3001 /* Call the input method. */
3002 tem
= call1 (Vinput_method_function
, c
);
3004 tem
= unbind_to (count
, tem
);
3006 /* Restore the saved echoing state
3007 and this_command_keys state. */
3008 this_command_key_count
= key_count
;
3009 this_command_key_count_reset
= key_count_reset
;
3011 this_command_keys
= keys
;
3014 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3015 kset_echo_string (current_kboard
, saved_echo_string
);
3016 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3017 if (saved_immediate_echo
)
3022 /* The input method can return no events. */
3025 /* Bring back the previous message, if any. */
3026 if (! NILP (previous_echo_area_message
))
3027 message_with_string ("%s", previous_echo_area_message
, 0);
3030 /* It returned one event or more. */
3032 Vunread_post_input_method_events
3033 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3038 /* Display help if not echoing. */
3039 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3041 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3042 Lisp_Object help
, object
, position
, window
, htem
;
3044 htem
= Fcdr (XCDR (c
));
3047 window
= Fcar (htem
);
3049 object
= Fcar (htem
);
3051 position
= Fcar (htem
);
3053 show_help_echo (help
, window
, object
, position
);
3055 /* We stopped being idle for this event; undo that. */
3057 timer_resume_idle ();
3061 if ((! reread
|| this_command_key_count
== 0
3062 || this_command_key_count_reset
)
3066 /* Don't echo mouse motion events. */
3067 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3068 && NILP (Fzerop (Vecho_keystrokes
))
3069 && ! (EVENT_HAS_PARAMETERS (c
)
3070 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3073 if (! NILP (also_record
))
3074 echo_char (also_record
);
3075 /* Once we reread a character, echoing can happen
3076 the next time we pause to read a new one. */
3077 ok_to_echo_at_next_pause
= current_kboard
;
3080 /* Record this character as part of the current key. */
3081 add_command_key (c
);
3082 if (! NILP (also_record
))
3083 add_command_key (also_record
);
3086 last_input_event
= c
;
3089 /* Process the help character specially if enabled. */
3090 if (!NILP (Vhelp_form
) && help_char_p (c
))
3092 ptrdiff_t count
= SPECPDL_INDEX ();
3094 help_form_saved_window_configs
3095 = Fcons (Fcurrent_window_configuration (Qnil
),
3096 help_form_saved_window_configs
);
3097 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3098 call0 (Qhelp_form_show
);
3103 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3104 if (EVENT_HAS_PARAMETERS (c
)
3105 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3106 XSETCAR (help_form_saved_window_configs
, Qnil
);
3108 while (BUFFERP (c
));
3109 /* Remove the help from the frame. */
3110 unbind_to (count
, Qnil
);
3113 if (EQ (c
, make_number (040)))
3117 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3118 while (BUFFERP (c
));
3127 /* Record a key that came from a mouse menu.
3128 Record it for echoing, for this-command-keys, and so on. */
3131 record_menu_key (Lisp_Object c
)
3133 /* Wipe the echo area. */
3134 clear_message (1, 0);
3139 before_command_key_count
= this_command_key_count
;
3140 before_command_echo_length
= echo_length ();
3143 /* Don't echo mouse motion events. */
3144 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3145 && NILP (Fzerop (Vecho_keystrokes
)))
3149 /* Once we reread a character, echoing can happen
3150 the next time we pause to read a new one. */
3151 ok_to_echo_at_next_pause
= 0;
3154 /* Record this character as part of the current key. */
3155 add_command_key (c
);
3157 /* Re-reading in the middle of a command */
3158 last_input_event
= c
;
3162 /* Return true if should recognize C as "the help character". */
3165 help_char_p (Lisp_Object c
)
3169 if (EQ (c
, Vhelp_char
))
3171 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3172 if (EQ (c
, XCAR (tail
)))
3177 /* Record the input event C in various ways. */
3180 record_char (Lisp_Object c
)
3184 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3186 /* To avoid filling recent_keys with help-echo and mouse-movement
3187 events, we filter out repeated help-echo events, only store the
3188 first and last in a series of mouse-movement events, and don't
3189 store repeated help-echo events which are only separated by
3190 mouse-movement events. */
3192 Lisp_Object ev1
, ev2
, ev3
;
3195 if ((ix1
= recent_keys_index
- 1) < 0)
3196 ix1
= NUM_RECENT_KEYS
- 1;
3197 ev1
= AREF (recent_keys
, ix1
);
3199 if ((ix2
= ix1
- 1) < 0)
3200 ix2
= NUM_RECENT_KEYS
- 1;
3201 ev2
= AREF (recent_keys
, ix2
);
3203 if ((ix3
= ix2
- 1) < 0)
3204 ix3
= NUM_RECENT_KEYS
- 1;
3205 ev3
= AREF (recent_keys
, ix3
);
3207 if (EQ (XCAR (c
), Qhelp_echo
))
3209 /* Don't record `help-echo' in recent_keys unless it shows some help
3210 message, and a different help than the previously recorded
3212 Lisp_Object help
, last_help
;
3214 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3215 if (!STRINGP (help
))
3217 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3218 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3220 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3221 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3222 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3224 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3225 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3226 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3227 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3230 else if (EQ (XCAR (c
), Qmouse_movement
))
3232 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3233 So additional mouse movement events replace the last element. */
3234 Lisp_Object last_window
, window
;
3236 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3237 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3238 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3239 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3240 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3242 ASET (recent_keys
, ix1
, c
);
3248 store_kbd_macro_char (c
);
3252 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3253 ASET (recent_keys
, recent_keys_index
, c
);
3254 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3255 recent_keys_index
= 0;
3257 else if (recorded
< 0)
3259 /* We need to remove one or two events from recent_keys.
3260 To do this, we simply put nil at those events and move the
3261 recent_keys_index backwards over those events. Usually,
3262 users will never see those nil events, as they will be
3263 overwritten by the command keys entered to see recent_keys
3266 while (recorded
++ < 0 && total_keys
> 0)
3268 if (total_keys
< NUM_RECENT_KEYS
)
3270 if (--recent_keys_index
< 0)
3271 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3272 ASET (recent_keys
, recent_keys_index
, Qnil
);
3276 num_nonmacro_input_events
++;
3278 /* Write c to the dribble file. If c is a lispy event, write
3279 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3280 If you, dear reader, have a better idea, you've got the source. :-) */
3286 if (XUINT (c
) < 0x100)
3287 putc (XUINT (c
), dribble
);
3289 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3293 Lisp_Object dribblee
;
3295 /* If it's a structured event, take the event header. */
3296 dribblee
= EVENT_HEAD (c
);
3298 if (SYMBOLP (dribblee
))
3300 putc ('<', dribble
);
3301 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3302 SBYTES (SYMBOL_NAME (dribblee
)),
3304 putc ('>', dribble
);
3313 /* Copy out or in the info on where C-g should throw to.
3314 This is used when running Lisp code from within get_char,
3315 in case get_char is called recursively.
3316 See read_process_output. */
3319 save_getcjmp (sys_jmp_buf temp
)
3321 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3325 restore_getcjmp (sys_jmp_buf temp
)
3327 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3330 /* Low level keyboard/mouse input.
3331 kbd_buffer_store_event places events in kbd_buffer, and
3332 kbd_buffer_get_event retrieves them. */
3334 /* Return true if there are any events in the queue that read-char
3335 would return. If this returns false, a read-char would block. */
3337 readable_events (int flags
)
3339 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3342 /* If the buffer contains only FOCUS_IN_EVENT events, and
3343 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3344 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3346 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3347 #ifdef USE_TOOLKIT_SCROLL_BARS
3348 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3352 struct input_event
*event
;
3354 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3361 #ifdef USE_TOOLKIT_SCROLL_BARS
3362 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3364 event
->kind
== FOCUS_IN_EVENT
)
3365 #ifdef USE_TOOLKIT_SCROLL_BARS
3366 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3367 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3368 && event
->part
== scroll_bar_handle
3369 && event
->modifiers
== 0)
3374 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3377 while (event
!= kbd_store_ptr
);
3383 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3384 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3388 if (current_kboard
->kbd_queue_has_data
)
3394 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3395 if (kb
->kbd_queue_has_data
)
3401 /* Set this for debugging, to have a way to get out */
3402 int stop_character EXTERNALLY_VISIBLE
;
3405 event_to_kboard (struct input_event
*event
)
3407 /* Not applicable for these special events. */
3408 if (event
->kind
== SELECTION_REQUEST_EVENT
3409 || event
->kind
== SELECTION_CLEAR_EVENT
)
3413 Lisp_Object obj
= event
->frame_or_window
;
3414 /* There are some events that set this field to nil or string. */
3416 obj
= WINDOW_FRAME (XWINDOW (obj
));
3417 /* Also ignore dead frames here. */
3418 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3419 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3424 /* Return the number of slots occupied in kbd_buffer. */
3427 kbd_buffer_nr_stored (void)
3429 return kbd_fetch_ptr
== kbd_store_ptr
3431 : (kbd_fetch_ptr
< kbd_store_ptr
3432 ? kbd_store_ptr
- kbd_fetch_ptr
3433 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3434 + (kbd_store_ptr
- kbd_buffer
)));
3436 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3439 kbd_buffer_store_event (register struct input_event
*event
)
3441 kbd_buffer_store_event_hold (event
, 0);
3444 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3446 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3447 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3448 Else, if EVENT is a quit event, store the quit event
3449 in HOLD_QUIT, and return (thus ignoring further events).
3451 This is used to postpone the processing of the quit event until all
3452 subsequent input events have been parsed (and discarded). */
3455 kbd_buffer_store_event_hold (register struct input_event
*event
,
3456 struct input_event
*hold_quit
)
3458 if (event
->kind
== NO_EVENT
)
3461 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3464 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3466 register int c
= event
->code
& 0377;
3468 if (event
->modifiers
& ctrl_modifier
)
3469 c
= make_ctrl_char (c
);
3471 c
|= (event
->modifiers
3472 & (meta_modifier
| alt_modifier
3473 | hyper_modifier
| super_modifier
));
3477 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3478 struct input_event
*sp
;
3480 if (single_kboard
&& kb
!= current_kboard
)
3483 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3484 Fcons (make_number (c
), Qnil
)));
3485 kb
->kbd_queue_has_data
= 1;
3486 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3488 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3491 if (event_to_kboard (sp
) == kb
)
3493 sp
->kind
= NO_EVENT
;
3494 sp
->frame_or_window
= Qnil
;
3503 *hold_quit
= *event
;
3507 /* If this results in a quit_char being returned to Emacs as
3508 input, set Vlast_event_frame properly. If this doesn't
3509 get returned to Emacs as an event, the next event read
3510 will set Vlast_event_frame again, so this is safe to do. */
3514 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3516 focus
= event
->frame_or_window
;
3517 internal_last_event_frame
= focus
;
3518 Vlast_event_frame
= focus
;
3521 last_event_timestamp
= event
->timestamp
;
3523 handle_interrupt (0);
3527 if (c
&& c
== stop_character
)
3533 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3534 Just ignore the second one. */
3535 else if (event
->kind
== BUFFER_SWITCH_EVENT
3536 && kbd_fetch_ptr
!= kbd_store_ptr
3537 && ((kbd_store_ptr
== kbd_buffer
3538 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3539 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3542 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3543 kbd_store_ptr
= kbd_buffer
;
3545 /* Don't let the very last slot in the buffer become full,
3546 since that would make the two pointers equal,
3547 and that is indistinguishable from an empty buffer.
3548 Discard the event if it would fill the last slot. */
3549 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3551 *kbd_store_ptr
= *event
;
3554 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3556 /* Don't read keyboard input until we have processed kbd_buffer.
3557 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3558 hold_keyboard_input ();
3559 if (!noninteractive
)
3563 #endif /* subprocesses */
3566 /* If we're inside while-no-input, and this event qualifies
3567 as input, set quit-flag to cause an interrupt. */
3568 if (!NILP (Vthrow_on_input
)
3569 && event
->kind
!= FOCUS_IN_EVENT
3570 && event
->kind
!= HELP_EVENT
3571 && event
->kind
!= DEICONIFY_EVENT
)
3573 Vquit_flag
= Vthrow_on_input
;
3574 /* If we're inside a function that wants immediate quits,
3576 if (immediate_quit
&& NILP (Vinhibit_quit
))
3585 /* Put an input event back in the head of the event queue. */
3588 kbd_buffer_unget_event (register struct input_event
*event
)
3590 if (kbd_fetch_ptr
== kbd_buffer
)
3591 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3593 /* Don't let the very last slot in the buffer become full, */
3594 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3597 *kbd_fetch_ptr
= *event
;
3602 /* Generate a HELP_EVENT input_event and store it in the keyboard
3605 HELP is the help form.
3607 FRAME and WINDOW are the frame and window where the help is
3608 generated. OBJECT is the Lisp object where the help was found (a
3609 buffer, a string, an overlay, or nil if neither from a string nor
3610 from a buffer). POS is the position within OBJECT where the help
3614 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3615 Lisp_Object object
, ptrdiff_t pos
)
3617 struct input_event event
;
3621 event
.kind
= HELP_EVENT
;
3622 event
.frame_or_window
= frame
;
3624 event
.x
= WINDOWP (window
) ? window
: frame
;
3627 kbd_buffer_store_event (&event
);
3631 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3634 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3636 struct input_event event
;
3638 event
.kind
= HELP_EVENT
;
3639 event
.frame_or_window
= frame
;
3644 kbd_buffer_store_event (&event
);
3648 /* Discard any mouse events in the event buffer by setting them to
3651 discard_mouse_events (void)
3653 struct input_event
*sp
;
3654 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3656 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3659 if (sp
->kind
== MOUSE_CLICK_EVENT
3660 || sp
->kind
== WHEEL_EVENT
3661 || sp
->kind
== HORIZ_WHEEL_EVENT
3663 || sp
->kind
== GPM_CLICK_EVENT
3665 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3667 sp
->kind
= NO_EVENT
;
3673 /* Return true if there are any real events waiting in the event
3674 buffer, not counting `NO_EVENT's.
3676 Discard NO_EVENT events at the front of the input queue, possibly
3677 leaving the input queue empty if there are no real input events. */
3680 kbd_buffer_events_waiting (void)
3682 struct input_event
*sp
;
3684 for (sp
= kbd_fetch_ptr
;
3685 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3688 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3693 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3697 /* Clear input event EVENT. */
3700 clear_event (struct input_event
*event
)
3702 event
->kind
= NO_EVENT
;
3706 /* Read one event from the event buffer, waiting if necessary.
3707 The value is a Lisp object representing the event.
3708 The value is nil for an event that should be ignored,
3709 or that was handled here.
3710 We always read and discard one event. */
3713 kbd_buffer_get_event (KBOARD
**kbp
,
3714 bool *used_mouse_menu
,
3715 EMACS_TIME
*end_time
)
3720 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3722 /* Start reading input again because we have processed enough to
3723 be able to accept new events again. */
3724 unhold_keyboard_input ();
3727 #endif /* subprocesses */
3729 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3731 /* In case we are running as a daemon, only do this before
3732 detaching from the terminal. */
3733 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3737 *kbp
= current_kboard
;
3740 #endif /* ! HAVE_DBUS */
3742 /* Wait until there is input available. */
3745 /* Break loop if there's an unread command event. Needed in
3746 moused window autoselection which uses a timer to insert such
3748 if (CONSP (Vunread_command_events
))
3751 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3753 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3756 /* If the quit flag is set, then read_char will return
3757 quit_char, so that counts as "available input." */
3758 if (!NILP (Vquit_flag
))
3759 quit_throw_to_read_char (0);
3761 /* One way or another, wait until input is available; then, if
3762 interrupt handlers have not read it, read it now. */
3767 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3769 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3773 EMACS_TIME now
= current_emacs_time ();
3774 if (EMACS_TIME_LE (*end_time
, now
))
3775 return Qnil
; /* Finished waiting. */
3778 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3779 wait_reading_process_output (min (EMACS_SECS (duration
),
3781 EMACS_NSECS (duration
),
3782 -1, 1, Qnil
, NULL
, 0);
3786 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3788 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3792 if (CONSP (Vunread_command_events
))
3795 first
= XCAR (Vunread_command_events
);
3796 Vunread_command_events
= XCDR (Vunread_command_events
);
3797 *kbp
= current_kboard
;
3801 /* At this point, we know that there is a readable event available
3802 somewhere. If the event queue is empty, then there must be a
3803 mouse movement enabled and available. */
3804 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3806 struct input_event
*event
;
3808 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3812 last_event_timestamp
= event
->timestamp
;
3814 *kbp
= event_to_kboard (event
);
3816 *kbp
= current_kboard
; /* Better than returning null ptr? */
3820 /* These two kinds of events get special handling
3821 and don't actually appear to the command loop.
3822 We return nil for them. */
3823 if (event
->kind
== SELECTION_REQUEST_EVENT
3824 || event
->kind
== SELECTION_CLEAR_EVENT
)
3827 struct input_event copy
;
3829 /* Remove it from the buffer before processing it,
3830 since otherwise swallow_events will see it
3831 and process it again. */
3833 kbd_fetch_ptr
= event
+ 1;
3834 input_pending
= readable_events (0);
3835 x_handle_selection_event (©
);
3837 /* We're getting selection request events, but we don't have
3843 #if defined (HAVE_NS)
3844 else if (event
->kind
== NS_TEXT_EVENT
)
3846 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3847 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3849 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3850 kbd_fetch_ptr
= event
+ 1;
3851 if (used_mouse_menu
)
3852 *used_mouse_menu
= 1;
3856 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3857 || defined (HAVE_NS)
3858 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3860 /* Make an event (delete-frame (FRAME)). */
3861 obj
= Fcons (event
->frame_or_window
, Qnil
);
3862 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3863 kbd_fetch_ptr
= event
+ 1;
3866 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3867 || defined (HAVE_NS)
3868 else if (event
->kind
== ICONIFY_EVENT
)
3870 /* Make an event (iconify-frame (FRAME)). */
3871 obj
= Fcons (event
->frame_or_window
, Qnil
);
3872 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3873 kbd_fetch_ptr
= event
+ 1;
3875 else if (event
->kind
== DEICONIFY_EVENT
)
3877 /* Make an event (make-frame-visible (FRAME)). */
3878 obj
= Fcons (event
->frame_or_window
, Qnil
);
3879 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3880 kbd_fetch_ptr
= event
+ 1;
3883 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3885 /* The value doesn't matter here; only the type is tested. */
3886 XSETBUFFER (obj
, current_buffer
);
3887 kbd_fetch_ptr
= event
+ 1;
3889 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3890 || defined (HAVE_NS) || defined (USE_GTK)
3891 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3893 kbd_fetch_ptr
= event
+ 1;
3894 input_pending
= readable_events (0);
3895 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3896 x_activate_menubar (XFRAME (event
->frame_or_window
));
3900 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3902 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3903 obj
= Fcons (Qlanguage_change
,
3904 list3 (event
->frame_or_window
,
3905 make_number (event
->code
),
3906 make_number (event
->modifiers
)));
3907 kbd_fetch_ptr
= event
+ 1;
3911 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3913 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3914 obj
= Fcons (Qfile_w32notify
,
3915 list2 (list3 (make_number (event
->code
),
3918 event
->frame_or_window
));
3919 kbd_fetch_ptr
= event
+ 1;
3922 else if (event
->kind
== SAVE_SESSION_EVENT
)
3924 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3925 kbd_fetch_ptr
= event
+ 1;
3927 /* Just discard these, by returning nil.
3928 With MULTI_KBOARD, these events are used as placeholders
3929 when we need to randomly delete events from the queue.
3930 (They shouldn't otherwise be found in the buffer,
3931 but on some machines it appears they do show up
3932 even without MULTI_KBOARD.) */
3933 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3934 mouse events during a popup-menu call. */
3935 else if (event
->kind
== NO_EVENT
)
3936 kbd_fetch_ptr
= event
+ 1;
3937 else if (event
->kind
== HELP_EVENT
)
3939 Lisp_Object object
, position
, help
, frame
, window
;
3941 frame
= event
->frame_or_window
;
3942 object
= event
->arg
;
3943 position
= make_number (event
->code
);
3946 clear_event (event
);
3948 kbd_fetch_ptr
= event
+ 1;
3949 if (!WINDOWP (window
))
3951 obj
= Fcons (Qhelp_echo
,
3952 list5 (frame
, help
, window
, object
, position
));
3954 else if (event
->kind
== FOCUS_IN_EVENT
)
3956 /* Notification of a FocusIn event. The frame receiving the
3957 focus is in event->frame_or_window. Generate a
3958 switch-frame event if necessary. */
3959 Lisp_Object frame
, focus
;
3961 frame
= event
->frame_or_window
;
3962 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3966 if (!EQ (frame
, internal_last_event_frame
)
3967 && !EQ (frame
, selected_frame
))
3968 obj
= make_lispy_switch_frame (frame
);
3969 internal_last_event_frame
= frame
;
3970 kbd_fetch_ptr
= event
+ 1;
3973 else if (event
->kind
== DBUS_EVENT
)
3975 obj
= make_lispy_event (event
);
3976 kbd_fetch_ptr
= event
+ 1;
3980 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3982 obj
= make_lispy_event (event
);
3983 kbd_fetch_ptr
= event
+ 1;
3986 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3988 obj
= make_lispy_event (event
);
3989 kbd_fetch_ptr
= event
+ 1;
3993 /* If this event is on a different frame, return a switch-frame this
3994 time, and leave the event in the queue for next time. */
3998 frame
= event
->frame_or_window
;
4000 frame
= XCAR (frame
);
4001 else if (WINDOWP (frame
))
4002 frame
= WINDOW_FRAME (XWINDOW (frame
));
4004 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4008 if (! EQ (frame
, internal_last_event_frame
)
4009 && !EQ (frame
, selected_frame
))
4010 obj
= make_lispy_switch_frame (frame
);
4011 internal_last_event_frame
= frame
;
4013 /* If we didn't decide to make a switch-frame event, go ahead
4014 and build a real event from the queue entry. */
4018 obj
= make_lispy_event (event
);
4020 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4021 || defined (HAVE_NS) || defined (USE_GTK)
4022 /* If this was a menu selection, then set the flag to inhibit
4023 writing to last_nonmenu_event. Don't do this if the event
4024 we're returning is (menu-bar), though; that indicates the
4025 beginning of the menu sequence, and we might as well leave
4026 that as the `event with parameters' for this selection. */
4028 && !EQ (event
->frame_or_window
, event
->arg
)
4029 && (event
->kind
== MENU_BAR_EVENT
4030 || event
->kind
== TOOL_BAR_EVENT
))
4031 *used_mouse_menu
= 1;
4034 /* Certain system events are non-key events. */
4036 && event
->kind
== NS_NONKEY_EVENT
)
4037 *used_mouse_menu
= 1;
4040 /* Wipe out this event, to catch bugs. */
4041 clear_event (event
);
4042 kbd_fetch_ptr
= event
+ 1;
4046 /* Try generating a mouse motion event. */
4047 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4049 FRAME_PTR f
= some_mouse_moved ();
4050 Lisp_Object bar_window
;
4051 enum scroll_bar_part part
;
4055 *kbp
= current_kboard
;
4056 /* Note that this uses F to determine which terminal to look at.
4057 If there is no valid info, it does not store anything
4058 so x remains nil. */
4061 /* XXX Can f or mouse_position_hook be NULL here? */
4062 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4063 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4068 /* Decide if we should generate a switch-frame event. Don't
4069 generate switch-frame events for motion outside of all Emacs
4075 frame
= FRAME_FOCUS_FRAME (f
);
4077 XSETFRAME (frame
, f
);
4079 if (! EQ (frame
, internal_last_event_frame
)
4080 && !EQ (frame
, selected_frame
))
4081 obj
= make_lispy_switch_frame (frame
);
4082 internal_last_event_frame
= frame
;
4085 /* If we didn't decide to make a switch-frame event, go ahead and
4086 return a mouse-motion event. */
4087 if (!NILP (x
) && NILP (obj
))
4088 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4091 /* We were promised by the above while loop that there was
4092 something for us to read! */
4095 input_pending
= readable_events (0);
4097 Vlast_event_frame
= internal_last_event_frame
;
4102 /* Process any non-user-visible events (currently X selection events),
4103 without reading any user-visible events. */
4106 process_special_events (void)
4108 struct input_event
*event
;
4110 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4112 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4115 if (event
== kbd_store_ptr
)
4119 /* If we find a stored X selection request, handle it now. */
4120 if (event
->kind
== SELECTION_REQUEST_EVENT
4121 || event
->kind
== SELECTION_CLEAR_EVENT
)
4125 /* Remove the event from the fifo buffer before processing;
4126 otherwise swallow_events called recursively could see it
4127 and process it again. To do this, we move the events
4128 between kbd_fetch_ptr and EVENT one slot to the right,
4131 struct input_event copy
= *event
;
4132 struct input_event
*beg
4133 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4134 ? kbd_buffer
: kbd_fetch_ptr
;
4137 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4138 else if (event
< beg
)
4140 if (event
> kbd_buffer
)
4141 memmove (kbd_buffer
+ 1, kbd_buffer
,
4142 (event
- kbd_buffer
) * sizeof (struct input_event
));
4143 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4144 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4145 memmove (beg
+ 1, beg
,
4146 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4147 * sizeof (struct input_event
));
4150 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4151 kbd_fetch_ptr
= kbd_buffer
+ 1;
4155 /* X wants last_event_timestamp for selection ownership. */
4156 last_event_timestamp
= copy
.timestamp
;
4157 input_pending
= readable_events (0);
4158 x_handle_selection_event (©
);
4160 /* We're getting selection request events, but we don't have
4168 /* Process any events that are not user-visible, run timer events that
4169 are ripe, and return, without reading any user-visible events. */
4172 swallow_events (bool do_display
)
4174 unsigned old_timers_run
;
4176 process_special_events ();
4178 old_timers_run
= timers_run
;
4179 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4181 if (timers_run
!= old_timers_run
&& do_display
)
4182 redisplay_preserve_echo_area (7);
4185 /* Record the start of when Emacs is idle,
4186 for the sake of running idle-time timers. */
4189 timer_start_idle (void)
4193 /* If we are already in the idle state, do nothing. */
4194 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4197 timer_idleness_start_time
= current_emacs_time ();
4198 timer_last_idleness_start_time
= timer_idleness_start_time
;
4200 /* Mark all idle-time timers as once again candidates for running. */
4201 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4205 timer
= XCAR (timers
);
4207 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4209 ASET (timer
, 0, Qnil
);
4213 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4216 timer_stop_idle (void)
4218 timer_idleness_start_time
= invalid_emacs_time ();
4221 /* Resume idle timer from last idle start time. */
4224 timer_resume_idle (void)
4226 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4229 timer_idleness_start_time
= timer_last_idleness_start_time
;
4232 /* This is only for debugging. */
4233 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4235 /* List of elisp functions to call, delayed because they were generated in
4236 a context where Elisp could not be safely run (e.g. redisplay, signal,
4237 ...). Each element has the form (FUN . ARGS). */
4238 Lisp_Object pending_funcalls
;
4240 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4242 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4244 Lisp_Object
*vector
;
4246 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4248 vector
= XVECTOR (timer
)->contents
;
4249 if (! NILP (vector
[0]))
4252 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4257 /* Check whether a timer has fired. To prevent larger problems we simply
4258 disregard elements that are not proper timers. Do not make a circular
4259 timer list for the time being.
4261 Returns the time to wait until the next timer fires. If a
4262 timer is triggering now, return zero.
4263 If no timer is active, return -1.
4265 If a timer is ripe, we run it, with quitting turned off.
4266 In that case we return 0 to indicate that a new timer_check_2 call
4270 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4272 EMACS_TIME nexttime
;
4274 EMACS_TIME idleness_now
;
4275 Lisp_Object chosen_timer
;
4276 struct gcpro gcpro1
;
4278 nexttime
= invalid_emacs_time ();
4280 chosen_timer
= Qnil
;
4281 GCPRO1 (chosen_timer
);
4283 /* First run the code that was delayed. */
4284 while (CONSP (pending_funcalls
))
4286 Lisp_Object funcall
= XCAR (pending_funcalls
);
4287 pending_funcalls
= XCDR (pending_funcalls
);
4288 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4291 if (CONSP (timers
) || CONSP (idle_timers
))
4293 now
= current_emacs_time ();
4294 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4295 ? sub_emacs_time (now
, timer_idleness_start_time
)
4296 : make_emacs_time (0, 0));
4299 while (CONSP (timers
) || CONSP (idle_timers
))
4301 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4302 EMACS_TIME timer_time
, idle_timer_time
;
4303 EMACS_TIME difference
;
4304 EMACS_TIME timer_difference
= invalid_emacs_time ();
4305 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4306 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4308 /* Set TIMER and TIMER_DIFFERENCE
4309 based on the next ordinary timer.
4310 TIMER_DIFFERENCE is the distance in time from NOW to when
4311 this timer becomes ripe (negative if it's already ripe).
4312 Skip past invalid timers and timers already handled. */
4315 timer
= XCAR (timers
);
4316 if (! decode_timer (timer
, &timer_time
))
4318 timers
= XCDR (timers
);
4322 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4323 timer_difference
= (timer_ripe
4324 ? sub_emacs_time (now
, timer_time
)
4325 : sub_emacs_time (timer_time
, now
));
4328 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4329 based on the next idle timer. */
4330 if (CONSP (idle_timers
))
4332 idle_timer
= XCAR (idle_timers
);
4333 if (! decode_timer (idle_timer
, &idle_timer_time
))
4335 idle_timers
= XCDR (idle_timers
);
4339 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4340 idle_timer_difference
4342 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4343 : sub_emacs_time (idle_timer_time
, idleness_now
));
4346 /* Decide which timer is the next timer,
4347 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4348 Also step down the list where we found that timer. */
4350 if (EMACS_TIME_VALID_P (timer_difference
)
4351 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4352 || idle_timer_ripe
< timer_ripe
4353 || (idle_timer_ripe
== timer_ripe
4355 ? EMACS_TIME_LT (idle_timer_difference
,
4357 : EMACS_TIME_LT (timer_difference
,
4358 idle_timer_difference
)))))
4360 chosen_timer
= timer
;
4361 timers
= XCDR (timers
);
4362 difference
= timer_difference
;
4367 chosen_timer
= idle_timer
;
4368 idle_timers
= XCDR (idle_timers
);
4369 difference
= idle_timer_difference
;
4370 ripe
= idle_timer_ripe
;
4373 /* If timer is ripe, run it if it hasn't been run. */
4376 if (NILP (AREF (chosen_timer
, 0)))
4378 ptrdiff_t count
= SPECPDL_INDEX ();
4379 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4381 /* Mark the timer as triggered to prevent problems if the lisp
4382 code fails to reschedule it right. */
4383 ASET (chosen_timer
, 0, Qt
);
4385 specbind (Qinhibit_quit
, Qt
);
4387 call1 (Qtimer_event_handler
, chosen_timer
);
4388 Vdeactivate_mark
= old_deactivate_mark
;
4390 unbind_to (count
, Qnil
);
4392 /* Since we have handled the event,
4393 we don't need to tell the caller to wake up and do it. */
4394 /* But the caller must still wait for the next timer, so
4395 return 0 to indicate that. */
4398 nexttime
= make_emacs_time (0, 0);
4402 /* When we encounter a timer that is still waiting,
4403 return the amount of time to wait before it is ripe. */
4410 /* No timers are pending in the future. */
4411 /* Return 0 if we generated an event, and -1 if not. */
4417 /* Check whether a timer has fired. To prevent larger problems we simply
4418 disregard elements that are not proper timers. Do not make a circular
4419 timer list for the time being.
4421 Returns the time to wait until the next timer fires.
4422 If no timer is active, return an invalid value.
4424 As long as any timer is ripe, we run it. */
4429 EMACS_TIME nexttime
;
4430 Lisp_Object timers
, idle_timers
;
4431 struct gcpro gcpro1
, gcpro2
;
4433 Lisp_Object tem
= Vinhibit_quit
;
4436 /* We use copies of the timers' lists to allow a timer to add itself
4437 again, without locking up Emacs if the newly added timer is
4438 already ripe when added. */
4440 /* Always consider the ordinary timers. */
4441 timers
= Fcopy_sequence (Vtimer_list
);
4442 /* Consider the idle timers only if Emacs is idle. */
4443 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4444 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4448 Vinhibit_quit
= tem
;
4450 GCPRO2 (timers
, idle_timers
);
4454 nexttime
= timer_check_2 (timers
, idle_timers
);
4456 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4462 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4463 doc
: /* Return the current length of Emacs idleness, or nil.
4464 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4465 in the same style as (current-time).
4467 The value when Emacs is not idle is nil.
4469 PSEC is a multiple of the system clock resolution. */)
4472 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4473 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4474 timer_idleness_start_time
));
4479 /* Caches for modify_event_symbol. */
4480 static Lisp_Object accent_key_syms
;
4481 static Lisp_Object func_key_syms
;
4482 static Lisp_Object mouse_syms
;
4483 static Lisp_Object wheel_syms
;
4484 static Lisp_Object drag_n_drop_syms
;
4486 /* This is a list of keysym codes for special "accent" characters.
4487 It parallels lispy_accent_keys. */
4489 static const int lispy_accent_codes
[] =
4491 #ifdef XK_dead_circumflex
4496 #ifdef XK_dead_grave
4501 #ifdef XK_dead_tilde
4506 #ifdef XK_dead_diaeresis
4511 #ifdef XK_dead_macron
4516 #ifdef XK_dead_degree
4521 #ifdef XK_dead_acute
4526 #ifdef XK_dead_cedilla
4531 #ifdef XK_dead_breve
4536 #ifdef XK_dead_ogonek
4541 #ifdef XK_dead_caron
4546 #ifdef XK_dead_doubleacute
4547 XK_dead_doubleacute
,
4551 #ifdef XK_dead_abovedot
4556 #ifdef XK_dead_abovering
4566 #ifdef XK_dead_belowdot
4571 #ifdef XK_dead_voiced_sound
4572 XK_dead_voiced_sound
,
4576 #ifdef XK_dead_semivoiced_sound
4577 XK_dead_semivoiced_sound
,
4593 /* This is a list of Lisp names for special "accent" characters.
4594 It parallels lispy_accent_codes. */
4596 static const char *const lispy_accent_keys
[] =
4614 "dead-voiced-sound",
4615 "dead-semivoiced-sound",
4621 #define FUNCTION_KEY_OFFSET 0x0
4623 const char *const lispy_function_keys
[] =
4627 0, /* VK_LBUTTON 0x01 */
4628 0, /* VK_RBUTTON 0x02 */
4629 "cancel", /* VK_CANCEL 0x03 */
4630 0, /* VK_MBUTTON 0x04 */
4632 0, 0, 0, /* 0x05 .. 0x07 */
4634 "backspace", /* VK_BACK 0x08 */
4635 "tab", /* VK_TAB 0x09 */
4637 0, 0, /* 0x0A .. 0x0B */
4639 "clear", /* VK_CLEAR 0x0C */
4640 "return", /* VK_RETURN 0x0D */
4642 0, 0, /* 0x0E .. 0x0F */
4644 0, /* VK_SHIFT 0x10 */
4645 0, /* VK_CONTROL 0x11 */
4646 0, /* VK_MENU 0x12 */
4647 "pause", /* VK_PAUSE 0x13 */
4648 "capslock", /* VK_CAPITAL 0x14 */
4649 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4651 "junja", /* VK_JUNJA 0x17 */
4652 "final", /* VK_FINAL 0x18 */
4653 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4655 "escape", /* VK_ESCAPE 0x1B */
4656 "convert", /* VK_CONVERT 0x1C */
4657 "non-convert", /* VK_NONCONVERT 0x1D */
4658 "accept", /* VK_ACCEPT 0x1E */
4659 "mode-change", /* VK_MODECHANGE 0x1F */
4660 0, /* VK_SPACE 0x20 */
4661 "prior", /* VK_PRIOR 0x21 */
4662 "next", /* VK_NEXT 0x22 */
4663 "end", /* VK_END 0x23 */
4664 "home", /* VK_HOME 0x24 */
4665 "left", /* VK_LEFT 0x25 */
4666 "up", /* VK_UP 0x26 */
4667 "right", /* VK_RIGHT 0x27 */
4668 "down", /* VK_DOWN 0x28 */
4669 "select", /* VK_SELECT 0x29 */
4670 "print", /* VK_PRINT 0x2A */
4671 "execute", /* VK_EXECUTE 0x2B */
4672 "snapshot", /* VK_SNAPSHOT 0x2C */
4673 "insert", /* VK_INSERT 0x2D */
4674 "delete", /* VK_DELETE 0x2E */
4675 "help", /* VK_HELP 0x2F */
4677 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4679 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4681 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4683 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4685 0, 0, 0, 0, 0, 0, 0, 0, 0,
4686 0, 0, 0, 0, 0, 0, 0, 0, 0,
4687 0, 0, 0, 0, 0, 0, 0, 0,
4689 "lwindow", /* VK_LWIN 0x5B */
4690 "rwindow", /* VK_RWIN 0x5C */
4691 "apps", /* VK_APPS 0x5D */
4694 "kp-0", /* VK_NUMPAD0 0x60 */
4695 "kp-1", /* VK_NUMPAD1 0x61 */
4696 "kp-2", /* VK_NUMPAD2 0x62 */
4697 "kp-3", /* VK_NUMPAD3 0x63 */
4698 "kp-4", /* VK_NUMPAD4 0x64 */
4699 "kp-5", /* VK_NUMPAD5 0x65 */
4700 "kp-6", /* VK_NUMPAD6 0x66 */
4701 "kp-7", /* VK_NUMPAD7 0x67 */
4702 "kp-8", /* VK_NUMPAD8 0x68 */
4703 "kp-9", /* VK_NUMPAD9 0x69 */
4704 "kp-multiply", /* VK_MULTIPLY 0x6A */
4705 "kp-add", /* VK_ADD 0x6B */
4706 "kp-separator", /* VK_SEPARATOR 0x6C */
4707 "kp-subtract", /* VK_SUBTRACT 0x6D */
4708 "kp-decimal", /* VK_DECIMAL 0x6E */
4709 "kp-divide", /* VK_DIVIDE 0x6F */
4710 "f1", /* VK_F1 0x70 */
4711 "f2", /* VK_F2 0x71 */
4712 "f3", /* VK_F3 0x72 */
4713 "f4", /* VK_F4 0x73 */
4714 "f5", /* VK_F5 0x74 */
4715 "f6", /* VK_F6 0x75 */
4716 "f7", /* VK_F7 0x76 */
4717 "f8", /* VK_F8 0x77 */
4718 "f9", /* VK_F9 0x78 */
4719 "f10", /* VK_F10 0x79 */
4720 "f11", /* VK_F11 0x7A */
4721 "f12", /* VK_F12 0x7B */
4722 "f13", /* VK_F13 0x7C */
4723 "f14", /* VK_F14 0x7D */
4724 "f15", /* VK_F15 0x7E */
4725 "f16", /* VK_F16 0x7F */
4726 "f17", /* VK_F17 0x80 */
4727 "f18", /* VK_F18 0x81 */
4728 "f19", /* VK_F19 0x82 */
4729 "f20", /* VK_F20 0x83 */
4730 "f21", /* VK_F21 0x84 */
4731 "f22", /* VK_F22 0x85 */
4732 "f23", /* VK_F23 0x86 */
4733 "f24", /* VK_F24 0x87 */
4735 0, 0, 0, 0, /* 0x88 .. 0x8B */
4736 0, 0, 0, 0, /* 0x8C .. 0x8F */
4738 "kp-numlock", /* VK_NUMLOCK 0x90 */
4739 "scroll", /* VK_SCROLL 0x91 */
4740 /* Not sure where the following block comes from.
4741 Windows headers have NEC and Fujitsu specific keys in
4742 this block, but nothing generic. */
4743 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4744 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4745 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4746 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4747 "kp-end", /* VK_NUMPAD_END 0x96 */
4748 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4749 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4750 "kp-up", /* VK_NUMPAD_UP 0x99 */
4751 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4752 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4753 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4754 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4756 0, 0, /* 0x9E .. 0x9F */
4759 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4760 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4761 * No other API or message will distinguish left and right keys this way.
4766 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4767 to enable them selectively, and gives access to a few more functions.
4768 See lispy_multimedia_keys below. */
4769 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4770 0, 0, 0, /* 0xAD .. 0xAF Volume */
4771 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4772 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4774 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4775 0, 0, 0, 0, 0, 0, 0, 0, 0,
4777 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4778 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4779 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4782 "ax", /* VK_OEM_AX 0xE1 */
4783 0, /* VK_OEM_102 0xE2 */
4784 "ico-help", /* VK_ICO_HELP 0xE3 */
4785 "ico-00", /* VK_ICO_00 0xE4 */
4786 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4787 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4788 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4790 "reset", /* VK_OEM_RESET 0xE9 */
4791 "jump", /* VK_OEM_JUMP 0xEA */
4792 "oem-pa1", /* VK_OEM_PA1 0xEB */
4793 "oem-pa2", /* VK_OEM_PA2 0xEC */
4794 "oem-pa3", /* VK_OEM_PA3 0xED */
4795 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4796 "cusel", /* VK_OEM_CUSEL 0xEF */
4797 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4798 "finish", /* VK_OEM_FINISH 0xF1 */
4799 "copy", /* VK_OEM_COPY 0xF2 */
4800 "auto", /* VK_OEM_AUTO 0xF3 */
4801 "enlw", /* VK_OEM_ENLW 0xF4 */
4802 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4803 "attn", /* VK_ATTN 0xF6 */
4804 "crsel", /* VK_CRSEL 0xF7 */
4805 "exsel", /* VK_EXSEL 0xF8 */
4806 "ereof", /* VK_EREOF 0xF9 */
4807 "play", /* VK_PLAY 0xFA */
4808 "zoom", /* VK_ZOOM 0xFB */
4809 "noname", /* VK_NONAME 0xFC */
4810 "pa1", /* VK_PA1 0xFD */
4811 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4815 /* Some of these duplicate the "Media keys" on newer keyboards,
4816 but they are delivered to the application in a different way. */
4817 static const char *const lispy_multimedia_keys
[] =
4825 "browser-favorites",
4862 "toggle-dictate-command",
4868 "media-fast-forward",
4871 "media-channel-down"
4874 #else /* not HAVE_NTGUI */
4876 /* This should be dealt with in XTread_socket now, and that doesn't
4877 depend on the client system having the Kana syms defined. See also
4878 the XK_kana_A case below. */
4881 static const char *const lispy_kana_keys
[] =
4883 /* X Keysym value */
4884 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4885 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4886 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4887 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4888 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4889 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4890 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4891 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4892 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4894 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4895 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4896 "kana-i", "kana-u", "kana-e", "kana-o",
4897 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4898 "prolongedsound", "kana-A", "kana-I", "kana-U",
4899 "kana-E", "kana-O", "kana-KA", "kana-KI",
4900 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4901 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4902 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4903 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4904 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4905 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4906 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4907 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4908 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4909 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4910 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4911 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4913 #endif /* XK_kana_A */
4916 #define FUNCTION_KEY_OFFSET 0xff00
4918 /* You'll notice that this table is arranged to be conveniently
4919 indexed by X Windows keysym values. */
4920 static const char *const lispy_function_keys
[] =
4922 /* X Keysym value */
4924 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4925 "backspace", "tab", "linefeed", "clear",
4927 0, 0, 0, "pause", /* 0xff10...1f */
4928 0, 0, 0, 0, 0, 0, 0, "escape",
4930 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4931 "romaji", "hiragana", "katakana", "hiragana-katakana",
4932 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4933 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4934 "eisu-toggle", /* 0xff30...3f */
4935 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4936 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4938 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4939 "down", "prior", "next", "end",
4940 "begin", 0, 0, 0, 0, 0, 0, 0,
4941 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4952 "break", /* 0xff6b */
4955 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4956 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4957 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4958 0, 0, 0, 0, 0, 0, 0, 0,
4959 "kp-tab", /* 0xff89 */
4961 "kp-enter", /* 0xff8d */
4963 "kp-f1", /* 0xff91 */
4967 "kp-home", /* 0xff95 */
4972 "kp-prior", /* kp-page-up */
4973 "kp-next", /* kp-page-down */
4979 0, 0, 0, 0, 0, 0, 0, 0, 0,
4980 "kp-multiply", /* 0xffaa */
4985 "kp-divide", /* 0xffaf */
4986 "kp-0", /* 0xffb0 */
4987 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4990 "kp-equal", /* 0xffbd */
4991 "f1", /* 0xffbe */ /* IsFunctionKey */
4993 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4994 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4995 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4996 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4997 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4998 0, 0, 0, 0, 0, 0, 0, 0,
4999 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5000 0, 0, 0, 0, 0, 0, 0, "delete"
5003 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5004 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5006 static const char *const iso_lispy_function_keys
[] =
5008 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5009 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5010 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5011 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5012 "iso-lefttab", /* 0xfe20 */
5013 "iso-move-line-up", "iso-move-line-down",
5014 "iso-partial-line-up", "iso-partial-line-down",
5015 "iso-partial-space-left", "iso-partial-space-right",
5016 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5017 "iso-release-margin-left", "iso-release-margin-right",
5018 "iso-release-both-margins",
5019 "iso-fast-cursor-left", "iso-fast-cursor-right",
5020 "iso-fast-cursor-up", "iso-fast-cursor-down",
5021 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5022 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5025 #endif /* not HAVE_NTGUI */
5027 static Lisp_Object Vlispy_mouse_stem
;
5029 static const char *const lispy_wheel_names
[] =
5031 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5034 /* drag-n-drop events are generated when a set of selected files are
5035 dragged from another application and dropped onto an Emacs window. */
5036 static const char *const lispy_drag_n_drop_names
[] =
5041 /* Scroll bar parts. */
5042 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5043 Lisp_Object Qup
, Qdown
, Qbottom
;
5044 static Lisp_Object Qend_scroll
;
5046 static Lisp_Object Qratio
;
5048 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5049 static Lisp_Object
*const scroll_bar_parts
[] = {
5050 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5051 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5054 /* A vector, indexed by button number, giving the down-going location
5055 of currently depressed buttons, both scroll bar and non-scroll bar.
5057 The elements have the form
5058 (BUTTON-NUMBER MODIFIER-MASK . REST)
5059 where REST is the cdr of a position as it would be reported in the event.
5061 The make_lispy_event function stores positions here to tell the
5062 difference between click and drag events, and to store the starting
5063 location to be included in drag events. */
5065 static Lisp_Object button_down_location
;
5067 /* Information about the most recent up-going button event: Which
5068 button, what location, and what time. */
5070 static int last_mouse_button
;
5071 static int last_mouse_x
;
5072 static int last_mouse_y
;
5073 static Time button_down_time
;
5075 /* The number of clicks in this multiple-click. */
5077 static int double_click_count
;
5079 /* X and Y are frame-relative coordinates for a click or wheel event.
5080 Return a Lisp-style event list. */
5083 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5086 enum window_part part
;
5087 Lisp_Object posn
= Qnil
;
5088 Lisp_Object extra_info
= Qnil
;
5089 /* Coordinate pixel positions to return. */
5090 int xret
= 0, yret
= 0;
5091 /* The window under frame pixel coordinates (x,y) */
5092 Lisp_Object window
= f
5093 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5096 if (WINDOWP (window
))
5098 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5099 struct window
*w
= XWINDOW (window
);
5100 Lisp_Object string_info
= Qnil
;
5101 ptrdiff_t textpos
= -1;
5102 int col
= -1, row
= -1;
5103 int dx
= -1, dy
= -1;
5104 int width
= -1, height
= -1;
5105 Lisp_Object object
= Qnil
;
5107 /* Pixel coordinates relative to the window corner. */
5108 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5109 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5111 /* For text area clicks, return X, Y relative to the corner of
5112 this text area. Note that dX, dY etc are set below, by
5113 buffer_posn_from_coords. */
5114 if (part
== ON_TEXT
)
5116 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5117 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5119 /* For mode line and header line clicks, return X, Y relative to
5120 the left window edge. Use mode_line_string to look for a
5121 string on the click position. */
5122 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5127 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5128 /* Note that mode_line_string takes COL, ROW as pixels and
5129 converts them to characters. */
5132 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5133 &object
, &dx
, &dy
, &width
, &height
);
5134 if (STRINGP (string
))
5135 string_info
= Fcons (string
, make_number (charpos
));
5136 textpos
= (w
== XWINDOW (selected_window
)
5137 && current_buffer
== XBUFFER (w
->contents
))
5138 ? PT
: marker_position (w
->pointm
);
5143 /* For fringes and margins, Y is relative to the area's (and the
5144 window's) top edge, while X is meaningless. */
5145 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5150 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5153 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5154 &object
, &dx
, &dy
, &width
, &height
);
5155 if (STRINGP (string
))
5156 string_info
= Fcons (string
, make_number (charpos
));
5157 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5159 else if (part
== ON_LEFT_FRINGE
)
5161 posn
= Qleft_fringe
;
5164 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5165 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5166 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5168 else if (part
== ON_RIGHT_FRINGE
)
5170 posn
= Qright_fringe
;
5173 - window_box_width (w
, LEFT_MARGIN_AREA
)
5174 - window_box_width (w
, TEXT_AREA
)
5175 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5176 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5178 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5180 else if (part
== ON_VERTICAL_BORDER
)
5182 posn
= Qvertical_line
;
5187 /* Nothing special for part == ON_SCROLL_BAR. */
5189 /* For clicks in the text area, fringes, or margins, call
5190 buffer_posn_from_coords to extract TEXTPOS, the buffer
5191 position nearest to the click. */
5194 Lisp_Object string2
, object2
= Qnil
;
5195 struct display_pos p
;
5197 int width2
, height2
;
5198 /* The pixel X coordinate passed to buffer_posn_from_coords
5199 is the X coordinate relative to the text area for
5200 text-area and right-margin clicks, zero otherwise. */
5202 = (part
== ON_TEXT
) ? xret
5203 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5204 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5208 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5209 &object2
, &dx2
, &dy2
,
5211 textpos
= CHARPOS (p
.pos
);
5212 if (col
< 0) col
= x2
;
5213 if (row
< 0) row
= y2
;
5214 if (dx
< 0) dx
= dx2
;
5215 if (dy
< 0) dy
= dy2
;
5216 if (width
< 0) width
= width2
;
5217 if (height
< 0) height
= height2
;
5221 posn
= make_number (textpos
);
5222 if (STRINGP (string2
))
5223 string_info
= Fcons (string2
,
5224 make_number (CHARPOS (p
.string_pos
)));
5230 #ifdef HAVE_WINDOW_SYSTEM
5231 if (IMAGEP (object
))
5233 Lisp_Object image_map
, hotspot
;
5234 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5236 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5238 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5239 posn
= XCAR (hotspot
);
5246 Fcons (make_number (dx
), make_number (dy
)),
5247 Fcons (make_number (width
), make_number (height
)));
5250 extra_info
= Fcons (string_info
,
5251 Fcons (make_number (textpos
),
5252 Fcons (Fcons (make_number (col
),
5257 XSETFRAME (window
, f
);
5261 return Fcons (window
,
5263 Fcons (Fcons (make_number (xret
),
5264 make_number (yret
)),
5265 Fcons (make_number (t
),
5269 /* Given a struct input_event, build the lisp event which represents
5270 it. If EVENT is 0, build a mouse movement event from the mouse
5271 movement buffer, which should have a movement event in it.
5273 Note that events must be passed to this function in the order they
5274 are received; this function stores the location of button presses
5275 in order to build drag events when the button is released. */
5278 make_lispy_event (struct input_event
*event
)
5282 switch (event
->kind
)
5284 /* A simple keystroke. */
5285 case ASCII_KEYSTROKE_EVENT
:
5286 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5288 Lisp_Object lispy_c
;
5289 EMACS_INT c
= event
->code
;
5290 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5293 eassert (c
== event
->code
);
5294 /* Turn ASCII characters into control characters
5296 if (event
->modifiers
& ctrl_modifier
)
5298 c
= make_ctrl_char (c
);
5299 event
->modifiers
&= ~ctrl_modifier
;
5303 /* Add in the other modifier bits. The shift key was taken care
5304 of by the X code. */
5305 c
|= (event
->modifiers
5306 & (meta_modifier
| alt_modifier
5307 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5308 /* Distinguish Shift-SPC from SPC. */
5309 if ((event
->code
) == 040
5310 && event
->modifiers
& shift_modifier
)
5311 c
|= shift_modifier
;
5312 button_down_time
= 0;
5313 XSETFASTINT (lispy_c
, c
);
5318 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5319 except that they are non-key events (last-nonmenu-event is nil). */
5320 case NS_NONKEY_EVENT
:
5323 /* A function key. The symbol may need to have modifier prefixes
5325 case NON_ASCII_KEYSTROKE_EVENT
:
5326 button_down_time
= 0;
5328 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5329 if (event
->code
== lispy_accent_codes
[i
])
5330 return modify_event_symbol (i
,
5332 Qfunction_key
, Qnil
,
5333 lispy_accent_keys
, &accent_key_syms
,
5334 (sizeof (lispy_accent_keys
)
5335 / sizeof (lispy_accent_keys
[0])));
5339 if (event
->code
>= 0x400 && event
->code
< 0x500)
5340 return modify_event_symbol (event
->code
- 0x400,
5341 event
->modifiers
& ~shift_modifier
,
5342 Qfunction_key
, Qnil
,
5343 lispy_kana_keys
, &func_key_syms
,
5344 (sizeof (lispy_kana_keys
)
5345 / sizeof (lispy_kana_keys
[0])));
5346 #endif /* XK_kana_A */
5349 #ifdef ISO_FUNCTION_KEY_OFFSET
5350 if (event
->code
< FUNCTION_KEY_OFFSET
5351 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5352 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5354 Qfunction_key
, Qnil
,
5355 iso_lispy_function_keys
, &func_key_syms
,
5356 (sizeof (iso_lispy_function_keys
)
5357 / sizeof (iso_lispy_function_keys
[0])));
5360 /* Handle system-specific or unknown keysyms. */
5361 if (event
->code
& (1 << 28)
5362 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5363 || (event
->code
- FUNCTION_KEY_OFFSET
5364 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5365 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5367 /* We need to use an alist rather than a vector as the cache
5368 since we can't make a vector long enough. */
5369 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5370 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5371 return modify_event_symbol (event
->code
,
5374 KVAR (current_kboard
, Vsystem_key_alist
),
5375 0, &KVAR (current_kboard
, system_key_syms
),
5379 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5381 Qfunction_key
, Qnil
,
5382 lispy_function_keys
, &func_key_syms
,
5383 (sizeof (lispy_function_keys
)
5384 / sizeof (lispy_function_keys
[0])));
5387 case MULTIMEDIA_KEY_EVENT
:
5388 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5389 / sizeof (lispy_multimedia_keys
[0]))
5390 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5392 return modify_event_symbol (event
->code
, event
->modifiers
,
5393 Qfunction_key
, Qnil
,
5394 lispy_multimedia_keys
, &func_key_syms
,
5395 (sizeof (lispy_multimedia_keys
)
5396 / sizeof (lispy_multimedia_keys
[0])));
5401 /* A mouse click. Figure out where it is, decide whether it's
5402 a press, click or drag, and build the appropriate structure. */
5403 case MOUSE_CLICK_EVENT
:
5404 #ifndef USE_TOOLKIT_SCROLL_BARS
5405 case SCROLL_BAR_CLICK_EVENT
:
5408 int button
= event
->code
;
5410 Lisp_Object position
;
5411 Lisp_Object
*start_pos_ptr
;
5412 Lisp_Object start_pos
;
5416 /* Build the position as appropriate for this mouse click. */
5417 if (event
->kind
== MOUSE_CLICK_EVENT
)
5419 struct frame
*f
= XFRAME (event
->frame_or_window
);
5420 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5424 /* Ignore mouse events that were made on frame that
5425 have been deleted. */
5426 if (! FRAME_LIVE_P (f
))
5429 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5430 /* EVENT->x and EVENT->y are frame-relative pixel
5431 coordinates at this place. Under old redisplay, COLUMN
5432 and ROW are set to frame relative glyph coordinates
5433 which are then used to determine whether this click is
5434 in a menu (non-toolkit version). */
5435 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5436 &column
, &row
, NULL
, 1);
5438 /* In the non-toolkit version, clicks on the menu bar
5439 are ordinary button events in the event buffer.
5440 Distinguish them, and invoke the menu.
5442 (In the toolkit version, the toolkit handles the menu bar
5443 and Emacs doesn't know about it until after the user
5444 makes a selection.) */
5445 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5446 && (event
->modifiers
& down_modifier
))
5448 Lisp_Object items
, item
;
5450 /* Find the menu bar item under `column'. */
5452 items
= FRAME_MENU_BAR_ITEMS (f
);
5453 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5455 Lisp_Object pos
, string
;
5456 string
= AREF (items
, i
+ 1);
5457 pos
= AREF (items
, i
+ 3);
5460 if (column
>= XINT (pos
)
5461 && column
< XINT (pos
) + SCHARS (string
))
5463 item
= AREF (items
, i
);
5468 /* ELisp manual 2.4b says (x y) are window relative but
5469 code says they are frame-relative. */
5471 = Fcons (event
->frame_or_window
,
5473 Fcons (Fcons (event
->x
, event
->y
),
5474 Fcons (make_number (event
->timestamp
),
5477 return Fcons (item
, Fcons (position
, Qnil
));
5479 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5481 position
= make_lispy_position (f
, event
->x
, event
->y
,
5484 #ifndef USE_TOOLKIT_SCROLL_BARS
5487 /* It's a scrollbar click. */
5489 Lisp_Object portion_whole
;
5492 window
= event
->frame_or_window
;
5493 portion_whole
= Fcons (event
->x
, event
->y
);
5494 part
= *scroll_bar_parts
[(int) event
->part
];
5498 Fcons (Qvertical_scroll_bar
,
5499 Fcons (portion_whole
,
5500 Fcons (make_number (event
->timestamp
),
5501 Fcons (part
, Qnil
)))));
5503 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5505 if (button
>= ASIZE (button_down_location
))
5507 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5508 button_down_location
= larger_vector (button_down_location
,
5510 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5513 start_pos_ptr
= aref_addr (button_down_location
, button
);
5514 start_pos
= *start_pos_ptr
;
5515 *start_pos_ptr
= Qnil
;
5518 /* On window-system frames, use the value of
5519 double-click-fuzz as is. On other frames, interpret it
5520 as a multiple of 1/8 characters. */
5524 if (WINDOWP (event
->frame_or_window
))
5525 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5526 else if (FRAMEP (event
->frame_or_window
))
5527 f
= XFRAME (event
->frame_or_window
);
5531 if (FRAME_WINDOW_P (f
))
5532 fuzz
= double_click_fuzz
;
5534 fuzz
= double_click_fuzz
/ 8;
5536 is_double
= (button
== last_mouse_button
5537 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5538 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5539 && button_down_time
!= 0
5540 && (EQ (Vdouble_click_time
, Qt
)
5541 || (NATNUMP (Vdouble_click_time
)
5542 && (event
->timestamp
- button_down_time
5543 < XFASTINT (Vdouble_click_time
)))));
5546 last_mouse_button
= button
;
5547 last_mouse_x
= XINT (event
->x
);
5548 last_mouse_y
= XINT (event
->y
);
5550 /* If this is a button press, squirrel away the location, so
5551 we can decide later whether it was a click or a drag. */
5552 if (event
->modifiers
& down_modifier
)
5556 double_click_count
++;
5557 event
->modifiers
|= ((double_click_count
> 2)
5562 double_click_count
= 1;
5563 button_down_time
= event
->timestamp
;
5564 *start_pos_ptr
= Fcopy_alist (position
);
5565 ignore_mouse_drag_p
= 0;
5568 /* Now we're releasing a button - check the co-ordinates to
5569 see if this was a click or a drag. */
5570 else if (event
->modifiers
& up_modifier
)
5572 /* If we did not see a down before this up, ignore the up.
5573 Probably this happened because the down event chose a
5574 menu item. It would be an annoyance to treat the
5575 release of the button that chose the menu item as a
5578 if (!CONSP (start_pos
))
5581 event
->modifiers
&= ~up_modifier
;
5584 Lisp_Object new_down
, down
;
5585 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5587 /* The third element of every position
5588 should be the (x,y) pair. */
5589 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5590 new_down
= Fcar (Fcdr (Fcdr (position
)));
5593 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5595 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5596 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5599 if (ignore_mouse_drag_p
)
5601 event
->modifiers
|= click_modifier
;
5602 ignore_mouse_drag_p
= 0;
5604 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5605 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5606 /* Maybe the mouse has moved a lot, caused scrolling, and
5607 eventually ended up at the same screen position (but
5608 not buffer position) in which case it is a drag, not
5610 /* FIXME: OTOH if the buffer position has changed
5611 because of a timer or process filter rather than
5612 because of mouse movement, it should be considered as
5613 a click. But mouse-drag-region completely ignores
5614 this case and it hasn't caused any real problem, so
5615 it's probably OK to ignore it as well. */
5616 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5617 /* Mouse hasn't moved (much). */
5618 event
->modifiers
|= click_modifier
;
5621 button_down_time
= 0;
5622 event
->modifiers
|= drag_modifier
;
5625 /* Don't check is_double; treat this as multiple
5626 if the down-event was multiple. */
5627 if (double_click_count
> 1)
5628 event
->modifiers
|= ((double_click_count
> 2)
5634 /* Every mouse event should either have the down_modifier or
5635 the up_modifier set. */
5639 /* Get the symbol we should use for the mouse click. */
5642 head
= modify_event_symbol (button
,
5644 Qmouse_click
, Vlispy_mouse_stem
,
5647 ASIZE (mouse_syms
));
5648 if (event
->modifiers
& drag_modifier
)
5653 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5656 Fcons (make_number (double_click_count
),
5666 case HORIZ_WHEEL_EVENT
:
5668 Lisp_Object position
;
5671 /* Build the position as appropriate for this mouse click. */
5672 struct frame
*f
= XFRAME (event
->frame_or_window
);
5674 /* Ignore wheel events that were made on frame that have been
5676 if (! FRAME_LIVE_P (f
))
5679 position
= make_lispy_position (f
, event
->x
, event
->y
,
5682 /* Set double or triple modifiers to indicate the wheel speed. */
5684 /* On window-system frames, use the value of
5685 double-click-fuzz as is. On other frames, interpret it
5686 as a multiple of 1/8 characters. */
5692 if (WINDOWP (event
->frame_or_window
))
5693 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5694 else if (FRAMEP (event
->frame_or_window
))
5695 fr
= XFRAME (event
->frame_or_window
);
5699 fuzz
= FRAME_WINDOW_P (fr
)
5700 ? double_click_fuzz
: double_click_fuzz
/ 8;
5702 if (event
->modifiers
& up_modifier
)
5704 /* Emit a wheel-up event. */
5705 event
->modifiers
&= ~up_modifier
;
5708 else if (event
->modifiers
& down_modifier
)
5710 /* Emit a wheel-down event. */
5711 event
->modifiers
&= ~down_modifier
;
5715 /* Every wheel event should either have the down_modifier or
5716 the up_modifier set. */
5719 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5722 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5723 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5724 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5725 && button_down_time
!= 0
5726 && (EQ (Vdouble_click_time
, Qt
)
5727 || (NATNUMP (Vdouble_click_time
)
5728 && (event
->timestamp
- button_down_time
5729 < XFASTINT (Vdouble_click_time
)))));
5732 double_click_count
++;
5733 event
->modifiers
|= ((double_click_count
> 2)
5739 double_click_count
= 1;
5740 event
->modifiers
|= click_modifier
;
5743 button_down_time
= event
->timestamp
;
5744 /* Use a negative value to distinguish wheel from mouse button. */
5745 last_mouse_button
= - (1 + symbol_num
);
5746 last_mouse_x
= XINT (event
->x
);
5747 last_mouse_y
= XINT (event
->y
);
5749 /* Get the symbol we should use for the wheel event. */
5750 head
= modify_event_symbol (symbol_num
,
5756 ASIZE (wheel_syms
));
5759 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5762 Fcons (make_number (double_click_count
),
5771 #ifdef USE_TOOLKIT_SCROLL_BARS
5773 /* We don't have down and up events if using toolkit scroll bars,
5774 so make this always a click event. Store in the `part' of
5775 the Lisp event a symbol which maps to the following actions:
5777 `above_handle' page up
5778 `below_handle' page down
5782 `bottom' bottom of buffer
5783 `handle' thumb has been dragged.
5784 `end-scroll' end of interaction with scroll bar
5786 The incoming input_event contains in its `part' member an
5787 index of type `enum scroll_bar_part' which we can use as an
5788 index in scroll_bar_parts to get the appropriate symbol. */
5790 case SCROLL_BAR_CLICK_EVENT
:
5792 Lisp_Object position
, head
, window
, portion_whole
, part
;
5794 window
= event
->frame_or_window
;
5795 portion_whole
= Fcons (event
->x
, event
->y
);
5796 part
= *scroll_bar_parts
[(int) event
->part
];
5800 Fcons (Qvertical_scroll_bar
,
5801 Fcons (portion_whole
,
5802 Fcons (make_number (event
->timestamp
),
5803 Fcons (part
, Qnil
)))));
5805 /* Always treat scroll bar events as clicks. */
5806 event
->modifiers
|= click_modifier
;
5807 event
->modifiers
&= ~up_modifier
;
5809 if (event
->code
>= ASIZE (mouse_syms
))
5810 mouse_syms
= larger_vector (mouse_syms
,
5811 event
->code
- ASIZE (mouse_syms
) + 1,
5814 /* Get the symbol we should use for the mouse click. */
5815 head
= modify_event_symbol (event
->code
,
5820 ASIZE (mouse_syms
));
5821 return Fcons (head
, Fcons (position
, Qnil
));
5824 #endif /* USE_TOOLKIT_SCROLL_BARS */
5826 case DRAG_N_DROP_EVENT
:
5829 Lisp_Object head
, position
;
5832 f
= XFRAME (event
->frame_or_window
);
5835 /* Ignore mouse events that were made on frames that
5836 have been deleted. */
5837 if (! FRAME_LIVE_P (f
))
5840 position
= make_lispy_position (f
, event
->x
, event
->y
,
5843 head
= modify_event_symbol (0, event
->modifiers
,
5845 lispy_drag_n_drop_names
,
5846 &drag_n_drop_syms
, 1);
5853 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5854 || defined (HAVE_NS) || defined (USE_GTK)
5855 case MENU_BAR_EVENT
:
5856 if (EQ (event
->arg
, event
->frame_or_window
))
5857 /* This is the prefix key. We translate this to
5858 `(menu_bar)' because the code in keyboard.c for menu
5859 events, which we use, relies on this. */
5860 return Fcons (Qmenu_bar
, Qnil
);
5864 case SELECT_WINDOW_EVENT
:
5865 /* Make an event (select-window (WINDOW)). */
5866 return Fcons (Qselect_window
,
5867 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5870 case TOOL_BAR_EVENT
:
5871 if (EQ (event
->arg
, event
->frame_or_window
))
5872 /* This is the prefix key. We translate this to
5873 `(tool_bar)' because the code in keyboard.c for tool bar
5874 events, which we use, relies on this. */
5875 return Fcons (Qtool_bar
, Qnil
);
5876 else if (SYMBOLP (event
->arg
))
5877 return apply_modifiers (event
->modifiers
, event
->arg
);
5880 case USER_SIGNAL_EVENT
:
5881 /* A user signal. */
5883 char *name
= find_user_signal_name (event
->code
);
5886 return intern (name
);
5889 case SAVE_SESSION_EVENT
:
5890 return Qsave_session
;
5895 return Fcons (Qdbus_event
, event
->arg
);
5897 #endif /* HAVE_DBUS */
5900 case FILE_NOTIFY_EVENT
:
5902 return Fcons (Qfile_inotify
, event
->arg
);
5904 #endif /* HAVE_INOTIFY */
5906 case CONFIG_CHANGED_EVENT
:
5907 return Fcons (Qconfig_changed_event
,
5909 Fcons (event
->frame_or_window
, Qnil
)));
5911 case GPM_CLICK_EVENT
:
5913 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5914 Lisp_Object head
, position
;
5915 Lisp_Object
*start_pos_ptr
;
5916 Lisp_Object start_pos
;
5917 int button
= event
->code
;
5919 if (button
>= ASIZE (button_down_location
))
5921 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5922 button_down_location
= larger_vector (button_down_location
,
5924 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5927 start_pos_ptr
= aref_addr (button_down_location
, button
);
5928 start_pos
= *start_pos_ptr
;
5930 position
= make_lispy_position (f
, event
->x
, event
->y
,
5933 if (event
->modifiers
& down_modifier
)
5934 *start_pos_ptr
= Fcopy_alist (position
);
5935 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5937 if (!CONSP (start_pos
))
5939 event
->modifiers
&= ~up_modifier
;
5942 head
= modify_event_symbol (button
,
5944 Qmouse_click
, Vlispy_mouse_stem
,
5947 ASIZE (mouse_syms
));
5949 if (event
->modifiers
& drag_modifier
)
5954 else if (event
->modifiers
& double_modifier
)
5957 Fcons (make_number (2),
5959 else if (event
->modifiers
& triple_modifier
)
5962 Fcons (make_number (3),
5969 #endif /* HAVE_GPM */
5971 /* The 'kind' field of the event is something we don't recognize. */
5978 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5979 Lisp_Object x
, Lisp_Object y
, Time t
)
5981 /* Is it a scroll bar movement? */
5982 if (frame
&& ! NILP (bar_window
))
5984 Lisp_Object part_sym
;
5986 part_sym
= *scroll_bar_parts
[(int) part
];
5987 return Fcons (Qscroll_bar_movement
,
5988 Fcons (list5 (bar_window
,
5989 Qvertical_scroll_bar
,
5995 /* Or is it an ordinary mouse movement? */
5998 Lisp_Object position
;
5999 position
= make_lispy_position (frame
, x
, y
, t
);
6000 return list2 (Qmouse_movement
, position
);
6004 /* Construct a switch frame event. */
6006 make_lispy_switch_frame (Lisp_Object frame
)
6008 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6011 /* Manipulating modifiers. */
6013 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6015 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6016 SYMBOL's name of the end of the modifiers; the string from this
6017 position is the unmodified symbol name.
6019 This doesn't use any caches. */
6022 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6028 CHECK_SYMBOL (symbol
);
6031 name
= SYMBOL_NAME (symbol
);
6033 for (i
= 0; i
< SBYTES (name
) - 1; )
6035 ptrdiff_t this_mod_end
= 0;
6038 /* See if the name continues with a modifier word.
6039 Check that the word appears, but don't check what follows it.
6040 Set this_mod and this_mod_end to record what we find. */
6042 switch (SREF (name
, i
))
6044 #define SINGLE_LETTER_MOD(BIT) \
6045 (this_mod_end = i + 1, this_mod = BIT)
6048 SINGLE_LETTER_MOD (alt_modifier
);
6052 SINGLE_LETTER_MOD (ctrl_modifier
);
6056 SINGLE_LETTER_MOD (hyper_modifier
);
6060 SINGLE_LETTER_MOD (meta_modifier
);
6064 SINGLE_LETTER_MOD (shift_modifier
);
6068 SINGLE_LETTER_MOD (super_modifier
);
6071 #undef SINGLE_LETTER_MOD
6073 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6074 if (i + LEN + 1 <= SBYTES (name) \
6075 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6077 this_mod_end = i + LEN; \
6082 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6083 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6084 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6088 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6090 #undef MULTI_LETTER_MOD
6094 /* If we found no modifier, stop looking for them. */
6095 if (this_mod_end
== 0)
6098 /* Check there is a dash after the modifier, so that it
6099 really is a modifier. */
6100 if (this_mod_end
>= SBYTES (name
)
6101 || SREF (name
, this_mod_end
) != '-')
6104 /* This modifier is real; look for another. */
6105 modifiers
|= this_mod
;
6106 i
= this_mod_end
+ 1;
6109 /* Should we include the `click' modifier? */
6110 if (! (modifiers
& (down_modifier
| drag_modifier
6111 | double_modifier
| triple_modifier
))
6112 && i
+ 7 == SBYTES (name
)
6113 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6114 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6115 modifiers
|= click_modifier
;
6117 if (! (modifiers
& (double_modifier
| triple_modifier
))
6118 && i
+ 6 < SBYTES (name
)
6119 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6120 modifiers
|= click_modifier
;
6128 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6129 prepended to the string BASE[0..BASE_LEN-1].
6130 This doesn't use any caches. */
6132 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6134 /* Since BASE could contain nulls, we can't use intern here; we have
6135 to use Fintern, which expects a genuine Lisp_String, and keeps a
6137 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6143 /* Only the event queue may use the `up' modifier; it should always
6144 be turned into a click or drag event before presented to lisp code. */
6145 if (modifiers
& up_modifier
)
6148 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6149 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6150 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6151 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6152 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6153 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6154 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6155 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6156 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6157 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6158 /* The click modifier is denoted by the absence of other modifiers. */
6162 mod_len
= p
- new_mods
;
6166 Lisp_Object new_name
;
6168 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6169 mod_len
+ base_len_byte
);
6170 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6171 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6173 return Fintern (new_name
, Qnil
);
6178 static const char *const modifier_names
[] =
6180 "up", "down", "drag", "click", "double", "triple", 0, 0,
6181 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6182 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6184 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6186 static Lisp_Object modifier_symbols
;
6188 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6190 lispy_modifier_list (int modifiers
)
6192 Lisp_Object modifier_list
;
6195 modifier_list
= Qnil
;
6196 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6197 if (modifiers
& (1<<i
))
6198 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6201 return modifier_list
;
6205 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6206 where UNMODIFIED is the unmodified form of SYMBOL,
6207 MASK is the set of modifiers present in SYMBOL's name.
6208 This is similar to parse_modifiers_uncached, but uses the cache in
6209 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6210 Qevent_symbol_elements property. */
6212 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6215 parse_modifiers (Lisp_Object symbol
)
6217 Lisp_Object elements
;
6219 if (INTEGERP (symbol
))
6220 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6221 else if (!SYMBOLP (symbol
))
6224 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6225 if (CONSP (elements
))
6230 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6231 Lisp_Object unmodified
;
6234 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6235 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6238 if (modifiers
& ~INTMASK
)
6240 XSETFASTINT (mask
, modifiers
);
6241 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6243 /* Cache the parsing results on SYMBOL. */
6244 Fput (symbol
, Qevent_symbol_element_mask
,
6246 Fput (symbol
, Qevent_symbol_elements
,
6247 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6249 /* Since we know that SYMBOL is modifiers applied to unmodified,
6250 it would be nice to put that in unmodified's cache.
6251 But we can't, since we're not sure that parse_modifiers is
6258 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6259 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6260 doc
: /* Parse the event symbol. For internal use. */)
6261 (Lisp_Object symbol
)
6263 /* Fill the cache if needed. */
6264 parse_modifiers (symbol
);
6265 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6266 and use the Lispier representation stored on Qevent_symbol_elements
6268 return Fget (symbol
, Qevent_symbol_elements
);
6271 /* Apply the modifiers MODIFIERS to the symbol BASE.
6272 BASE must be unmodified.
6274 This is like apply_modifiers_uncached, but uses BASE's
6275 Qmodifier_cache property, if present. It also builds
6276 Qevent_symbol_elements properties, since it has that info anyway.
6278 apply_modifiers copies the value of BASE's Qevent_kind property to
6279 the modified symbol. */
6281 apply_modifiers (int modifiers
, Lisp_Object base
)
6283 Lisp_Object cache
, idx
, entry
, new_symbol
;
6285 /* Mask out upper bits. We don't know where this value's been. */
6286 modifiers
&= INTMASK
;
6288 if (INTEGERP (base
))
6289 return make_number (XINT (base
) | modifiers
);
6291 /* The click modifier never figures into cache indices. */
6292 cache
= Fget (base
, Qmodifier_cache
);
6293 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6294 entry
= assq_no_quit (idx
, cache
);
6297 new_symbol
= XCDR (entry
);
6300 /* We have to create the symbol ourselves. */
6301 new_symbol
= apply_modifiers_uncached (modifiers
,
6302 SSDATA (SYMBOL_NAME (base
)),
6303 SCHARS (SYMBOL_NAME (base
)),
6304 SBYTES (SYMBOL_NAME (base
)));
6306 /* Add the new symbol to the base's cache. */
6307 entry
= Fcons (idx
, new_symbol
);
6308 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6310 /* We have the parsing info now for free, so we could add it to
6312 XSETFASTINT (idx, modifiers);
6313 Fput (new_symbol, Qevent_symbol_element_mask,
6314 Fcons (base, Fcons (idx, Qnil)));
6315 Fput (new_symbol, Qevent_symbol_elements,
6316 Fcons (base, lispy_modifier_list (modifiers)));
6317 Sadly, this is only correct if `base' is indeed a base event,
6318 which is not necessarily the case. -stef */
6321 /* Make sure this symbol is of the same kind as BASE.
6323 You'd think we could just set this once and for all when we
6324 intern the symbol above, but reorder_modifiers may call us when
6325 BASE's property isn't set right; we can't assume that just
6326 because it has a Qmodifier_cache property it must have its
6327 Qevent_kind set right as well. */
6328 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6332 kind
= Fget (base
, Qevent_kind
);
6334 Fput (new_symbol
, Qevent_kind
, kind
);
6341 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6342 return a symbol with the modifiers placed in the canonical order.
6343 Canonical order is alphabetical, except for down and drag, which
6344 always come last. The 'click' modifier is never written out.
6346 Fdefine_key calls this to make sure that (for example) C-M-foo
6347 and M-C-foo end up being equivalent in the keymap. */
6350 reorder_modifiers (Lisp_Object symbol
)
6352 /* It's hopefully okay to write the code this way, since everything
6353 will soon be in caches, and no consing will be done at all. */
6356 parsed
= parse_modifiers (symbol
);
6357 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6362 /* For handling events, we often want to produce a symbol whose name
6363 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6364 to some base, like the name of a function key or mouse button.
6365 modify_event_symbol produces symbols of this sort.
6367 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6368 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6371 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6372 into symbol names, or a string specifying a name stem used to
6373 construct a symbol name or the form `STEM-N', where N is the decimal
6374 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6375 non-nil; otherwise NAME_TABLE is used.
6377 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6378 persist between calls to modify_event_symbol that it can use to
6379 store a cache of the symbols it's generated for this NAME_TABLE
6380 before. The object stored there may be a vector or an alist.
6382 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6384 MODIFIERS is a set of modifier bits (as given in struct input_events)
6385 whose prefixes should be applied to the symbol name.
6387 SYMBOL_KIND is the value to be placed in the event_kind property of
6388 the returned symbol.
6390 The symbols we create are supposed to have an
6391 `event-symbol-elements' property, which lists the modifiers present
6392 in the symbol's name. */
6395 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6396 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6397 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6400 Lisp_Object symbol_int
;
6402 /* Get rid of the "vendor-specific" bit here. */
6403 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6405 /* Is this a request for a valid symbol? */
6406 if (symbol_num
< 0 || symbol_num
>= table_size
)
6409 if (CONSP (*symbol_table
))
6410 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6412 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6413 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6414 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6415 we've never used that symbol before. */
6418 if (! VECTORP (*symbol_table
)
6419 || ASIZE (*symbol_table
) != table_size
)
6423 XSETFASTINT (size
, table_size
);
6424 *symbol_table
= Fmake_vector (size
, Qnil
);
6427 value
= AREF (*symbol_table
, symbol_num
);
6430 /* Have we already used this symbol before? */
6433 /* No; let's create it. */
6434 if (CONSP (name_alist_or_stem
))
6435 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6436 else if (STRINGP (name_alist_or_stem
))
6439 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6440 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6442 buf
= SAFE_ALLOCA (len
);
6443 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6444 XINT (symbol_int
) + 1);
6445 value
= intern (buf
);
6448 else if (name_table
!= 0 && name_table
[symbol_num
])
6449 value
= intern (name_table
[symbol_num
]);
6451 #ifdef HAVE_WINDOW_SYSTEM
6454 char *name
= x_get_keysym_name (symbol_num
);
6456 value
= intern (name
);
6462 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6463 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6464 value
= intern (buf
);
6467 if (CONSP (*symbol_table
))
6468 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6470 ASET (*symbol_table
, symbol_num
, value
);
6472 /* Fill in the cache entries for this symbol; this also
6473 builds the Qevent_symbol_elements property, which the user
6475 apply_modifiers (modifiers
& click_modifier
, value
);
6476 Fput (value
, Qevent_kind
, symbol_kind
);
6479 /* Apply modifiers to that symbol. */
6480 return apply_modifiers (modifiers
, value
);
6483 /* Convert a list that represents an event type,
6484 such as (ctrl meta backspace), into the usual representation of that
6485 event type as a number or a symbol. */
6487 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6488 doc
: /* Convert the event description list EVENT-DESC to an event type.
6489 EVENT-DESC should contain one base event type (a character or symbol)
6490 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6491 drag, down, double or triple). The base must be last.
6492 The return value is an event type (a character or symbol) which
6493 has the same base event type and all the specified modifiers. */)
6494 (Lisp_Object event_desc
)
6502 while (CONSP (rest
))
6510 /* Given a symbol, see if it is a modifier name. */
6511 if (SYMBOLP (elt
) && CONSP (rest
))
6512 this = parse_solitary_modifier (elt
);
6516 else if (!NILP (base
))
6517 error ("Two bases given in one event");
6523 /* Let the symbol A refer to the character A. */
6524 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6525 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6527 if (INTEGERP (base
))
6529 /* Turn (shift a) into A. */
6530 if ((modifiers
& shift_modifier
) != 0
6531 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6533 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6534 modifiers
&= ~shift_modifier
;
6537 /* Turn (control a) into C-a. */
6538 if (modifiers
& ctrl_modifier
)
6539 return make_number ((modifiers
& ~ctrl_modifier
)
6540 | make_ctrl_char (XINT (base
)));
6542 return make_number (modifiers
| XINT (base
));
6544 else if (SYMBOLP (base
))
6545 return apply_modifiers (modifiers
, base
);
6547 error ("Invalid base event");
6550 /* Try to recognize SYMBOL as a modifier name.
6551 Return the modifier flag bit, or 0 if not recognized. */
6554 parse_solitary_modifier (Lisp_Object symbol
)
6556 Lisp_Object name
= SYMBOL_NAME (symbol
);
6558 switch (SREF (name
, 0))
6560 #define SINGLE_LETTER_MOD(BIT) \
6561 if (SBYTES (name) == 1) \
6564 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6565 if (LEN == SBYTES (name) \
6566 && ! memcmp (SDATA (name), NAME, LEN)) \
6570 SINGLE_LETTER_MOD (alt_modifier
);
6574 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6578 SINGLE_LETTER_MOD (ctrl_modifier
);
6582 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6583 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6587 SINGLE_LETTER_MOD (hyper_modifier
);
6591 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6595 SINGLE_LETTER_MOD (meta_modifier
);
6599 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6603 SINGLE_LETTER_MOD (shift_modifier
);
6607 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6608 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6609 SINGLE_LETTER_MOD (super_modifier
);
6613 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6614 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6615 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6619 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6622 #undef SINGLE_LETTER_MOD
6623 #undef MULTI_LETTER_MOD
6629 /* Return true if EVENT is a list whose elements are all integers or symbols.
6630 Such a list is not valid as an event,
6631 but it can be a Lucid-style event type list. */
6634 lucid_event_type_list_p (Lisp_Object object
)
6638 if (! CONSP (object
))
6641 if (EQ (XCAR (object
), Qhelp_echo
)
6642 || EQ (XCAR (object
), Qvertical_line
)
6643 || EQ (XCAR (object
), Qmode_line
)
6644 || EQ (XCAR (object
), Qheader_line
))
6647 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6651 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6658 /* Return true if terminal input chars are available.
6659 Also, store the return value into INPUT_PENDING.
6661 Serves the purpose of ioctl (0, FIONREAD, ...)
6662 but works even if FIONREAD does not exist.
6663 (In fact, this may actually read some input.)
6665 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6666 timer events that are ripe.
6667 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6668 events (FOCUS_IN_EVENT).
6669 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6670 movements and toolkit scroll bar thumb drags. */
6673 get_input_pending (int flags
)
6675 /* First of all, have we already counted some input? */
6676 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6678 /* If input is being read as it arrives, and we have none, there is none. */
6679 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6681 /* Try to read some input and see how much we get. */
6683 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6686 return input_pending
;
6689 /* Put a BUFFER_SWITCH_EVENT in the buffer
6690 so that read_key_sequence will notice the new current buffer. */
6693 record_asynch_buffer_change (void)
6695 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6696 The purpose of the event is to make read_key_sequence look up the
6697 keymaps again. If we aren't in read_key_sequence, we don't need one,
6698 and the event could cause trouble by messing up (input-pending-p).
6699 Note: Fwaiting_for_user_input_p always returns nil when async
6700 subprocesses aren't supported. */
6701 if (!NILP (Fwaiting_for_user_input_p ()))
6703 struct input_event event
;
6706 event
.kind
= BUFFER_SWITCH_EVENT
;
6707 event
.frame_or_window
= Qnil
;
6710 /* Make sure no interrupt happens while storing the event. */
6712 if (interrupt_input
)
6713 kbd_buffer_store_event (&event
);
6718 kbd_buffer_store_event (&event
);
6724 /* Read any terminal input already buffered up by the system
6725 into the kbd_buffer, but do not wait.
6727 Return the number of keyboard chars read, or -1 meaning
6728 this is a bad time to try to read input. */
6737 /* Store pending user signal events, if any. */
6738 store_user_signal_events ();
6740 /* Loop through the available terminals, and call their input hooks. */
6744 struct terminal
*next
= t
->next_terminal
;
6746 if (t
->read_socket_hook
)
6749 struct input_event hold_quit
;
6751 if (input_blocked_p ())
6753 pending_signals
= 1;
6757 EVENT_INIT (hold_quit
);
6758 hold_quit
.kind
= NO_EVENT
;
6760 /* No need for FIONREAD or fcntl; just say don't wait. */
6761 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6764 if (nr
== -1) /* Not OK to read input now. */
6768 else if (nr
== -2) /* Non-transient error. */
6770 /* The terminal device terminated; it should be closed. */
6772 /* Kill Emacs if this was our last terminal. */
6773 if (!terminal_list
->next_terminal
)
6774 /* Formerly simply reported no input, but that
6775 sometimes led to a failure of Emacs to terminate.
6776 SIGHUP seems appropriate if we can't reach the
6778 /* ??? Is it really right to send the signal just to
6779 this process rather than to the whole process
6780 group? Perhaps on systems with FIONREAD Emacs is
6781 alone in its group. */
6782 terminate_due_to_signal (SIGHUP
, 10);
6784 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6787 XSETTERMINAL (tmp
, t
);
6788 Fdelete_terminal (tmp
, Qnoelisp
);
6792 if (hold_quit
.kind
!= NO_EVENT
)
6793 kbd_buffer_store_event (&hold_quit
);
6802 frame_make_pointer_visible ();
6807 /* This is the tty way of reading available input.
6809 Note that each terminal device has its own `struct terminal' object,
6810 and so this function is called once for each individual termcap
6811 terminal. The first parameter indicates which terminal to read from. */
6814 tty_read_avail_input (struct terminal
*terminal
,
6815 struct input_event
*hold_quit
)
6817 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6818 the kbd_buffer can really hold. That may prevent loss
6819 of characters on some systems when input is stuffed at us. */
6820 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6822 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6825 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6827 if (kbd_on_hold_p () || buffer_free
<= 0)
6829 #endif /* subprocesses */
6831 if (!terminal
->name
) /* Don't read from a dead terminal. */
6834 if (terminal
->type
!= output_termcap
6835 && terminal
->type
!= output_msdos_raw
)
6838 /* XXX I think the following code should be moved to separate hook
6839 functions in system-dependent files. */
6842 #else /* not WINDOWSNT */
6843 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6847 return 0; /* The terminal is suspended. */
6850 n_to_read
= dos_keysns ();
6854 cbuf
[0] = dos_keyread ();
6857 #else /* not MSDOS */
6862 struct input_event gpm_hold_quit
;
6863 int gpm
, fd
= gpm_fd
;
6865 EVENT_INIT (gpm_hold_quit
);
6866 gpm_hold_quit
.kind
= NO_EVENT
;
6868 /* gpm==1 if event received.
6869 gpm==0 if the GPM daemon has closed the connection, in which case
6870 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6871 we save it in `fd' so close_gpm can remove it from the
6873 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6874 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6875 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6878 /* Presumably the GPM daemon has closed the connection. */
6880 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6881 kbd_buffer_store_event (&gpm_hold_quit
);
6885 #endif /* HAVE_GPM */
6887 /* Determine how many characters we should *try* to read. */
6888 #ifdef USABLE_FIONREAD
6889 /* Find out how much input is available. */
6890 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6892 if (! noninteractive
)
6893 return -2; /* Close this terminal. */
6899 if (n_to_read
> sizeof cbuf
)
6900 n_to_read
= sizeof cbuf
;
6901 #elif defined USG || defined CYGWIN
6902 /* Read some input if available, but don't wait. */
6903 n_to_read
= sizeof cbuf
;
6904 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6906 # error "Cannot read without possibly delaying"
6910 /* Don't read more than we can store. */
6911 if (n_to_read
> buffer_free
)
6912 n_to_read
= buffer_free
;
6913 #endif /* subprocesses */
6915 /* Now read; for one reason or another, this will not block.
6916 NREAD is set to the number of chars read. */
6919 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6920 /* POSIX infers that processes which are not in the session leader's
6921 process group won't get SIGHUP's at logout time. BSDI adheres to
6922 this part standard and returns -1 from read (0) with errno==EIO
6923 when the control tty is taken away.
6924 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6925 if (nread
== -1 && errno
== EIO
)
6926 return -2; /* Close this terminal. */
6927 #if defined (AIX) && defined (_BSD)
6928 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6929 This looks incorrect, but it isn't, because _BSD causes
6930 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6931 and that causes a value other than 0 when there is no input. */
6933 return -2; /* Close this terminal. */
6937 /* We used to retry the read if it was interrupted.
6938 But this does the wrong thing when O_NONBLOCK causes
6939 an EAGAIN error. Does anybody know of a situation
6940 where a retry is actually needed? */
6942 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6952 #ifndef USABLE_FIONREAD
6953 #if defined (USG) || defined (CYGWIN)
6954 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6955 #endif /* USG or CYGWIN */
6956 #endif /* no FIONREAD */
6961 #endif /* not MSDOS */
6962 #endif /* not WINDOWSNT */
6964 for (i
= 0; i
< nread
; i
++)
6966 struct input_event buf
;
6968 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6970 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6971 buf
.modifiers
= meta_modifier
;
6972 if (tty
->meta_key
!= 2)
6976 /* Set the frame corresponding to the active tty. Note that the
6977 value of selected_frame is not reliable here, redisplay tends
6978 to temporarily change it. */
6979 buf
.frame_or_window
= tty
->top_frame
;
6982 kbd_buffer_store_event (&buf
);
6983 /* Don't look at input that follows a C-g too closely.
6984 This reduces lossage due to autorepeat on C-g. */
6985 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6986 && buf
.code
== quit_char
)
6994 handle_async_input (void)
6999 int nread
= gobble_input ();
7000 /* -1 means it's not ok to read the input now.
7001 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7002 0 means there was no keyboard input available. */
7010 process_pending_signals (void)
7012 pending_signals
= 0;
7013 handle_async_input ();
7014 do_pending_atimers ();
7017 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7018 and also (if the level is now 0) reinvoke any pending signal. */
7021 unblock_input_to (int level
)
7023 interrupt_input_blocked
= level
;
7026 if (pending_signals
)
7027 process_pending_signals ();
7033 /* End critical section.
7035 If doing signal-driven input, and a signal came in when input was
7036 blocked, reinvoke the signal handler now to deal with it. */
7039 unblock_input (void)
7041 unblock_input_to (interrupt_input_blocked
- 1);
7044 /* Undo any number of BLOCK_INPUT calls,
7045 and also reinvoke any pending signal. */
7048 totally_unblock_input (void)
7050 unblock_input_to (0);
7056 handle_input_available_signal (int sig
)
7058 pending_signals
= 1;
7060 if (input_available_clear_time
)
7061 *input_available_clear_time
= make_emacs_time (0, 0);
7065 deliver_input_available_signal (int sig
)
7067 deliver_process_signal (sig
, handle_input_available_signal
);
7069 #endif /* USABLE_SIGIO */
7072 /* User signal events. */
7074 struct user_signal_info
7076 /* Signal number. */
7079 /* Name of the signal. */
7082 /* Number of pending signals. */
7085 struct user_signal_info
*next
;
7088 /* List of user signals. */
7089 static struct user_signal_info
*user_signals
= NULL
;
7092 add_user_signal (int sig
, const char *name
)
7094 struct sigaction action
;
7095 struct user_signal_info
*p
;
7097 for (p
= user_signals
; p
; p
= p
->next
)
7099 /* Already added. */
7102 p
= xmalloc (sizeof *p
);
7104 p
->name
= xstrdup (name
);
7106 p
->next
= user_signals
;
7109 emacs_sigaction_init (&action
, deliver_user_signal
);
7110 sigaction (sig
, &action
, 0);
7114 handle_user_signal (int sig
)
7116 struct user_signal_info
*p
;
7117 const char *special_event_name
= NULL
;
7119 if (SYMBOLP (Vdebug_on_event
))
7120 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7122 for (p
= user_signals
; p
; p
= p
->next
)
7125 if (special_event_name
7126 && strcmp (special_event_name
, p
->name
) == 0)
7128 /* Enter the debugger in many ways. */
7129 debug_on_next_call
= 1;
7132 Vinhibit_quit
= Qnil
;
7134 /* Eat the event. */
7140 if (interrupt_input
)
7141 handle_input_available_signal (sig
);
7145 /* Tell wait_reading_process_output that it needs to wake
7146 up and look around. */
7147 if (input_available_clear_time
)
7148 *input_available_clear_time
= make_emacs_time (0, 0);
7155 deliver_user_signal (int sig
)
7157 deliver_process_signal (sig
, handle_user_signal
);
7161 find_user_signal_name (int sig
)
7163 struct user_signal_info
*p
;
7165 for (p
= user_signals
; p
; p
= p
->next
)
7173 store_user_signal_events (void)
7175 struct user_signal_info
*p
;
7176 struct input_event buf
;
7177 bool buf_initialized
= 0;
7179 for (p
= user_signals
; p
; p
= p
->next
)
7180 if (p
->npending
> 0)
7182 if (! buf_initialized
)
7184 memset (&buf
, 0, sizeof buf
);
7185 buf
.kind
= USER_SIGNAL_EVENT
;
7186 buf
.frame_or_window
= selected_frame
;
7187 buf_initialized
= 1;
7193 kbd_buffer_store_event (&buf
);
7196 while (p
->npending
> 0);
7201 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7202 static Lisp_Object menu_bar_one_keymap_changed_items
;
7204 /* These variables hold the vector under construction within
7205 menu_bar_items and its subroutines, and the current index
7206 for storing into that vector. */
7207 static Lisp_Object menu_bar_items_vector
;
7208 static int menu_bar_items_index
;
7211 static const char* separator_names
[] = {
7216 "single-dashed-line",
7217 "double-dashed-line",
7219 "shadow-etched-out",
7220 "shadow-etched-in-dash",
7221 "shadow-etched-out-dash",
7222 "shadow-double-etched-in",
7223 "shadow-double-etched-out",
7224 "shadow-double-etched-in-dash",
7225 "shadow-double-etched-out-dash",
7229 /* Return true if LABEL specifies a separator. */
7232 menu_separator_name_p (const char *label
)
7236 else if (strlen (label
) > 3
7237 && memcmp (label
, "--", 2) == 0
7242 for (i
= 0; separator_names
[i
]; ++i
)
7243 if (strcmp (label
, separator_names
[i
]) == 0)
7248 /* It's a separator if it contains only dashes. */
7249 while (*label
== '-')
7251 return (*label
== 0);
7258 /* Return a vector of menu items for a menu bar, appropriate
7259 to the current buffer. Each item has three elements in the vector:
7262 OLD is an old vector we can optionally reuse, or nil. */
7265 menu_bar_items (Lisp_Object old
)
7267 /* The number of keymaps we're scanning right now, and the number of
7268 keymaps we have allocated space for. */
7271 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7272 in the current keymaps, or nil where it is not a prefix. */
7275 Lisp_Object def
, tail
;
7280 /* In order to build the menus, we need to call the keymap
7281 accessors. They all call QUIT. But this function is called
7282 during redisplay, during which a quit is fatal. So inhibit
7283 quitting while building the menus.
7284 We do this instead of specbind because (1) errors will clear it anyway
7285 and (2) this avoids risk of specpdl overflow. */
7286 oquit
= Vinhibit_quit
;
7290 menu_bar_items_vector
= old
;
7292 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7293 menu_bar_items_index
= 0;
7295 /* Build our list of keymaps.
7296 If we recognize a function key and replace its escape sequence in
7297 keybuf with its symbol, or if the sequence starts with a mouse
7298 click and we need to switch buffers, we jump back here to rebuild
7299 the initial keymaps from the current buffer. */
7303 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7304 if (!NILP (Voverriding_local_map_menu_flag
))
7306 /* Yes, use them (if non-nil) as well as the global map. */
7307 maps
= alloca (3 * sizeof (maps
[0]));
7309 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7310 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7311 if (!NILP (Voverriding_local_map
))
7312 maps
[nmaps
++] = Voverriding_local_map
;
7316 /* No, so use major and minor mode keymaps and keymap property.
7317 Note that menu-bar bindings in the local-map and keymap
7318 properties may not work reliable, as they are only
7319 recognized when the menu-bar (or mode-line) is updated,
7320 which does not normally happen after every command. */
7323 nminor
= current_minor_maps (NULL
, &tmaps
);
7324 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7326 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7327 maps
[nmaps
++] = tem
;
7328 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7330 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7332 maps
[nmaps
++] = current_global_map
;
7335 /* Look up in each map the dummy prefix key `menu-bar'. */
7337 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7338 if (!NILP (maps
[mapno
]))
7340 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7344 menu_bar_one_keymap_changed_items
= Qnil
;
7345 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7349 /* Move to the end those items that should be at the end. */
7351 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7354 int end
= menu_bar_items_index
;
7356 for (i
= 0; i
< end
; i
+= 4)
7357 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7359 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7360 /* Move the item at index I to the end,
7361 shifting all the others forward. */
7362 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7363 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7364 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7365 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7367 memmove (aref_addr (menu_bar_items_vector
, i
),
7368 aref_addr (menu_bar_items_vector
, i
+ 4),
7369 (end
- i
- 4) * word_size
);
7370 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7371 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7372 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7373 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7378 /* Add nil, nil, nil, nil at the end. */
7380 int i
= menu_bar_items_index
;
7381 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7382 menu_bar_items_vector
=
7383 larger_vector (menu_bar_items_vector
, 4, -1);
7384 /* Add this item. */
7385 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7386 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7387 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7388 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7389 menu_bar_items_index
= i
;
7392 Vinhibit_quit
= oquit
;
7393 return menu_bar_items_vector
;
7396 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7397 If there's already an item for KEY, add this DEF to it. */
7399 Lisp_Object item_properties
;
7402 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7404 struct gcpro gcpro1
;
7409 if (EQ (item
, Qundefined
))
7411 /* If a map has an explicit `undefined' as definition,
7412 discard any previously made menu bar item. */
7414 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7415 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7417 if (menu_bar_items_index
> i
+ 4)
7418 memmove (aref_addr (menu_bar_items_vector
, i
),
7419 aref_addr (menu_bar_items_vector
, i
+ 4),
7420 (menu_bar_items_index
- i
- 4) * word_size
);
7421 menu_bar_items_index
-= 4;
7425 /* If this keymap has already contributed to this KEY,
7426 don't contribute to it a second time. */
7427 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7428 if (!NILP (tem
) || NILP (item
))
7431 menu_bar_one_keymap_changed_items
7432 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7434 /* We add to menu_bar_one_keymap_changed_items before doing the
7435 parse_menu_item, so that if it turns out it wasn't a menu item,
7436 it still correctly hides any further menu item. */
7438 parsed
= parse_menu_item (item
, 1);
7443 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7445 /* Find any existing item for this KEY. */
7446 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7447 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7450 /* If we did not find this KEY, add it at the end. */
7451 if (i
== menu_bar_items_index
)
7453 /* If vector is too small, get a bigger one. */
7454 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7455 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7456 /* Add this item. */
7457 ASET (menu_bar_items_vector
, i
, key
); i
++;
7458 ASET (menu_bar_items_vector
, i
,
7459 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7460 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7461 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7462 menu_bar_items_index
= i
;
7464 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7468 old
= AREF (menu_bar_items_vector
, i
+ 2);
7469 /* If the new and the old items are not both keymaps,
7470 the lookup will only find `item'. */
7471 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7472 ASET (menu_bar_items_vector
, i
+ 2, item
);
7476 /* This is used as the handler when calling menu_item_eval_property. */
7478 menu_item_eval_property_1 (Lisp_Object arg
)
7480 /* If we got a quit from within the menu computation,
7481 quit all the way out of it. This takes care of C-] in the debugger. */
7482 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7483 Fsignal (Qquit
, Qnil
);
7489 eval_dyn (Lisp_Object form
)
7491 return Feval (form
, Qnil
);
7494 /* Evaluate an expression and return the result (or nil if something
7495 went wrong). Used to evaluate dynamic parts of menu items. */
7497 menu_item_eval_property (Lisp_Object sexpr
)
7499 ptrdiff_t count
= SPECPDL_INDEX ();
7501 specbind (Qinhibit_redisplay
, Qt
);
7502 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7503 menu_item_eval_property_1
);
7504 return unbind_to (count
, val
);
7507 /* This function parses a menu item and leaves the result in the
7508 vector item_properties.
7509 ITEM is a key binding, a possible menu item.
7510 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7512 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7513 parse_menu_item returns true if the item is a menu item and false
7517 parse_menu_item (Lisp_Object item
, int inmenubar
)
7519 Lisp_Object def
, tem
, item_string
, start
;
7521 Lisp_Object keyhint
;
7530 /* Create item_properties vector if necessary. */
7531 if (NILP (item_properties
))
7533 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7535 /* Initialize optional entries. */
7536 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7537 ASET (item_properties
, i
, Qnil
);
7538 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7540 /* Save the item here to protect it from GC. */
7541 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7543 item_string
= XCAR (item
);
7547 if (STRINGP (item_string
))
7549 /* Old format menu item. */
7550 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7552 /* Maybe help string. */
7553 if (CONSP (item
) && STRINGP (XCAR (item
)))
7555 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7560 /* Maybe an obsolete key binding cache. */
7561 if (CONSP (item
) && CONSP (XCAR (item
))
7562 && (NILP (XCAR (XCAR (item
)))
7563 || VECTORP (XCAR (XCAR (item
)))))
7566 /* This is the real definition--the function to run. */
7567 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7569 /* Get enable property, if any. */
7572 tem
= Fget (item
, Qmenu_enable
);
7573 if (!NILP (Venable_disabled_menus_and_buttons
))
7574 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7575 else if (!NILP (tem
))
7576 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7579 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7581 /* New format menu item. */
7582 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7583 start
= XCDR (item
);
7586 /* We have a real binding. */
7587 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7589 item
= XCDR (start
);
7590 /* Is there an obsolete cache list with key equivalences. */
7591 if (CONSP (item
) && CONSP (XCAR (item
)))
7594 /* Parse properties. */
7595 while (CONSP (item
) && CONSP (XCDR (item
)))
7600 if (EQ (tem
, QCenable
))
7602 if (!NILP (Venable_disabled_menus_and_buttons
))
7603 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7605 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7607 else if (EQ (tem
, QCvisible
))
7609 /* If got a visible property and that evaluates to nil
7610 then ignore this item. */
7611 tem
= menu_item_eval_property (XCAR (item
));
7615 else if (EQ (tem
, QChelp
))
7616 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7617 else if (EQ (tem
, QCfilter
))
7619 else if (EQ (tem
, QCkey_sequence
))
7622 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7623 /* Be GC protected. Set keyhint to item instead of tem. */
7626 else if (EQ (tem
, QCkeys
))
7629 if (CONSP (tem
) || STRINGP (tem
))
7630 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7632 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7637 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7639 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7641 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7647 else if (inmenubar
|| !NILP (start
))
7651 return 0; /* not a menu item */
7653 /* If item string is not a string, evaluate it to get string.
7654 If we don't get a string, skip this item. */
7655 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7656 if (!(STRINGP (item_string
)))
7658 item_string
= menu_item_eval_property (item_string
);
7659 if (!STRINGP (item_string
))
7661 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7664 /* If got a filter apply it on definition. */
7665 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7668 def
= menu_item_eval_property (list2 (XCAR (filter
),
7669 list2 (Qquote
, def
)));
7671 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7674 /* Enable or disable selection of item. */
7675 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7678 tem
= menu_item_eval_property (tem
);
7679 if (inmenubar
&& NILP (tem
))
7680 return 0; /* Ignore disabled items in menu bar. */
7681 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7684 /* If we got no definition, this item is just unselectable text which
7685 is OK in a submenu but not in the menubar. */
7687 return (!inmenubar
);
7689 /* See if this is a separate pane or a submenu. */
7690 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7691 tem
= get_keymap (def
, 0, 1);
7692 /* For a subkeymap, just record its details and exit. */
7695 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7696 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7700 /* At the top level in the menu bar, do likewise for commands also.
7701 The menu bar does not display equivalent key bindings anyway.
7702 ITEM_PROPERTY_DEF is already set up properly. */
7706 { /* This is a command. See if there is an equivalent key binding. */
7707 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7709 /* The previous code preferred :key-sequence to :keys, so we
7710 preserve this behavior. */
7711 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7712 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7715 Lisp_Object prefix
= keyeq
;
7716 Lisp_Object keys
= Qnil
;
7720 def
= XCAR (prefix
);
7721 prefix
= XCDR (prefix
);
7724 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7726 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7728 keys
= XCAR (keyhint
);
7729 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7731 /* We have a suggested key. Is it bound to the command? */
7734 /* If the command is an alias for another
7735 (such as lmenu.el set it up), check if the
7736 original command matches the cached command. */
7738 && EQ (tem
, XSYMBOL (def
)->function
))))
7743 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7747 tem
= Fkey_description (keys
, Qnil
);
7750 if (STRINGP (XCAR (prefix
)))
7751 tem
= concat2 (XCAR (prefix
), tem
);
7752 if (STRINGP (XCDR (prefix
)))
7753 tem
= concat2 (tem
, XCDR (prefix
));
7755 keyeq
= concat2 (build_string (" "), tem
);
7756 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7762 /* If we have an equivalent key binding, use that. */
7763 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7766 /* Include this when menu help is implemented.
7767 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7768 if (!(NILP (tem) || STRINGP (tem)))
7770 tem = menu_item_eval_property (tem);
7773 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7777 /* Handle radio buttons or toggle boxes. */
7778 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7780 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7781 menu_item_eval_property (tem
));
7788 /***********************************************************************
7790 ***********************************************************************/
7792 /* A vector holding tool bar items while they are parsed in function
7793 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7796 static Lisp_Object tool_bar_items_vector
;
7798 /* A vector holding the result of parse_tool_bar_item. Layout is like
7799 the one for a single item in tool_bar_items_vector. */
7801 static Lisp_Object tool_bar_item_properties
;
7803 /* Next free index in tool_bar_items_vector. */
7805 static int ntool_bar_items
;
7807 /* The symbols `:image' and `:rtl'. */
7809 static Lisp_Object QCimage
;
7810 static Lisp_Object QCrtl
;
7812 /* Function prototypes. */
7814 static void init_tool_bar_items (Lisp_Object
);
7815 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7816 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7817 static void append_tool_bar_item (void);
7820 /* Return a vector of tool bar items for keymaps currently in effect.
7821 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7822 tool bar items found. */
7825 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7834 /* In order to build the menus, we need to call the keymap
7835 accessors. They all call QUIT. But this function is called
7836 during redisplay, during which a quit is fatal. So inhibit
7837 quitting while building the menus. We do this instead of
7838 specbind because (1) errors will clear it anyway and (2) this
7839 avoids risk of specpdl overflow. */
7840 oquit
= Vinhibit_quit
;
7843 /* Initialize tool_bar_items_vector and protect it from GC. */
7844 init_tool_bar_items (reuse
);
7846 /* Build list of keymaps in maps. Set nmaps to the number of maps
7849 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7850 if (!NILP (Voverriding_local_map_menu_flag
))
7852 /* Yes, use them (if non-nil) as well as the global map. */
7853 maps
= alloca (3 * sizeof *maps
);
7855 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7856 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7857 if (!NILP (Voverriding_local_map
))
7858 maps
[nmaps
++] = Voverriding_local_map
;
7862 /* No, so use major and minor mode keymaps and keymap property.
7863 Note that tool-bar bindings in the local-map and keymap
7864 properties may not work reliable, as they are only
7865 recognized when the tool-bar (or mode-line) is updated,
7866 which does not normally happen after every command. */
7869 nminor
= current_minor_maps (NULL
, &tmaps
);
7870 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7872 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7873 maps
[nmaps
++] = tem
;
7874 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7876 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7879 /* Add global keymap at the end. */
7880 maps
[nmaps
++] = current_global_map
;
7882 /* Process maps in reverse order and look up in each map the prefix
7884 for (i
= nmaps
- 1; i
>= 0; --i
)
7885 if (!NILP (maps
[i
]))
7889 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7891 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7894 Vinhibit_quit
= oquit
;
7895 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7896 return tool_bar_items_vector
;
7900 /* Process the definition of KEY which is DEF. */
7903 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7906 struct gcpro gcpro1
, gcpro2
;
7908 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7912 if (EQ (def
, Qundefined
))
7914 /* If a map has an explicit `undefined' as definition,
7915 discard any previously made item. */
7916 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7918 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7920 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7922 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7923 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7924 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7926 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7931 else if (parse_tool_bar_item (key
, def
))
7932 /* Append a new tool bar item to tool_bar_items_vector. Accept
7933 more than one definition for the same key. */
7934 append_tool_bar_item ();
7939 /* Access slot with index IDX of vector tool_bar_item_properties. */
7940 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7942 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7944 ASET (tool_bar_item_properties
, idx
, val
);
7948 /* Parse a tool bar item specification ITEM for key KEY and return the
7949 result in tool_bar_item_properties. Value is false if ITEM is
7952 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7954 CAPTION is the caption of the item, If it's not a string, it is
7955 evaluated to get a string.
7957 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7958 as binding are currently ignored.
7960 The following properties are recognized:
7964 FORM is evaluated and specifies whether the tool bar item is
7965 enabled or disabled.
7969 FORM is evaluated and specifies whether the tool bar item is visible.
7971 - `:filter FUNCTION'
7973 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7974 result is stored as the new binding.
7976 - `:button (TYPE SELECTED)'
7978 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7979 and specifies whether the button is selected (pressed) or not.
7983 IMAGES is either a single image specification or a vector of four
7984 image specifications. See enum tool_bar_item_images.
7986 - `:help HELP-STRING'.
7988 Gives a help string to display for the tool bar item.
7990 - `:label LABEL-STRING'.
7992 A text label to show with the tool bar button if labels are enabled. */
7995 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
7997 Lisp_Object filter
= Qnil
;
7998 Lisp_Object caption
;
8000 bool have_label
= 0;
8002 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8003 Rule out items that aren't lists, don't start with
8004 `menu-item' or whose rest following `tool-bar-item' is not a
8009 /* As an exception, allow old-style menu separators. */
8010 if (STRINGP (XCAR (item
)))
8011 item
= Fcons (XCAR (item
), Qnil
);
8012 else if (!EQ (XCAR (item
), Qmenu_item
)
8013 || (item
= XCDR (item
), !CONSP (item
)))
8016 /* Create tool_bar_item_properties vector if necessary. Reset it to
8018 if (VECTORP (tool_bar_item_properties
))
8020 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8024 tool_bar_item_properties
8025 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8028 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8029 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8031 /* Get the caption of the item. If the caption is not a string,
8032 evaluate it to get a string. If we don't get a string, skip this
8034 caption
= XCAR (item
);
8035 if (!STRINGP (caption
))
8037 caption
= menu_item_eval_property (caption
);
8038 if (!STRINGP (caption
))
8041 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8043 /* If the rest following the caption is not a list, the menu item is
8044 either a separator, or invalid. */
8048 if (menu_separator_name_p (SSDATA (caption
)))
8050 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8051 #if !defined (USE_GTK) && !defined (HAVE_NS)
8052 /* If we use build_desired_tool_bar_string to render the
8053 tool bar, the separator is rendered as an image. */
8054 PROP (TOOL_BAR_ITEM_IMAGES
)
8055 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8056 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8057 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8058 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8065 /* Store the binding. */
8066 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8069 /* Ignore cached key binding, if any. */
8070 if (CONSP (item
) && CONSP (XCAR (item
)))
8073 /* Process the rest of the properties. */
8074 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8076 Lisp_Object ikey
, value
;
8079 value
= XCAR (XCDR (item
));
8081 if (EQ (ikey
, QCenable
))
8083 /* `:enable FORM'. */
8084 if (!NILP (Venable_disabled_menus_and_buttons
))
8085 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8087 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8089 else if (EQ (ikey
, QCvisible
))
8091 /* `:visible FORM'. If got a visible property and that
8092 evaluates to nil then ignore this item. */
8093 if (NILP (menu_item_eval_property (value
)))
8096 else if (EQ (ikey
, QChelp
))
8097 /* `:help HELP-STRING'. */
8098 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8099 else if (EQ (ikey
, QCvert_only
))
8100 /* `:vert-only t/nil'. */
8101 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8102 else if (EQ (ikey
, QClabel
))
8104 const char *bad_label
= "!!?GARBLED ITEM?!!";
8105 /* `:label LABEL-STRING'. */
8106 set_prop (TOOL_BAR_ITEM_LABEL
,
8107 STRINGP (value
) ? value
: build_string (bad_label
));
8110 else if (EQ (ikey
, QCfilter
))
8111 /* ':filter FORM'. */
8113 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8115 /* `:button (TYPE . SELECTED)'. */
8116 Lisp_Object type
, selected
;
8118 type
= XCAR (value
);
8119 selected
= XCDR (value
);
8120 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8122 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8123 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8126 else if (EQ (ikey
, QCimage
)
8128 || (VECTORP (value
) && ASIZE (value
) == 4)))
8129 /* Value is either a single image specification or a vector
8130 of 4 such specifications for the different button states. */
8131 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8132 else if (EQ (ikey
, QCrtl
))
8134 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8140 /* Try to make one from caption and key. */
8141 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8142 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8143 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8144 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8146 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8147 char *buf
= xmalloc (max_lbl
+ 1);
8148 Lisp_Object new_lbl
;
8149 ptrdiff_t caption_len
= strlen (capt
);
8151 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8154 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8156 buf
[caption_len
] = '\0';
8160 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8164 strcpy (buf
, label
);
8166 for (j
= 0; buf
[j
] != '\0'; ++j
)
8174 new_lbl
= Fupcase_initials (build_string (label
));
8175 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8176 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8178 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8182 /* If got a filter apply it on binding. */
8184 set_prop (TOOL_BAR_ITEM_BINDING
,
8185 (menu_item_eval_property
8188 PROP (TOOL_BAR_ITEM_BINDING
))))));
8190 /* See if the binding is a keymap. Give up if it is. */
8191 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8194 /* Enable or disable selection of item. */
8195 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8196 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8197 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8199 /* Handle radio buttons or toggle boxes. */
8200 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8201 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8202 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8210 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8211 that can be reused. */
8214 init_tool_bar_items (Lisp_Object reuse
)
8216 if (VECTORP (reuse
))
8217 tool_bar_items_vector
= reuse
;
8219 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8220 ntool_bar_items
= 0;
8224 /* Append parsed tool bar item properties from
8225 tool_bar_item_properties */
8228 append_tool_bar_item (void)
8232 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8234 /* Enlarge tool_bar_items_vector if necessary. */
8236 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8238 /* Append entries from tool_bar_item_properties to the end of
8239 tool_bar_items_vector. */
8240 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8241 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8242 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8249 /* Read a character using menus based on the keymap MAP.
8250 Return nil if there are no menus in the maps.
8251 Return t if we displayed a menu but the user rejected it.
8253 PREV_EVENT is the previous input event, or nil if we are reading
8254 the first event of a key sequence.
8256 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8257 if we used a mouse menu to read the input, or false otherwise. If
8258 USED_MOUSE_MENU is null, don't dereference it.
8260 The prompting is done based on the prompt-string of the map
8261 and the strings associated with various map elements.
8263 This can be done with X menus or with menus put in the minibuf.
8264 These are done in different ways, depending on how the input will be read.
8265 Menus using X are done after auto-saving in read-char, getting the input
8266 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8267 and do auto-saving in the inner call of read_char. */
8270 read_char_x_menu_prompt (Lisp_Object map
,
8271 Lisp_Object prev_event
, bool *used_mouse_menu
)
8273 if (used_mouse_menu
)
8274 *used_mouse_menu
= 0;
8276 /* Use local over global Menu maps. */
8278 if (! menu_prompting
)
8282 /* If we got to this point via a mouse click,
8283 use a real menu for mouse selection. */
8284 if (EVENT_HAS_PARAMETERS (prev_event
)
8285 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8286 && !EQ (XCAR (prev_event
), Qtool_bar
))
8288 /* Display the menu and get the selection. */
8291 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8296 record_menu_key (XCAR (value
));
8298 /* If we got multiple events, unread all but
8300 There is no way to prevent those unread events
8301 from showing up later in last_nonmenu_event.
8302 So turn symbol and integer events into lists,
8303 to indicate that they came from a mouse menu,
8304 so that when present in last_nonmenu_event
8305 they won't confuse things. */
8306 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8308 record_menu_key (XCAR (tem
));
8309 if (SYMBOLP (XCAR (tem
))
8310 || INTEGERP (XCAR (tem
)))
8311 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8314 /* If we got more than one event, put all but the first
8315 onto this list to be read later.
8316 Return just the first event now. */
8317 Vunread_command_events
8318 = nconc2 (XCDR (value
), Vunread_command_events
);
8319 value
= XCAR (value
);
8321 else if (NILP (value
))
8323 if (used_mouse_menu
)
8324 *used_mouse_menu
= 1;
8327 #endif /* HAVE_MENUS */
8332 read_char_minibuf_menu_prompt (int commandflag
,
8335 register Lisp_Object name
;
8337 /* FIXME: Use the minibuffer's frame width. */
8338 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8340 bool nobindings
= 1;
8341 Lisp_Object rest
, vector
;
8342 Lisp_Object prompt_strings
= Qnil
;
8346 if (! menu_prompting
)
8349 map
= get_keymap (map
, 0, 1);
8350 name
= Fkeymap_prompt (map
);
8352 /* If we don't have any menus, just read a character normally. */
8353 if (!STRINGP (name
))
8356 #define PUSH_C_STR(str, listvar) \
8357 listvar = Fcons (make_unibyte_string (str, strlen (str)), listvar)
8359 /* Prompt string always starts with map's prompt, and a space. */
8360 prompt_strings
= Fcons (name
, prompt_strings
);
8361 PUSH_C_STR (": ", prompt_strings
);
8362 nlength
= SCHARS (name
) + 2;
8366 /* Present the documented bindings, a line at a time. */
8370 Lisp_Object menu_strings
= prompt_strings
;
8371 ptrdiff_t i
= nlength
;
8373 Lisp_Object orig_defn_macro
;
8375 /* Loop over elements of map. */
8380 /* FIXME: Use map_keymap to handle new keymap formats. */
8382 /* At end of map, wrap around if just starting,
8383 or end this line if already have something on it. */
8386 if (notfirst
|| nobindings
)
8392 /* Look at the next element of the map. */
8394 elt
= AREF (vector
, idx
);
8396 elt
= Fcar_safe (rest
);
8398 if (idx
< 0 && VECTORP (elt
))
8400 /* If we found a dense table in the keymap,
8401 advanced past it, but start scanning its contents. */
8402 rest
= Fcdr_safe (rest
);
8408 /* An ordinary element. */
8409 Lisp_Object event
, tem
;
8413 event
= Fcar_safe (elt
); /* alist */
8414 elt
= Fcdr_safe (elt
);
8418 XSETINT (event
, idx
); /* vector */
8421 /* Ignore the element if it has no prompt string. */
8422 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8424 /* True if the char to type matches the string. */
8426 Lisp_Object upcased_event
, downcased_event
;
8427 Lisp_Object desc
= Qnil
;
8429 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8431 upcased_event
= Fupcase (event
);
8432 downcased_event
= Fdowncase (event
);
8433 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8434 || XINT (downcased_event
) == SREF (s
, 0));
8436 desc
= Fsingle_key_description (event
, Qnil
);
8438 #if 0 /* It is redundant to list the equivalent key bindings because
8439 the prefix is what the user has already typed. */
8441 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8443 /* Insert equivalent keybinding. */
8444 s
= concat2 (s
, tem
);
8447 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8448 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8450 /* Insert button prefix. */
8451 Lisp_Object selected
8452 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8453 if (EQ (tem
, QCradio
))
8454 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8456 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8457 s
= concat2 (tem
, s
);
8461 /* If we have room for the prompt string, add it to this line.
8462 If this is the first on the line, always add it. */
8463 if ((SCHARS (s
) + i
+ 2
8464 + (char_matches
? 0 : SCHARS (desc
) + 3))
8468 ptrdiff_t thiswidth
;
8470 /* Punctuate between strings. */
8473 PUSH_C_STR (", ", menu_strings
);
8479 /* If the char to type doesn't match the string's
8480 first char, explicitly show what char to type. */
8483 /* Add as much of string as fits. */
8484 thiswidth
= min (SCHARS (desc
), width
- i
);
8486 = Fcons (Fsubstring (desc
, make_number (0),
8487 make_number (thiswidth
)),
8490 PUSH_C_STR (" = ", menu_strings
);
8494 /* Add as much of string as fits. */
8495 thiswidth
= min (SCHARS (s
), width
- i
);
8497 = Fcons (Fsubstring (s
, make_number (0),
8498 make_number (thiswidth
)),
8504 /* If this element does not fit, end the line now,
8505 and save the element for the next line. */
8506 PUSH_C_STR ("...", menu_strings
);
8511 /* Move past this element. */
8512 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8513 /* Handle reaching end of dense table. */
8518 rest
= Fcdr_safe (rest
);
8522 /* Prompt with that and read response. */
8523 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8525 /* Make believe it's not a keyboard macro in case the help char
8526 is pressed. Help characters are not recorded because menu prompting
8527 is not used on replay. */
8528 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8529 kset_defining_kbd_macro (current_kboard
, Qnil
);
8531 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8532 while (BUFFERP (obj
));
8533 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8535 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8538 if (! EQ (obj
, menu_prompt_more_char
)
8539 && (!INTEGERP (menu_prompt_more_char
)
8540 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8542 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8543 store_kbd_macro_char (obj
);
8546 /* Help char - go round again. */
8550 /* Reading key sequences. */
8553 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8555 return access_keymap (get_keymap (keymap
, 0, 1),
8560 active_maps (Lisp_Object first_event
)
8562 Lisp_Object position
8563 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8564 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8567 /* Structure used to keep track of partial application of key remapping
8568 such as Vfunction_key_map and Vkey_translation_map. */
8569 typedef struct keyremap
8571 /* This is the map originally specified for this use. */
8573 /* This is a submap reached by looking up, in PARENT,
8574 the events from START to END. */
8576 /* Positions [START, END) in the key sequence buffer
8577 are the key that we have scanned so far.
8578 Those events are the ones that we will replace
8579 if PARENT maps them into a key sequence. */
8583 /* Lookup KEY in MAP.
8584 MAP is a keymap mapping keys to key vectors or functions.
8585 If the mapping is a function and DO_FUNCALL is true,
8586 the function is called with PROMPT as parameter and its return
8587 value is used as the return value of this function (after checking
8588 that it is indeed a vector). */
8591 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8596 next
= access_keymap (map
, key
, 1, 0, 1);
8598 /* Handle a symbol whose function definition is a keymap
8600 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8601 && (ARRAYP (XSYMBOL (next
)->function
)
8602 || KEYMAPP (XSYMBOL (next
)->function
)))
8603 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8605 /* If the keymap gives a function, not an
8606 array, then call the function with one arg and use
8607 its value instead. */
8608 if (do_funcall
&& FUNCTIONP (next
))
8613 next
= call1 (next
, prompt
);
8614 /* If the function returned something invalid,
8615 barf--don't ignore it.
8616 (To ignore it safely, we would need to gcpro a bunch of
8617 other variables.) */
8618 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8619 error ("Function %s returns invalid key sequence",
8620 SSDATA (SYMBOL_NAME (tem
)));
8625 /* Do one step of the key remapping used for function-key-map and
8626 key-translation-map:
8627 KEYBUF is the buffer holding the input events.
8628 BUFSIZE is its maximum size.
8629 FKEY is a pointer to the keyremap structure to use.
8630 INPUT is the index of the last element in KEYBUF.
8631 DOIT if true says that the remapping can actually take place.
8632 DIFF is used to return the number of keys added/removed by the remapping.
8633 PARENT is the root of the keymap.
8634 PROMPT is the prompt to use if the remapping happens through a function.
8635 Return true if the remapping actually took place. */
8638 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8639 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8641 Lisp_Object next
, key
;
8643 key
= keybuf
[fkey
->end
++];
8645 if (KEYMAPP (fkey
->parent
))
8646 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8650 /* If keybuf[fkey->start..fkey->end] is bound in the
8651 map and we're in a position to do the key remapping, replace it with
8652 the binding and restart with fkey->start at the end. */
8653 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8655 int len
= XFASTINT (Flength (next
));
8658 *diff
= len
- (fkey
->end
- fkey
->start
);
8660 if (bufsize
- input
<= *diff
)
8661 error ("Key sequence too long");
8663 /* Shift the keys that follow fkey->end. */
8665 for (i
= fkey
->end
; i
< input
; i
++)
8666 keybuf
[i
+ *diff
] = keybuf
[i
];
8668 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8669 keybuf
[i
+ *diff
] = keybuf
[i
];
8670 /* Overwrite the old keys with the new ones. */
8671 for (i
= 0; i
< len
; i
++)
8672 keybuf
[fkey
->start
+ i
]
8673 = Faref (next
, make_number (i
));
8675 fkey
->start
= fkey
->end
+= *diff
;
8676 fkey
->map
= fkey
->parent
;
8681 fkey
->map
= get_keymap (next
, 0, 1);
8683 /* If we no longer have a bound suffix, try a new position for
8685 if (!CONSP (fkey
->map
))
8687 fkey
->end
= ++fkey
->start
;
8688 fkey
->map
= fkey
->parent
;
8694 test_undefined (Lisp_Object binding
)
8696 return (NILP (binding
)
8697 || EQ (binding
, Qundefined
)
8698 || (SYMBOLP (binding
)
8699 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8702 /* Like `read_char' but applies keyboard-coding-system to tty input. */
8704 read_decoded_char (int commandflag
, Lisp_Object map
,
8705 Lisp_Object prev_event
, bool *used_mouse_menu
)
8707 #define MAX_ENCODED_BYTES 16
8708 Lisp_Object events
[MAX_ENCODED_BYTES
];
8713 = read_char (commandflag
, map
, prev_event
, used_mouse_menu
, NULL
);
8714 struct frame
*frame
= XFRAME (selected_frame
);
8715 struct terminal
*terminal
= frame
->terminal
;
8716 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
8717 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
8718 & CODING_REQUIRE_DECODING_MASK
)))
8719 return nextevt
; /* No decoding needed. */
8722 int meta_key
= terminal
->display_info
.tty
->meta_key
;
8723 eassert (n
< MAX_ENCODED_BYTES
);
8724 events
[n
++] = nextevt
;
8725 if (NATNUMP (nextevt
)
8726 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
8727 { /* An encoded byte sequence, let's try to decode it. */
8728 struct coding_system
*coding
8729 = TERMINAL_KEYBOARD_CODING (terminal
);
8730 unsigned char *src
= alloca (n
);
8732 for (i
= 0; i
< n
; i
++)
8733 src
[i
] = XINT (events
[i
]);
8735 for (i
= 0; i
< n
; i
++)
8737 coding
->destination
= alloca (n
* 4);
8738 coding
->dst_bytes
= n
* 4;
8739 decode_coding_c_string (coding
, src
, n
, Qnil
);
8740 eassert (coding
->produced_char
<= n
);
8741 if (coding
->produced_char
== 0)
8742 { /* The encoded sequence is incomplete. */
8743 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
8744 continue; /* Read on! */
8748 const unsigned char *p
= coding
->destination
;
8749 eassert (coding
->carryover_bytes
== 0);
8751 while (n
< coding
->produced_char
)
8752 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
8755 /* Now `events' should hold decoded events.
8756 Normally, n should be equal to 1, but better not rely on it.
8757 We can only return one event here, so return the first we
8758 had and keep the others (if any) for later. */
8760 Vunread_command_events
8761 = Fcons (events
[--n
], Vunread_command_events
);
8767 /* Read a sequence of keys that ends with a non prefix character,
8768 storing it in KEYBUF, a buffer of size BUFSIZE.
8770 Return the length of the key sequence stored.
8771 Return -1 if the user rejected a command menu.
8773 Echo starting immediately unless `prompt' is 0.
8775 Where a key sequence ends depends on the currently active keymaps.
8776 These include any minor mode keymaps active in the current buffer,
8777 the current buffer's local map, and the global map.
8779 If a key sequence has no other bindings, we check Vfunction_key_map
8780 to see if some trailing subsequence might be the beginning of a
8781 function key's sequence. If so, we try to read the whole function
8782 key, and substitute its symbolic name into the key sequence.
8784 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8785 `double-' events into similar click events, if that would make them
8786 bound. We try to turn `triple-' events first into `double-' events,
8789 If we get a mouse click in a mode line, vertical divider, or other
8790 non-text area, we treat the click as if it were prefixed by the
8791 symbol denoting that area - `mode-line', `vertical-line', or
8794 If the sequence starts with a mouse click, we read the key sequence
8795 with respect to the buffer clicked on, not the current buffer.
8797 If the user switches frames in the midst of a key sequence, we put
8798 off the switch-frame event until later; the next call to
8799 read_char will return it.
8801 If FIX_CURRENT_BUFFER, we restore current_buffer
8802 from the selected window's buffer. */
8805 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8806 bool dont_downcase_last
, bool can_return_switch_frame
,
8807 bool fix_current_buffer
)
8809 ptrdiff_t count
= SPECPDL_INDEX ();
8811 /* How many keys there are in the current key sequence. */
8814 /* The length of the echo buffer when we started reading, and
8815 the length of this_command_keys when we started reading. */
8816 ptrdiff_t echo_start
IF_LINT (= 0);
8817 ptrdiff_t keys_start
;
8819 Lisp_Object current_binding
= Qnil
;
8820 Lisp_Object first_event
= Qnil
;
8822 /* Index of the first key that has no binding.
8823 It is useless to try fkey.start larger than that. */
8826 /* If t < mock_input, then KEYBUF[t] should be read as the next
8829 We use this to recover after recognizing a function key. Once we
8830 realize that a suffix of the current key sequence is actually a
8831 function key's escape sequence, we replace the suffix with the
8832 function key's binding from Vfunction_key_map. Now keybuf
8833 contains a new and different key sequence, so the echo area,
8834 this_command_keys, and the submaps and defs arrays are wrong. In
8835 this situation, we set mock_input to t, set t to 0, and jump to
8836 restart_sequence; the loop will read keys from keybuf up until
8837 mock_input, thus rebuilding the state; and then it will resume
8838 reading characters from the keyboard. */
8841 /* If the sequence is unbound in submaps[], then
8842 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8843 and fkey.map is its binding.
8845 These might be > t, indicating that all function key scanning
8846 should hold off until t reaches them. We do this when we've just
8847 recognized a function key, to avoid searching for the function
8848 key's again in Vfunction_key_map. */
8851 /* Likewise, for key_translation_map and input-decode-map. */
8852 keyremap keytran
, indec
;
8854 /* True if we are trying to map a key by changing an upper-case
8855 letter to lower case, or a shifted function key to an unshifted
8857 bool shift_translated
= 0;
8859 /* If we receive a `switch-frame' or `select-window' event in the middle of
8860 a key sequence, we put it off for later.
8861 While we're reading, we keep the event here. */
8862 Lisp_Object delayed_switch_frame
;
8864 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8865 int original_uppercase_position
= -1;
8867 /* Gets around Microsoft compiler limitations. */
8870 struct buffer
*starting_buffer
;
8872 /* List of events for which a fake prefix key has been generated. */
8873 Lisp_Object fake_prefixed_keys
= Qnil
;
8875 struct gcpro gcpro1
;
8877 GCPRO1 (fake_prefixed_keys
);
8878 raw_keybuf_count
= 0;
8880 last_nonmenu_event
= Qnil
;
8882 delayed_switch_frame
= Qnil
;
8888 /* Install the string STR as the beginning of the string of
8889 echoing, so that it serves as a prompt for the next
8891 kset_echo_string (current_kboard
, prompt
);
8892 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8895 else if (cursor_in_echo_area
8896 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8897 && NILP (Fzerop (Vecho_keystrokes
)))
8898 /* This doesn't put in a dash if the echo buffer is empty, so
8899 you don't always see a dash hanging out in the minibuffer. */
8903 /* Record the initial state of the echo area and this_command_keys;
8904 we will need to restore them if we replay a key sequence. */
8906 echo_start
= echo_length ();
8907 keys_start
= this_command_key_count
;
8908 this_single_command_key_start
= keys_start
;
8910 /* We jump here when we need to reinitialize fkey and keytran; this
8911 happens if we switch keyboards between rescans. */
8912 replay_entire_sequence
:
8914 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8915 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8916 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8917 indec
.start
= indec
.end
= 0;
8918 fkey
.start
= fkey
.end
= 0;
8919 keytran
.start
= keytran
.end
= 0;
8921 /* We jump here when the key sequence has been thoroughly changed, and
8922 we need to rescan it starting from the beginning. When we jump here,
8923 keybuf[0..mock_input] holds the sequence we should reread. */
8926 starting_buffer
= current_buffer
;
8927 first_unbound
= bufsize
+ 1;
8929 /* Build our list of keymaps.
8930 If we recognize a function key and replace its escape sequence in
8931 keybuf with its symbol, or if the sequence starts with a mouse
8932 click and we need to switch buffers, we jump back here to rebuild
8933 the initial keymaps from the current buffer. */
8934 current_binding
= active_maps (first_event
);
8936 /* Start from the beginning in keybuf. */
8939 /* These are no-ops the first time through, but if we restart, they
8940 revert the echo area and this_command_keys to their original state. */
8941 this_command_key_count
= keys_start
;
8942 if (INTERACTIVE
&& t
< mock_input
)
8943 echo_truncate (echo_start
);
8945 /* If the best binding for the current key sequence is a keymap, or
8946 we may be looking at a function key's escape sequence, keep on
8948 while (!NILP (current_binding
)
8949 /* Keep reading as long as there's a prefix binding. */
8950 ? KEYMAPP (current_binding
)
8951 /* Don't return in the middle of a possible function key sequence,
8952 if the only bindings we found were via case conversion.
8953 Thus, if ESC O a has a function-key-map translation
8954 and ESC o has a binding, don't return after ESC O,
8955 so that we can translate ESC O plus the next character. */
8956 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8959 bool used_mouse_menu
= 0;
8961 /* Where the last real key started. If we need to throw away a
8962 key that has expanded into more than one element of keybuf
8963 (say, a mouse click on the mode line which is being treated
8964 as [mode-line (mouse-...)], then we backtrack to this point
8966 int last_real_key_start
;
8968 /* These variables are analogous to echo_start and keys_start;
8969 while those allow us to restart the entire key sequence,
8970 echo_local_start and keys_local_start allow us to throw away
8972 ptrdiff_t echo_local_start
IF_LINT (= 0);
8973 int keys_local_start
;
8974 Lisp_Object new_binding
;
8976 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8977 eassert (indec
.start
<= indec
.end
);
8978 eassert (fkey
.start
<= fkey
.end
);
8979 eassert (keytran
.start
<= keytran
.end
);
8980 /* key-translation-map is applied *after* function-key-map
8981 which is itself applied *after* input-decode-map. */
8982 eassert (fkey
.end
<= indec
.start
);
8983 eassert (keytran
.end
<= fkey
.start
);
8985 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8986 first_unbound
< keytran
.start
)
8987 { /* The prefix upto first_unbound has no binding and has
8988 no translation left to do either, so we know it's unbound.
8989 If we don't stop now, we risk staying here indefinitely
8990 (if the user keeps entering fkey or keytran prefixes
8991 like C-c ESC ESC ESC ESC ...) */
8993 for (i
= first_unbound
+ 1; i
< t
; i
++)
8994 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8995 mock_input
= t
- first_unbound
- 1;
8996 indec
.end
= indec
.start
-= first_unbound
+ 1;
8997 indec
.map
= indec
.parent
;
8998 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8999 fkey
.map
= fkey
.parent
;
9000 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9001 keytran
.map
= keytran
.parent
;
9002 goto replay_sequence
;
9006 error ("Key sequence too long");
9009 echo_local_start
= echo_length ();
9010 keys_local_start
= this_command_key_count
;
9013 /* These are no-ops, unless we throw away a keystroke below and
9014 jumped back up to replay_key; in that case, these restore the
9015 variables to their original state, allowing us to replay the
9017 if (INTERACTIVE
&& t
< mock_input
)
9018 echo_truncate (echo_local_start
);
9019 this_command_key_count
= keys_local_start
;
9021 /* By default, assume each event is "real". */
9022 last_real_key_start
= t
;
9024 /* Does mock_input indicate that we are re-reading a key sequence? */
9028 add_command_key (key
);
9029 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9030 && NILP (Fzerop (Vecho_keystrokes
))
9031 && current_kboard
->immediate_echo
)
9038 /* If not, we should actually read a character. */
9042 KBOARD
*interrupted_kboard
= current_kboard
;
9043 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9044 key
= read_decoded_char (NILP (prompt
),
9045 current_binding
, last_nonmenu_event
,
9047 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9048 /* When switching to a new tty (with a new keyboard),
9049 read_char returns the new buffer, rather than -2
9050 (Bug#5095). This is because `terminal-init-xterm'
9051 calls read-char, which eats the wrong_kboard_jmpbuf
9052 return. Any better way to fix this? -- cyd */
9053 || (interrupted_kboard
!= current_kboard
))
9058 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9059 if (k
== interrupted_kboard
)
9064 /* Don't touch interrupted_kboard when it's been
9066 delayed_switch_frame
= Qnil
;
9067 goto replay_entire_sequence
;
9070 if (!NILP (delayed_switch_frame
))
9073 (interrupted_kboard
,
9074 Fcons (delayed_switch_frame
,
9075 KVAR (interrupted_kboard
, kbd_queue
)));
9076 delayed_switch_frame
= Qnil
;
9081 (interrupted_kboard
,
9082 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9084 /* If the side queue is non-empty, ensure it begins with a
9085 switch-frame, so we'll replay it in the right context. */
9086 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9087 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9088 !(EVENT_HAS_PARAMETERS (key
)
9089 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9093 XSETFRAME (frame
, interrupted_frame
);
9095 (interrupted_kboard
,
9096 Fcons (make_lispy_switch_frame (frame
),
9097 KVAR (interrupted_kboard
, kbd_queue
)));
9100 goto replay_entire_sequence
;
9104 /* read_char returns t when it shows a menu and the user rejects it.
9108 unbind_to (count
, Qnil
);
9113 /* read_char returns -1 at the end of a macro.
9114 Emacs 18 handles this by returning immediately with a
9115 zero, so that's what we'll do. */
9116 if (INTEGERP (key
) && XINT (key
) == -1)
9119 /* The Microsoft C compiler can't handle the goto that
9125 /* If the current buffer has been changed from under us, the
9126 keymap may have changed, so replay the sequence. */
9129 timer_resume_idle ();
9132 /* Reset the current buffer from the selected window
9133 in case something changed the former and not the latter.
9134 This is to be more consistent with the behavior
9135 of the command_loop_1. */
9136 if (fix_current_buffer
)
9138 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9140 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9142 Fset_buffer (XWINDOW (selected_window
)->contents
);
9145 goto replay_sequence
;
9148 /* If we have a quit that was typed in another frame, and
9149 quit_throw_to_read_char switched buffers,
9150 replay to get the right keymap. */
9152 && XINT (key
) == quit_char
9153 && current_buffer
!= starting_buffer
)
9156 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9161 goto replay_sequence
;
9166 if (EVENT_HAS_PARAMETERS (key
)
9167 /* Either a `switch-frame' or a `select-window' event. */
9168 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9170 /* If we're at the beginning of a key sequence, and the caller
9171 says it's okay, go ahead and return this event. If we're
9172 in the midst of a key sequence, delay it until the end. */
9173 if (t
> 0 || !can_return_switch_frame
)
9175 delayed_switch_frame
= key
;
9180 if (NILP (first_event
))
9183 /* Even if first_event does not specify a particular
9184 window/position, it's important to recompute the maps here
9185 since a long time might have passed since we entered
9186 read_key_sequence, and a timer (or process-filter or
9187 special-event-map, ...) might have switched the current buffer
9188 or the selected window from under us in the mean time. */
9189 if (fix_current_buffer
9190 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9192 Fset_buffer (XWINDOW (selected_window
)->contents
);
9193 current_binding
= active_maps (first_event
);
9197 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9201 /* Clicks in non-text areas get prefixed by the symbol
9202 in their CHAR-ADDRESS field. For example, a click on
9203 the mode line is prefixed by the symbol `mode-line'.
9205 Furthermore, key sequences beginning with mouse clicks
9206 are read using the keymaps of the buffer clicked on, not
9207 the current buffer. So we may have to switch the buffer
9210 When we turn one event into two events, we must make sure
9211 that neither of the two looks like the original--so that,
9212 if we replay the events, they won't be expanded again.
9213 If not for this, such reexpansion could happen either here
9214 or when user programs play with this-command-keys. */
9215 if (EVENT_HAS_PARAMETERS (key
))
9217 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9218 if (EQ (kind
, Qmouse_click
))
9220 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9221 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9224 || (!NILP (fake_prefixed_keys
)
9225 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9227 /* We're looking a second time at an event for which
9228 we generated a fake prefix key. Set
9229 last_real_key_start appropriately. */
9231 last_real_key_start
= t
- 1;
9234 if (last_real_key_start
== 0)
9236 /* Key sequences beginning with mouse clicks are
9237 read using the keymaps in the buffer clicked on,
9238 not the current buffer. If we're at the
9239 beginning of a key sequence, switch buffers. */
9240 if (WINDOWP (window
)
9241 && BUFFERP (XWINDOW (window
)->contents
)
9242 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9244 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9249 /* Arrange to go back to the original buffer once we're
9250 done reading the key sequence. Note that we can't
9251 use save_excursion_{save,restore} here, because they
9252 save point as well as the current buffer; we don't
9253 want to save point, because redisplay may change it,
9254 to accommodate a Fset_window_start or something. We
9255 don't want to do this at the top of the function,
9256 because we may get input from a subprocess which
9257 wants to change the selected window and stuff (say,
9259 record_unwind_current_buffer ();
9261 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9263 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9264 goto replay_sequence
;
9268 /* Expand mode-line and scroll-bar events into two events:
9269 use posn as a fake prefix key. */
9271 && (NILP (fake_prefixed_keys
)
9272 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9274 if (bufsize
- t
<= 1)
9275 error ("Key sequence too long");
9278 keybuf
[t
+ 1] = key
;
9281 /* Record that a fake prefix key has been generated
9282 for KEY. Don't modify the event; this would
9283 prevent proper action when the event is pushed
9284 back into unread-command-events. */
9285 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9289 else if (CONSP (XCDR (key
))
9290 && CONSP (EVENT_START (key
))
9291 && CONSP (XCDR (EVENT_START (key
))))
9295 posn
= POSN_POSN (EVENT_START (key
));
9296 /* Handle menu-bar events:
9297 insert the dummy prefix event `menu-bar'. */
9298 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9300 if (bufsize
- t
<= 1)
9301 error ("Key sequence too long");
9303 keybuf
[t
+ 1] = key
;
9305 /* Zap the position in key, so we know that we've
9306 expanded it, and don't try to do so again. */
9307 POSN_SET_POSN (EVENT_START (key
),
9308 Fcons (posn
, Qnil
));
9311 goto replay_sequence
;
9313 else if (CONSP (posn
))
9315 /* We're looking at the second event of a
9316 sequence which we expanded before. Set
9317 last_real_key_start appropriately. */
9318 if (last_real_key_start
== t
&& t
> 0)
9319 last_real_key_start
= t
- 1;
9324 /* We have finally decided that KEY is something we might want
9326 new_binding
= follow_key (current_binding
, key
);
9328 /* If KEY wasn't bound, we'll try some fallbacks. */
9329 if (!NILP (new_binding
))
9330 /* This is needed for the following scenario:
9331 event 0: a down-event that gets dropped by calling replay_key.
9332 event 1: some normal prefix like C-h.
9333 After event 0, first_unbound is 0, after event 1 indec.start,
9334 fkey.start, and keytran.start are all 1, so when we see that
9335 C-h is bound, we need to update first_unbound. */
9336 first_unbound
= max (t
+ 1, first_unbound
);
9341 /* Remember the position to put an upper bound on indec.start. */
9342 first_unbound
= min (t
, first_unbound
);
9344 head
= EVENT_HEAD (key
);
9345 if (help_char_p (head
) && t
> 0)
9347 read_key_sequence_cmd
= Vprefix_help_command
;
9349 last_nonmenu_event
= key
;
9350 /* The Microsoft C compiler can't handle the goto that
9358 Lisp_Object breakdown
;
9361 breakdown
= parse_modifiers (head
);
9362 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9363 /* Attempt to reduce an unbound mouse event to a simpler
9364 event that is bound:
9365 Drags reduce to clicks.
9366 Double-clicks reduce to clicks.
9367 Triple-clicks reduce to double-clicks, then to clicks.
9368 Down-clicks are eliminated.
9369 Double-downs reduce to downs, then are eliminated.
9370 Triple-downs reduce to double-downs, then to downs,
9371 then are eliminated. */
9372 if (modifiers
& (down_modifier
| drag_modifier
9373 | double_modifier
| triple_modifier
))
9375 while (modifiers
& (down_modifier
| drag_modifier
9376 | double_modifier
| triple_modifier
))
9378 Lisp_Object new_head
, new_click
;
9379 if (modifiers
& triple_modifier
)
9380 modifiers
^= (double_modifier
| triple_modifier
);
9381 else if (modifiers
& double_modifier
)
9382 modifiers
&= ~double_modifier
;
9383 else if (modifiers
& drag_modifier
)
9384 modifiers
&= ~drag_modifier
;
9387 /* Dispose of this `down' event by simply jumping
9388 back to replay_key, to get another event.
9390 Note that if this event came from mock input,
9391 then just jumping back to replay_key will just
9392 hand it to us again. So we have to wipe out any
9395 We could delete keybuf[t] and shift everything
9396 after that to the left by one spot, but we'd also
9397 have to fix up any variable that points into
9398 keybuf, and shifting isn't really necessary
9401 Adding prefixes for non-textual mouse clicks
9402 creates two characters of mock input, and both
9403 must be thrown away. If we're only looking at
9404 the prefix now, we can just jump back to
9405 replay_key. On the other hand, if we've already
9406 processed the prefix, and now the actual click
9407 itself is giving us trouble, then we've lost the
9408 state of the keymaps we want to backtrack to, and
9409 we need to replay the whole sequence to rebuild
9412 Beyond that, only function key expansion could
9413 create more than two keys, but that should never
9414 generate mouse events, so it's okay to zero
9415 mock_input in that case too.
9417 FIXME: The above paragraph seems just plain
9418 wrong, if you consider things like
9419 xterm-mouse-mode. -stef
9421 Isn't this just the most wonderful code ever? */
9423 /* If mock_input > t + 1, the above simplification
9424 will actually end up dropping keys on the floor.
9425 This is probably OK for now, but even
9426 if mock_input <= t + 1, we need to adjust indec,
9428 Typical case [header-line down-mouse-N]:
9429 mock_input = 2, t = 1, fkey.end = 1,
9430 last_real_key_start = 0. */
9431 if (indec
.end
> last_real_key_start
)
9433 indec
.end
= indec
.start
9434 = min (last_real_key_start
, indec
.start
);
9435 indec
.map
= indec
.parent
;
9436 if (fkey
.end
> last_real_key_start
)
9438 fkey
.end
= fkey
.start
9439 = min (last_real_key_start
, fkey
.start
);
9440 fkey
.map
= fkey
.parent
;
9441 if (keytran
.end
> last_real_key_start
)
9443 keytran
.end
= keytran
.start
9444 = min (last_real_key_start
, keytran
.start
);
9445 keytran
.map
= keytran
.parent
;
9449 if (t
== last_real_key_start
)
9456 mock_input
= last_real_key_start
;
9457 goto replay_sequence
;
9462 = apply_modifiers (modifiers
, XCAR (breakdown
));
9464 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9466 /* Look for a binding for this new key. */
9467 new_binding
= follow_key (current_binding
, new_click
);
9469 /* If that click is bound, go for it. */
9470 if (!NILP (new_binding
))
9472 current_binding
= new_binding
;
9476 /* Otherwise, we'll leave key set to the drag event. */
9481 current_binding
= new_binding
;
9484 /* Normally, last_nonmenu_event gets the previous key we read.
9485 But when a mouse popup menu is being used,
9486 we don't update last_nonmenu_event; it continues to hold the mouse
9487 event that preceded the first level of menu. */
9488 if (!used_mouse_menu
)
9489 last_nonmenu_event
= key
;
9491 /* Record what part of this_command_keys is the current key sequence. */
9492 this_single_command_key_start
= this_command_key_count
- t
;
9494 /* Look for this sequence in input-decode-map.
9495 Scan from indec.end until we find a bound suffix. */
9496 while (indec
.end
< t
)
9498 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9502 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9503 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9508 mock_input
= diff
+ max (t
, mock_input
);
9509 goto replay_sequence
;
9513 if (!KEYMAPP (current_binding
)
9514 && !test_undefined (current_binding
)
9515 && indec
.start
>= t
)
9516 /* There is a binding and it's not a prefix.
9517 (and it doesn't have any input-decode-map translation pending).
9518 There is thus no function-key in this sequence.
9519 Moving fkey.start is important in this case to allow keytran.start
9520 to go over the sequence before we return (since we keep the
9521 invariant that keytran.end <= fkey.start). */
9524 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9527 /* If the sequence is unbound, see if we can hang a function key
9528 off the end of it. */
9529 /* Continue scan from fkey.end until we find a bound suffix. */
9530 while (fkey
.end
< indec
.start
)
9532 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9536 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9537 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9538 max (t
, mock_input
),
9539 /* If there's a binding (i.e.
9540 first_binding >= nmaps) we don't want
9541 to apply this function-key-mapping. */
9543 && (test_undefined (current_binding
)),
9548 mock_input
= diff
+ max (t
, mock_input
);
9549 /* Adjust the input-decode-map counters. */
9551 indec
.start
+= diff
;
9553 goto replay_sequence
;
9557 /* Look for this sequence in key-translation-map.
9558 Scan from keytran.end until we find a bound suffix. */
9559 while (keytran
.end
< fkey
.start
)
9561 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9565 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9566 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9571 mock_input
= diff
+ max (t
, mock_input
);
9572 /* Adjust the function-key-map and input-decode-map counters. */
9574 indec
.start
+= diff
;
9578 goto replay_sequence
;
9582 /* If KEY is not defined in any of the keymaps,
9583 and cannot be part of a function key or translation,
9584 and is an upper case letter
9585 use the corresponding lower-case letter instead. */
9586 if (NILP (current_binding
)
9587 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9589 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9590 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9591 || (XINT (key
) & shift_modifier
)))
9593 Lisp_Object new_key
;
9595 original_uppercase
= key
;
9596 original_uppercase_position
= t
- 1;
9598 if (XINT (key
) & shift_modifier
)
9599 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9601 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9602 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9604 /* We have to do this unconditionally, regardless of whether
9605 the lower-case char is defined in the keymaps, because they
9606 might get translated through function-key-map. */
9607 keybuf
[t
- 1] = new_key
;
9608 mock_input
= max (t
, mock_input
);
9609 shift_translated
= 1;
9611 goto replay_sequence
;
9613 /* If KEY is not defined in any of the keymaps,
9614 and cannot be part of a function key or translation,
9615 and is a shifted function key,
9616 use the corresponding unshifted function key instead. */
9617 if (NILP (current_binding
)
9618 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9620 Lisp_Object breakdown
= parse_modifiers (key
);
9622 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9624 if (modifiers
& shift_modifier
9625 /* Treat uppercase keys as shifted. */
9627 && (KEY_TO_CHAR (key
)
9628 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9629 && uppercasep (KEY_TO_CHAR (key
))))
9632 = (modifiers
& shift_modifier
9633 ? apply_modifiers (modifiers
& ~shift_modifier
,
9635 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9637 original_uppercase
= key
;
9638 original_uppercase_position
= t
- 1;
9640 /* We have to do this unconditionally, regardless of whether
9641 the lower-case char is defined in the keymaps, because they
9642 might get translated through function-key-map. */
9643 keybuf
[t
- 1] = new_key
;
9644 mock_input
= max (t
, mock_input
);
9645 /* Reset fkey (and consequently keytran) to apply
9646 function-key-map on the result, so that S-backspace is
9647 correctly mapped to DEL (via backspace). OTOH,
9648 input-decode-map doesn't need to go through it again. */
9649 fkey
.start
= fkey
.end
= 0;
9650 keytran
.start
= keytran
.end
= 0;
9651 shift_translated
= 1;
9653 goto replay_sequence
;
9658 read_key_sequence_cmd
= current_binding
;
9659 read_key_sequence_remapped
9660 /* Remap command through active keymaps.
9661 Do the remapping here, before the unbind_to so it uses the keymaps
9662 of the appropriate buffer. */
9663 = SYMBOLP (read_key_sequence_cmd
)
9664 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9667 unread_switch_frame
= delayed_switch_frame
;
9668 unbind_to (count
, Qnil
);
9670 /* Don't downcase the last character if the caller says don't.
9671 Don't downcase it if the result is undefined, either. */
9672 if ((dont_downcase_last
|| NILP (current_binding
))
9674 && t
- 1 == original_uppercase_position
)
9676 keybuf
[t
- 1] = original_uppercase
;
9677 shift_translated
= 0;
9680 if (shift_translated
)
9681 Vthis_command_keys_shift_translated
= Qt
;
9683 /* Occasionally we fabricate events, perhaps by expanding something
9684 according to function-key-map, or by adding a prefix symbol to a
9685 mouse click in the scroll bar or modeline. In this cases, return
9686 the entire generated key sequence, even if we hit an unbound
9687 prefix or a definition before the end. This means that you will
9688 be able to push back the event properly, and also means that
9689 read-key-sequence will always return a logical unit.
9692 for (; t
< mock_input
; t
++)
9694 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9695 && NILP (Fzerop (Vecho_keystrokes
)))
9696 echo_char (keybuf
[t
]);
9697 add_command_key (keybuf
[t
]);
9704 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9705 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9706 The sequence is sufficient to specify a non-prefix command in the
9707 current local and global maps.
9709 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9710 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9711 as a continuation of the previous key.
9713 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9714 convert the last event to lower case. (Normally any upper case event
9715 is converted to lower case if the original event is undefined and the lower
9716 case equivalent is defined.) A non-nil value is appropriate for reading
9717 a key sequence to be defined.
9719 A C-g typed while in this function is treated like any other character,
9720 and `quit-flag' is not set.
9722 If the key sequence starts with a mouse click, then the sequence is read
9723 using the keymaps of the buffer of the window clicked in, not the buffer
9724 of the selected window as normal.
9726 `read-key-sequence' drops unbound button-down events, since you normally
9727 only care about the click or drag events which follow them. If a drag
9728 or multi-click event is unbound, but the corresponding click event would
9729 be bound, `read-key-sequence' turns the event into a click event at the
9730 drag's starting position. This means that you don't have to distinguish
9731 between click and drag, double, or triple events unless you want to.
9733 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9734 lines separating windows, and scroll bars with imaginary keys
9735 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9737 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9738 function will process a switch-frame event if the user switches frames
9739 before typing anything. If the user switches frames in the middle of a
9740 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9741 is nil, then the event will be put off until after the current key sequence.
9743 `read-key-sequence' checks `function-key-map' for function key
9744 sequences, where they wouldn't conflict with ordinary bindings. See
9745 `function-key-map' for more details.
9747 The optional fifth argument CMD-LOOP, if non-nil, means
9748 that this key sequence is being read by something that will
9749 read commands one after another. It should be nil if the caller
9750 will read just one key sequence. */)
9751 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9753 Lisp_Object keybuf
[30];
9755 struct gcpro gcpro1
;
9756 ptrdiff_t count
= SPECPDL_INDEX ();
9759 CHECK_STRING (prompt
);
9762 specbind (Qinput_method_exit_on_first_char
,
9763 (NILP (cmd_loop
) ? Qt
: Qnil
));
9764 specbind (Qinput_method_use_echo_area
,
9765 (NILP (cmd_loop
) ? Qt
: Qnil
));
9767 memset (keybuf
, 0, sizeof keybuf
);
9769 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9771 if (NILP (continue_echo
))
9773 this_command_key_count
= 0;
9774 this_command_key_count_reset
= 0;
9775 this_single_command_key_start
= 0;
9778 #ifdef HAVE_WINDOW_SYSTEM
9779 if (display_hourglass_p
)
9780 cancel_hourglass ();
9783 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9784 prompt
, ! NILP (dont_downcase_last
),
9785 ! NILP (can_return_switch_frame
), 0);
9787 #if 0 /* The following is fine for code reading a key sequence and
9788 then proceeding with a lengthy computation, but it's not good
9789 for code reading keys in a loop, like an input method. */
9790 #ifdef HAVE_WINDOW_SYSTEM
9791 if (display_hourglass_p
)
9802 return unbind_to (count
, make_event_array (i
, keybuf
));
9805 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9806 Sread_key_sequence_vector
, 1, 5, 0,
9807 doc
: /* Like `read-key-sequence' but always return a vector. */)
9808 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9810 Lisp_Object keybuf
[30];
9812 struct gcpro gcpro1
;
9813 ptrdiff_t count
= SPECPDL_INDEX ();
9816 CHECK_STRING (prompt
);
9819 specbind (Qinput_method_exit_on_first_char
,
9820 (NILP (cmd_loop
) ? Qt
: Qnil
));
9821 specbind (Qinput_method_use_echo_area
,
9822 (NILP (cmd_loop
) ? Qt
: Qnil
));
9824 memset (keybuf
, 0, sizeof keybuf
);
9826 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9828 if (NILP (continue_echo
))
9830 this_command_key_count
= 0;
9831 this_command_key_count_reset
= 0;
9832 this_single_command_key_start
= 0;
9835 #ifdef HAVE_WINDOW_SYSTEM
9836 if (display_hourglass_p
)
9837 cancel_hourglass ();
9840 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9841 prompt
, ! NILP (dont_downcase_last
),
9842 ! NILP (can_return_switch_frame
), 0);
9844 #ifdef HAVE_WINDOW_SYSTEM
9845 if (display_hourglass_p
)
9855 return unbind_to (count
, Fvector (i
, keybuf
));
9858 /* Return true if input events are pending. */
9861 detect_input_pending (void)
9863 return input_pending
|| get_input_pending (0);
9866 /* Return true if input events other than mouse movements are
9870 detect_input_pending_ignore_squeezables (void)
9872 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9875 /* Return true if input events are pending, and run any pending timers. */
9878 detect_input_pending_run_timers (bool do_display
)
9880 unsigned old_timers_run
= timers_run
;
9883 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9885 if (old_timers_run
!= timers_run
&& do_display
)
9887 redisplay_preserve_echo_area (8);
9888 /* The following fixes a bug when using lazy-lock with
9889 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9890 from an idle timer function. The symptom of the bug is that
9891 the cursor sometimes doesn't become visible until the next X
9892 event is processed. --gerd. */
9894 Lisp_Object tail
, frame
;
9895 FOR_EACH_FRAME (tail
, frame
)
9896 if (FRAME_RIF (XFRAME (frame
)))
9897 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9901 return input_pending
;
9904 /* This is called in some cases before a possible quit.
9905 It cases the next call to detect_input_pending to recompute input_pending.
9906 So calling this function unnecessarily can't do any harm. */
9909 clear_input_pending (void)
9914 /* Return true if there are pending requeued events.
9915 This isn't used yet. The hope is to make wait_reading_process_output
9916 call it, and return if it runs Lisp code that unreads something.
9917 The problem is, kbd_buffer_get_event needs to be fixed to know what
9918 to do in that case. It isn't trivial. */
9921 requeued_events_pending_p (void)
9923 return (!NILP (Vunread_command_events
));
9927 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9928 doc
: /* Return t if command input is currently available with no wait.
9929 Actually, the value is nil only if we can be sure that no input is available;
9930 if there is a doubt, the value is t. */)
9933 if (!NILP (Vunread_command_events
)
9934 || !NILP (Vunread_post_input_method_events
)
9935 || !NILP (Vunread_input_method_events
))
9938 /* Process non-user-visible events (Bug#10195). */
9939 process_special_events ();
9941 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9942 | READABLE_EVENTS_FILTER_EVENTS
)
9946 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9947 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9950 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9953 if (total_keys
< NUM_RECENT_KEYS
)
9954 return Fvector (total_keys
, keys
);
9957 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9958 vcopy (val
, 0, keys
+ recent_keys_index
,
9959 NUM_RECENT_KEYS
- recent_keys_index
);
9960 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9961 keys
, recent_keys_index
);
9966 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9967 doc
: /* Return the key sequence that invoked this command.
9968 However, if the command has called `read-key-sequence', it returns
9969 the last key sequence that has been read.
9970 The value is a string or a vector.
9972 See also `this-command-keys-vector'. */)
9975 return make_event_array (this_command_key_count
,
9976 XVECTOR (this_command_keys
)->contents
);
9979 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9980 doc
: /* Return the key sequence that invoked this command, as a vector.
9981 However, if the command has called `read-key-sequence', it returns
9982 the last key sequence that has been read.
9984 See also `this-command-keys'. */)
9987 return Fvector (this_command_key_count
,
9988 XVECTOR (this_command_keys
)->contents
);
9991 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9992 Sthis_single_command_keys
, 0, 0, 0,
9993 doc
: /* Return the key sequence that invoked this command.
9994 More generally, it returns the last key sequence read, either by
9995 the command loop or by `read-key-sequence'.
9996 Unlike `this-command-keys', this function's value
9997 does not include prefix arguments.
9998 The value is always a vector. */)
10001 return Fvector (this_command_key_count
10002 - this_single_command_key_start
,
10003 (XVECTOR (this_command_keys
)->contents
10004 + this_single_command_key_start
));
10007 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10008 Sthis_single_command_raw_keys
, 0, 0, 0,
10009 doc
: /* Return the raw events that were read for this command.
10010 More generally, it returns the last key sequence read, either by
10011 the command loop or by `read-key-sequence'.
10012 Unlike `this-single-command-keys', this function's value
10013 shows the events before all translations (except for input methods).
10014 The value is always a vector. */)
10017 return Fvector (raw_keybuf_count
,
10018 (XVECTOR (raw_keybuf
)->contents
));
10021 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10022 Sreset_this_command_lengths
, 0, 0, 0,
10023 doc
: /* Make the unread events replace the last command and echo.
10024 Used in `universal-argument-other-key'.
10026 `universal-argument-other-key' rereads the event just typed.
10027 It then gets translated through `function-key-map'.
10028 The translated event has to replace the real events,
10029 both in the value of (this-command-keys) and in echoing.
10030 To achieve this, `universal-argument-other-key' calls
10031 `reset-this-command-lengths', which discards the record of reading
10032 these events the first time. */)
10035 this_command_key_count
= before_command_key_count
;
10036 if (this_command_key_count
< this_single_command_key_start
)
10037 this_single_command_key_start
= this_command_key_count
;
10039 echo_truncate (before_command_echo_length
);
10041 /* Cause whatever we put into unread-command-events
10042 to echo as if it were being freshly read from the keyboard. */
10043 this_command_key_count_reset
= 1;
10048 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10049 Sclear_this_command_keys
, 0, 1, 0,
10050 doc
: /* Clear out the vector that `this-command-keys' returns.
10051 Also clear the record of the last 100 events, unless optional arg
10052 KEEP-RECORD is non-nil. */)
10053 (Lisp_Object keep_record
)
10057 this_command_key_count
= 0;
10058 this_command_key_count_reset
= 0;
10060 if (NILP (keep_record
))
10062 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10063 ASET (recent_keys
, i
, Qnil
);
10065 recent_keys_index
= 0;
10070 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10071 doc
: /* Return the current depth in recursive edits. */)
10075 /* Wrap around reliably on integer overflow. */
10076 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10077 XSETINT (temp
, sum
);
10081 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10082 "FOpen dribble file: ",
10083 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10084 If FILE is nil, close any open dribble file.
10085 The file will be closed when Emacs exits. */)
10097 file
= Fexpand_file_name (file
, Qnil
);
10098 dribble
= fopen (SSDATA (file
), "w");
10100 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10105 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10106 doc
: /* Discard the contents of the terminal input buffer.
10107 Also end any kbd macro being defined. */)
10110 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10112 /* Discard the last command from the macro. */
10113 Fcancel_kbd_macro_events ();
10117 update_mode_lines
++;
10119 Vunread_command_events
= Qnil
;
10121 discard_tty_input ();
10123 kbd_fetch_ptr
= kbd_store_ptr
;
10129 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10130 doc
: /* Stop Emacs and return to superior process. You can resume later.
10131 If `cannot-suspend' is non-nil, or if the system doesn't support job
10132 control, run a subshell instead.
10134 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10135 to be read as terminal input by Emacs's parent, after suspension.
10137 Before suspending, run the normal hook `suspend-hook'.
10138 After resumption run the normal hook `suspend-resume-hook'.
10140 Some operating systems cannot stop the Emacs process and resume it later.
10141 On such systems, Emacs starts a subshell instead of suspending. */)
10142 (Lisp_Object stuffstring
)
10144 ptrdiff_t count
= SPECPDL_INDEX ();
10145 int old_height
, old_width
;
10147 struct gcpro gcpro1
;
10150 if (tty_list
&& tty_list
->next
)
10151 error ("There are other tty frames open; close them before suspending Emacs");
10153 if (!NILP (stuffstring
))
10154 CHECK_STRING (stuffstring
);
10156 /* Run the functions in suspend-hook. */
10157 hook
= intern ("suspend-hook");
10158 Frun_hooks (1, &hook
);
10160 GCPRO1 (stuffstring
);
10161 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10162 reset_all_sys_modes ();
10163 /* sys_suspend can get an error if it tries to fork a subshell
10164 and the system resources aren't available for that. */
10165 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10167 stuff_buffered_input (stuffstring
);
10168 if (cannot_suspend
)
10172 unbind_to (count
, Qnil
);
10174 /* Check if terminal/window size has changed.
10175 Note that this is not useful when we are running directly
10176 with a window system; but suspend should be disabled in that case. */
10177 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10178 if (width
!= old_width
|| height
!= old_height
)
10179 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10181 /* Run suspend-resume-hook. */
10182 hook
= intern ("suspend-resume-hook");
10183 Frun_hooks (1, &hook
);
10189 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10190 Then in any case stuff anything Emacs has read ahead and not used. */
10193 stuff_buffered_input (Lisp_Object stuffstring
)
10195 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10196 register unsigned char *p
;
10198 if (STRINGP (stuffstring
))
10200 register ptrdiff_t count
;
10202 p
= SDATA (stuffstring
);
10203 count
= SBYTES (stuffstring
);
10204 while (count
-- > 0)
10209 /* Anything we have read ahead, put back for the shell to read. */
10210 /* ?? What should this do when we have multiple keyboards??
10211 Should we ignore anything that was typed in at the "wrong" kboard?
10213 rms: we should stuff everything back into the kboard
10215 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10218 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10219 kbd_fetch_ptr
= kbd_buffer
;
10220 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10221 stuff_char (kbd_fetch_ptr
->code
);
10223 clear_event (kbd_fetch_ptr
);
10227 #endif /* SIGTSTP */
10231 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10233 input_available_clear_time
= time_to_clear
;
10235 /* Tell handle_interrupt to throw back to read_char, */
10236 waiting_for_input
= 1;
10238 /* If handle_interrupt was called before and buffered a C-g,
10239 make it run again now, to avoid timing error. */
10240 if (!NILP (Vquit_flag
))
10241 quit_throw_to_read_char (0);
10245 clear_waiting_for_input (void)
10247 /* Tell handle_interrupt not to throw back to read_char, */
10248 waiting_for_input
= 0;
10249 input_available_clear_time
= 0;
10252 /* The SIGINT handler.
10254 If we have a frame on the controlling tty, we assume that the
10255 SIGINT was generated by C-g, so we call handle_interrupt.
10256 Otherwise, tell QUIT to kill Emacs. */
10259 handle_interrupt_signal (int sig
)
10261 /* See if we have an active terminal on our controlling tty. */
10262 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10265 /* If there are no frames there, let's pretend that we are a
10266 well-behaving UN*X program and quit. We must not call Lisp
10267 in a signal handler, so tell QUIT to exit when it is
10269 Vquit_flag
= Qkill_emacs
;
10273 /* Otherwise, the SIGINT was probably generated by C-g. */
10275 /* Set internal_last_event_frame to the top frame of the
10276 controlling tty, if we have a frame there. We disable the
10277 interrupt key on secondary ttys, so the SIGINT must have come
10278 from the controlling tty. */
10279 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10281 handle_interrupt (1);
10286 deliver_interrupt_signal (int sig
)
10288 deliver_process_signal (sig
, handle_interrupt_signal
);
10292 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10293 of the number of times C-g has been requested. If C-g is pressed
10294 enough times, then quit anyway. See bug#6585. */
10295 static int volatile force_quit_count
;
10297 /* This routine is called at interrupt level in response to C-g.
10299 It is called from the SIGINT handler or kbd_buffer_store_event.
10301 If `waiting_for_input' is non zero, then unless `echoing' is
10302 nonzero, immediately throw back to read_char.
10304 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10305 eval to throw, when it gets a chance. If quit-flag is already
10306 non-nil, it stops the job right away. */
10309 handle_interrupt (bool in_signal_handler
)
10315 /* XXX This code needs to be revised for multi-tty support. */
10316 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10318 if (! in_signal_handler
)
10320 /* If SIGINT isn't blocked, don't let us be interrupted by
10321 a SIGINT. It might be harmful due to non-reentrancy
10322 in I/O functions. */
10324 sigemptyset (&blocked
);
10325 sigaddset (&blocked
, SIGINT
);
10326 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10330 reset_all_sys_modes ();
10334 * On systems which can suspend the current process and return to the original
10335 * shell, this command causes the user to end up back at the shell.
10336 * The "Auto-save" and "Abort" questions are not asked until
10337 * the user elects to return to emacs, at which point he can save the current
10338 * job and either dump core or continue.
10342 /* Perhaps should really fork an inferior shell?
10343 But that would not provide any way to get back
10344 to the original shell, ever. */
10345 printf ("No support for stopping a process on this operating system;\n");
10346 printf ("you can continue or abort.\n");
10347 #endif /* not SIGTSTP */
10349 /* We must remain inside the screen area when the internal terminal
10350 is used. Note that [Enter] is not echoed by dos. */
10351 cursor_to (SELECTED_FRAME (), 0, 0);
10353 /* It doesn't work to autosave while GC is in progress;
10354 the code used for auto-saving doesn't cope with the mark bit. */
10355 if (!gc_in_progress
)
10357 printf ("Auto-save? (y or n) ");
10359 if (((c
= getchar ()) & ~040) == 'Y')
10361 Fdo_auto_save (Qt
, Qnil
);
10363 printf ("\r\nAuto-save done");
10364 #else /* not MSDOS */
10365 printf ("Auto-save done\n");
10366 #endif /* not MSDOS */
10368 while (c
!= '\n') c
= getchar ();
10372 /* During GC, it must be safe to reenable quitting again. */
10373 Vinhibit_quit
= Qnil
;
10376 #endif /* not MSDOS */
10377 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10378 printf ("but will instead do a real quit after garbage collection ends\r\n");
10383 printf ("\r\nAbort? (y or n) ");
10384 #else /* not MSDOS */
10385 printf ("Abort (and dump core)? (y or n) ");
10386 #endif /* not MSDOS */
10388 if (((c
= getchar ()) & ~040) == 'Y')
10390 while (c
!= '\n') c
= getchar ();
10392 printf ("\r\nContinuing...\r\n");
10393 #else /* not MSDOS */
10394 printf ("Continuing...\n");
10395 #endif /* not MSDOS */
10397 init_all_sys_modes ();
10401 /* If executing a function that wants to be interrupted out of
10402 and the user has not deferred quitting by binding `inhibit-quit'
10403 then quit right away. */
10404 if (immediate_quit
&& NILP (Vinhibit_quit
))
10406 struct gl_state_s saved
;
10407 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10409 immediate_quit
= 0;
10410 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10412 GCPRO4 (saved
.object
, saved
.global_code
,
10413 saved
.current_syntax_table
, saved
.old_prop
);
10414 Fsignal (Qquit
, Qnil
);
10419 { /* Else request quit when it's safe. */
10420 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10421 force_quit_count
= count
;
10424 immediate_quit
= 1;
10425 Vinhibit_quit
= Qnil
;
10431 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10433 /* TODO: The longjmp in this call throws the NS event loop integration off,
10434 and it seems to do fine without this. Probably some attention
10435 needs to be paid to the setting of waiting_for_input in
10436 wait_reading_process_output() under HAVE_NS because of the call
10437 to ns_select there (needed because otherwise events aren't picked up
10438 outside of polling since we don't get SIGIO like X and we don't have a
10439 separate event loop thread like W32. */
10441 if (waiting_for_input
&& !echoing
)
10442 quit_throw_to_read_char (in_signal_handler
);
10446 /* Handle a C-g by making read_char return C-g. */
10449 quit_throw_to_read_char (bool from_signal
)
10451 /* When not called from a signal handler it is safe to call
10453 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10454 Fkill_emacs (Qnil
);
10456 /* Prevent another signal from doing this before we finish. */
10457 clear_waiting_for_input ();
10460 Vunread_command_events
= Qnil
;
10462 if (FRAMEP (internal_last_event_frame
)
10463 && !EQ (internal_last_event_frame
, selected_frame
))
10464 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10467 sys_longjmp (getcjmp
, 1);
10470 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10471 Sset_input_interrupt_mode
, 1, 1, 0,
10472 doc
: /* Set interrupt mode of reading keyboard input.
10473 If INTERRUPT is non-nil, Emacs will use input interrupts;
10474 otherwise Emacs uses CBREAK mode.
10476 See also `current-input-mode'. */)
10477 (Lisp_Object interrupt
)
10479 bool new_interrupt_input
;
10480 #ifdef USABLE_SIGIO
10481 #ifdef HAVE_X_WINDOWS
10482 if (x_display_list
!= NULL
)
10484 /* When using X, don't give the user a real choice,
10485 because we haven't implemented the mechanisms to support it. */
10486 new_interrupt_input
= 1;
10489 #endif /* HAVE_X_WINDOWS */
10490 new_interrupt_input
= !NILP (interrupt
);
10491 #else /* not USABLE_SIGIO */
10492 new_interrupt_input
= 0;
10493 #endif /* not USABLE_SIGIO */
10495 if (new_interrupt_input
!= interrupt_input
)
10497 #ifdef POLL_FOR_INPUT
10501 /* this causes startup screen to be restored and messes with the mouse */
10502 reset_all_sys_modes ();
10503 interrupt_input
= new_interrupt_input
;
10504 init_all_sys_modes ();
10506 interrupt_input
= new_interrupt_input
;
10509 #ifdef POLL_FOR_INPUT
10510 poll_suppress_count
= 1;
10517 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10518 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10519 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10520 C-q in key sequences.
10522 This setting only has an effect on tty terminals and only when
10523 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10525 See also `current-input-mode'. */)
10526 (Lisp_Object flow
, Lisp_Object terminal
)
10528 struct terminal
*t
= get_terminal (terminal
, 1);
10529 struct tty_display_info
*tty
;
10530 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10532 tty
= t
->display_info
.tty
;
10534 if (tty
->flow_control
!= !NILP (flow
))
10537 /* This causes startup screen to be restored and messes with the mouse. */
10538 reset_sys_modes (tty
);
10541 tty
->flow_control
= !NILP (flow
);
10544 init_sys_modes (tty
);
10550 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10551 doc
: /* Enable or disable 8-bit input on TERMINAL.
10552 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10553 bit as the Meta modifier.
10555 If META is nil, Emacs will ignore the top bit, on the assumption it is
10558 Otherwise, Emacs will accept and pass through 8-bit input without
10559 specially interpreting the top bit.
10561 This setting only has an effect on tty terminal devices.
10563 Optional parameter TERMINAL specifies the tty terminal device to use.
10564 It may be a terminal object, a frame, or nil for the terminal used by
10565 the currently selected frame.
10567 See also `current-input-mode'. */)
10568 (Lisp_Object meta
, Lisp_Object terminal
)
10570 struct terminal
*t
= get_terminal (terminal
, 1);
10571 struct tty_display_info
*tty
;
10574 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10576 tty
= t
->display_info
.tty
;
10580 else if (EQ (meta
, Qt
))
10585 if (tty
->meta_key
!= new_meta
)
10588 /* this causes startup screen to be restored and messes with the mouse */
10589 reset_sys_modes (tty
);
10592 tty
->meta_key
= new_meta
;
10595 init_sys_modes (tty
);
10601 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10602 doc
: /* Specify character used for quitting.
10603 QUIT must be an ASCII character.
10605 This function only has an effect on the controlling tty of the Emacs
10608 See also `current-input-mode'. */)
10611 struct terminal
*t
= get_named_tty ("/dev/tty");
10612 struct tty_display_info
*tty
;
10613 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10615 tty
= t
->display_info
.tty
;
10617 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10618 error ("QUIT must be an ASCII character");
10621 /* this causes startup screen to be restored and messes with the mouse */
10622 reset_sys_modes (tty
);
10625 /* Don't let this value be out of range. */
10626 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10629 init_sys_modes (tty
);
10635 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10636 doc
: /* Set mode of reading keyboard input.
10637 First arg INTERRUPT non-nil means use input interrupts;
10638 nil means use CBREAK mode.
10639 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10640 (no effect except in CBREAK mode).
10641 Third arg META t means accept 8-bit input (for a Meta key).
10642 META nil means ignore the top bit, on the assumption it is parity.
10643 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10644 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10645 See also `current-input-mode'. */)
10646 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10648 Fset_input_interrupt_mode (interrupt
);
10649 Fset_output_flow_control (flow
, Qnil
);
10650 Fset_input_meta_mode (meta
, Qnil
);
10652 Fset_quit_char (quit
);
10656 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10657 doc
: /* Return information about the way Emacs currently reads keyboard input.
10658 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10659 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10660 nil, Emacs is using CBREAK mode.
10661 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10662 terminal; this does not apply if Emacs uses interrupt-driven input.
10663 META is t if accepting 8-bit input with 8th bit as Meta flag.
10664 META nil means ignoring the top bit, on the assumption it is parity.
10665 META is neither t nor nil if accepting 8-bit input and using
10666 all 8 bits as the character code.
10667 QUIT is the character Emacs currently uses to quit.
10668 The elements of this list correspond to the arguments of
10669 `set-input-mode'. */)
10672 Lisp_Object val
[4];
10673 struct frame
*sf
= XFRAME (selected_frame
);
10675 val
[0] = interrupt_input
? Qt
: Qnil
;
10676 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10678 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10679 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10681 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10688 XSETFASTINT (val
[3], quit_char
);
10690 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10693 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10694 doc
: /* Return position information for pixel coordinates X and Y.
10695 By default, X and Y are relative to text area of the selected window.
10696 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10697 If optional fourth arg WHOLE is non-nil, X is relative to the left
10698 edge of the window.
10700 The return value is similar to a mouse click position:
10701 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10702 IMAGE (DX . DY) (WIDTH . HEIGHT))
10703 The `posn-' functions access elements of such lists. */)
10704 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10709 if (NILP (frame_or_window
))
10710 frame_or_window
= selected_window
;
10712 if (WINDOWP (frame_or_window
))
10714 struct window
*w
= decode_live_window (frame_or_window
);
10716 XSETINT (x
, (XINT (x
)
10717 + WINDOW_LEFT_EDGE_X (w
)
10719 ? window_box_left_offset (w
, TEXT_AREA
)
10721 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10722 frame_or_window
= w
->frame
;
10725 CHECK_LIVE_FRAME (frame_or_window
);
10727 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10730 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10731 doc
: /* Return position information for buffer POS in WINDOW.
10732 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10734 Return nil if position is not visible in window. Otherwise,
10735 the return value is similar to that returned by `event-start' for
10736 a mouse click at the upper left corner of the glyph corresponding
10737 to the given buffer position:
10738 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10739 IMAGE (DX . DY) (WIDTH . HEIGHT))
10740 The `posn-' functions access elements of such lists. */)
10741 (Lisp_Object pos
, Lisp_Object window
)
10746 window
= selected_window
;
10748 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10751 Lisp_Object x
= XCAR (tem
);
10752 Lisp_Object y
= XCAR (XCDR (tem
));
10754 /* Point invisible due to hscrolling? */
10757 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10765 * Set up a new kboard object with reasonable initial values.
10768 init_kboard (KBOARD
*kb
)
10770 kset_overriding_terminal_local_map (kb
, Qnil
);
10771 kset_last_command (kb
, Qnil
);
10772 kset_real_last_command (kb
, Qnil
);
10773 kset_keyboard_translate_table (kb
, Qnil
);
10774 kset_last_repeatable_command (kb
, Qnil
);
10775 kset_prefix_arg (kb
, Qnil
);
10776 kset_last_prefix_arg (kb
, Qnil
);
10777 kset_kbd_queue (kb
, Qnil
);
10778 kb
->kbd_queue_has_data
= 0;
10779 kb
->immediate_echo
= 0;
10780 kset_echo_string (kb
, Qnil
);
10781 kb
->echo_after_prompt
= -1;
10782 kb
->kbd_macro_buffer
= 0;
10783 kb
->kbd_macro_bufsize
= 0;
10784 kset_defining_kbd_macro (kb
, Qnil
);
10785 kset_last_kbd_macro (kb
, Qnil
);
10786 kb
->reference_count
= 0;
10787 kset_system_key_alist (kb
, Qnil
);
10788 kset_system_key_syms (kb
, Qnil
);
10789 kset_window_system (kb
, Qt
); /* Unset. */
10790 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10791 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10792 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10793 kset_default_minibuffer_frame (kb
, Qnil
);
10797 * Destroy the contents of a kboard object, but not the object itself.
10798 * We use this just before deleting it, or if we're going to initialize
10799 * it a second time.
10802 wipe_kboard (KBOARD
*kb
)
10804 xfree (kb
->kbd_macro_buffer
);
10807 /* Free KB and memory referenced from it. */
10810 delete_kboard (KBOARD
*kb
)
10814 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10817 *kbp
= kb
->next_kboard
;
10819 /* Prevent a dangling reference to KB. */
10820 if (kb
== current_kboard
10821 && FRAMEP (selected_frame
)
10822 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10824 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10826 if (current_kboard
== kb
)
10835 init_keyboard (void)
10837 /* This is correct before outermost invocation of the editor loop. */
10838 command_loop_level
= -1;
10839 immediate_quit
= 0;
10840 quit_char
= Ctl ('g');
10841 Vunread_command_events
= Qnil
;
10842 timer_idleness_start_time
= invalid_emacs_time ();
10844 recent_keys_index
= 0;
10845 kbd_fetch_ptr
= kbd_buffer
;
10846 kbd_store_ptr
= kbd_buffer
;
10847 do_mouse_tracking
= Qnil
;
10849 interrupt_input_blocked
= 0;
10850 pending_signals
= 0;
10852 /* This means that command_loop_1 won't try to select anything the first
10854 internal_last_event_frame
= Qnil
;
10855 Vlast_event_frame
= internal_last_event_frame
;
10857 current_kboard
= initial_kboard
;
10858 /* Re-initialize the keyboard again. */
10859 wipe_kboard (current_kboard
);
10860 init_kboard (current_kboard
);
10861 /* A value of nil for Vwindow_system normally means a tty, but we also use
10862 it for the initial terminal since there is no window system there. */
10863 kset_window_system (current_kboard
, Qnil
);
10865 if (!noninteractive
)
10867 /* Before multi-tty support, these handlers used to be installed
10868 only if the current session was a tty session. Now an Emacs
10869 session may have multiple display types, so we always handle
10870 SIGINT. There is special code in handle_interrupt_signal to exit
10871 Emacs on SIGINT when there are no termcap frames on the
10872 controlling terminal. */
10873 struct sigaction action
;
10874 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10875 sigaction (SIGINT
, &action
, 0);
10877 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10878 SIGQUIT and we can't tell which one it will give us. */
10879 sigaction (SIGQUIT
, &action
, 0);
10880 #endif /* not DOS_NT */
10882 #ifdef USABLE_SIGIO
10883 if (!noninteractive
)
10885 struct sigaction action
;
10886 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10887 sigaction (SIGIO
, &action
, 0);
10891 /* Use interrupt input by default, if it works and noninterrupt input
10892 has deficiencies. */
10894 #ifdef INTERRUPT_INPUT
10895 interrupt_input
= 1;
10897 interrupt_input
= 0;
10900 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10903 if (keyboard_init_hook
)
10904 (*keyboard_init_hook
) ();
10906 #ifdef POLL_FOR_INPUT
10908 poll_suppress_count
= 1;
10913 /* This type's only use is in syms_of_keyboard, to initialize the
10914 event header symbols and put properties on them. */
10915 struct event_head
{
10921 static const struct event_head head_table
[] = {
10922 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10923 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10924 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10925 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10926 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10927 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10928 /* `select-window' should be handled just like `switch-frame'
10929 in read_key_sequence. */
10930 {&Qselect_window
, "select-window", &Qswitch_frame
}
10934 syms_of_keyboard (void)
10936 pending_funcalls
= Qnil
;
10937 staticpro (&pending_funcalls
);
10939 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10940 staticpro (&Vlispy_mouse_stem
);
10943 DEFSYM (QCimage
, ":image");
10944 DEFSYM (Qhelp_echo
, "help-echo");
10945 DEFSYM (QCrtl
, ":rtl");
10947 staticpro (&item_properties
);
10948 item_properties
= Qnil
;
10950 staticpro (&tool_bar_item_properties
);
10951 tool_bar_item_properties
= Qnil
;
10952 staticpro (&tool_bar_items_vector
);
10953 tool_bar_items_vector
= Qnil
;
10955 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10956 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10957 DEFSYM (Qself_insert_command
, "self-insert-command");
10958 DEFSYM (Qforward_char
, "forward-char");
10959 DEFSYM (Qbackward_char
, "backward-char");
10960 DEFSYM (Qdisabled
, "disabled");
10961 DEFSYM (Qundefined
, "undefined");
10962 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10963 DEFSYM (Qpost_command_hook
, "post-command-hook");
10964 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10965 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10966 DEFSYM (Qfunction_key
, "function-key");
10967 DEFSYM (Qmouse_click
, "mouse-click");
10968 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10969 DEFSYM (Qsave_session
, "save-session");
10970 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10971 DEFSYM (Qmenu_enable
, "menu-enable");
10974 DEFSYM (Qlanguage_change
, "language-change");
10978 DEFSYM (Qfile_w32notify
, "file-w32notify");
10982 DEFSYM (Qdbus_event
, "dbus-event");
10985 #ifdef HAVE_INOTIFY
10986 DEFSYM (Qfile_inotify
, "file-inotify");
10987 #endif /* HAVE_INOTIFY */
10989 DEFSYM (QCenable
, ":enable");
10990 DEFSYM (QCvisible
, ":visible");
10991 DEFSYM (QChelp
, ":help");
10992 DEFSYM (QCfilter
, ":filter");
10993 DEFSYM (QCbutton
, ":button");
10994 DEFSYM (QCkeys
, ":keys");
10995 DEFSYM (QCkey_sequence
, ":key-sequence");
10996 DEFSYM (QCtoggle
, ":toggle");
10997 DEFSYM (QCradio
, ":radio");
10998 DEFSYM (QClabel
, ":label");
10999 DEFSYM (QCvert_only
, ":vert-only");
11001 DEFSYM (Qmode_line
, "mode-line");
11002 DEFSYM (Qvertical_line
, "vertical-line");
11003 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11004 DEFSYM (Qmenu_bar
, "menu-bar");
11006 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11008 DEFSYM (Qabove_handle
, "above-handle");
11009 DEFSYM (Qhandle
, "handle");
11010 DEFSYM (Qbelow_handle
, "below-handle");
11011 DEFSYM (Qup
, "up");
11012 DEFSYM (Qdown
, "down");
11013 DEFSYM (Qtop
, "top");
11014 DEFSYM (Qbottom
, "bottom");
11015 DEFSYM (Qend_scroll
, "end-scroll");
11016 DEFSYM (Qratio
, "ratio");
11018 DEFSYM (Qevent_kind
, "event-kind");
11019 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11020 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11021 DEFSYM (Qmodifier_cache
, "modifier-cache");
11023 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11024 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11026 DEFSYM (Qpolling_period
, "polling-period");
11028 DEFSYM (Qx_set_selection
, "x-set-selection");
11029 DEFSYM (QPRIMARY
, "PRIMARY");
11030 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11031 DEFSYM (Qhandle_select_window
, "handle-select-window");
11033 DEFSYM (Qinput_method_function
, "input-method-function");
11034 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11035 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11037 DEFSYM (Qhelp_form_show
, "help-form-show");
11039 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11040 Fset (Qinput_method_use_echo_area
, Qnil
);
11044 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11046 for (i
= 0; i
< len
; i
++)
11048 const struct event_head
*p
= &head_table
[i
];
11049 *p
->var
= intern_c_string (p
->name
);
11050 staticpro (p
->var
);
11051 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11052 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11056 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11057 staticpro (&button_down_location
);
11058 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11059 staticpro (&mouse_syms
);
11060 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11061 / sizeof (lispy_wheel_names
[0])),
11063 staticpro (&wheel_syms
);
11067 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11069 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11070 for (i
= 0; i
< len
; i
++)
11071 if (modifier_names
[i
])
11072 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11073 staticpro (&modifier_symbols
);
11076 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11077 staticpro (&recent_keys
);
11079 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11080 staticpro (&this_command_keys
);
11082 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11083 staticpro (&raw_keybuf
);
11085 DEFSYM (Qcommand_execute
, "command-execute");
11087 accent_key_syms
= Qnil
;
11088 staticpro (&accent_key_syms
);
11090 func_key_syms
= Qnil
;
11091 staticpro (&func_key_syms
);
11093 drag_n_drop_syms
= Qnil
;
11094 staticpro (&drag_n_drop_syms
);
11096 unread_switch_frame
= Qnil
;
11097 staticpro (&unread_switch_frame
);
11099 internal_last_event_frame
= Qnil
;
11100 staticpro (&internal_last_event_frame
);
11102 read_key_sequence_cmd
= Qnil
;
11103 staticpro (&read_key_sequence_cmd
);
11104 read_key_sequence_remapped
= Qnil
;
11105 staticpro (&read_key_sequence_remapped
);
11107 menu_bar_one_keymap_changed_items
= Qnil
;
11108 staticpro (&menu_bar_one_keymap_changed_items
);
11110 menu_bar_items_vector
= Qnil
;
11111 staticpro (&menu_bar_items_vector
);
11113 help_form_saved_window_configs
= Qnil
;
11114 staticpro (&help_form_saved_window_configs
);
11116 defsubr (&Scurrent_idle_time
);
11117 defsubr (&Sevent_symbol_parse_modifiers
);
11118 defsubr (&Sevent_convert_list
);
11119 defsubr (&Sread_key_sequence
);
11120 defsubr (&Sread_key_sequence_vector
);
11121 defsubr (&Srecursive_edit
);
11122 defsubr (&Strack_mouse
);
11123 defsubr (&Sinput_pending_p
);
11124 defsubr (&Srecent_keys
);
11125 defsubr (&Sthis_command_keys
);
11126 defsubr (&Sthis_command_keys_vector
);
11127 defsubr (&Sthis_single_command_keys
);
11128 defsubr (&Sthis_single_command_raw_keys
);
11129 defsubr (&Sreset_this_command_lengths
);
11130 defsubr (&Sclear_this_command_keys
);
11131 defsubr (&Ssuspend_emacs
);
11132 defsubr (&Sabort_recursive_edit
);
11133 defsubr (&Sexit_recursive_edit
);
11134 defsubr (&Srecursion_depth
);
11135 defsubr (&Stop_level
);
11136 defsubr (&Sdiscard_input
);
11137 defsubr (&Sopen_dribble_file
);
11138 defsubr (&Sset_input_interrupt_mode
);
11139 defsubr (&Sset_output_flow_control
);
11140 defsubr (&Sset_input_meta_mode
);
11141 defsubr (&Sset_quit_char
);
11142 defsubr (&Sset_input_mode
);
11143 defsubr (&Scurrent_input_mode
);
11144 defsubr (&Sposn_at_point
);
11145 defsubr (&Sposn_at_x_y
);
11147 DEFVAR_LISP ("last-command-event", last_command_event
,
11148 doc
: /* Last input event that was part of a command. */);
11150 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11151 doc
: /* Last input event in a command, except for mouse menu events.
11152 Mouse menus give back keys that don't look like mouse events;
11153 this variable holds the actual mouse event that led to the menu,
11154 so that you can determine whether the command was run by mouse or not. */);
11156 DEFVAR_LISP ("last-input-event", last_input_event
,
11157 doc
: /* Last input event. */);
11159 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11160 doc
: /* List of events to be read as the command input.
11161 These events are processed first, before actual keyboard input.
11162 Events read from this list are not normally added to `this-command-keys',
11163 as they will already have been added once as they were read for the first time.
11164 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11165 Vunread_command_events
= Qnil
;
11167 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11168 doc
: /* List of events to be processed as input by input methods.
11169 These events are processed before `unread-command-events'
11170 and actual keyboard input, but are not given to `input-method-function'. */);
11171 Vunread_post_input_method_events
= Qnil
;
11173 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11174 doc
: /* List of events to be processed as input by input methods.
11175 These events are processed after `unread-command-events', but
11176 before actual keyboard input.
11177 If there's an active input method, the events are given to
11178 `input-method-function'. */);
11179 Vunread_input_method_events
= Qnil
;
11181 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11182 doc
: /* Meta-prefix character code.
11183 Meta-foo as command input turns into this character followed by foo. */);
11184 XSETINT (meta_prefix_char
, 033);
11186 DEFVAR_KBOARD ("last-command", Vlast_command
,
11187 doc
: /* The last command executed.
11188 Normally a symbol with a function definition, but can be whatever was found
11189 in the keymap, or whatever the variable `this-command' was set to by that
11192 The value `mode-exit' is special; it means that the previous command
11193 read an event that told it to exit, and it did so and unread that event.
11194 In other words, the present command is the event that made the previous
11197 The value `kill-region' is special; it means that the previous command
11198 was a kill command.
11200 `last-command' has a separate binding for each terminal device.
11201 See Info node `(elisp)Multiple Terminals'. */);
11203 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11204 doc
: /* Same as `last-command', but never altered by Lisp code.
11205 Taken from the previous value of `real-this-command'. */);
11207 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11208 doc
: /* Last command that may be repeated.
11209 The last command executed that was not bound to an input event.
11210 This is the command `repeat' will try to repeat.
11211 Taken from a previous value of `real-this-command'. */);
11213 DEFVAR_LISP ("this-command", Vthis_command
,
11214 doc
: /* The command now being executed.
11215 The command can set this variable; whatever is put here
11216 will be in `last-command' during the following command. */);
11217 Vthis_command
= Qnil
;
11219 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11220 doc
: /* This is like `this-command', except that commands should never modify it. */);
11221 Vreal_this_command
= Qnil
;
11223 DEFVAR_LISP ("this-command-keys-shift-translated",
11224 Vthis_command_keys_shift_translated
,
11225 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11226 Shift-translation occurs when there is no binding for the key sequence
11227 as entered, but a binding was found by changing an upper-case letter
11228 to lower-case, or a shifted function key to an unshifted one. */);
11229 Vthis_command_keys_shift_translated
= Qnil
;
11231 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11232 doc
: /* The command bound to the current key sequence before remapping.
11233 It equals `this-command' if the original command was not remapped through
11234 any of the active keymaps. Otherwise, the value of `this-command' is the
11235 result of looking up the original command in the active keymaps. */);
11236 Vthis_original_command
= Qnil
;
11238 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11239 doc
: /* Number of input events between auto-saves.
11240 Zero means disable autosaving due to number of characters typed. */);
11241 auto_save_interval
= 300;
11243 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11244 doc
: /* Number of seconds idle time before auto-save.
11245 Zero or nil means disable auto-saving due to idleness.
11246 After auto-saving due to this many seconds of idle time,
11247 Emacs also does a garbage collection if that seems to be warranted. */);
11248 XSETFASTINT (Vauto_save_timeout
, 30);
11250 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11251 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11252 The value may be integer or floating point.
11253 If the value is zero, don't echo at all. */);
11254 Vecho_keystrokes
= make_number (1);
11256 DEFVAR_INT ("polling-period", polling_period
,
11257 doc
: /* Interval between polling for input during Lisp execution.
11258 The reason for polling is to make C-g work to stop a running program.
11259 Polling is needed only when using X windows and SIGIO does not work.
11260 Polling is automatically disabled in all other cases. */);
11261 polling_period
= 2;
11263 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11264 doc
: /* Maximum time between mouse clicks to make a double-click.
11265 Measured in milliseconds. The value nil means disable double-click
11266 recognition; t means double-clicks have no time limit and are detected
11267 by position only. */);
11268 Vdouble_click_time
= make_number (500);
11270 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11271 doc
: /* Maximum mouse movement between clicks to make a double-click.
11272 On window-system frames, value is the number of pixels the mouse may have
11273 moved horizontally or vertically between two clicks to make a double-click.
11274 On non window-system frames, value is interpreted in units of 1/8 characters
11277 This variable is also the threshold for motion of the mouse
11278 to count as a drag. */);
11279 double_click_fuzz
= 3;
11281 DEFVAR_INT ("num-input-keys", num_input_keys
,
11282 doc
: /* Number of complete key sequences read as input so far.
11283 This includes key sequences read from keyboard macros.
11284 The number is effectively the number of interactive command invocations. */);
11285 num_input_keys
= 0;
11287 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11288 doc
: /* Number of input events read from the keyboard so far.
11289 This does not include events generated by keyboard macros. */);
11290 num_nonmacro_input_events
= 0;
11292 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11293 doc
: /* The frame in which the most recently read event occurred.
11294 If the last event came from a keyboard macro, this is set to `macro'. */);
11295 Vlast_event_frame
= Qnil
;
11297 /* This variable is set up in sysdep.c. */
11298 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11299 doc
: /* The ERASE character as set by the user with stty. */);
11301 DEFVAR_LISP ("help-char", Vhelp_char
,
11302 doc
: /* Character to recognize as meaning Help.
11303 When it is read, do `(eval help-form)', and display result if it's a string.
11304 If the value of `help-form' is nil, this char can be read normally. */);
11305 XSETINT (Vhelp_char
, Ctl ('H'));
11307 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11308 doc
: /* List of input events to recognize as meaning Help.
11309 These work just like the value of `help-char' (see that). */);
11310 Vhelp_event_list
= Qnil
;
11312 DEFVAR_LISP ("help-form", Vhelp_form
,
11313 doc
: /* Form to execute when character `help-char' is read.
11314 If the form returns a string, that string is displayed.
11315 If `help-form' is nil, the help char is not recognized. */);
11318 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11319 doc
: /* Command to run when `help-char' character follows a prefix key.
11320 This command is used only when there is no actual binding
11321 for that character after that prefix key. */);
11322 Vprefix_help_command
= Qnil
;
11324 DEFVAR_LISP ("top-level", Vtop_level
,
11325 doc
: /* Form to evaluate when Emacs starts up.
11326 Useful to set before you dump a modified Emacs. */);
11329 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11330 doc
: /* Translate table for local keyboard input, or nil.
11331 If non-nil, the value should be a char-table. Each character read
11332 from the keyboard is looked up in this char-table. If the value found
11333 there is non-nil, then it is used instead of the actual input character.
11335 The value can also be a string or vector, but this is considered obsolete.
11336 If it is a string or vector of length N, character codes N and up are left
11337 untranslated. In a vector, an element which is nil means "no translation".
11339 This is applied to the characters supplied to input methods, not their
11340 output. See also `translation-table-for-input'.
11342 This variable has a separate binding for each terminal.
11343 See Info node `(elisp)Multiple Terminals'. */);
11345 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11346 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11347 \(Even if the operating system has support for stopping a process.\) */);
11348 cannot_suspend
= 0;
11350 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11351 doc
: /* Non-nil means prompt with menus when appropriate.
11352 This is done when reading from a keymap that has a prompt string,
11353 for elements that have prompt strings.
11354 The menu is displayed on the screen
11355 if X menus were enabled at configuration
11356 time and the previous event was a mouse click prefix key.
11357 Otherwise, menu prompting uses the echo area. */);
11358 menu_prompting
= 1;
11360 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11361 doc
: /* Character to see next line of menu prompt.
11362 Type this character while in a menu prompt to rotate around the lines of it. */);
11363 XSETINT (menu_prompt_more_char
, ' ');
11365 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11366 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11367 Emacs applies the modifiers of the character stored here to each keyboard
11368 character it reads. For example, after evaluating the expression
11369 (setq extra-keyboard-modifiers ?\\C-x)
11370 all input characters will have the control modifier applied to them.
11372 Note that the character ?\\C-@, equivalent to the integer zero, does
11373 not count as a control character; rather, it counts as a character
11374 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11375 cancels any modification. */);
11376 extra_keyboard_modifiers
= 0;
11378 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11379 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11380 The command loop sets this to nil before each command,
11381 and tests the value when the command returns.
11382 Buffer modification stores t in this variable. */);
11383 Vdeactivate_mark
= Qnil
;
11384 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11386 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11387 doc
: /* Normal hook run before each command is executed.
11388 If an unhandled error happens in running this hook,
11389 the function in which the error occurred is unconditionally removed, since
11390 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11391 Vpre_command_hook
= Qnil
;
11393 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11394 doc
: /* Normal hook run after each command is executed.
11395 If an unhandled error happens in running this hook,
11396 the function in which the error occurred is unconditionally removed, since
11397 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11398 Vpost_command_hook
= Qnil
;
11401 DEFVAR_LISP ("echo-area-clear-hook", ...,
11402 doc
: /* Normal hook run when clearing the echo area. */);
11404 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11405 Fset (Qecho_area_clear_hook
, Qnil
);
11407 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11408 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11409 Vlucid_menu_bar_dirty_flag
= Qnil
;
11411 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11412 doc
: /* List of menu bar items to move to the end of the menu bar.
11413 The elements of the list are event types that may have menu bar bindings. */);
11414 Vmenu_bar_final_items
= Qnil
;
11416 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11417 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11418 This is used internally by graphical displays that do not render
11419 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11420 Vtool_bar_separator_image_expression
= Qnil
;
11422 DEFVAR_KBOARD ("overriding-terminal-local-map",
11423 Voverriding_terminal_local_map
,
11424 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11425 If this variable is non-nil, it is used as a keymap instead of the
11426 buffer's local map, and the minor mode keymaps and text property keymaps.
11427 It also replaces `overriding-local-map'.
11429 This variable is intended to let commands such as `universal-argument'
11430 set up a different keymap for reading the next command.
11432 `overriding-terminal-local-map' has a separate binding for each
11434 See Info node `(elisp)Multiple Terminals'. */);
11436 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11437 doc
: /* Keymap that overrides all other local keymaps.
11438 If this variable is non-nil, it is used as a keymap--replacing the
11439 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11440 Voverriding_local_map
= Qnil
;
11442 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11443 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11444 Otherwise, the menu bar continues to reflect the buffer's local map
11445 and the minor mode maps regardless of `overriding-local-map'. */);
11446 Voverriding_local_map_menu_flag
= Qnil
;
11448 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11449 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11450 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11452 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11453 doc
: /* Non-nil means generate motion events for mouse motion. */);
11455 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11456 doc
: /* Alist of system-specific X windows key symbols.
11457 Each element should have the form (N . SYMBOL) where N is the
11458 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11459 and SYMBOL is its name.
11461 `system-key-alist' has a separate binding for each terminal device.
11462 See Info node `(elisp)Multiple Terminals'. */);
11464 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11465 doc
: /* Keymap that translates key sequences to key sequences during input.
11466 This is used mainly for mapping key sequences into some preferred
11467 key events (symbols).
11469 The `read-key-sequence' function replaces any subsequence bound by
11470 `local-function-key-map' with its binding. More precisely, when the
11471 active keymaps have no binding for the current key sequence but
11472 `local-function-key-map' binds a suffix of the sequence to a vector or
11473 string, `read-key-sequence' replaces the matching suffix with its
11474 binding, and continues with the new sequence.
11476 If the binding is a function, it is called with one argument (the prompt)
11477 and its return value (a key sequence) is used.
11479 The events that come from bindings in `local-function-key-map' are not
11480 themselves looked up in `local-function-key-map'.
11482 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11483 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11484 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11485 typing `ESC O P x' would return [f1 x].
11487 `local-function-key-map' has a separate binding for each terminal
11488 device. See Info node `(elisp)Multiple Terminals'. If you need to
11489 define a binding on all terminals, change `function-key-map'
11490 instead. Initially, `local-function-key-map' is an empty keymap that
11491 has `function-key-map' as its parent on all terminal devices. */);
11493 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11494 doc
: /* Keymap that decodes input escape sequences.
11495 This is used mainly for mapping ASCII function key sequences into
11496 real Emacs function key events (symbols).
11498 The `read-key-sequence' function replaces any subsequence bound by
11499 `input-decode-map' with its binding. Contrary to `function-key-map',
11500 this map applies its rebinding regardless of the presence of an ordinary
11501 binding. So it is more like `key-translation-map' except that it applies
11502 before `function-key-map' rather than after.
11504 If the binding is a function, it is called with one argument (the prompt)
11505 and its return value (a key sequence) is used.
11507 The events that come from bindings in `input-decode-map' are not
11508 themselves looked up in `input-decode-map'. */);
11510 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11511 doc
: /* The parent keymap of all `local-function-key-map' instances.
11512 Function key definitions that apply to all terminal devices should go
11513 here. If a mapping is defined in both the current
11514 `local-function-key-map' binding and this variable, then the local
11515 definition will take precedence. */);
11516 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11518 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11519 doc
: /* Keymap of key translations that can override keymaps.
11520 This keymap works like `input-decode-map', but comes after `function-key-map'.
11521 Another difference is that it is global rather than terminal-local. */);
11522 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11524 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11525 doc
: /* List of deferred actions to be performed at a later time.
11526 The precise format isn't relevant here; we just check whether it is nil. */);
11527 Vdeferred_action_list
= Qnil
;
11529 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11530 doc
: /* Function to call to handle deferred actions, after each command.
11531 This function is called with no arguments after each command
11532 whenever `deferred-action-list' is non-nil. */);
11533 Vdeferred_action_function
= Qnil
;
11535 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11536 doc
: /* List of warnings to be displayed after this command.
11537 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11538 as per the args of `display-warning' (which see).
11539 If this variable is non-nil, `delayed-warnings-hook' will be run
11540 immediately after running `post-command-hook'. */);
11541 Vdelayed_warnings_list
= Qnil
;
11543 DEFVAR_LISP ("timer-list", Vtimer_list
,
11544 doc
: /* List of active absolute time timers in order of increasing time. */);
11545 Vtimer_list
= Qnil
;
11547 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11548 doc
: /* List of active idle-time timers in order of increasing time. */);
11549 Vtimer_idle_list
= Qnil
;
11551 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11552 doc
: /* If non-nil, the function that implements the current input method.
11553 It's called with one argument, a printing character that was just read.
11554 \(That means a character with code 040...0176.)
11555 Typically this function uses `read-event' to read additional events.
11556 When it does so, it should first bind `input-method-function' to nil
11557 so it will not be called recursively.
11559 The function should return a list of zero or more events
11560 to be used as input. If it wants to put back some events
11561 to be reconsidered, separately, by the input method,
11562 it can add them to the beginning of `unread-command-events'.
11564 The input method function can find in `input-method-previous-message'
11565 the previous echo area message.
11567 The input method function should refer to the variables
11568 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11569 for guidance on what to do. */);
11570 Vinput_method_function
= Qnil
;
11572 DEFVAR_LISP ("input-method-previous-message",
11573 Vinput_method_previous_message
,
11574 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11575 This variable exists because `read-event' clears the echo area
11576 before running the input method. It is nil if there was no message. */);
11577 Vinput_method_previous_message
= Qnil
;
11579 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11580 doc
: /* If non-nil, the function that implements the display of help.
11581 It's called with one argument, the help string to display. */);
11582 Vshow_help_function
= Qnil
;
11584 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11585 doc
: /* If non-nil, suppress point adjustment after executing a command.
11587 After a command is executed, if point is moved into a region that has
11588 special properties (e.g. composition, display), we adjust point to
11589 the boundary of the region. But, when a command sets this variable to
11590 non-nil, we suppress the point adjustment.
11592 This variable is set to nil before reading a command, and is checked
11593 just after executing the command. */);
11594 Vdisable_point_adjustment
= Qnil
;
11596 DEFVAR_LISP ("global-disable-point-adjustment",
11597 Vglobal_disable_point_adjustment
,
11598 doc
: /* If non-nil, always suppress point adjustment.
11600 The default value is nil, in which case, point adjustment are
11601 suppressed only after special commands that set
11602 `disable-point-adjustment' (which see) to non-nil. */);
11603 Vglobal_disable_point_adjustment
= Qnil
;
11605 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11606 doc
: /* How long to display an echo-area message when the minibuffer is active.
11607 If the value is not a number, such messages don't time out. */);
11608 Vminibuffer_message_timeout
= make_number (2);
11610 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11611 doc
: /* If non-nil, any keyboard input throws to this symbol.
11612 The value of that variable is passed to `quit-flag' and later causes a
11613 peculiar kind of quitting. */);
11614 Vthrow_on_input
= Qnil
;
11616 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11617 doc
: /* If non-nil, function to output error messages.
11618 The arguments are the error data, a list of the form
11619 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11620 such as just as `condition-case' would bind its variable to,
11621 the context (a string which normally goes at the start of the message),
11622 and the Lisp function within which the error was signaled. */);
11623 Vcommand_error_function
= Qnil
;
11625 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11626 Venable_disabled_menus_and_buttons
,
11627 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11629 Help functions bind this to allow help on disabled menu items
11630 and tool-bar buttons. */);
11631 Venable_disabled_menus_and_buttons
= Qnil
;
11633 DEFVAR_LISP ("select-active-regions",
11634 Vselect_active_regions
,
11635 doc
: /* If non-nil, an active region automatically sets the primary selection.
11636 If the value is `only', only temporarily active regions (usually made
11637 by mouse-dragging or shift-selection) set the window selection.
11639 This takes effect only when Transient Mark mode is enabled. */);
11640 Vselect_active_regions
= Qt
;
11642 DEFVAR_LISP ("saved-region-selection",
11643 Vsaved_region_selection
,
11644 doc
: /* Contents of active region prior to buffer modification.
11645 If `select-active-regions' is non-nil, Emacs sets this to the
11646 text in the region before modifying the buffer. The next call to
11647 the function `deactivate-mark' uses this to set the window selection. */);
11648 Vsaved_region_selection
= Qnil
;
11650 DEFVAR_LISP ("selection-inhibit-update-commands",
11651 Vselection_inhibit_update_commands
,
11652 doc
: /* List of commands which should not update the selection.
11653 Normally, if `select-active-regions' is non-nil and the mark remains
11654 active after a command (i.e. the mark was not deactivated), the Emacs
11655 command loop sets the selection to the text in the region. However,
11656 if the command is in this list, the selection is not updated. */);
11657 Vselection_inhibit_update_commands
11658 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11660 DEFVAR_LISP ("debug-on-event",
11662 doc
: /* Enter debugger on this event. When Emacs
11663 receives the special event specified by this variable, it will try to
11664 break into the debugger as soon as possible instead of processing the
11665 event normally through `special-event-map'.
11667 Currently, the only supported values for this
11668 variable are `sigusr1' and `sigusr2'. */);
11669 Vdebug_on_event
= intern_c_string ("sigusr2");
11671 /* Create the initial keyboard. */
11672 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11673 init_kboard (initial_kboard
);
11674 /* Vwindow_system is left at t for now. */
11675 initial_kboard
->next_kboard
= all_kboards
;
11676 all_kboards
= initial_kboard
;
11680 keys_of_keyboard (void)
11682 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11683 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11684 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11685 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11686 initial_define_key (meta_map
, 'x', "execute-extended-command");
11688 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11689 "handle-delete-frame");
11690 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11691 "ns-put-working-text");
11692 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11693 "ns-unput-working-text");
11694 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11695 current-prefix-arg, as is done in `handle-switch-frame'.
11696 But `handle-switch-frame is not run from the special-map.
11697 Commands from that map are run in a special way that automatically
11698 preserves the prefix-arg. Restoring the prefix arg here is not just
11699 redundant but harmful:
11701 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11702 - after the first prompt, the exit-minibuffer-hook is run which may
11703 iconify a frame and thus push a `iconify-frame' event.
11704 - after running exit-minibuffer-hook, current-prefix-arg is
11705 restored to the non-nil value it had before the prompt.
11706 - we enter the second prompt.
11707 current-prefix-arg is non-nil, prefix-arg is nil.
11708 - before running the first real event, we run the special iconify-frame
11709 event, but we pass the `special' arg to execute-command so
11710 current-prefix-arg and prefix-arg are left untouched.
11711 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11712 - the next key event will have a spuriously non-nil current-prefix-arg. */
11713 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11715 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11717 /* Handling it at such a low-level causes read_key_sequence to get
11718 * confused because it doesn't realize that the current_buffer was
11719 * changed by read_char.
11721 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11722 * "handle-select-window"); */
11723 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11724 "handle-save-session");
11727 /* Define a special event which is raised for dbus callback
11729 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11730 "dbus-handle-event");
11733 #ifdef HAVE_INOTIFY
11734 /* Define a special event which is raised for inotify callback
11736 initial_define_lispy_key (Vspecial_event_map
, "file-inotify",
11737 "inotify-handle-event");
11738 #endif /* HAVE_INOTIFY */
11740 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11742 #if defined (WINDOWSNT)
11743 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11745 initial_define_lispy_key (Vspecial_event_map
, "file-w32notify",
11746 "w32notify-handle-event");
11750 /* Mark the pointers in the kboard objects.
11751 Called by Fgarbage_collect. */
11753 mark_kboards (void)
11757 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11759 if (kb
->kbd_macro_buffer
)
11760 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11762 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11763 mark_object (KVAR (kb
, Vlast_command
));
11764 mark_object (KVAR (kb
, Vreal_last_command
));
11765 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11766 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11767 mark_object (KVAR (kb
, Vprefix_arg
));
11768 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11769 mark_object (KVAR (kb
, kbd_queue
));
11770 mark_object (KVAR (kb
, defining_kbd_macro
));
11771 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11772 mark_object (KVAR (kb
, Vsystem_key_alist
));
11773 mark_object (KVAR (kb
, system_key_syms
));
11774 mark_object (KVAR (kb
, Vwindow_system
));
11775 mark_object (KVAR (kb
, Vinput_decode_map
));
11776 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11777 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11778 mark_object (KVAR (kb
, echo_string
));
11781 struct input_event
*event
;
11782 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11784 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11785 event
= kbd_buffer
;
11786 /* These two special event types has no Lisp_Objects to mark. */
11787 if (event
->kind
!= SELECTION_REQUEST_EVENT
11788 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11790 mark_object (event
->x
);
11791 mark_object (event
->y
);
11792 mark_object (event
->frame_or_window
);
11793 mark_object (event
->arg
);