1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #define BLOCKINPUT_INLINE EXTERN_INLINE
24 #define KEYBOARD_INLINE EXTERN_INLINE
32 #include "termhooks.h"
37 #include "character.h"
40 #include "dispextern.h"
42 #include "intervals.h"
44 #include "blockinput.h"
58 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #if defined USABLE_FIONREAD && defined USG5_4
62 # include <sys/filio.h>
65 #include "syssignal.h"
67 #include <sys/types.h>
71 #ifdef HAVE_WINDOW_SYSTEM
73 #endif /* HAVE_WINDOW_SYSTEM */
75 /* Variables for blockinput.h: */
77 /* Positive if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* True means an input interrupt or alarm signal has arrived.
81 The QUIT macro checks this. */
82 volatile bool pending_signals
;
84 #define KBD_BUFFER_SIZE 4096
86 KBOARD
*initial_kboard
;
87 KBOARD
*current_kboard
;
90 /* True in the single-kboard state, false in the any-kboard state. */
91 static bool single_kboard
;
93 /* Non-nil disable property on a command means
94 do not execute it; call disabled-command-function's value instead. */
95 Lisp_Object Qdisabled
;
96 static Lisp_Object Qdisabled_command_function
;
98 #define NUM_RECENT_KEYS (300)
100 /* Index for storing next element into recent_keys. */
101 static int recent_keys_index
;
103 /* Total number of elements stored into recent_keys. */
104 static int total_keys
;
106 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
107 static Lisp_Object recent_keys
;
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 ptrdiff_t this_command_key_count
;
117 /* True after calling Freset_this_command_lengths.
118 Usually it is false. */
119 static bool this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static ptrdiff_t before_command_key_count
;
137 static ptrdiff_t before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static sys_jmp_buf getcjmp
;
143 /* True while doing kbd input. */
144 bool waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* True means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 EMACS_INT command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static ptrdiff_t last_non_minibuf_size
;
203 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
204 uintmax_t num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 /* The timestamp of the last input event we received from the X server.
225 X Windows wants this for selection ownership. */
226 Time last_event_timestamp
;
228 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
229 static Lisp_Object Qhandle_select_window
;
230 Lisp_Object QPRIMARY
;
232 static Lisp_Object Qself_insert_command
;
233 static Lisp_Object Qforward_char
;
234 static Lisp_Object Qbackward_char
;
235 Lisp_Object Qundefined
;
236 static Lisp_Object Qtimer_event_handler
;
238 /* read_key_sequence stores here the command definition of the
239 key sequence that it reads. */
240 static Lisp_Object read_key_sequence_cmd
;
241 static Lisp_Object read_key_sequence_remapped
;
243 static Lisp_Object Qinput_method_function
;
245 static Lisp_Object Qdeactivate_mark
;
247 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
249 static Lisp_Object Qecho_area_clear_hook
;
251 /* Hooks to run before and after each command. */
252 static Lisp_Object Qpre_command_hook
;
253 static Lisp_Object Qpost_command_hook
;
255 static Lisp_Object Qdeferred_action_function
;
257 static Lisp_Object Qdelayed_warnings_hook
;
259 static Lisp_Object Qinput_method_exit_on_first_char
;
260 static Lisp_Object Qinput_method_use_echo_area
;
262 static Lisp_Object Qhelp_form_show
;
264 /* File in which we write all commands we read. */
265 static FILE *dribble
;
267 /* Nonzero if input is available. */
270 /* Circular buffer for pre-read keyboard input. */
272 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
274 /* Pointer to next available character in kbd_buffer.
275 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
276 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
277 next available char is in kbd_buffer[0]. */
278 static struct input_event
*kbd_fetch_ptr
;
280 /* Pointer to next place to store character in kbd_buffer. This
281 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
282 character should go in kbd_buffer[0]. */
283 static struct input_event
* volatile kbd_store_ptr
;
285 /* The above pair of variables forms a "queue empty" flag. When we
286 enqueue a non-hook event, we increment kbd_store_ptr. When we
287 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
288 there is input available if the two pointers are not equal.
290 Why not just have a flag set and cleared by the enqueuing and
291 dequeuing functions? Such a flag could be screwed up by interrupts
292 at inopportune times. */
294 /* Symbols to head events. */
295 static Lisp_Object Qmouse_movement
;
296 static Lisp_Object Qscroll_bar_movement
;
297 Lisp_Object Qswitch_frame
;
298 static Lisp_Object Qfocus_in
, Qfocus_out
;
299 static Lisp_Object Qdelete_frame
;
300 static Lisp_Object Qiconify_frame
;
301 static Lisp_Object Qmake_frame_visible
;
302 static Lisp_Object Qselect_window
;
303 Lisp_Object Qhelp_echo
;
305 static Lisp_Object Qmouse_fixup_help_message
;
307 /* Symbols to denote kinds of events. */
308 static Lisp_Object Qfunction_key
;
309 Lisp_Object Qmouse_click
;
311 Lisp_Object Qlanguage_change
;
313 static Lisp_Object Qdrag_n_drop
;
314 static Lisp_Object Qsave_session
;
316 static Lisp_Object Qdbus_event
;
318 #ifdef USE_FILE_NOTIFY
319 static Lisp_Object Qfile_notify
;
320 #endif /* USE_FILE_NOTIFY */
321 static Lisp_Object Qconfig_changed_event
;
323 /* Lisp_Object Qmouse_movement; - also an event header */
325 /* Properties of event headers. */
326 Lisp_Object Qevent_kind
;
327 static Lisp_Object Qevent_symbol_elements
;
329 /* Menu and tool bar item parts. */
330 static Lisp_Object Qmenu_enable
;
331 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
332 Lisp_Object QCfilter
;
334 /* Non-nil disable property on a command means
335 do not execute it; call disabled-command-function's value instead. */
336 Lisp_Object QCtoggle
, QCradio
;
337 static Lisp_Object QCbutton
, QClabel
;
339 static Lisp_Object QCvert_only
;
341 /* An event header symbol HEAD may have a property named
342 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
343 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
344 mask of modifiers applied to it. If present, this is used to help
345 speed up parse_modifiers. */
346 Lisp_Object Qevent_symbol_element_mask
;
348 /* An unmodified event header BASE may have a property named
349 Qmodifier_cache, which is an alist mapping modifier masks onto
350 modified versions of BASE. If present, this helps speed up
352 static Lisp_Object Qmodifier_cache
;
354 /* Symbols to use for parts of windows. */
355 Lisp_Object Qmode_line
;
356 Lisp_Object Qvertical_line
;
357 static Lisp_Object Qvertical_scroll_bar
;
358 Lisp_Object Qmenu_bar
;
360 static void recursive_edit_unwind (Lisp_Object buffer
);
361 static Lisp_Object
command_loop (void);
362 static Lisp_Object Qcommand_execute
;
363 struct timespec
timer_check (void);
365 static void echo_now (void);
366 static ptrdiff_t echo_length (void);
368 static Lisp_Object Qpolling_period
;
370 /* Incremented whenever a timer is run. */
373 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
375 struct timespec
*input_available_clear_time
;
377 /* True means use SIGIO interrupts; false means use CBREAK mode.
378 Default is true if INTERRUPT_INPUT is defined. */
379 bool interrupt_input
;
381 /* Nonzero while interrupts are temporarily deferred during redisplay. */
382 bool interrupts_deferred
;
384 /* If we support a window system, turn on the code to poll periodically
385 to detect C-g. It isn't actually used when doing interrupt input. */
386 #ifdef HAVE_WINDOW_SYSTEM
387 #define POLL_FOR_INPUT
390 /* The time when Emacs started being idle. */
392 static struct timespec timer_idleness_start_time
;
394 /* After Emacs stops being idle, this saves the last value
395 of timer_idleness_start_time from when it was idle. */
397 static struct timespec timer_last_idleness_start_time
;
400 /* Global variable declarations. */
402 /* Flags for readable_events. */
403 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
404 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
405 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
407 /* Function for init_keyboard to call with no args (if nonzero). */
408 static void (*keyboard_init_hook
) (void);
410 static bool get_input_pending (int);
411 static bool readable_events (int);
412 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
413 Lisp_Object
, bool *);
414 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
415 static Lisp_Object
make_lispy_event (struct input_event
*);
416 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
417 enum scroll_bar_part
,
418 Lisp_Object
, Lisp_Object
,
420 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
421 Lisp_Object
, const char *const *,
422 Lisp_Object
*, ptrdiff_t);
423 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
424 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
425 static Lisp_Object
make_lispy_focus_out (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 void restore_kboard_configuration (int);
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;
858 #if 0 /* These two functions are now replaced with
859 temporarily_switch_to_single_kboard. */
863 #if 0 /* Theory: if there's anything in Vunread_command_events,
864 it will right away be read by read_key_sequence,
865 and then if we do switch KBOARDS, it will go into the side
866 queue then. So we don't need to do anything special here -- rms. */
867 if (CONSP (Vunread_command_events
))
869 current_kboard
->kbd_queue
870 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
871 current_kboard
->kbd_queue_has_data
= 1;
873 Vunread_command_events
= Qnil
;
878 /* Switch to the single-kboard state, making current_kboard
879 the only KBOARD from which further input is accepted. */
882 single_kboard_state ()
888 /* If we're in single_kboard state for kboard KBOARD,
892 not_single_kboard_state (KBOARD
*kboard
)
894 if (kboard
== current_kboard
)
898 /* Maintain a stack of kboards, so other parts of Emacs
899 can switch temporarily to the kboard of a given frame
900 and then revert to the previous status. */
905 struct kboard_stack
*next
;
908 static struct kboard_stack
*kboard_stack
;
911 push_kboard (struct kboard
*k
)
913 struct kboard_stack
*p
= xmalloc (sizeof *p
);
915 p
->next
= kboard_stack
;
916 p
->kboard
= current_kboard
;
926 struct kboard_stack
*p
= kboard_stack
;
928 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
930 if (t
->kboard
== p
->kboard
)
932 current_kboard
= p
->kboard
;
939 /* The terminal we remembered has been deleted. */
940 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
943 kboard_stack
= p
->next
;
947 /* Switch to single_kboard mode, making current_kboard the only KBOARD
948 from which further input is accepted. If F is non-nil, set its
949 KBOARD as the current keyboard.
951 This function uses record_unwind_protect_int to return to the previous
954 If Emacs is already in single_kboard mode, and F's keyboard is
955 locked, then this function will throw an error. */
958 temporarily_switch_to_single_kboard (struct frame
*f
)
960 bool was_locked
= single_kboard
;
963 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
964 /* We can not switch keyboards while in single_kboard mode.
965 In rare cases, Lisp code may call `recursive-edit' (or
966 `read-minibuffer' or `y-or-n-p') after it switched to a
967 locked frame. For example, this is likely to happen
968 when server.el connects to a new terminal while Emacs is in
969 single_kboard mode. It is best to throw an error instead
970 of presenting the user with a frozen screen. */
971 error ("Terminal %d is locked, cannot read from it",
972 FRAME_TERMINAL (f
)->id
);
974 /* This call is unnecessary, but helps
975 `restore_kboard_configuration' discover if somebody changed
976 `current_kboard' behind our back. */
977 push_kboard (current_kboard
);
980 current_kboard
= FRAME_KBOARD (f
);
982 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
985 #if 0 /* This function is not needed anymore. */
987 record_single_kboard_state ()
990 push_kboard (current_kboard
);
991 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
996 restore_kboard_configuration (int was_locked
)
998 single_kboard
= was_locked
;
1001 struct kboard
*prev
= current_kboard
;
1003 /* The pop should not change the kboard. */
1004 if (single_kboard
&& current_kboard
!= prev
)
1010 /* Handle errors that are not handled at inner levels
1011 by printing an error message and returning to the editor command loop. */
1014 cmd_error (Lisp_Object data
)
1016 Lisp_Object old_level
, old_length
;
1017 char macroerror
[sizeof "After..kbd macro iterations: "
1018 + INT_STRLEN_BOUND (EMACS_INT
)];
1020 #ifdef HAVE_WINDOW_SYSTEM
1021 if (display_hourglass_p
)
1022 cancel_hourglass ();
1025 if (!NILP (executing_kbd_macro
))
1027 if (executing_kbd_macro_iterations
== 1)
1028 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1030 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1031 executing_kbd_macro_iterations
);
1036 Vstandard_output
= Qt
;
1037 Vstandard_input
= Qt
;
1038 Vexecuting_kbd_macro
= Qnil
;
1039 executing_kbd_macro
= Qnil
;
1040 kset_prefix_arg (current_kboard
, Qnil
);
1041 kset_last_prefix_arg (current_kboard
, Qnil
);
1044 /* Avoid unquittable loop if data contains a circular list. */
1045 old_level
= Vprint_level
;
1046 old_length
= Vprint_length
;
1047 XSETFASTINT (Vprint_level
, 10);
1048 XSETFASTINT (Vprint_length
, 10);
1049 cmd_error_internal (data
, macroerror
);
1050 Vprint_level
= old_level
;
1051 Vprint_length
= old_length
;
1054 Vinhibit_quit
= Qnil
;
1056 return make_number (0);
1059 /* Take actions on handling an error. DATA is the data that describes
1062 CONTEXT is a C-string containing ASCII characters only which
1063 describes the context in which the error happened. If we need to
1064 generalize CONTEXT to allow multibyte characters, make it a Lisp
1068 cmd_error_internal (Lisp_Object data
, const char *context
)
1070 struct frame
*sf
= SELECTED_FRAME ();
1072 /* The immediate context is not interesting for Quits,
1073 since they are asynchronous. */
1074 if (EQ (XCAR (data
), Qquit
))
1075 Vsignaling_function
= Qnil
;
1080 /* Use user's specified output function if any. */
1081 if (!NILP (Vcommand_error_function
))
1082 call3 (Vcommand_error_function
, data
,
1083 context
? build_string (context
) : empty_unibyte_string
,
1084 Vsignaling_function
);
1085 /* If the window system or terminal frame hasn't been initialized
1086 yet, or we're not interactive, write the message to stderr and exit. */
1087 else if (!sf
->glyphs_initialized_p
1088 /* The initial frame is a special non-displaying frame. It
1089 will be current in daemon mode when there are no frames
1090 to display, and in non-daemon mode before the real frame
1091 has finished initializing. If an error is thrown in the
1092 latter case while creating the frame, then the frame
1093 will never be displayed, so the safest thing to do is
1094 write to stderr and quit. In daemon mode, there are
1095 many other potential errors that do not prevent frames
1096 from being created, so continuing as normal is better in
1098 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1101 print_error_message (data
, Qexternal_debugging_output
,
1102 context
, Vsignaling_function
);
1103 Fterpri (Qexternal_debugging_output
);
1104 Fkill_emacs (make_number (-1));
1108 clear_message (1, 0);
1110 message_log_maybe_newline ();
1113 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1116 Vsignaling_function
= Qnil
;
1119 static Lisp_Object
command_loop_2 (Lisp_Object
);
1120 static Lisp_Object
top_level_1 (Lisp_Object
);
1122 /* Entry to editor-command-loop.
1123 This level has the catches for exiting/returning to editor command loop.
1124 It returns nil to exit recursive edit, t to abort it. */
1129 if (command_loop_level
> 0 || minibuf_level
> 0)
1132 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1133 executing_kbd_macro
= Qnil
;
1139 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1140 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1141 executing_kbd_macro
= Qnil
;
1143 /* End of file in -batch run causes exit here. */
1149 /* Here we catch errors in execution of commands within the
1150 editing loop, and reenter the editing loop.
1151 When there is an error, cmd_error runs and returns a non-nil
1152 value to us. A value of nil means that command_loop_1 itself
1153 returned due to end of file (or end of kbd macro). */
1156 command_loop_2 (Lisp_Object ignore
)
1158 register Lisp_Object val
;
1161 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1162 while (!NILP (val
));
1170 return Feval (Vtop_level
, Qnil
);
1174 top_level_1 (Lisp_Object ignore
)
1176 /* On entry to the outer level, run the startup file. */
1177 if (!NILP (Vtop_level
))
1178 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1179 else if (!NILP (Vpurify_flag
))
1180 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1182 message1 ("Bare Emacs (standard Lisp code not loaded)");
1186 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1187 doc
: /* Exit all recursive editing levels.
1188 This also exits all active minibuffers. */)
1191 #ifdef HAVE_WINDOW_SYSTEM
1192 if (display_hourglass_p
)
1193 cancel_hourglass ();
1196 /* Unblock input if we enter with input blocked. This may happen if
1197 redisplay traps e.g. during tool-bar update with input blocked. */
1198 totally_unblock_input ();
1200 Fthrow (Qtop_level
, Qnil
);
1203 static _Noreturn
void
1204 user_error (const char *msg
)
1206 xsignal1 (Quser_error
, build_string (msg
));
1210 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1211 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1214 if (command_loop_level
> 0 || minibuf_level
> 0)
1215 Fthrow (Qexit
, Qnil
);
1217 user_error ("No recursive edit is in progress");
1221 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1222 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1225 if (command_loop_level
> 0 || minibuf_level
> 0)
1228 user_error ("No recursive edit is in progress");
1231 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1232 of this function. */
1235 tracking_off (Lisp_Object old_value
)
1237 do_mouse_tracking
= old_value
;
1238 if (NILP (old_value
))
1240 /* Redisplay may have been preempted because there was input
1241 available, and it assumes it will be called again after the
1242 input has been processed. If the only input available was
1243 the sort that we have just disabled, then we need to call
1245 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1247 redisplay_preserve_echo_area (6);
1248 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1253 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1254 doc
: /* Evaluate BODY with mouse movement events enabled.
1255 Within a `track-mouse' form, mouse motion generates input events that
1256 you can read with `read-event'.
1257 Normally, mouse motion is ignored.
1258 usage: (track-mouse BODY...) */)
1261 ptrdiff_t count
= SPECPDL_INDEX ();
1264 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1266 do_mouse_tracking
= Qt
;
1268 val
= Fprogn (args
);
1269 return unbind_to (count
, val
);
1272 /* If mouse has moved on some frame, return one of those frames.
1276 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1277 after resizing the tool-bar window. */
1279 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1282 bool ignore_mouse_drag_p
;
1284 static struct frame
*
1285 some_mouse_moved (void)
1287 Lisp_Object tail
, frame
;
1289 if (ignore_mouse_drag_p
)
1291 /* ignore_mouse_drag_p = 0; */
1295 FOR_EACH_FRAME (tail
, frame
)
1297 if (XFRAME (frame
)->mouse_moved
)
1298 return XFRAME (frame
);
1305 /* This is the actual command reading loop,
1306 sans error-handling encapsulation. */
1308 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1310 void safe_run_hooks (Lisp_Object
);
1311 static void adjust_point_for_property (ptrdiff_t, bool);
1313 /* The last boundary auto-added to buffer-undo-list. */
1314 Lisp_Object last_undo_boundary
;
1316 /* FIXME: This is wrong rather than test window-system, we should call
1317 a new set-selection, which will then dispatch to x-set-selection, or
1318 tty-set-selection, or w32-set-selection, ... */
1321 command_loop_1 (void)
1324 Lisp_Object keybuf
[30];
1326 EMACS_INT prev_modiff
= 0;
1327 struct buffer
*prev_buffer
= NULL
;
1328 bool already_adjusted
= 0;
1330 kset_prefix_arg (current_kboard
, Qnil
);
1331 kset_last_prefix_arg (current_kboard
, Qnil
);
1332 Vdeactivate_mark
= Qnil
;
1333 waiting_for_input
= 0;
1336 this_command_key_count
= 0;
1337 this_command_key_count_reset
= 0;
1338 this_single_command_key_start
= 0;
1340 if (NILP (Vmemory_full
))
1342 /* Make sure this hook runs after commands that get errors and
1343 throw to top level. */
1344 /* Note that the value cell will never directly contain nil
1345 if the symbol is a local variable. */
1346 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1347 safe_run_hooks (Qpost_command_hook
);
1349 /* If displaying a message, resize the echo area window to fit
1350 that message's size exactly. */
1351 if (!NILP (echo_area_buffer
[0]))
1352 resize_echo_area_exactly ();
1354 /* If there are warnings waiting, process them. */
1355 if (!NILP (Vdelayed_warnings_list
))
1356 safe_run_hooks (Qdelayed_warnings_hook
);
1358 if (!NILP (Vdeferred_action_list
))
1359 safe_run_hooks (Qdeferred_action_function
);
1362 /* Do this after running Vpost_command_hook, for consistency. */
1363 kset_last_command (current_kboard
, Vthis_command
);
1364 kset_real_last_command (current_kboard
, Vreal_this_command
);
1365 if (!CONSP (last_command_event
))
1366 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1370 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1373 /* Make sure the current window's buffer is selected. */
1374 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1376 /* Display any malloc warning that just came out. Use while because
1377 displaying one warning can cause another. */
1379 while (pending_malloc_warning
)
1380 display_malloc_warning ();
1382 Vdeactivate_mark
= Qnil
;
1384 /* Don't ignore mouse movements for more than a single command
1385 loop. (This flag is set in xdisp.c whenever the tool bar is
1386 resized, because the resize moves text up or down, and would
1387 generate false mouse drag events if we don't ignore them.) */
1388 ignore_mouse_drag_p
= 0;
1390 /* If minibuffer on and echo area in use,
1391 wait a short time and redraw minibuffer. */
1394 && !NILP (echo_area_buffer
[0])
1395 && EQ (minibuf_window
, echo_area_window
)
1396 && NUMBERP (Vminibuffer_message_timeout
))
1398 /* Bind inhibit-quit to t so that C-g gets read in
1399 rather than quitting back to the minibuffer. */
1400 ptrdiff_t count
= SPECPDL_INDEX ();
1401 specbind (Qinhibit_quit
, Qt
);
1403 sit_for (Vminibuffer_message_timeout
, 0, 2);
1405 /* Clear the echo area. */
1407 safe_run_hooks (Qecho_area_clear_hook
);
1409 unbind_to (count
, Qnil
);
1411 /* If a C-g came in before, treat it as input now. */
1412 if (!NILP (Vquit_flag
))
1415 Vunread_command_events
= list1 (make_number (quit_char
));
1419 /* If it has changed current-menubar from previous value,
1420 really recompute the menubar from the value. */
1421 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1422 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1423 call0 (Qrecompute_lucid_menubar
);
1425 before_command_key_count
= this_command_key_count
;
1426 before_command_echo_length
= echo_length ();
1428 Vthis_command
= Qnil
;
1429 Vreal_this_command
= Qnil
;
1430 Vthis_original_command
= Qnil
;
1431 Vthis_command_keys_shift_translated
= Qnil
;
1433 /* Read next key sequence; i gets its length. */
1434 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1437 /* A filter may have run while we were reading the input. */
1438 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1440 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1444 /* Now we have read a key sequence of length I,
1445 or else I is 0 and we found end of file. */
1447 if (i
== 0) /* End of file -- happens only in */
1448 return Qnil
; /* a kbd macro, at the end. */
1449 /* -1 means read_key_sequence got a menu that was rejected.
1450 Just loop around and read another command. */
1454 this_command_key_count
= 0;
1455 this_command_key_count_reset
= 0;
1456 this_single_command_key_start
= 0;
1460 last_command_event
= keybuf
[i
- 1];
1462 /* If the previous command tried to force a specific window-start,
1463 forget about that, in case this command moves point far away
1464 from that position. But also throw away beg_unchanged and
1465 end_unchanged information in that case, so that redisplay will
1466 update the whole window properly. */
1467 if (XWINDOW (selected_window
)->force_start
)
1470 XWINDOW (selected_window
)->force_start
= 0;
1471 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1472 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1475 cmd
= read_key_sequence_cmd
;
1476 if (!NILP (Vexecuting_kbd_macro
))
1478 if (!NILP (Vquit_flag
))
1480 Vexecuting_kbd_macro
= Qt
;
1481 QUIT
; /* Make some noise. */
1482 /* Will return since macro now empty. */
1486 /* Do redisplay processing after this command except in special
1487 cases identified below. */
1488 prev_buffer
= current_buffer
;
1489 prev_modiff
= MODIFF
;
1490 last_point_position
= PT
;
1492 /* By default, we adjust point to a boundary of a region that
1493 has such a property that should be treated intangible
1494 (e.g. composition, display). But, some commands will set
1495 this variable differently. */
1496 Vdisable_point_adjustment
= Qnil
;
1498 /* Process filters and timers may have messed with deactivate-mark.
1499 reset it before we execute the command. */
1500 Vdeactivate_mark
= Qnil
;
1502 /* Remap command through active keymaps. */
1503 Vthis_original_command
= cmd
;
1504 if (!NILP (read_key_sequence_remapped
))
1505 cmd
= read_key_sequence_remapped
;
1507 /* Execute the command. */
1509 Vthis_command
= cmd
;
1510 Vreal_this_command
= cmd
;
1511 safe_run_hooks (Qpre_command_hook
);
1513 already_adjusted
= 0;
1515 if (NILP (Vthis_command
))
1517 /* nil means key is undefined. */
1518 Lisp_Object keys
= Fvector (i
, keybuf
);
1519 keys
= Fkey_description (keys
, Qnil
);
1521 message_with_string ("%s is undefined", keys
, 0);
1522 kset_defining_kbd_macro (current_kboard
, Qnil
);
1523 update_mode_lines
= 1;
1524 /* If this is a down-mouse event, don't reset prefix-arg;
1525 pass it to the command run by the up event. */
1526 if (EVENT_HAS_PARAMETERS (last_command_event
))
1528 Lisp_Object breakdown
1529 = parse_modifiers (EVENT_HEAD (last_command_event
));
1530 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1531 if (!(modifiers
& down_modifier
))
1532 kset_prefix_arg (current_kboard
, Qnil
);
1535 kset_prefix_arg (current_kboard
, Qnil
);
1539 /* Here for a command that isn't executed directly. */
1541 #ifdef HAVE_WINDOW_SYSTEM
1542 ptrdiff_t scount
= SPECPDL_INDEX ();
1544 if (display_hourglass_p
1545 && NILP (Vexecuting_kbd_macro
))
1547 record_unwind_protect_void (cancel_hourglass
);
1552 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1554 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1557 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1558 ? Qnil
: BVAR (current_buffer
, undo_list
));
1560 call1 (Qcommand_execute
, Vthis_command
);
1562 #ifdef HAVE_WINDOW_SYSTEM
1563 /* Do not check display_hourglass_p here, because
1564 `command-execute' could change it, but we should cancel
1565 hourglass cursor anyway.
1566 But don't cancel the hourglass within a macro
1567 just because a command in the macro finishes. */
1568 if (NILP (Vexecuting_kbd_macro
))
1569 unbind_to (scount
, Qnil
);
1572 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1574 safe_run_hooks (Qpost_command_hook
);
1576 /* If displaying a message, resize the echo area window to fit
1577 that message's size exactly. */
1578 if (!NILP (echo_area_buffer
[0]))
1579 resize_echo_area_exactly ();
1581 /* If there are warnings waiting, process them. */
1582 if (!NILP (Vdelayed_warnings_list
))
1583 safe_run_hooks (Qdelayed_warnings_hook
);
1585 safe_run_hooks (Qdeferred_action_function
);
1587 /* If there is a prefix argument,
1588 1) We don't want Vlast_command to be ``universal-argument''
1589 (that would be dumb), so don't set Vlast_command,
1590 2) we want to leave echoing on so that the prefix will be
1591 echoed as part of this key sequence, so don't call
1593 3) we want to leave this_command_key_count non-zero, so that
1594 read_char will realize that it is re-reading a character, and
1595 not echo it a second time.
1597 If the command didn't actually create a prefix arg,
1598 but is merely a frame event that is transparent to prefix args,
1599 then the above doesn't apply. */
1600 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1601 || CONSP (last_command_event
))
1603 kset_last_command (current_kboard
, Vthis_command
);
1604 kset_real_last_command (current_kboard
, Vreal_this_command
);
1605 if (!CONSP (last_command_event
))
1606 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1608 this_command_key_count
= 0;
1609 this_command_key_count_reset
= 0;
1610 this_single_command_key_start
= 0;
1613 if (!NILP (BVAR (current_buffer
, mark_active
))
1614 && !NILP (Vrun_hooks
))
1616 /* In Emacs 22, setting transient-mark-mode to `only' was a
1617 way of turning it on for just one command. This usage is
1618 obsolete, but support it anyway. */
1619 if (EQ (Vtransient_mark_mode
, Qidentity
))
1620 Vtransient_mark_mode
= Qnil
;
1621 else if (EQ (Vtransient_mark_mode
, Qonly
))
1622 Vtransient_mark_mode
= Qidentity
;
1624 if (!NILP (Vdeactivate_mark
))
1625 /* If `select-active-regions' is non-nil, this call to
1626 `deactivate-mark' also sets the PRIMARY selection. */
1627 call0 (Qdeactivate_mark
);
1630 /* Even if not deactivating the mark, set PRIMARY if
1631 `select-active-regions' is non-nil. */
1632 if (!NILP (Fwindow_system (Qnil
))
1633 /* Even if mark_active is non-nil, the actual buffer
1634 marker may not have been set yet (Bug#7044). */
1635 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1636 && (EQ (Vselect_active_regions
, Qonly
)
1637 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1638 : (!NILP (Vselect_active_regions
)
1639 && !NILP (Vtransient_mark_mode
)))
1640 && NILP (Fmemq (Vthis_command
,
1641 Vselection_inhibit_update_commands
)))
1644 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1647 call2 (Qx_set_selection
, QPRIMARY
,
1648 make_buffer_string (beg
, end
, 0));
1650 call2 (Qx_set_selection
, QPRIMARY
,
1651 make_buffer_string (end
, beg
, 0));
1652 /* Don't set empty selections. */
1655 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1657 Lisp_Object hook
= intern ("activate-mark-hook");
1658 Frun_hooks (1, &hook
);
1662 Vsaved_region_selection
= Qnil
;
1667 if (current_buffer
== prev_buffer
1668 && last_point_position
!= PT
1669 && NILP (Vdisable_point_adjustment
)
1670 && NILP (Vglobal_disable_point_adjustment
))
1672 if (last_point_position
> BEGV
1673 && last_point_position
< ZV
1674 && (composition_adjust_point (last_point_position
,
1675 last_point_position
)
1676 != last_point_position
))
1677 /* The last point was temporarily set within a grapheme
1678 cluster to prevent automatic composition. To recover
1679 the automatic composition, we must update the
1681 windows_or_buffers_changed
++;
1682 if (!already_adjusted
)
1683 adjust_point_for_property (last_point_position
,
1684 MODIFF
!= prev_modiff
);
1687 /* Install chars successfully executed in kbd macro. */
1689 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1690 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1691 finalize_kbd_macro_chars ();
1695 /* Adjust point to a boundary of a region that has such a property
1696 that should be treated intangible. For the moment, we check
1697 `composition', `display' and `invisible' properties.
1698 LAST_PT is the last position of point. */
1701 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1704 Lisp_Object val
, overlay
, tmp
;
1705 /* When called after buffer modification, we should temporarily
1706 suppress the point adjustment for automatic composition so that a
1707 user can keep inserting another character at point or keep
1708 deleting characters around point. */
1709 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1710 ptrdiff_t orig_pt
= PT
;
1712 /* FIXME: cycling is probably not necessary because these properties
1713 can't be usefully combined anyway. */
1714 while (check_composition
|| check_display
|| check_invisible
)
1716 /* FIXME: check `intangible'. */
1717 if (check_composition
1718 && PT
> BEGV
&& PT
< ZV
1719 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1722 check_display
= check_invisible
= 1;
1724 check_composition
= 0;
1726 && PT
> BEGV
&& PT
< ZV
1727 && !NILP (val
= get_char_property_and_overlay
1728 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1729 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1730 && (!OVERLAYP (overlay
)
1731 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1732 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1733 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1734 && (beg
< PT
/* && end > PT <- It's always the case. */
1735 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1738 SET_PT (PT
< last_pt
1739 ? (STRINGP (val
) && SCHARS (val
) == 0
1740 ? max (beg
- 1, BEGV
)
1743 check_composition
= check_invisible
= 1;
1746 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1752 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1755 /* FIXME: We should stop if we find a spot between
1756 two runs of `invisible' where inserted text would
1757 be visible. This is important when we have two
1758 invisible boundaries that enclose an area: if the
1759 area is empty, we need this test in order to make
1760 it possible to place point in the middle rather
1761 than skip both boundaries. However, this code
1762 also stops anywhere in a non-sticky text-property,
1763 which breaks (e.g.) Org mode. */
1764 && (val
= get_pos_property (make_number (end
),
1766 TEXT_PROP_MEANS_INVISIBLE (val
))
1768 && !NILP (val
= get_char_property_and_overlay
1769 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1770 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1772 ellipsis
= ellipsis
|| inv
> 1
1773 || (OVERLAYP (overlay
)
1774 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1775 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1776 tmp
= Fnext_single_char_property_change
1777 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1778 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1782 && (val
= get_pos_property (make_number (beg
),
1784 TEXT_PROP_MEANS_INVISIBLE (val
))
1786 && !NILP (val
= get_char_property_and_overlay
1787 (make_number (beg
- 1), 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
= Fprevious_single_char_property_change
1795 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1796 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1799 /* Move away from the inside area. */
1800 if (beg
< PT
&& end
> PT
)
1802 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1803 /* We haven't moved yet (so we don't need to fear
1804 infinite-looping) and we were outside the range
1805 before (so either end of the range still corresponds
1806 to a move in the right direction): pretend we moved
1807 less than we actually did, so that we still have
1808 more freedom below in choosing which end of the range
1810 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1811 /* We either have moved already or the last point
1812 was already in the range: we don't get to choose
1813 which end of the range we have to go to. */
1814 : (PT
< last_pt
? beg
: end
));
1815 check_composition
= check_display
= 1;
1817 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1818 the point to something other than its argument, due to
1819 point-motion hooks, intangibility, etc. */
1820 eassert (PT
== beg
|| PT
== end
);
1823 /* Pretend the area doesn't exist if the buffer is not
1825 if (!modified
&& !ellipsis
&& beg
< end
)
1827 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1828 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1829 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1830 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1831 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1832 /* We've already moved as far as we can. Trying to go
1833 to the other end would mean moving backwards and thus
1834 could lead to an infinite loop. */
1836 else if (val
= get_pos_property (make_number (PT
),
1838 TEXT_PROP_MEANS_INVISIBLE (val
)
1839 && (val
= get_pos_property
1840 (make_number (PT
== beg
? end
: beg
),
1842 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1843 (check_composition
= check_display
= 1,
1844 SET_PT (PT
== beg
? end
: beg
));
1847 check_invisible
= 0;
1851 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1854 safe_run_hooks_1 (void)
1856 eassert (CONSP (Vinhibit_quit
));
1857 return call0 (XCDR (Vinhibit_quit
));
1860 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1864 safe_run_hooks_error (Lisp_Object error_data
)
1867 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1868 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1869 Lisp_Object args
[4];
1870 args
[0] = build_string ("Error in %s (%S): %S");
1873 args
[3] = error_data
;
1879 Lisp_Object newval
= Qnil
;
1880 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1881 if (EQ (fun
, XCAR (val
)))
1884 newval
= Fcons (XCAR (val
), newval
);
1886 return Fset (hook
, Fnreverse (newval
));
1887 /* Not found in the local part of the hook. Let's look at the global
1890 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1891 : Fdefault_value (hook
));
1892 CONSP (val
); val
= XCDR (val
))
1893 if (EQ (fun
, XCAR (val
)))
1896 newval
= Fcons (XCAR (val
), newval
);
1898 return Fset_default (hook
, Fnreverse (newval
));
1904 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1906 eassert (nargs
== 1);
1907 if (CONSP (Vinhibit_quit
))
1908 XSETCDR (Vinhibit_quit
, args
[0]);
1910 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1912 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1916 /* If we get an error while running the hook, cause the hook variable
1917 to be nil. Also inhibit quits, so that C-g won't cause the hook
1918 to mysteriously evaporate. */
1921 safe_run_hooks (Lisp_Object hook
)
1923 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1924 to its body or to its handlers other than via globals such as
1925 dynamically-bound variables ;-) */
1926 ptrdiff_t count
= SPECPDL_INDEX ();
1927 specbind (Qinhibit_quit
, hook
);
1929 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1931 unbind_to (count
, Qnil
);
1935 /* Nonzero means polling for input is temporarily suppressed. */
1937 int poll_suppress_count
;
1940 #ifdef POLL_FOR_INPUT
1942 /* Asynchronous timer for polling. */
1944 static struct atimer
*poll_timer
;
1946 /* Poll for input, so that we catch a C-g if it comes in. This
1947 function is called from x_make_frame_visible, see comment
1951 poll_for_input_1 (void)
1953 if (! input_blocked_p ()
1954 && !waiting_for_input
)
1958 /* Timer callback function for poll_timer. TIMER is equal to
1962 poll_for_input (struct atimer
*timer
)
1964 if (poll_suppress_count
== 0)
1965 pending_signals
= 1;
1968 #endif /* POLL_FOR_INPUT */
1970 /* Begin signals to poll for input, if they are appropriate.
1971 This function is called unconditionally from various places. */
1974 start_polling (void)
1976 #ifdef POLL_FOR_INPUT
1977 /* XXX This condition was (read_socket_hook && !interrupt_input),
1978 but read_socket_hook is not global anymore. Let's pretend that
1980 if (!interrupt_input
)
1982 /* Turn alarm handling on unconditionally. It might have
1983 been turned off in process.c. */
1984 turn_on_atimers (1);
1986 /* If poll timer doesn't exist, are we need one with
1987 a different interval, start a new one. */
1988 if (poll_timer
== NULL
1989 || poll_timer
->interval
.tv_sec
!= polling_period
)
1991 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1992 struct timespec interval
= make_timespec (period
, 0);
1995 cancel_atimer (poll_timer
);
1997 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1998 poll_for_input
, NULL
);
2001 /* Let the timer's callback function poll for input
2002 if this becomes zero. */
2003 --poll_suppress_count
;
2008 /* True if we are using polling to handle input asynchronously. */
2011 input_polling_used (void)
2013 #ifdef POLL_FOR_INPUT
2014 /* XXX This condition was (read_socket_hook && !interrupt_input),
2015 but read_socket_hook is not global anymore. Let's pretend that
2017 return !interrupt_input
;
2023 /* Turn off polling. */
2028 #ifdef POLL_FOR_INPUT
2029 /* XXX This condition was (read_socket_hook && !interrupt_input),
2030 but read_socket_hook is not global anymore. Let's pretend that
2032 if (!interrupt_input
)
2033 ++poll_suppress_count
;
2037 /* Set the value of poll_suppress_count to COUNT
2038 and start or stop polling accordingly. */
2041 set_poll_suppress_count (int count
)
2043 #ifdef POLL_FOR_INPUT
2044 if (count
== 0 && poll_suppress_count
!= 0)
2046 poll_suppress_count
= 1;
2049 else if (count
!= 0 && poll_suppress_count
== 0)
2053 poll_suppress_count
= count
;
2057 /* Bind polling_period to a value at least N.
2058 But don't decrease it. */
2061 bind_polling_period (int n
)
2063 #ifdef POLL_FOR_INPUT
2064 EMACS_INT
new = polling_period
;
2069 stop_other_atimers (poll_timer
);
2071 specbind (Qpolling_period
, make_number (new));
2072 /* Start a new alarm with the new period. */
2077 /* Apply the control modifier to CHARACTER. */
2080 make_ctrl_char (int c
)
2082 /* Save the upper bits here. */
2083 int upper
= c
& ~0177;
2085 if (! ASCII_BYTE_P (c
))
2086 return c
|= ctrl_modifier
;
2090 /* Everything in the columns containing the upper-case letters
2091 denotes a control character. */
2092 if (c
>= 0100 && c
< 0140)
2096 /* Set the shift modifier for a control char
2097 made from a shifted letter. But only for letters! */
2098 if (oc
>= 'A' && oc
<= 'Z')
2099 c
|= shift_modifier
;
2102 /* The lower-case letters denote control characters too. */
2103 else if (c
>= 'a' && c
<= 'z')
2106 /* Include the bits for control and shift
2107 only if the basic ASCII code can't indicate them. */
2111 /* Replace the high bits. */
2112 c
|= (upper
& ~ctrl_modifier
);
2117 /* Display the help-echo property of the character after the mouse pointer.
2118 Either show it in the echo area, or call show-help-function to display
2119 it by other means (maybe in a tooltip).
2121 If HELP is nil, that means clear the previous help echo.
2123 If HELP is a string, display that string. If HELP is a function,
2124 call it with OBJECT and POS as arguments; the function should
2125 return a help string or nil for none. For all other types of HELP,
2126 evaluate it to obtain a string.
2128 WINDOW is the window in which the help was generated, if any.
2129 It is nil if not in a window.
2131 If OBJECT is a buffer, POS is the position in the buffer where the
2132 `help-echo' text property was found.
2134 If OBJECT is an overlay, that overlay has a `help-echo' property,
2135 and POS is the position in the overlay's buffer under the mouse.
2137 If OBJECT is a string (an overlay string or a string displayed with
2138 the `display' property). POS is the position in that string under
2141 Note: this function may only be called with HELP nil or a string
2142 from X code running asynchronously. */
2145 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2148 if (!NILP (help
) && !STRINGP (help
))
2150 if (FUNCTIONP (help
))
2151 help
= safe_call (4, help
, window
, object
, pos
);
2153 help
= safe_eval (help
);
2155 if (!STRINGP (help
))
2159 if (!noninteractive
&& STRINGP (help
))
2161 /* The mouse-fixup-help-message Lisp function can call
2162 mouse_position_hook, which resets the mouse_moved flags.
2163 This causes trouble if we are trying to read a mouse motion
2164 event (i.e., if we are inside a `track-mouse' form), so we
2165 restore the mouse_moved flag. */
2166 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2167 help
= call1 (Qmouse_fixup_help_message
, help
);
2172 if (STRINGP (help
) || NILP (help
))
2174 if (!NILP (Vshow_help_function
))
2175 call1 (Vshow_help_function
, help
);
2176 help_echo_showing_p
= STRINGP (help
);
2182 /* Input of single characters from keyboard */
2184 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2185 struct timespec
*end_time
);
2186 static void record_char (Lisp_Object c
);
2188 static Lisp_Object help_form_saved_window_configs
;
2190 read_char_help_form_unwind (void)
2192 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2193 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2194 if (!NILP (window_config
))
2195 Fset_window_configuration (window_config
);
2198 #define STOP_POLLING \
2199 do { if (! polling_stopped_here) stop_polling (); \
2200 polling_stopped_here = 1; } while (0)
2202 #define RESUME_POLLING \
2203 do { if (polling_stopped_here) start_polling (); \
2204 polling_stopped_here = 0; } while (0)
2207 read_event_from_main_queue (struct timespec
*end_time
,
2208 sys_jmp_buf local_getcjmp
,
2209 bool *used_mouse_menu
)
2211 Lisp_Object c
= Qnil
;
2212 sys_jmp_buf save_jump
;
2213 KBOARD
*kb
IF_LINT (= NULL
);
2217 /* Read from the main queue, and if that gives us something we can't use yet,
2218 we put it on the appropriate side queue and try again. */
2220 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2223 /* Actually read a character, waiting if necessary. */
2224 save_getcjmp (save_jump
);
2225 restore_getcjmp (local_getcjmp
);
2227 timer_start_idle ();
2228 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2229 restore_getcjmp (save_jump
);
2231 if (! NILP (c
) && (kb
!= current_kboard
))
2233 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2236 while (CONSP (XCDR (last
)))
2238 if (!NILP (XCDR (last
)))
2242 kset_kbd_queue (kb
, list1 (c
));
2244 XSETCDR (last
, list1 (c
));
2245 kb
->kbd_queue_has_data
= 1;
2249 current_kboard
= kb
;
2250 /* This is going to exit from read_char
2251 so we had better get rid of this frame's stuff. */
2252 return make_number (-2);
2255 /* Terminate Emacs in batch mode if at eof. */
2256 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2257 Fkill_emacs (make_number (1));
2261 /* Add in any extra modifiers, where appropriate. */
2262 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2263 || ((extra_keyboard_modifiers
& 0177) < ' '
2264 && (extra_keyboard_modifiers
& 0177) != 0))
2265 XSETINT (c
, make_ctrl_char (XINT (c
)));
2267 /* Transfer any other modifier bits directly from
2268 extra_keyboard_modifiers to c. Ignore the actual character code
2269 in the low 16 bits of extra_keyboard_modifiers. */
2270 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2278 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2281 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2282 sys_jmp_buf local_getcjmp
,
2283 Lisp_Object prev_event
,
2284 bool *used_mouse_menu
)
2286 #define MAX_ENCODED_BYTES 16
2287 Lisp_Object events
[MAX_ENCODED_BYTES
];
2292 = read_event_from_main_queue (end_time
, local_getcjmp
,
2295 /* w32_console already returns decoded events. It either reads
2296 Unicode characters from the Windows keyboard input, or
2297 converts characters encoded in the current codepage into
2298 Unicode. See w32inevt.c:key_event, near its end. */
2301 struct frame
*frame
= XFRAME (selected_frame
);
2302 struct terminal
*terminal
= frame
->terminal
;
2303 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2304 /* Don't apply decoding if we're just reading a raw event
2305 (e.g. reading bytes sent by the xterm to specify the position
2306 of a mouse click). */
2307 && (!EQ (prev_event
, Qt
))
2308 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2309 & CODING_REQUIRE_DECODING_MASK
)))
2310 return nextevt
; /* No decoding needed. */
2313 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2314 eassert (n
< MAX_ENCODED_BYTES
);
2315 events
[n
++] = nextevt
;
2316 if (NATNUMP (nextevt
)
2317 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2318 { /* An encoded byte sequence, let's try to decode it. */
2319 struct coding_system
*coding
2320 = TERMINAL_KEYBOARD_CODING (terminal
);
2321 unsigned char *src
= alloca (n
);
2323 for (i
= 0; i
< n
; i
++)
2324 src
[i
] = XINT (events
[i
]);
2326 for (i
= 0; i
< n
; i
++)
2328 coding
->destination
= alloca (n
* 4);
2329 coding
->dst_bytes
= n
* 4;
2330 decode_coding_c_string (coding
, src
, n
, Qnil
);
2331 eassert (coding
->produced_char
<= n
);
2332 if (coding
->produced_char
== 0)
2333 { /* The encoded sequence is incomplete. */
2334 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2335 continue; /* Read on! */
2339 const unsigned char *p
= coding
->destination
;
2340 eassert (coding
->carryover_bytes
== 0);
2342 while (n
< coding
->produced_char
)
2343 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2346 /* Now `events' should hold decoded events.
2347 Normally, n should be equal to 1, but better not rely on it.
2348 We can only return one event here, so return the first we
2349 had and keep the others (if any) for later. */
2351 Vunread_command_events
2352 = Fcons (events
[--n
], Vunread_command_events
);
2359 /* Read a character from the keyboard; call the redisplay if needed. */
2360 /* commandflag 0 means do not autosave, but do redisplay.
2361 -1 means do not redisplay, but do autosave.
2364 /* The arguments MAP is for menu prompting. MAP is a keymap.
2366 PREV_EVENT is the previous input event, or nil if we are reading
2367 the first event of a key sequence (or not reading a key sequence).
2368 If PREV_EVENT is t, that is a "magic" value that says
2369 not to run input methods, but in other respects to act as if
2370 not reading a key sequence.
2372 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2373 if we used a mouse menu to read the input, or false otherwise. If
2374 USED_MOUSE_MENU is null, don't dereference it.
2376 Value is -2 when we find input on another keyboard. A second call
2377 to read_char will read it.
2379 If END_TIME is non-null, it is a pointer to a struct timespec
2380 specifying the maximum time to wait until. If no input arrives by
2381 that time, stop waiting and return nil.
2383 Value is t if we showed a menu and the user rejected it. */
2386 read_char (int commandflag
, Lisp_Object map
,
2387 Lisp_Object prev_event
,
2388 bool *used_mouse_menu
, struct timespec
*end_time
)
2392 sys_jmp_buf local_getcjmp
;
2393 sys_jmp_buf save_jump
;
2394 Lisp_Object tem
, save
;
2395 volatile Lisp_Object previous_echo_area_message
;
2396 volatile Lisp_Object also_record
;
2397 volatile bool reread
;
2398 struct gcpro gcpro1
, gcpro2
;
2399 bool volatile polling_stopped_here
= 0;
2400 struct kboard
*orig_kboard
= current_kboard
;
2404 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2405 before_command_key_count
= this_command_key_count
;
2406 before_command_echo_length
= echo_length ();
2409 previous_echo_area_message
= Qnil
;
2411 GCPRO2 (c
, previous_echo_area_message
);
2416 if (CONSP (Vunread_post_input_method_events
))
2418 c
= XCAR (Vunread_post_input_method_events
);
2419 Vunread_post_input_method_events
2420 = XCDR (Vunread_post_input_method_events
);
2422 /* Undo what read_char_x_menu_prompt did when it unread
2423 additional keys returned by Fx_popup_menu. */
2425 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2433 if (CONSP (Vunread_command_events
))
2435 bool was_disabled
= 0;
2437 c
= XCAR (Vunread_command_events
);
2438 Vunread_command_events
= XCDR (Vunread_command_events
);
2442 /* Undo what sit-for did when it unread additional keys
2443 inside universal-argument. */
2446 && EQ (XCAR (c
), Qt
))
2452 /* Undo what read_char_x_menu_prompt did when it unread
2453 additional keys returned by Fx_popup_menu. */
2455 && EQ (XCDR (c
), Qdisabled
)
2456 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2462 /* If the queued event is something that used the mouse,
2463 set used_mouse_menu accordingly. */
2465 /* Also check was_disabled so last-nonmenu-event won't return
2466 a bad value when submenus are involved. (Bug#447) */
2467 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2468 *used_mouse_menu
= 1;
2470 goto reread_for_input_method
;
2473 if (CONSP (Vunread_input_method_events
))
2475 c
= XCAR (Vunread_input_method_events
);
2476 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2478 /* Undo what read_char_x_menu_prompt did when it unread
2479 additional keys returned by Fx_popup_menu. */
2481 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2485 goto reread_for_input_method
;
2488 this_command_key_count_reset
= 0;
2490 if (!NILP (Vexecuting_kbd_macro
))
2492 /* We set this to Qmacro; since that's not a frame, nobody will
2493 try to switch frames on us, and the selected window will
2496 Since this event came from a macro, it would be misleading to
2497 leave internal_last_event_frame set to wherever the last
2498 real event came from. Normally, a switch-frame event selects
2499 internal_last_event_frame after each command is read, but
2500 events read from a macro should never cause a new frame to be
2502 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2504 /* Exit the macro if we are at the end.
2505 Also, some things replace the macro with t
2506 to force an early exit. */
2507 if (EQ (Vexecuting_kbd_macro
, Qt
)
2508 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2514 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2515 if (STRINGP (Vexecuting_kbd_macro
)
2516 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2517 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2519 executing_kbd_macro_index
++;
2524 if (!NILP (unread_switch_frame
))
2526 c
= unread_switch_frame
;
2527 unread_switch_frame
= Qnil
;
2529 /* This event should make it into this_command_keys, and get echoed
2530 again, so we do not set `reread'. */
2534 /* If redisplay was requested. */
2535 if (commandflag
>= 0)
2537 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2539 /* If there is pending input, process any events which are not
2540 user-visible, such as X selection_request events. */
2542 || detect_input_pending_run_timers (0))
2543 swallow_events (0); /* May clear input_pending. */
2545 /* Redisplay if no pending input. */
2546 while (!input_pending
)
2548 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2549 redisplay_preserve_echo_area (5);
2554 /* Normal case: no input arrived during redisplay. */
2557 /* Input arrived and pre-empted redisplay.
2558 Process any events which are not user-visible. */
2560 /* If that cleared input_pending, try again to redisplay. */
2563 /* Prevent the redisplay we just did
2564 from messing up echoing of the input after the prompt. */
2565 if (commandflag
== 0 && echo_current
)
2566 echo_message_buffer
= echo_area_buffer
[0];
2570 /* Message turns off echoing unless more keystrokes turn it on again.
2572 The code in 20.x for the condition was
2574 1. echo_area_glyphs && *echo_area_glyphs
2575 2. && echo_area_glyphs != current_kboard->echobuf
2576 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2578 (1) means there's a current message displayed
2580 (2) means it's not the message from echoing from the current
2583 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2584 is set to a non-null value. This is done in read_char and it is
2585 set to echo_area_glyphs after a call to echo_char. That means
2586 ok_to_echo_at_next_pause is either null or
2587 current_kboard->echobuf with the appropriate current_kboard at
2590 So, condition (3) means in clear text ok_to_echo_at_next_pause
2591 must be either null, or the current message isn't from echoing at
2592 all, or it's from echoing from a different kboard than the
2595 if (/* There currently is something in the echo area. */
2596 !NILP (echo_area_buffer
[0])
2597 && (/* And it's either not from echoing. */
2598 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2599 /* Or it's an echo from a different kboard. */
2600 || echo_kboard
!= current_kboard
2601 /* Or we explicitly allow overwriting whatever there is. */
2602 || ok_to_echo_at_next_pause
== NULL
))
2607 /* Try reading a character via menu prompting in the minibuf.
2608 Try this before the sit-for, because the sit-for
2609 would do the wrong thing if we are supposed to do
2610 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2611 after a mouse event so don't try a minibuf menu. */
2613 if (KEYMAPP (map
) && INTERACTIVE
2614 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2615 /* Don't bring up a menu if we already have another event. */
2616 && NILP (Vunread_command_events
)
2617 && !detect_input_pending_run_timers (0))
2619 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2621 if (INTEGERP (c
) && XINT (c
) == -2)
2622 return c
; /* wrong_kboard_jmpbuf */
2628 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2629 We will do that below, temporarily for short sections of code,
2630 when appropriate. local_getcjmp must be in effect
2631 around any call to sit_for or kbd_buffer_get_event;
2632 it *must not* be in effect when we call redisplay. */
2634 jmpcount
= SPECPDL_INDEX ();
2635 if (sys_setjmp (local_getcjmp
))
2637 /* Handle quits while reading the keyboard. */
2638 /* We must have saved the outer value of getcjmp here,
2639 so restore it now. */
2640 restore_getcjmp (save_jump
);
2641 unbind_to (jmpcount
, Qnil
);
2642 XSETINT (c
, quit_char
);
2643 internal_last_event_frame
= selected_frame
;
2644 Vlast_event_frame
= internal_last_event_frame
;
2645 /* If we report the quit char as an event,
2646 don't do so more than once. */
2647 if (!NILP (Vinhibit_quit
))
2651 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2652 if (kb
!= current_kboard
)
2654 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2655 /* We shouldn't get here if we were in single-kboard mode! */
2660 while (CONSP (XCDR (last
)))
2662 if (!NILP (XCDR (last
)))
2666 kset_kbd_queue (kb
, list1 (c
));
2668 XSETCDR (last
, list1 (c
));
2669 kb
->kbd_queue_has_data
= 1;
2670 current_kboard
= kb
;
2671 /* This is going to exit from read_char
2672 so we had better get rid of this frame's stuff. */
2674 return make_number (-2); /* wrong_kboard_jmpbuf */
2680 /* Start idle timers if no time limit is supplied. We don't do it
2681 if a time limit is supplied to avoid an infinite recursion in the
2682 situation where an idle timer calls `sit-for'. */
2685 timer_start_idle ();
2687 /* If in middle of key sequence and minibuffer not active,
2688 start echoing if enough time elapses. */
2690 if (minibuf_level
== 0
2692 && !current_kboard
->immediate_echo
2693 && this_command_key_count
> 0
2695 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2696 && NILP (Fzerop (Vecho_keystrokes
))
2697 && (/* No message. */
2698 NILP (echo_area_buffer
[0])
2699 /* Or empty message. */
2700 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2701 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2702 /* Or already echoing from same kboard. */
2703 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2704 /* Or not echoing before and echoing allowed. */
2705 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2707 /* After a mouse event, start echoing right away.
2708 This is because we are probably about to display a menu,
2709 and we don't want to delay before doing so. */
2710 if (EVENT_HAS_PARAMETERS (prev_event
))
2716 save_getcjmp (save_jump
);
2717 restore_getcjmp (local_getcjmp
);
2718 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2719 restore_getcjmp (save_jump
);
2721 && ! CONSP (Vunread_command_events
))
2726 /* Maybe auto save due to number of keystrokes. */
2728 if (commandflag
!= 0
2729 && auto_save_interval
> 0
2730 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2731 && !detect_input_pending_run_timers (0))
2733 Fdo_auto_save (Qnil
, Qnil
);
2734 /* Hooks can actually change some buffers in auto save. */
2738 /* Try reading using an X menu.
2739 This is never confused with reading using the minibuf
2740 because the recursive call of read_char in read_char_minibuf_menu_prompt
2741 does not pass on any keymaps. */
2743 if (KEYMAPP (map
) && INTERACTIVE
2744 && !NILP (prev_event
)
2745 && EVENT_HAS_PARAMETERS (prev_event
)
2746 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2747 && !EQ (XCAR (prev_event
), Qtool_bar
)
2748 /* Don't bring up a menu if we already have another event. */
2749 && NILP (Vunread_command_events
))
2751 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2753 /* Now that we have read an event, Emacs is not idle. */
2760 /* Maybe autosave and/or garbage collect due to idleness. */
2762 if (INTERACTIVE
&& NILP (c
))
2765 ptrdiff_t buffer_size
;
2767 /* Slow down auto saves logarithmically in size of current buffer,
2768 and garbage collect while we're at it. */
2769 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2770 last_non_minibuf_size
= Z
- BEG
;
2771 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2773 while (buffer_size
> 64)
2774 delay_level
++, buffer_size
-= buffer_size
>> 2;
2775 if (delay_level
< 4) delay_level
= 4;
2776 /* delay_level is 4 for files under around 50k, 7 at 100k,
2777 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2779 /* Auto save if enough time goes by without input. */
2780 if (commandflag
!= 0
2781 && num_nonmacro_input_events
> last_auto_save
2782 && INTEGERP (Vauto_save_timeout
)
2783 && XINT (Vauto_save_timeout
) > 0)
2786 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2788 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2789 timeout
= delay_level
* timeout
/ 4;
2790 save_getcjmp (save_jump
);
2791 restore_getcjmp (local_getcjmp
);
2792 tem0
= sit_for (make_number (timeout
), 1, 1);
2793 restore_getcjmp (save_jump
);
2796 && ! CONSP (Vunread_command_events
))
2798 Fdo_auto_save (Qnil
, Qnil
);
2803 /* If there is still no input available, ask for GC. */
2804 if (!detect_input_pending_run_timers (0))
2808 /* Notify the caller if an autosave hook, or a timer, sentinel or
2809 filter in the sit_for calls above have changed the current
2810 kboard. This could happen if they use the minibuffer or start a
2811 recursive edit, like the fancy splash screen in server.el's
2812 filter. If this longjmp wasn't here, read_key_sequence would
2813 interpret the next key sequence using the wrong translation
2814 tables and function keymaps. */
2815 if (NILP (c
) && current_kboard
!= orig_kboard
)
2818 return make_number (-2); /* wrong_kboard_jmpbuf */
2821 /* If this has become non-nil here, it has been set by a timer
2822 or sentinel or filter. */
2823 if (CONSP (Vunread_command_events
))
2825 c
= XCAR (Vunread_command_events
);
2826 Vunread_command_events
= XCDR (Vunread_command_events
);
2829 /* Read something from current KBOARD's side queue, if possible. */
2833 if (current_kboard
->kbd_queue_has_data
)
2835 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2837 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2838 kset_kbd_queue (current_kboard
,
2839 XCDR (KVAR (current_kboard
, kbd_queue
)));
2840 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2841 current_kboard
->kbd_queue_has_data
= 0;
2842 input_pending
= readable_events (0);
2843 if (EVENT_HAS_PARAMETERS (c
)
2844 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2845 internal_last_event_frame
= XCAR (XCDR (c
));
2846 Vlast_event_frame
= internal_last_event_frame
;
2850 /* If current_kboard's side queue is empty check the other kboards.
2851 If one of them has data that we have not yet seen here,
2852 switch to it and process the data waiting for it.
2854 Note: if the events queued up for another kboard
2855 have already been seen here, and therefore are not a complete command,
2856 the kbd_queue_has_data field is 0, so we skip that kboard here.
2857 That's to avoid an infinite loop switching between kboards here. */
2858 if (NILP (c
) && !single_kboard
)
2861 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2862 if (kb
->kbd_queue_has_data
)
2864 current_kboard
= kb
;
2865 /* This is going to exit from read_char
2866 so we had better get rid of this frame's stuff. */
2868 return make_number (-2); /* wrong_kboard_jmpbuf */
2878 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2879 prev_event
, used_mouse_menu
);
2880 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2882 if (EQ (c
, make_number (-2)))
2884 /* This is going to exit from read_char
2885 so we had better get rid of this frame's stuff. */
2899 if (commandflag
>= 0
2900 && !input_pending
&& !detect_input_pending_run_timers (0))
2906 /* Buffer switch events are only for internal wakeups
2907 so don't show them to the user.
2908 Also, don't record a key if we already did. */
2912 /* Process special events within read_char
2913 and loop around to read another event. */
2916 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2921 struct buffer
*prev_buffer
= current_buffer
;
2922 last_input_event
= c
;
2923 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2925 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2926 /* We stopped being idle for this event; undo that. This
2927 prevents automatic window selection (under
2928 mouse_autoselect_window from acting as a real input event, for
2929 example banishing the mouse under mouse-avoidance-mode. */
2930 timer_resume_idle ();
2932 if (current_buffer
!= prev_buffer
)
2934 /* The command may have changed the keymaps. Pretend there
2935 is input in another keyboard and return. This will
2936 recalculate keymaps. */
2937 c
= make_number (-2);
2944 /* Handle things that only apply to characters. */
2947 /* If kbd_buffer_get_event gave us an EOF, return that. */
2951 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2952 && UNSIGNED_CMP (XFASTINT (c
), <,
2953 SCHARS (KVAR (current_kboard
,
2954 Vkeyboard_translate_table
))))
2955 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2956 && UNSIGNED_CMP (XFASTINT (c
), <,
2957 ASIZE (KVAR (current_kboard
,
2958 Vkeyboard_translate_table
))))
2959 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2963 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2964 /* nil in keyboard-translate-table means no translation. */
2970 /* If this event is a mouse click in the menu bar,
2971 return just menu-bar for now. Modify the mouse click event
2972 so we won't do this twice, then queue it up. */
2973 if (EVENT_HAS_PARAMETERS (c
)
2975 && CONSP (EVENT_START (c
))
2976 && CONSP (XCDR (EVENT_START (c
))))
2980 posn
= POSN_POSN (EVENT_START (c
));
2981 /* Handle menu-bar events:
2982 insert the dummy prefix event `menu-bar'. */
2983 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2985 /* Change menu-bar to (menu-bar) as the event "position". */
2986 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2989 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2994 /* Store these characters into recent_keys, the dribble file if any,
2995 and the keyboard macro being defined, if any. */
2997 if (! NILP (also_record
))
2998 record_char (also_record
);
3000 /* Wipe the echo area.
3001 But first, if we are about to use an input method,
3002 save the echo area contents for it to refer to. */
3004 && ! NILP (Vinput_method_function
)
3005 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3007 previous_echo_area_message
= Fcurrent_message ();
3008 Vinput_method_previous_message
= previous_echo_area_message
;
3011 /* Now wipe the echo area, except for help events which do their
3012 own stuff with the echo area. */
3014 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3015 && !(EQ (Qswitch_frame
, XCAR (c
)))
3016 /* Don't wipe echo area for select window events: These might
3017 get delayed via `mouse-autoselect-window' (Bug#11304). */
3018 && !(EQ (Qselect_window
, XCAR (c
)))))
3020 if (!NILP (echo_area_buffer
[0]))
3022 safe_run_hooks (Qecho_area_clear_hook
);
3023 clear_message (1, 0);
3027 reread_for_input_method
:
3029 /* Pass this to the input method, if appropriate. */
3031 && ! NILP (Vinput_method_function
)
3032 /* Don't run the input method within a key sequence,
3033 after the first event of the key sequence. */
3034 && NILP (prev_event
)
3035 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3038 ptrdiff_t key_count
;
3039 bool key_count_reset
;
3040 struct gcpro gcpro1
;
3041 ptrdiff_t count
= SPECPDL_INDEX ();
3043 /* Save the echo status. */
3044 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3045 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3046 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3047 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3050 if (before_command_restore_flag
)
3052 this_command_key_count
= before_command_key_count_1
;
3053 if (this_command_key_count
< this_single_command_key_start
)
3054 this_single_command_key_start
= this_command_key_count
;
3055 echo_truncate (before_command_echo_length_1
);
3056 before_command_restore_flag
= 0;
3060 /* Save the this_command_keys status. */
3061 key_count
= this_command_key_count
;
3062 key_count_reset
= this_command_key_count_reset
;
3065 keys
= Fcopy_sequence (this_command_keys
);
3070 /* Clear out this_command_keys. */
3071 this_command_key_count
= 0;
3072 this_command_key_count_reset
= 0;
3074 /* Now wipe the echo area. */
3075 if (!NILP (echo_area_buffer
[0]))
3076 safe_run_hooks (Qecho_area_clear_hook
);
3077 clear_message (1, 0);
3080 /* If we are not reading a key sequence,
3081 never use the echo area. */
3084 specbind (Qinput_method_use_echo_area
, Qt
);
3087 /* Call the input method. */
3088 tem
= call1 (Vinput_method_function
, c
);
3090 tem
= unbind_to (count
, tem
);
3092 /* Restore the saved echoing state
3093 and this_command_keys state. */
3094 this_command_key_count
= key_count
;
3095 this_command_key_count_reset
= key_count_reset
;
3097 this_command_keys
= keys
;
3100 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3101 kset_echo_string (current_kboard
, saved_echo_string
);
3102 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3103 if (saved_immediate_echo
)
3108 /* The input method can return no events. */
3111 /* Bring back the previous message, if any. */
3112 if (! NILP (previous_echo_area_message
))
3113 message_with_string ("%s", previous_echo_area_message
, 0);
3116 /* It returned one event or more. */
3118 Vunread_post_input_method_events
3119 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3124 /* Display help if not echoing. */
3125 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3127 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3128 Lisp_Object help
, object
, position
, window
, htem
;
3130 htem
= Fcdr (XCDR (c
));
3133 window
= Fcar (htem
);
3135 object
= Fcar (htem
);
3137 position
= Fcar (htem
);
3139 show_help_echo (help
, window
, object
, position
);
3141 /* We stopped being idle for this event; undo that. */
3143 timer_resume_idle ();
3147 if ((! reread
|| this_command_key_count
== 0
3148 || this_command_key_count_reset
)
3152 /* Don't echo mouse motion events. */
3153 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3154 && NILP (Fzerop (Vecho_keystrokes
))
3155 && ! (EVENT_HAS_PARAMETERS (c
)
3156 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3159 if (! NILP (also_record
))
3160 echo_char (also_record
);
3161 /* Once we reread a character, echoing can happen
3162 the next time we pause to read a new one. */
3163 ok_to_echo_at_next_pause
= current_kboard
;
3166 /* Record this character as part of the current key. */
3167 add_command_key (c
);
3168 if (! NILP (also_record
))
3169 add_command_key (also_record
);
3172 last_input_event
= c
;
3175 /* Process the help character specially if enabled. */
3176 if (!NILP (Vhelp_form
) && help_char_p (c
))
3178 ptrdiff_t count
= SPECPDL_INDEX ();
3180 help_form_saved_window_configs
3181 = Fcons (Fcurrent_window_configuration (Qnil
),
3182 help_form_saved_window_configs
);
3183 record_unwind_protect_void (read_char_help_form_unwind
);
3184 call0 (Qhelp_form_show
);
3189 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3190 if (EVENT_HAS_PARAMETERS (c
)
3191 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3192 XSETCAR (help_form_saved_window_configs
, Qnil
);
3194 while (BUFFERP (c
));
3195 /* Remove the help from the frame. */
3196 unbind_to (count
, Qnil
);
3199 if (EQ (c
, make_number (040)))
3203 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3204 while (BUFFERP (c
));
3213 /* Record a key that came from a mouse menu.
3214 Record it for echoing, for this-command-keys, and so on. */
3217 record_menu_key (Lisp_Object c
)
3219 /* Wipe the echo area. */
3220 clear_message (1, 0);
3225 before_command_key_count
= this_command_key_count
;
3226 before_command_echo_length
= echo_length ();
3229 /* Don't echo mouse motion events. */
3230 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3231 && NILP (Fzerop (Vecho_keystrokes
)))
3235 /* Once we reread a character, echoing can happen
3236 the next time we pause to read a new one. */
3237 ok_to_echo_at_next_pause
= 0;
3240 /* Record this character as part of the current key. */
3241 add_command_key (c
);
3243 /* Re-reading in the middle of a command */
3244 last_input_event
= c
;
3248 /* Return true if should recognize C as "the help character". */
3251 help_char_p (Lisp_Object c
)
3255 if (EQ (c
, Vhelp_char
))
3257 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3258 if (EQ (c
, XCAR (tail
)))
3263 /* Record the input event C in various ways. */
3266 record_char (Lisp_Object c
)
3270 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3272 /* To avoid filling recent_keys with help-echo and mouse-movement
3273 events, we filter out repeated help-echo events, only store the
3274 first and last in a series of mouse-movement events, and don't
3275 store repeated help-echo events which are only separated by
3276 mouse-movement events. */
3278 Lisp_Object ev1
, ev2
, ev3
;
3281 if ((ix1
= recent_keys_index
- 1) < 0)
3282 ix1
= NUM_RECENT_KEYS
- 1;
3283 ev1
= AREF (recent_keys
, ix1
);
3285 if ((ix2
= ix1
- 1) < 0)
3286 ix2
= NUM_RECENT_KEYS
- 1;
3287 ev2
= AREF (recent_keys
, ix2
);
3289 if ((ix3
= ix2
- 1) < 0)
3290 ix3
= NUM_RECENT_KEYS
- 1;
3291 ev3
= AREF (recent_keys
, ix3
);
3293 if (EQ (XCAR (c
), Qhelp_echo
))
3295 /* Don't record `help-echo' in recent_keys unless it shows some help
3296 message, and a different help than the previously recorded
3298 Lisp_Object help
, last_help
;
3300 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3301 if (!STRINGP (help
))
3303 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3304 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3306 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3307 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3308 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3310 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3311 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3312 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3313 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3316 else if (EQ (XCAR (c
), Qmouse_movement
))
3318 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3319 So additional mouse movement events replace the last element. */
3320 Lisp_Object last_window
, window
;
3322 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3323 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3324 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3325 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3326 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3328 ASET (recent_keys
, ix1
, c
);
3334 store_kbd_macro_char (c
);
3338 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3339 ASET (recent_keys
, recent_keys_index
, c
);
3340 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3341 recent_keys_index
= 0;
3343 else if (recorded
< 0)
3345 /* We need to remove one or two events from recent_keys.
3346 To do this, we simply put nil at those events and move the
3347 recent_keys_index backwards over those events. Usually,
3348 users will never see those nil events, as they will be
3349 overwritten by the command keys entered to see recent_keys
3352 while (recorded
++ < 0 && total_keys
> 0)
3354 if (total_keys
< NUM_RECENT_KEYS
)
3356 if (--recent_keys_index
< 0)
3357 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3358 ASET (recent_keys
, recent_keys_index
, Qnil
);
3362 num_nonmacro_input_events
++;
3364 /* Write c to the dribble file. If c is a lispy event, write
3365 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3366 If you, dear reader, have a better idea, you've got the source. :-) */
3372 if (XUINT (c
) < 0x100)
3373 putc (XUINT (c
), dribble
);
3375 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3379 Lisp_Object dribblee
;
3381 /* If it's a structured event, take the event header. */
3382 dribblee
= EVENT_HEAD (c
);
3384 if (SYMBOLP (dribblee
))
3386 putc ('<', dribble
);
3387 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3388 SBYTES (SYMBOL_NAME (dribblee
)),
3390 putc ('>', dribble
);
3399 /* Copy out or in the info on where C-g should throw to.
3400 This is used when running Lisp code from within get_char,
3401 in case get_char is called recursively.
3402 See read_process_output. */
3405 save_getcjmp (sys_jmp_buf temp
)
3407 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3411 restore_getcjmp (sys_jmp_buf temp
)
3413 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3416 /* Low level keyboard/mouse input.
3417 kbd_buffer_store_event places events in kbd_buffer, and
3418 kbd_buffer_get_event retrieves them. */
3420 /* Return true if there are any events in the queue that read-char
3421 would return. If this returns false, a read-char would block. */
3423 readable_events (int flags
)
3425 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3428 /* If the buffer contains only FOCUS_IN_EVENT events, and
3429 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3430 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3432 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3433 #ifdef USE_TOOLKIT_SCROLL_BARS
3434 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3438 struct input_event
*event
;
3440 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3447 #ifdef USE_TOOLKIT_SCROLL_BARS
3448 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3450 event
->kind
== FOCUS_IN_EVENT
)
3451 #ifdef USE_TOOLKIT_SCROLL_BARS
3452 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3453 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3454 && event
->part
== scroll_bar_handle
3455 && event
->modifiers
== 0)
3460 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3463 while (event
!= kbd_store_ptr
);
3469 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3470 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3474 if (current_kboard
->kbd_queue_has_data
)
3480 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3481 if (kb
->kbd_queue_has_data
)
3487 /* Set this for debugging, to have a way to get out */
3488 int stop_character EXTERNALLY_VISIBLE
;
3491 event_to_kboard (struct input_event
*event
)
3493 /* Not applicable for these special events. */
3494 if (event
->kind
== SELECTION_REQUEST_EVENT
3495 || event
->kind
== SELECTION_CLEAR_EVENT
)
3499 Lisp_Object obj
= event
->frame_or_window
;
3500 /* There are some events that set this field to nil or string. */
3502 obj
= WINDOW_FRAME (XWINDOW (obj
));
3503 /* Also ignore dead frames here. */
3504 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3505 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3510 /* Return the number of slots occupied in kbd_buffer. */
3513 kbd_buffer_nr_stored (void)
3515 return kbd_fetch_ptr
== kbd_store_ptr
3517 : (kbd_fetch_ptr
< kbd_store_ptr
3518 ? kbd_store_ptr
- kbd_fetch_ptr
3519 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3520 + (kbd_store_ptr
- kbd_buffer
)));
3522 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3525 kbd_buffer_store_event (register struct input_event
*event
)
3527 kbd_buffer_store_event_hold (event
, 0);
3530 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3532 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3533 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3534 Else, if EVENT is a quit event, store the quit event
3535 in HOLD_QUIT, and return (thus ignoring further events).
3537 This is used to postpone the processing of the quit event until all
3538 subsequent input events have been parsed (and discarded). */
3541 kbd_buffer_store_event_hold (register struct input_event
*event
,
3542 struct input_event
*hold_quit
)
3544 if (event
->kind
== NO_EVENT
)
3547 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3550 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3552 register int c
= event
->code
& 0377;
3554 if (event
->modifiers
& ctrl_modifier
)
3555 c
= make_ctrl_char (c
);
3557 c
|= (event
->modifiers
3558 & (meta_modifier
| alt_modifier
3559 | hyper_modifier
| super_modifier
));
3563 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3564 struct input_event
*sp
;
3566 if (single_kboard
&& kb
!= current_kboard
)
3569 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3571 kb
->kbd_queue_has_data
= 1;
3572 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3574 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3577 if (event_to_kboard (sp
) == kb
)
3579 sp
->kind
= NO_EVENT
;
3580 sp
->frame_or_window
= Qnil
;
3589 *hold_quit
= *event
;
3593 /* If this results in a quit_char being returned to Emacs as
3594 input, set Vlast_event_frame properly. If this doesn't
3595 get returned to Emacs as an event, the next event read
3596 will set Vlast_event_frame again, so this is safe to do. */
3600 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3602 focus
= event
->frame_or_window
;
3603 internal_last_event_frame
= focus
;
3604 Vlast_event_frame
= focus
;
3607 last_event_timestamp
= event
->timestamp
;
3609 handle_interrupt (0);
3613 if (c
&& c
== stop_character
)
3619 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3620 Just ignore the second one. */
3621 else if (event
->kind
== BUFFER_SWITCH_EVENT
3622 && kbd_fetch_ptr
!= kbd_store_ptr
3623 && ((kbd_store_ptr
== kbd_buffer
3624 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3625 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3628 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3629 kbd_store_ptr
= kbd_buffer
;
3631 /* Don't let the very last slot in the buffer become full,
3632 since that would make the two pointers equal,
3633 and that is indistinguishable from an empty buffer.
3634 Discard the event if it would fill the last slot. */
3635 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3637 *kbd_store_ptr
= *event
;
3640 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3642 /* Don't read keyboard input until we have processed kbd_buffer.
3643 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3644 hold_keyboard_input ();
3645 if (!noninteractive
)
3649 #endif /* subprocesses */
3652 /* If we're inside while-no-input, and this event qualifies
3653 as input, set quit-flag to cause an interrupt. */
3654 if (!NILP (Vthrow_on_input
)
3655 && event
->kind
!= FOCUS_IN_EVENT
3656 && event
->kind
!= HELP_EVENT
3657 && event
->kind
!= DEICONIFY_EVENT
)
3659 Vquit_flag
= Vthrow_on_input
;
3660 /* If we're inside a function that wants immediate quits,
3662 if (immediate_quit
&& NILP (Vinhibit_quit
))
3671 /* Put an input event back in the head of the event queue. */
3674 kbd_buffer_unget_event (register struct input_event
*event
)
3676 if (kbd_fetch_ptr
== kbd_buffer
)
3677 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3679 /* Don't let the very last slot in the buffer become full, */
3680 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3683 *kbd_fetch_ptr
= *event
;
3688 /* Generate a HELP_EVENT input_event and store it in the keyboard
3691 HELP is the help form.
3693 FRAME and WINDOW are the frame and window where the help is
3694 generated. OBJECT is the Lisp object where the help was found (a
3695 buffer, a string, an overlay, or nil if neither from a string nor
3696 from a buffer). POS is the position within OBJECT where the help
3700 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3701 Lisp_Object object
, ptrdiff_t pos
)
3703 struct input_event event
;
3707 event
.kind
= HELP_EVENT
;
3708 event
.frame_or_window
= frame
;
3710 event
.x
= WINDOWP (window
) ? window
: frame
;
3713 kbd_buffer_store_event (&event
);
3717 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3720 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3722 struct input_event event
;
3724 event
.kind
= HELP_EVENT
;
3725 event
.frame_or_window
= frame
;
3730 kbd_buffer_store_event (&event
);
3734 /* Discard any mouse events in the event buffer by setting them to
3737 discard_mouse_events (void)
3739 struct input_event
*sp
;
3740 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3742 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3745 if (sp
->kind
== MOUSE_CLICK_EVENT
3746 || sp
->kind
== WHEEL_EVENT
3747 || sp
->kind
== HORIZ_WHEEL_EVENT
3749 || sp
->kind
== GPM_CLICK_EVENT
3751 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3753 sp
->kind
= NO_EVENT
;
3759 /* Return true if there are any real events waiting in the event
3760 buffer, not counting `NO_EVENT's.
3762 Discard NO_EVENT events at the front of the input queue, possibly
3763 leaving the input queue empty if there are no real input events. */
3766 kbd_buffer_events_waiting (void)
3768 struct input_event
*sp
;
3770 for (sp
= kbd_fetch_ptr
;
3771 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3774 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3779 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3783 /* Clear input event EVENT. */
3786 clear_event (struct input_event
*event
)
3788 event
->kind
= NO_EVENT
;
3792 /* Read one event from the event buffer, waiting if necessary.
3793 The value is a Lisp object representing the event.
3794 The value is nil for an event that should be ignored,
3795 or that was handled here.
3796 We always read and discard one event. */
3799 kbd_buffer_get_event (KBOARD
**kbp
,
3800 bool *used_mouse_menu
,
3801 struct timespec
*end_time
)
3806 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3808 /* Start reading input again because we have processed enough to
3809 be able to accept new events again. */
3810 unhold_keyboard_input ();
3813 #endif /* subprocesses */
3815 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3817 /* In case we are running as a daemon, only do this before
3818 detaching from the terminal. */
3819 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3823 *kbp
= current_kboard
;
3826 #endif /* ! HAVE_DBUS */
3828 /* Wait until there is input available. */
3831 /* Break loop if there's an unread command event. Needed in
3832 moused window autoselection which uses a timer to insert such
3834 if (CONSP (Vunread_command_events
))
3837 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3839 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3842 /* If the quit flag is set, then read_char will return
3843 quit_char, so that counts as "available input." */
3844 if (!NILP (Vquit_flag
))
3845 quit_throw_to_read_char (0);
3847 /* One way or another, wait until input is available; then, if
3848 interrupt handlers have not read it, read it now. */
3853 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3855 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3859 struct timespec now
= current_timespec ();
3860 if (timespec_cmp (*end_time
, now
) <= 0)
3861 return Qnil
; /* Finished waiting. */
3864 struct timespec duration
= timespec_sub (*end_time
, now
);
3865 wait_reading_process_output (min (duration
.tv_sec
,
3868 -1, 1, Qnil
, NULL
, 0);
3872 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3874 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3878 if (CONSP (Vunread_command_events
))
3881 first
= XCAR (Vunread_command_events
);
3882 Vunread_command_events
= XCDR (Vunread_command_events
);
3883 *kbp
= current_kboard
;
3887 /* At this point, we know that there is a readable event available
3888 somewhere. If the event queue is empty, then there must be a
3889 mouse movement enabled and available. */
3890 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3892 struct input_event
*event
;
3894 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3898 last_event_timestamp
= event
->timestamp
;
3900 *kbp
= event_to_kboard (event
);
3902 *kbp
= current_kboard
; /* Better than returning null ptr? */
3906 /* These two kinds of events get special handling
3907 and don't actually appear to the command loop.
3908 We return nil for them. */
3909 if (event
->kind
== SELECTION_REQUEST_EVENT
3910 || event
->kind
== SELECTION_CLEAR_EVENT
)
3913 struct input_event copy
;
3915 /* Remove it from the buffer before processing it,
3916 since otherwise swallow_events will see it
3917 and process it again. */
3919 kbd_fetch_ptr
= event
+ 1;
3920 input_pending
= readable_events (0);
3921 x_handle_selection_event (©
);
3923 /* We're getting selection request events, but we don't have
3929 #if defined (HAVE_NS)
3930 else if (event
->kind
== NS_TEXT_EVENT
)
3932 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3933 obj
= list1 (intern ("ns-put-working-text"));
3935 obj
= list1 (intern ("ns-unput-working-text"));
3936 kbd_fetch_ptr
= event
+ 1;
3937 if (used_mouse_menu
)
3938 *used_mouse_menu
= 1;
3942 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3943 || defined (HAVE_NS)
3944 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3946 /* Make an event (delete-frame (FRAME)). */
3947 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3948 kbd_fetch_ptr
= event
+ 1;
3951 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3952 || defined (HAVE_NS)
3953 else if (event
->kind
== ICONIFY_EVENT
)
3955 /* Make an event (iconify-frame (FRAME)). */
3956 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3957 kbd_fetch_ptr
= event
+ 1;
3959 else if (event
->kind
== DEICONIFY_EVENT
)
3961 /* Make an event (make-frame-visible (FRAME)). */
3962 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3963 kbd_fetch_ptr
= event
+ 1;
3966 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3968 /* The value doesn't matter here; only the type is tested. */
3969 XSETBUFFER (obj
, current_buffer
);
3970 kbd_fetch_ptr
= event
+ 1;
3972 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3973 || defined (HAVE_NS) || defined (USE_GTK)
3974 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3976 kbd_fetch_ptr
= event
+ 1;
3977 input_pending
= readable_events (0);
3978 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3979 x_activate_menubar (XFRAME (event
->frame_or_window
));
3983 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3985 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3986 obj
= list4 (Qlanguage_change
,
3987 event
->frame_or_window
,
3988 make_number (event
->code
),
3989 make_number (event
->modifiers
));
3990 kbd_fetch_ptr
= event
+ 1;
3993 #ifdef USE_FILE_NOTIFY
3994 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3996 #ifdef HAVE_W32NOTIFY
3997 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3998 obj
= list3 (Qfile_notify
,
3999 list3 (make_number (event
->code
),
4002 event
->frame_or_window
);
4004 obj
= make_lispy_event (event
);
4006 kbd_fetch_ptr
= event
+ 1;
4008 #endif /* USE_FILE_NOTIFY */
4009 else if (event
->kind
== SAVE_SESSION_EVENT
)
4011 obj
= list2 (Qsave_session
, event
->arg
);
4012 kbd_fetch_ptr
= event
+ 1;
4014 /* Just discard these, by returning nil.
4015 With MULTI_KBOARD, these events are used as placeholders
4016 when we need to randomly delete events from the queue.
4017 (They shouldn't otherwise be found in the buffer,
4018 but on some machines it appears they do show up
4019 even without MULTI_KBOARD.) */
4020 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4021 mouse events during a popup-menu call. */
4022 else if (event
->kind
== NO_EVENT
)
4023 kbd_fetch_ptr
= event
+ 1;
4024 else if (event
->kind
== HELP_EVENT
)
4026 Lisp_Object object
, position
, help
, frame
, window
;
4028 frame
= event
->frame_or_window
;
4029 object
= event
->arg
;
4030 position
= make_number (event
->code
);
4033 clear_event (event
);
4035 kbd_fetch_ptr
= event
+ 1;
4036 if (!WINDOWP (window
))
4038 obj
= Fcons (Qhelp_echo
,
4039 list5 (frame
, help
, window
, object
, position
));
4041 else if (event
->kind
== FOCUS_IN_EVENT
)
4043 /* Notification of a FocusIn event. The frame receiving the
4044 focus is in event->frame_or_window. Generate a
4045 switch-frame event if necessary. */
4046 Lisp_Object frame
, focus
;
4048 frame
= event
->frame_or_window
;
4049 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4058 !EQ (frame
, internal_last_event_frame
)
4059 && !EQ (frame
, selected_frame
))
4060 obj
= make_lispy_switch_frame (frame
);
4062 obj
= make_lispy_focus_in (frame
);
4064 internal_last_event_frame
= frame
;
4065 kbd_fetch_ptr
= event
+ 1;
4067 else if (event
->kind
== FOCUS_OUT_EVENT
)
4069 #ifdef HAVE_WINDOW_SYSTEM
4072 Lisp_Object frame
= event
->frame_or_window
;
4073 bool focused
= false;
4075 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4076 focused
= di
->x_highlight_frame
!= 0;
4079 obj
= make_lispy_focus_out (frame
);
4081 #endif /* HAVE_WINDOW_SYSTEM */
4083 kbd_fetch_ptr
= event
+ 1;
4086 else if (event
->kind
== DBUS_EVENT
)
4088 obj
= make_lispy_event (event
);
4089 kbd_fetch_ptr
= event
+ 1;
4092 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4094 obj
= make_lispy_event (event
);
4095 kbd_fetch_ptr
= event
+ 1;
4099 /* If this event is on a different frame, return a switch-frame this
4100 time, and leave the event in the queue for next time. */
4104 frame
= event
->frame_or_window
;
4106 frame
= XCAR (frame
);
4107 else if (WINDOWP (frame
))
4108 frame
= WINDOW_FRAME (XWINDOW (frame
));
4110 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4114 if (! EQ (frame
, internal_last_event_frame
)
4115 && !EQ (frame
, selected_frame
))
4116 obj
= make_lispy_switch_frame (frame
);
4117 internal_last_event_frame
= frame
;
4119 /* If we didn't decide to make a switch-frame event, go ahead
4120 and build a real event from the queue entry. */
4124 obj
= make_lispy_event (event
);
4126 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4127 || defined (HAVE_NS) || defined (USE_GTK)
4128 /* If this was a menu selection, then set the flag to inhibit
4129 writing to last_nonmenu_event. Don't do this if the event
4130 we're returning is (menu-bar), though; that indicates the
4131 beginning of the menu sequence, and we might as well leave
4132 that as the `event with parameters' for this selection. */
4134 && !EQ (event
->frame_or_window
, event
->arg
)
4135 && (event
->kind
== MENU_BAR_EVENT
4136 || event
->kind
== TOOL_BAR_EVENT
))
4137 *used_mouse_menu
= 1;
4140 /* Certain system events are non-key events. */
4142 && event
->kind
== NS_NONKEY_EVENT
)
4143 *used_mouse_menu
= 1;
4146 /* Wipe out this event, to catch bugs. */
4147 clear_event (event
);
4148 kbd_fetch_ptr
= event
+ 1;
4152 /* Try generating a mouse motion event. */
4153 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4155 struct frame
*f
= some_mouse_moved ();
4156 Lisp_Object bar_window
;
4157 enum scroll_bar_part part
;
4161 *kbp
= current_kboard
;
4162 /* Note that this uses F to determine which terminal to look at.
4163 If there is no valid info, it does not store anything
4164 so x remains nil. */
4167 /* XXX Can f or mouse_position_hook be NULL here? */
4168 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4169 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4174 /* Decide if we should generate a switch-frame event. Don't
4175 generate switch-frame events for motion outside of all Emacs
4181 frame
= FRAME_FOCUS_FRAME (f
);
4183 XSETFRAME (frame
, f
);
4185 if (! EQ (frame
, internal_last_event_frame
)
4186 && !EQ (frame
, selected_frame
))
4187 obj
= make_lispy_switch_frame (frame
);
4188 internal_last_event_frame
= frame
;
4191 /* If we didn't decide to make a switch-frame event, go ahead and
4192 return a mouse-motion event. */
4193 if (!NILP (x
) && NILP (obj
))
4194 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4197 /* We were promised by the above while loop that there was
4198 something for us to read! */
4201 input_pending
= readable_events (0);
4203 Vlast_event_frame
= internal_last_event_frame
;
4208 /* Process any non-user-visible events (currently X selection events),
4209 without reading any user-visible events. */
4212 process_special_events (void)
4214 struct input_event
*event
;
4216 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4218 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4221 if (event
== kbd_store_ptr
)
4225 /* If we find a stored X selection request, handle it now. */
4226 if (event
->kind
== SELECTION_REQUEST_EVENT
4227 || event
->kind
== SELECTION_CLEAR_EVENT
)
4231 /* Remove the event from the fifo buffer before processing;
4232 otherwise swallow_events called recursively could see it
4233 and process it again. To do this, we move the events
4234 between kbd_fetch_ptr and EVENT one slot to the right,
4237 struct input_event copy
= *event
;
4238 struct input_event
*beg
4239 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4240 ? kbd_buffer
: kbd_fetch_ptr
;
4243 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4244 else if (event
< beg
)
4246 if (event
> kbd_buffer
)
4247 memmove (kbd_buffer
+ 1, kbd_buffer
,
4248 (event
- kbd_buffer
) * sizeof (struct input_event
));
4249 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4250 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4251 memmove (beg
+ 1, beg
,
4252 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4253 * sizeof (struct input_event
));
4256 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4257 kbd_fetch_ptr
= kbd_buffer
+ 1;
4261 /* X wants last_event_timestamp for selection ownership. */
4262 last_event_timestamp
= copy
.timestamp
;
4263 input_pending
= readable_events (0);
4264 x_handle_selection_event (©
);
4266 /* We're getting selection request events, but we don't have
4274 /* Process any events that are not user-visible, run timer events that
4275 are ripe, and return, without reading any user-visible events. */
4278 swallow_events (bool do_display
)
4280 unsigned old_timers_run
;
4282 process_special_events ();
4284 old_timers_run
= timers_run
;
4285 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4287 if (timers_run
!= old_timers_run
&& do_display
)
4288 redisplay_preserve_echo_area (7);
4291 /* Record the start of when Emacs is idle,
4292 for the sake of running idle-time timers. */
4295 timer_start_idle (void)
4297 /* If we are already in the idle state, do nothing. */
4298 if (timespec_valid_p (timer_idleness_start_time
))
4301 timer_idleness_start_time
= current_timespec ();
4302 timer_last_idleness_start_time
= timer_idleness_start_time
;
4304 /* Mark all idle-time timers as once again candidates for running. */
4305 call0 (intern ("internal-timer-start-idle"));
4308 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4311 timer_stop_idle (void)
4313 timer_idleness_start_time
= invalid_timespec ();
4316 /* Resume idle timer from last idle start time. */
4319 timer_resume_idle (void)
4321 if (timespec_valid_p (timer_idleness_start_time
))
4324 timer_idleness_start_time
= timer_last_idleness_start_time
;
4327 /* This is only for debugging. */
4328 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4330 /* List of elisp functions to call, delayed because they were generated in
4331 a context where Elisp could not be safely run (e.g. redisplay, signal,
4332 ...). Each element has the form (FUN . ARGS). */
4333 Lisp_Object pending_funcalls
;
4335 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4337 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4339 Lisp_Object
*vector
;
4341 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4343 vector
= XVECTOR (timer
)->contents
;
4344 if (! NILP (vector
[0]))
4347 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4352 /* Check whether a timer has fired. To prevent larger problems we simply
4353 disregard elements that are not proper timers. Do not make a circular
4354 timer list for the time being.
4356 Returns the time to wait until the next timer fires. If a
4357 timer is triggering now, return zero.
4358 If no timer is active, return -1.
4360 If a timer is ripe, we run it, with quitting turned off.
4361 In that case we return 0 to indicate that a new timer_check_2 call
4364 static struct timespec
4365 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4367 struct timespec nexttime
;
4368 struct timespec now
;
4369 struct timespec idleness_now
;
4370 Lisp_Object chosen_timer
;
4371 struct gcpro gcpro1
;
4373 nexttime
= invalid_timespec ();
4375 chosen_timer
= Qnil
;
4376 GCPRO1 (chosen_timer
);
4378 /* First run the code that was delayed. */
4379 while (CONSP (pending_funcalls
))
4381 Lisp_Object funcall
= XCAR (pending_funcalls
);
4382 pending_funcalls
= XCDR (pending_funcalls
);
4383 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4386 if (CONSP (timers
) || CONSP (idle_timers
))
4388 now
= current_timespec ();
4389 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4390 ? timespec_sub (now
, timer_idleness_start_time
)
4391 : make_timespec (0, 0));
4394 while (CONSP (timers
) || CONSP (idle_timers
))
4396 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4397 struct timespec timer_time
, idle_timer_time
;
4398 struct timespec difference
;
4399 struct timespec timer_difference
= invalid_timespec ();
4400 struct timespec idle_timer_difference
= invalid_timespec ();
4401 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4403 /* Set TIMER and TIMER_DIFFERENCE
4404 based on the next ordinary timer.
4405 TIMER_DIFFERENCE is the distance in time from NOW to when
4406 this timer becomes ripe (negative if it's already ripe).
4407 Skip past invalid timers and timers already handled. */
4410 timer
= XCAR (timers
);
4411 if (! decode_timer (timer
, &timer_time
))
4413 timers
= XCDR (timers
);
4417 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4418 timer_difference
= (timer_ripe
4419 ? timespec_sub (now
, timer_time
)
4420 : timespec_sub (timer_time
, now
));
4423 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4424 based on the next idle timer. */
4425 if (CONSP (idle_timers
))
4427 idle_timer
= XCAR (idle_timers
);
4428 if (! decode_timer (idle_timer
, &idle_timer_time
))
4430 idle_timers
= XCDR (idle_timers
);
4434 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4435 idle_timer_difference
4437 ? timespec_sub (idleness_now
, idle_timer_time
)
4438 : timespec_sub (idle_timer_time
, idleness_now
));
4441 /* Decide which timer is the next timer,
4442 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4443 Also step down the list where we found that timer. */
4445 if (timespec_valid_p (timer_difference
)
4446 && (! timespec_valid_p (idle_timer_difference
)
4447 || idle_timer_ripe
< timer_ripe
4448 || (idle_timer_ripe
== timer_ripe
4450 ? timespec_cmp (idle_timer_difference
,
4452 : timespec_cmp (timer_difference
,
4453 idle_timer_difference
))
4456 chosen_timer
= timer
;
4457 timers
= XCDR (timers
);
4458 difference
= timer_difference
;
4463 chosen_timer
= idle_timer
;
4464 idle_timers
= XCDR (idle_timers
);
4465 difference
= idle_timer_difference
;
4466 ripe
= idle_timer_ripe
;
4469 /* If timer is ripe, run it if it hasn't been run. */
4472 if (NILP (AREF (chosen_timer
, 0)))
4474 ptrdiff_t count
= SPECPDL_INDEX ();
4475 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4477 /* Mark the timer as triggered to prevent problems if the lisp
4478 code fails to reschedule it right. */
4479 ASET (chosen_timer
, 0, Qt
);
4481 specbind (Qinhibit_quit
, Qt
);
4483 call1 (Qtimer_event_handler
, chosen_timer
);
4484 Vdeactivate_mark
= old_deactivate_mark
;
4486 unbind_to (count
, Qnil
);
4488 /* Since we have handled the event,
4489 we don't need to tell the caller to wake up and do it. */
4490 /* But the caller must still wait for the next timer, so
4491 return 0 to indicate that. */
4494 nexttime
= make_timespec (0, 0);
4498 /* When we encounter a timer that is still waiting,
4499 return the amount of time to wait before it is ripe. */
4506 /* No timers are pending in the future. */
4507 /* Return 0 if we generated an event, and -1 if not. */
4513 /* Check whether a timer has fired. To prevent larger problems we simply
4514 disregard elements that are not proper timers. Do not make a circular
4515 timer list for the time being.
4517 Returns the time to wait until the next timer fires.
4518 If no timer is active, return an invalid value.
4520 As long as any timer is ripe, we run it. */
4525 struct timespec nexttime
;
4526 Lisp_Object timers
, idle_timers
;
4527 struct gcpro gcpro1
, gcpro2
;
4529 Lisp_Object tem
= Vinhibit_quit
;
4532 /* We use copies of the timers' lists to allow a timer to add itself
4533 again, without locking up Emacs if the newly added timer is
4534 already ripe when added. */
4536 /* Always consider the ordinary timers. */
4537 timers
= Fcopy_sequence (Vtimer_list
);
4538 /* Consider the idle timers only if Emacs is idle. */
4539 if (timespec_valid_p (timer_idleness_start_time
))
4540 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4544 Vinhibit_quit
= tem
;
4546 GCPRO2 (timers
, idle_timers
);
4550 nexttime
= timer_check_2 (timers
, idle_timers
);
4552 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4558 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4559 doc
: /* Return the current length of Emacs idleness, or nil.
4560 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4561 in the same style as (current-time).
4563 The value when Emacs is not idle is nil.
4565 PSEC is a multiple of the system clock resolution. */)
4568 if (timespec_valid_p (timer_idleness_start_time
))
4569 return make_lisp_time (timespec_sub (current_timespec (),
4570 timer_idleness_start_time
));
4575 /* Caches for modify_event_symbol. */
4576 static Lisp_Object accent_key_syms
;
4577 static Lisp_Object func_key_syms
;
4578 static Lisp_Object mouse_syms
;
4579 static Lisp_Object wheel_syms
;
4580 static Lisp_Object drag_n_drop_syms
;
4582 /* This is a list of keysym codes for special "accent" characters.
4583 It parallels lispy_accent_keys. */
4585 static const int lispy_accent_codes
[] =
4587 #ifdef XK_dead_circumflex
4592 #ifdef XK_dead_grave
4597 #ifdef XK_dead_tilde
4602 #ifdef XK_dead_diaeresis
4607 #ifdef XK_dead_macron
4612 #ifdef XK_dead_degree
4617 #ifdef XK_dead_acute
4622 #ifdef XK_dead_cedilla
4627 #ifdef XK_dead_breve
4632 #ifdef XK_dead_ogonek
4637 #ifdef XK_dead_caron
4642 #ifdef XK_dead_doubleacute
4643 XK_dead_doubleacute
,
4647 #ifdef XK_dead_abovedot
4652 #ifdef XK_dead_abovering
4662 #ifdef XK_dead_belowdot
4667 #ifdef XK_dead_voiced_sound
4668 XK_dead_voiced_sound
,
4672 #ifdef XK_dead_semivoiced_sound
4673 XK_dead_semivoiced_sound
,
4689 /* This is a list of Lisp names for special "accent" characters.
4690 It parallels lispy_accent_codes. */
4692 static const char *const lispy_accent_keys
[] =
4710 "dead-voiced-sound",
4711 "dead-semivoiced-sound",
4717 #define FUNCTION_KEY_OFFSET 0x0
4719 const char *const lispy_function_keys
[] =
4723 0, /* VK_LBUTTON 0x01 */
4724 0, /* VK_RBUTTON 0x02 */
4725 "cancel", /* VK_CANCEL 0x03 */
4726 0, /* VK_MBUTTON 0x04 */
4728 0, 0, 0, /* 0x05 .. 0x07 */
4730 "backspace", /* VK_BACK 0x08 */
4731 "tab", /* VK_TAB 0x09 */
4733 0, 0, /* 0x0A .. 0x0B */
4735 "clear", /* VK_CLEAR 0x0C */
4736 "return", /* VK_RETURN 0x0D */
4738 0, 0, /* 0x0E .. 0x0F */
4740 0, /* VK_SHIFT 0x10 */
4741 0, /* VK_CONTROL 0x11 */
4742 0, /* VK_MENU 0x12 */
4743 "pause", /* VK_PAUSE 0x13 */
4744 "capslock", /* VK_CAPITAL 0x14 */
4745 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4747 "junja", /* VK_JUNJA 0x17 */
4748 "final", /* VK_FINAL 0x18 */
4749 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4751 "escape", /* VK_ESCAPE 0x1B */
4752 "convert", /* VK_CONVERT 0x1C */
4753 "non-convert", /* VK_NONCONVERT 0x1D */
4754 "accept", /* VK_ACCEPT 0x1E */
4755 "mode-change", /* VK_MODECHANGE 0x1F */
4756 0, /* VK_SPACE 0x20 */
4757 "prior", /* VK_PRIOR 0x21 */
4758 "next", /* VK_NEXT 0x22 */
4759 "end", /* VK_END 0x23 */
4760 "home", /* VK_HOME 0x24 */
4761 "left", /* VK_LEFT 0x25 */
4762 "up", /* VK_UP 0x26 */
4763 "right", /* VK_RIGHT 0x27 */
4764 "down", /* VK_DOWN 0x28 */
4765 "select", /* VK_SELECT 0x29 */
4766 "print", /* VK_PRINT 0x2A */
4767 "execute", /* VK_EXECUTE 0x2B */
4768 "snapshot", /* VK_SNAPSHOT 0x2C */
4769 "insert", /* VK_INSERT 0x2D */
4770 "delete", /* VK_DELETE 0x2E */
4771 "help", /* VK_HELP 0x2F */
4773 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4775 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4777 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4779 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4781 0, 0, 0, 0, 0, 0, 0, 0, 0,
4782 0, 0, 0, 0, 0, 0, 0, 0, 0,
4783 0, 0, 0, 0, 0, 0, 0, 0,
4785 "lwindow", /* VK_LWIN 0x5B */
4786 "rwindow", /* VK_RWIN 0x5C */
4787 "apps", /* VK_APPS 0x5D */
4790 "kp-0", /* VK_NUMPAD0 0x60 */
4791 "kp-1", /* VK_NUMPAD1 0x61 */
4792 "kp-2", /* VK_NUMPAD2 0x62 */
4793 "kp-3", /* VK_NUMPAD3 0x63 */
4794 "kp-4", /* VK_NUMPAD4 0x64 */
4795 "kp-5", /* VK_NUMPAD5 0x65 */
4796 "kp-6", /* VK_NUMPAD6 0x66 */
4797 "kp-7", /* VK_NUMPAD7 0x67 */
4798 "kp-8", /* VK_NUMPAD8 0x68 */
4799 "kp-9", /* VK_NUMPAD9 0x69 */
4800 "kp-multiply", /* VK_MULTIPLY 0x6A */
4801 "kp-add", /* VK_ADD 0x6B */
4802 "kp-separator", /* VK_SEPARATOR 0x6C */
4803 "kp-subtract", /* VK_SUBTRACT 0x6D */
4804 "kp-decimal", /* VK_DECIMAL 0x6E */
4805 "kp-divide", /* VK_DIVIDE 0x6F */
4806 "f1", /* VK_F1 0x70 */
4807 "f2", /* VK_F2 0x71 */
4808 "f3", /* VK_F3 0x72 */
4809 "f4", /* VK_F4 0x73 */
4810 "f5", /* VK_F5 0x74 */
4811 "f6", /* VK_F6 0x75 */
4812 "f7", /* VK_F7 0x76 */
4813 "f8", /* VK_F8 0x77 */
4814 "f9", /* VK_F9 0x78 */
4815 "f10", /* VK_F10 0x79 */
4816 "f11", /* VK_F11 0x7A */
4817 "f12", /* VK_F12 0x7B */
4818 "f13", /* VK_F13 0x7C */
4819 "f14", /* VK_F14 0x7D */
4820 "f15", /* VK_F15 0x7E */
4821 "f16", /* VK_F16 0x7F */
4822 "f17", /* VK_F17 0x80 */
4823 "f18", /* VK_F18 0x81 */
4824 "f19", /* VK_F19 0x82 */
4825 "f20", /* VK_F20 0x83 */
4826 "f21", /* VK_F21 0x84 */
4827 "f22", /* VK_F22 0x85 */
4828 "f23", /* VK_F23 0x86 */
4829 "f24", /* VK_F24 0x87 */
4831 0, 0, 0, 0, /* 0x88 .. 0x8B */
4832 0, 0, 0, 0, /* 0x8C .. 0x8F */
4834 "kp-numlock", /* VK_NUMLOCK 0x90 */
4835 "scroll", /* VK_SCROLL 0x91 */
4836 /* Not sure where the following block comes from.
4837 Windows headers have NEC and Fujitsu specific keys in
4838 this block, but nothing generic. */
4839 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4840 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4841 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4842 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4843 "kp-end", /* VK_NUMPAD_END 0x96 */
4844 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4845 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4846 "kp-up", /* VK_NUMPAD_UP 0x99 */
4847 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4848 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4849 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4850 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4852 0, 0, /* 0x9E .. 0x9F */
4855 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4856 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4857 * No other API or message will distinguish left and right keys this way.
4862 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4863 to enable them selectively, and gives access to a few more functions.
4864 See lispy_multimedia_keys below. */
4865 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4866 0, 0, 0, /* 0xAD .. 0xAF Volume */
4867 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4868 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4870 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4871 0, 0, 0, 0, 0, 0, 0, 0, 0,
4873 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4874 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4875 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4878 "ax", /* VK_OEM_AX 0xE1 */
4879 0, /* VK_OEM_102 0xE2 */
4880 "ico-help", /* VK_ICO_HELP 0xE3 */
4881 "ico-00", /* VK_ICO_00 0xE4 */
4882 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4883 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4884 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4886 "reset", /* VK_OEM_RESET 0xE9 */
4887 "jump", /* VK_OEM_JUMP 0xEA */
4888 "oem-pa1", /* VK_OEM_PA1 0xEB */
4889 "oem-pa2", /* VK_OEM_PA2 0xEC */
4890 "oem-pa3", /* VK_OEM_PA3 0xED */
4891 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4892 "cusel", /* VK_OEM_CUSEL 0xEF */
4893 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4894 "finish", /* VK_OEM_FINISH 0xF1 */
4895 "copy", /* VK_OEM_COPY 0xF2 */
4896 "auto", /* VK_OEM_AUTO 0xF3 */
4897 "enlw", /* VK_OEM_ENLW 0xF4 */
4898 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4899 "attn", /* VK_ATTN 0xF6 */
4900 "crsel", /* VK_CRSEL 0xF7 */
4901 "exsel", /* VK_EXSEL 0xF8 */
4902 "ereof", /* VK_EREOF 0xF9 */
4903 "play", /* VK_PLAY 0xFA */
4904 "zoom", /* VK_ZOOM 0xFB */
4905 "noname", /* VK_NONAME 0xFC */
4906 "pa1", /* VK_PA1 0xFD */
4907 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4911 /* Some of these duplicate the "Media keys" on newer keyboards,
4912 but they are delivered to the application in a different way. */
4913 static const char *const lispy_multimedia_keys
[] =
4921 "browser-favorites",
4958 "toggle-dictate-command",
4964 "media-fast-forward",
4967 "media-channel-down"
4970 #else /* not HAVE_NTGUI */
4972 /* This should be dealt with in XTread_socket now, and that doesn't
4973 depend on the client system having the Kana syms defined. See also
4974 the XK_kana_A case below. */
4977 static const char *const lispy_kana_keys
[] =
4979 /* X Keysym value */
4980 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4981 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4982 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4983 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4984 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4985 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4986 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4987 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4988 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4989 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4990 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4991 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4992 "kana-i", "kana-u", "kana-e", "kana-o",
4993 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4994 "prolongedsound", "kana-A", "kana-I", "kana-U",
4995 "kana-E", "kana-O", "kana-KA", "kana-KI",
4996 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4997 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4998 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4999 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5000 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5001 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5002 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5003 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5004 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5005 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5006 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5007 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5009 #endif /* XK_kana_A */
5012 #define FUNCTION_KEY_OFFSET 0xff00
5014 /* You'll notice that this table is arranged to be conveniently
5015 indexed by X Windows keysym values. */
5016 static const char *const lispy_function_keys
[] =
5018 /* X Keysym value */
5020 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5021 "backspace", "tab", "linefeed", "clear",
5023 0, 0, 0, "pause", /* 0xff10...1f */
5024 0, 0, 0, 0, 0, 0, 0, "escape",
5026 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5027 "romaji", "hiragana", "katakana", "hiragana-katakana",
5028 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5029 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5030 "eisu-toggle", /* 0xff30...3f */
5031 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5032 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5034 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5035 "down", "prior", "next", "end",
5036 "begin", 0, 0, 0, 0, 0, 0, 0,
5037 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5048 "break", /* 0xff6b */
5051 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5052 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5053 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5054 0, 0, 0, 0, 0, 0, 0, 0,
5055 "kp-tab", /* 0xff89 */
5057 "kp-enter", /* 0xff8d */
5059 "kp-f1", /* 0xff91 */
5063 "kp-home", /* 0xff95 */
5068 "kp-prior", /* kp-page-up */
5069 "kp-next", /* kp-page-down */
5075 0, 0, 0, 0, 0, 0, 0, 0, 0,
5076 "kp-multiply", /* 0xffaa */
5081 "kp-divide", /* 0xffaf */
5082 "kp-0", /* 0xffb0 */
5083 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5086 "kp-equal", /* 0xffbd */
5087 "f1", /* 0xffbe */ /* IsFunctionKey */
5089 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5090 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5091 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5092 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5093 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5094 0, 0, 0, 0, 0, 0, 0, 0,
5095 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5096 0, 0, 0, 0, 0, 0, 0, "delete"
5099 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5100 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5102 static const char *const iso_lispy_function_keys
[] =
5104 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5105 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5106 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5107 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5108 "iso-lefttab", /* 0xfe20 */
5109 "iso-move-line-up", "iso-move-line-down",
5110 "iso-partial-line-up", "iso-partial-line-down",
5111 "iso-partial-space-left", "iso-partial-space-right",
5112 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5113 "iso-release-margin-left", "iso-release-margin-right",
5114 "iso-release-both-margins",
5115 "iso-fast-cursor-left", "iso-fast-cursor-right",
5116 "iso-fast-cursor-up", "iso-fast-cursor-down",
5117 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5118 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5121 #endif /* not HAVE_NTGUI */
5123 static Lisp_Object Vlispy_mouse_stem
;
5125 static const char *const lispy_wheel_names
[] =
5127 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5130 /* drag-n-drop events are generated when a set of selected files are
5131 dragged from another application and dropped onto an Emacs window. */
5132 static const char *const lispy_drag_n_drop_names
[] =
5137 /* Scroll bar parts. */
5138 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5139 Lisp_Object Qup
, Qdown
, Qbottom
;
5140 static Lisp_Object Qend_scroll
;
5142 static Lisp_Object Qratio
;
5144 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5145 static Lisp_Object
*const scroll_bar_parts
[] = {
5146 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5147 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5150 /* A vector, indexed by button number, giving the down-going location
5151 of currently depressed buttons, both scroll bar and non-scroll bar.
5153 The elements have the form
5154 (BUTTON-NUMBER MODIFIER-MASK . REST)
5155 where REST is the cdr of a position as it would be reported in the event.
5157 The make_lispy_event function stores positions here to tell the
5158 difference between click and drag events, and to store the starting
5159 location to be included in drag events. */
5161 static Lisp_Object button_down_location
;
5163 /* Information about the most recent up-going button event: Which
5164 button, what location, and what time. */
5166 static int last_mouse_button
;
5167 static int last_mouse_x
;
5168 static int last_mouse_y
;
5169 static Time button_down_time
;
5171 /* The number of clicks in this multiple-click. */
5173 static int double_click_count
;
5175 /* X and Y are frame-relative coordinates for a click or wheel event.
5176 Return a Lisp-style event list. */
5179 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5182 enum window_part part
;
5183 Lisp_Object posn
= Qnil
;
5184 Lisp_Object extra_info
= Qnil
;
5185 /* Coordinate pixel positions to return. */
5186 int xret
= 0, yret
= 0;
5187 /* The window under frame pixel coordinates (x,y) */
5188 Lisp_Object window
= f
5189 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5192 if (WINDOWP (window
))
5194 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5195 struct window
*w
= XWINDOW (window
);
5196 Lisp_Object string_info
= Qnil
;
5197 ptrdiff_t textpos
= -1;
5198 int col
= -1, row
= -1;
5199 int dx
= -1, dy
= -1;
5200 int width
= -1, height
= -1;
5201 Lisp_Object object
= Qnil
;
5203 /* Pixel coordinates relative to the window corner. */
5204 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5205 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5207 /* For text area clicks, return X, Y relative to the corner of
5208 this text area. Note that dX, dY etc are set below, by
5209 buffer_posn_from_coords. */
5210 if (part
== ON_TEXT
)
5212 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5213 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5215 /* For mode line and header line clicks, return X, Y relative to
5216 the left window edge. Use mode_line_string to look for a
5217 string on the click position. */
5218 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5223 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5224 /* Note that mode_line_string takes COL, ROW as pixels and
5225 converts them to characters. */
5228 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5229 &object
, &dx
, &dy
, &width
, &height
);
5230 if (STRINGP (string
))
5231 string_info
= Fcons (string
, make_number (charpos
));
5232 textpos
= (w
== XWINDOW (selected_window
)
5233 && current_buffer
== XBUFFER (w
->contents
))
5234 ? PT
: marker_position (w
->pointm
);
5239 /* For fringes and margins, Y is relative to the area's (and the
5240 window's) top edge, while X is meaningless. */
5241 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5246 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5249 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5250 &object
, &dx
, &dy
, &width
, &height
);
5251 if (STRINGP (string
))
5252 string_info
= Fcons (string
, make_number (charpos
));
5253 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5255 else if (part
== ON_LEFT_FRINGE
)
5257 posn
= Qleft_fringe
;
5260 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5261 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5262 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5264 else if (part
== ON_RIGHT_FRINGE
)
5266 posn
= Qright_fringe
;
5269 - window_box_width (w
, LEFT_MARGIN_AREA
)
5270 - window_box_width (w
, TEXT_AREA
)
5271 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5272 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5274 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5276 else if (part
== ON_VERTICAL_BORDER
)
5278 posn
= Qvertical_line
;
5283 /* Nothing special for part == ON_SCROLL_BAR. */
5285 /* For clicks in the text area, fringes, or margins, call
5286 buffer_posn_from_coords to extract TEXTPOS, the buffer
5287 position nearest to the click. */
5290 Lisp_Object string2
, object2
= Qnil
;
5291 struct display_pos p
;
5293 int width2
, height2
;
5294 /* The pixel X coordinate passed to buffer_posn_from_coords
5295 is the X coordinate relative to the text area for
5296 text-area and right-margin clicks, zero otherwise. */
5298 = (part
== ON_TEXT
) ? xret
5299 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5300 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5304 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5305 &object2
, &dx2
, &dy2
,
5307 textpos
= CHARPOS (p
.pos
);
5308 if (col
< 0) col
= x2
;
5309 if (row
< 0) row
= y2
;
5310 if (dx
< 0) dx
= dx2
;
5311 if (dy
< 0) dy
= dy2
;
5312 if (width
< 0) width
= width2
;
5313 if (height
< 0) height
= height2
;
5317 posn
= make_number (textpos
);
5318 if (STRINGP (string2
))
5319 string_info
= Fcons (string2
,
5320 make_number (CHARPOS (p
.string_pos
)));
5326 #ifdef HAVE_WINDOW_SYSTEM
5327 if (IMAGEP (object
))
5329 Lisp_Object image_map
, hotspot
;
5330 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5332 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5334 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5335 posn
= XCAR (hotspot
);
5342 Fcons (make_number (dx
), make_number (dy
)),
5343 Fcons (make_number (width
), make_number (height
)));
5346 extra_info
= Fcons (string_info
,
5347 Fcons (make_number (textpos
),
5348 Fcons (Fcons (make_number (col
),
5353 XSETFRAME (window
, f
);
5357 return Fcons (window
,
5359 Fcons (Fcons (make_number (xret
),
5360 make_number (yret
)),
5361 Fcons (make_number (t
),
5365 /* Given a struct input_event, build the lisp event which represents
5366 it. If EVENT is 0, build a mouse movement event from the mouse
5367 movement buffer, which should have a movement event in it.
5369 Note that events must be passed to this function in the order they
5370 are received; this function stores the location of button presses
5371 in order to build drag events when the button is released. */
5374 make_lispy_event (struct input_event
*event
)
5378 switch (event
->kind
)
5380 /* A simple keystroke. */
5381 case ASCII_KEYSTROKE_EVENT
:
5382 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5384 Lisp_Object lispy_c
;
5385 EMACS_INT c
= event
->code
;
5386 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5389 eassert (c
== event
->code
);
5390 /* Turn ASCII characters into control characters
5392 if (event
->modifiers
& ctrl_modifier
)
5394 c
= make_ctrl_char (c
);
5395 event
->modifiers
&= ~ctrl_modifier
;
5399 /* Add in the other modifier bits. The shift key was taken care
5400 of by the X code. */
5401 c
|= (event
->modifiers
5402 & (meta_modifier
| alt_modifier
5403 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5404 /* Distinguish Shift-SPC from SPC. */
5405 if ((event
->code
) == 040
5406 && event
->modifiers
& shift_modifier
)
5407 c
|= shift_modifier
;
5408 button_down_time
= 0;
5409 XSETFASTINT (lispy_c
, c
);
5414 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5415 except that they are non-key events (last-nonmenu-event is nil). */
5416 case NS_NONKEY_EVENT
:
5419 /* A function key. The symbol may need to have modifier prefixes
5421 case NON_ASCII_KEYSTROKE_EVENT
:
5422 button_down_time
= 0;
5424 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5425 if (event
->code
== lispy_accent_codes
[i
])
5426 return modify_event_symbol (i
,
5428 Qfunction_key
, Qnil
,
5429 lispy_accent_keys
, &accent_key_syms
,
5430 (sizeof (lispy_accent_keys
)
5431 / sizeof (lispy_accent_keys
[0])));
5435 if (event
->code
>= 0x400 && event
->code
< 0x500)
5436 return modify_event_symbol (event
->code
- 0x400,
5437 event
->modifiers
& ~shift_modifier
,
5438 Qfunction_key
, Qnil
,
5439 lispy_kana_keys
, &func_key_syms
,
5440 (sizeof (lispy_kana_keys
)
5441 / sizeof (lispy_kana_keys
[0])));
5442 #endif /* XK_kana_A */
5445 #ifdef ISO_FUNCTION_KEY_OFFSET
5446 if (event
->code
< FUNCTION_KEY_OFFSET
5447 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5448 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5450 Qfunction_key
, Qnil
,
5451 iso_lispy_function_keys
, &func_key_syms
,
5452 (sizeof (iso_lispy_function_keys
)
5453 / sizeof (iso_lispy_function_keys
[0])));
5456 /* Handle system-specific or unknown keysyms. */
5457 if (event
->code
& (1 << 28)
5458 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5459 || (event
->code
- FUNCTION_KEY_OFFSET
5460 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5461 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5463 /* We need to use an alist rather than a vector as the cache
5464 since we can't make a vector long enough. */
5465 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5466 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5467 return modify_event_symbol (event
->code
,
5470 KVAR (current_kboard
, Vsystem_key_alist
),
5471 0, &KVAR (current_kboard
, system_key_syms
),
5475 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5477 Qfunction_key
, Qnil
,
5478 lispy_function_keys
, &func_key_syms
,
5479 (sizeof (lispy_function_keys
)
5480 / sizeof (lispy_function_keys
[0])));
5483 case MULTIMEDIA_KEY_EVENT
:
5484 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5485 / sizeof (lispy_multimedia_keys
[0]))
5486 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5488 return modify_event_symbol (event
->code
, event
->modifiers
,
5489 Qfunction_key
, Qnil
,
5490 lispy_multimedia_keys
, &func_key_syms
,
5491 (sizeof (lispy_multimedia_keys
)
5492 / sizeof (lispy_multimedia_keys
[0])));
5497 /* A mouse click. Figure out where it is, decide whether it's
5498 a press, click or drag, and build the appropriate structure. */
5499 case MOUSE_CLICK_EVENT
:
5500 #ifndef USE_TOOLKIT_SCROLL_BARS
5501 case SCROLL_BAR_CLICK_EVENT
:
5504 int button
= event
->code
;
5506 Lisp_Object position
;
5507 Lisp_Object
*start_pos_ptr
;
5508 Lisp_Object start_pos
;
5512 /* Build the position as appropriate for this mouse click. */
5513 if (event
->kind
== MOUSE_CLICK_EVENT
)
5515 struct frame
*f
= XFRAME (event
->frame_or_window
);
5516 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5520 /* Ignore mouse events that were made on frame that
5521 have been deleted. */
5522 if (! FRAME_LIVE_P (f
))
5525 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5526 /* EVENT->x and EVENT->y are frame-relative pixel
5527 coordinates at this place. Under old redisplay, COLUMN
5528 and ROW are set to frame relative glyph coordinates
5529 which are then used to determine whether this click is
5530 in a menu (non-toolkit version). */
5531 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5532 &column
, &row
, NULL
, 1);
5534 /* In the non-toolkit version, clicks on the menu bar
5535 are ordinary button events in the event buffer.
5536 Distinguish them, and invoke the menu.
5538 (In the toolkit version, the toolkit handles the menu bar
5539 and Emacs doesn't know about it until after the user
5540 makes a selection.) */
5541 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5542 && (event
->modifiers
& down_modifier
))
5544 Lisp_Object items
, item
;
5546 /* Find the menu bar item under `column'. */
5548 items
= FRAME_MENU_BAR_ITEMS (f
);
5549 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5551 Lisp_Object pos
, string
;
5552 string
= AREF (items
, i
+ 1);
5553 pos
= AREF (items
, i
+ 3);
5556 if (column
>= XINT (pos
)
5557 && column
< XINT (pos
) + SCHARS (string
))
5559 item
= AREF (items
, i
);
5564 /* ELisp manual 2.4b says (x y) are window relative but
5565 code says they are frame-relative. */
5566 position
= list4 (event
->frame_or_window
,
5568 Fcons (event
->x
, event
->y
),
5569 make_number (event
->timestamp
));
5571 return list2 (item
, position
);
5573 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5575 position
= make_lispy_position (f
, event
->x
, event
->y
,
5578 #ifndef USE_TOOLKIT_SCROLL_BARS
5581 /* It's a scrollbar click. */
5583 Lisp_Object portion_whole
;
5586 window
= event
->frame_or_window
;
5587 portion_whole
= Fcons (event
->x
, event
->y
);
5588 part
= *scroll_bar_parts
[(int) event
->part
];
5590 position
= list5 (window
, Qvertical_scroll_bar
,
5591 portion_whole
, make_number (event
->timestamp
),
5594 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5596 if (button
>= ASIZE (button_down_location
))
5598 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5599 button_down_location
= larger_vector (button_down_location
,
5601 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5604 start_pos_ptr
= aref_addr (button_down_location
, button
);
5605 start_pos
= *start_pos_ptr
;
5606 *start_pos_ptr
= Qnil
;
5609 /* On window-system frames, use the value of
5610 double-click-fuzz as is. On other frames, interpret it
5611 as a multiple of 1/8 characters. */
5615 if (WINDOWP (event
->frame_or_window
))
5616 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5617 else if (FRAMEP (event
->frame_or_window
))
5618 f
= XFRAME (event
->frame_or_window
);
5622 if (FRAME_WINDOW_P (f
))
5623 fuzz
= double_click_fuzz
;
5625 fuzz
= double_click_fuzz
/ 8;
5627 is_double
= (button
== last_mouse_button
5628 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5629 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5630 && button_down_time
!= 0
5631 && (EQ (Vdouble_click_time
, Qt
)
5632 || (NATNUMP (Vdouble_click_time
)
5633 && (event
->timestamp
- button_down_time
5634 < XFASTINT (Vdouble_click_time
)))));
5637 last_mouse_button
= button
;
5638 last_mouse_x
= XINT (event
->x
);
5639 last_mouse_y
= XINT (event
->y
);
5641 /* If this is a button press, squirrel away the location, so
5642 we can decide later whether it was a click or a drag. */
5643 if (event
->modifiers
& down_modifier
)
5647 double_click_count
++;
5648 event
->modifiers
|= ((double_click_count
> 2)
5653 double_click_count
= 1;
5654 button_down_time
= event
->timestamp
;
5655 *start_pos_ptr
= Fcopy_alist (position
);
5656 ignore_mouse_drag_p
= 0;
5659 /* Now we're releasing a button - check the co-ordinates to
5660 see if this was a click or a drag. */
5661 else if (event
->modifiers
& up_modifier
)
5663 /* If we did not see a down before this up, ignore the up.
5664 Probably this happened because the down event chose a
5665 menu item. It would be an annoyance to treat the
5666 release of the button that chose the menu item as a
5669 if (!CONSP (start_pos
))
5672 event
->modifiers
&= ~up_modifier
;
5675 Lisp_Object new_down
, down
;
5676 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5678 /* The third element of every position
5679 should be the (x,y) pair. */
5680 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5681 new_down
= Fcar (Fcdr (Fcdr (position
)));
5684 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5686 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5687 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5690 if (ignore_mouse_drag_p
)
5692 event
->modifiers
|= click_modifier
;
5693 ignore_mouse_drag_p
= 0;
5695 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5696 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5697 /* Maybe the mouse has moved a lot, caused scrolling, and
5698 eventually ended up at the same screen position (but
5699 not buffer position) in which case it is a drag, not
5701 /* FIXME: OTOH if the buffer position has changed
5702 because of a timer or process filter rather than
5703 because of mouse movement, it should be considered as
5704 a click. But mouse-drag-region completely ignores
5705 this case and it hasn't caused any real problem, so
5706 it's probably OK to ignore it as well. */
5707 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5708 /* Mouse hasn't moved (much). */
5709 event
->modifiers
|= click_modifier
;
5712 button_down_time
= 0;
5713 event
->modifiers
|= drag_modifier
;
5716 /* Don't check is_double; treat this as multiple
5717 if the down-event was multiple. */
5718 if (double_click_count
> 1)
5719 event
->modifiers
|= ((double_click_count
> 2)
5725 /* Every mouse event should either have the down_modifier or
5726 the up_modifier set. */
5730 /* Get the symbol we should use for the mouse click. */
5733 head
= modify_event_symbol (button
,
5735 Qmouse_click
, Vlispy_mouse_stem
,
5738 ASIZE (mouse_syms
));
5739 if (event
->modifiers
& drag_modifier
)
5740 return list3 (head
, start_pos
, position
);
5741 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5742 return list3 (head
, position
, make_number (double_click_count
));
5744 return list2 (head
, position
);
5749 case HORIZ_WHEEL_EVENT
:
5751 Lisp_Object position
;
5754 /* Build the position as appropriate for this mouse click. */
5755 struct frame
*f
= XFRAME (event
->frame_or_window
);
5757 /* Ignore wheel events that were made on frame that have been
5759 if (! FRAME_LIVE_P (f
))
5762 position
= make_lispy_position (f
, event
->x
, event
->y
,
5765 /* Set double or triple modifiers to indicate the wheel speed. */
5767 /* On window-system frames, use the value of
5768 double-click-fuzz as is. On other frames, interpret it
5769 as a multiple of 1/8 characters. */
5775 if (WINDOWP (event
->frame_or_window
))
5776 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5777 else if (FRAMEP (event
->frame_or_window
))
5778 fr
= XFRAME (event
->frame_or_window
);
5782 fuzz
= FRAME_WINDOW_P (fr
)
5783 ? double_click_fuzz
: double_click_fuzz
/ 8;
5785 if (event
->modifiers
& up_modifier
)
5787 /* Emit a wheel-up event. */
5788 event
->modifiers
&= ~up_modifier
;
5791 else if (event
->modifiers
& down_modifier
)
5793 /* Emit a wheel-down event. */
5794 event
->modifiers
&= ~down_modifier
;
5798 /* Every wheel event should either have the down_modifier or
5799 the up_modifier set. */
5802 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5805 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5806 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5807 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5808 && button_down_time
!= 0
5809 && (EQ (Vdouble_click_time
, Qt
)
5810 || (NATNUMP (Vdouble_click_time
)
5811 && (event
->timestamp
- button_down_time
5812 < XFASTINT (Vdouble_click_time
)))));
5815 double_click_count
++;
5816 event
->modifiers
|= ((double_click_count
> 2)
5822 double_click_count
= 1;
5823 event
->modifiers
|= click_modifier
;
5826 button_down_time
= event
->timestamp
;
5827 /* Use a negative value to distinguish wheel from mouse button. */
5828 last_mouse_button
= - (1 + symbol_num
);
5829 last_mouse_x
= XINT (event
->x
);
5830 last_mouse_y
= XINT (event
->y
);
5832 /* Get the symbol we should use for the wheel event. */
5833 head
= modify_event_symbol (symbol_num
,
5839 ASIZE (wheel_syms
));
5842 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5843 return list3 (head
, position
, make_number (double_click_count
));
5845 return list2 (head
, position
);
5849 #ifdef USE_TOOLKIT_SCROLL_BARS
5851 /* We don't have down and up events if using toolkit scroll bars,
5852 so make this always a click event. Store in the `part' of
5853 the Lisp event a symbol which maps to the following actions:
5855 `above_handle' page up
5856 `below_handle' page down
5860 `bottom' bottom of buffer
5861 `handle' thumb has been dragged.
5862 `end-scroll' end of interaction with scroll bar
5864 The incoming input_event contains in its `part' member an
5865 index of type `enum scroll_bar_part' which we can use as an
5866 index in scroll_bar_parts to get the appropriate symbol. */
5868 case SCROLL_BAR_CLICK_EVENT
:
5870 Lisp_Object position
, head
, window
, portion_whole
, part
;
5872 window
= event
->frame_or_window
;
5873 portion_whole
= Fcons (event
->x
, event
->y
);
5874 part
= *scroll_bar_parts
[(int) event
->part
];
5876 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5877 make_number (event
->timestamp
), part
);
5879 /* Always treat scroll bar events as clicks. */
5880 event
->modifiers
|= click_modifier
;
5881 event
->modifiers
&= ~up_modifier
;
5883 if (event
->code
>= ASIZE (mouse_syms
))
5884 mouse_syms
= larger_vector (mouse_syms
,
5885 event
->code
- ASIZE (mouse_syms
) + 1,
5888 /* Get the symbol we should use for the mouse click. */
5889 head
= modify_event_symbol (event
->code
,
5894 ASIZE (mouse_syms
));
5895 return list2 (head
, position
);
5898 #endif /* USE_TOOLKIT_SCROLL_BARS */
5900 case DRAG_N_DROP_EVENT
:
5903 Lisp_Object head
, position
;
5906 f
= XFRAME (event
->frame_or_window
);
5909 /* Ignore mouse events that were made on frames that
5910 have been deleted. */
5911 if (! FRAME_LIVE_P (f
))
5914 position
= make_lispy_position (f
, event
->x
, event
->y
,
5917 head
= modify_event_symbol (0, event
->modifiers
,
5919 lispy_drag_n_drop_names
,
5920 &drag_n_drop_syms
, 1);
5921 return list3 (head
, position
, files
);
5924 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5925 || defined (HAVE_NS) || defined (USE_GTK)
5926 case MENU_BAR_EVENT
:
5927 if (EQ (event
->arg
, event
->frame_or_window
))
5928 /* This is the prefix key. We translate this to
5929 `(menu_bar)' because the code in keyboard.c for menu
5930 events, which we use, relies on this. */
5931 return list1 (Qmenu_bar
);
5935 case SELECT_WINDOW_EVENT
:
5936 /* Make an event (select-window (WINDOW)). */
5937 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5939 case TOOL_BAR_EVENT
:
5940 if (EQ (event
->arg
, event
->frame_or_window
))
5941 /* This is the prefix key. We translate this to
5942 `(tool_bar)' because the code in keyboard.c for tool bar
5943 events, which we use, relies on this. */
5944 return list1 (Qtool_bar
);
5945 else if (SYMBOLP (event
->arg
))
5946 return apply_modifiers (event
->modifiers
, event
->arg
);
5949 case USER_SIGNAL_EVENT
:
5950 /* A user signal. */
5952 char *name
= find_user_signal_name (event
->code
);
5955 return intern (name
);
5958 case SAVE_SESSION_EVENT
:
5959 return Qsave_session
;
5964 return Fcons (Qdbus_event
, event
->arg
);
5966 #endif /* HAVE_DBUS */
5968 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5969 case FILE_NOTIFY_EVENT
:
5971 return Fcons (Qfile_notify
, event
->arg
);
5973 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5975 case CONFIG_CHANGED_EVENT
:
5976 return list3 (Qconfig_changed_event
,
5977 event
->arg
, event
->frame_or_window
);
5979 case GPM_CLICK_EVENT
:
5981 struct frame
*f
= XFRAME (event
->frame_or_window
);
5982 Lisp_Object head
, position
;
5983 Lisp_Object
*start_pos_ptr
;
5984 Lisp_Object start_pos
;
5985 int button
= event
->code
;
5987 if (button
>= ASIZE (button_down_location
))
5989 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5990 button_down_location
= larger_vector (button_down_location
,
5992 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5995 start_pos_ptr
= aref_addr (button_down_location
, button
);
5996 start_pos
= *start_pos_ptr
;
5998 position
= make_lispy_position (f
, event
->x
, event
->y
,
6001 if (event
->modifiers
& down_modifier
)
6002 *start_pos_ptr
= Fcopy_alist (position
);
6003 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6005 if (!CONSP (start_pos
))
6007 event
->modifiers
&= ~up_modifier
;
6010 head
= modify_event_symbol (button
,
6012 Qmouse_click
, Vlispy_mouse_stem
,
6015 ASIZE (mouse_syms
));
6017 if (event
->modifiers
& drag_modifier
)
6018 return list3 (head
, start_pos
, position
);
6019 else if (event
->modifiers
& double_modifier
)
6020 return list3 (head
, position
, make_number (2));
6021 else if (event
->modifiers
& triple_modifier
)
6022 return list3 (head
, position
, make_number (3));
6024 return list2 (head
, position
);
6026 #endif /* HAVE_GPM */
6028 /* The 'kind' field of the event is something we don't recognize. */
6035 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6036 Lisp_Object x
, Lisp_Object y
, Time t
)
6038 /* Is it a scroll bar movement? */
6039 if (frame
&& ! NILP (bar_window
))
6041 Lisp_Object part_sym
;
6043 part_sym
= *scroll_bar_parts
[(int) part
];
6044 return list2 (Qscroll_bar_movement
,
6046 Qvertical_scroll_bar
,
6051 /* Or is it an ordinary mouse movement? */
6054 Lisp_Object position
;
6055 position
= make_lispy_position (frame
, x
, y
, t
);
6056 return list2 (Qmouse_movement
, position
);
6060 /* Construct a switch frame event. */
6062 make_lispy_switch_frame (Lisp_Object frame
)
6064 return list2 (Qswitch_frame
, frame
);
6068 make_lispy_focus_in (Lisp_Object frame
)
6070 return list2 (Qfocus_in
, frame
);
6073 make_lispy_focus_out (Lisp_Object frame
)
6075 return list2 (Qfocus_out
, frame
);
6078 /* Manipulating modifiers. */
6080 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6082 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6083 SYMBOL's name of the end of the modifiers; the string from this
6084 position is the unmodified symbol name.
6086 This doesn't use any caches. */
6089 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6095 CHECK_SYMBOL (symbol
);
6098 name
= SYMBOL_NAME (symbol
);
6100 for (i
= 0; i
< SBYTES (name
) - 1; )
6102 ptrdiff_t this_mod_end
= 0;
6105 /* See if the name continues with a modifier word.
6106 Check that the word appears, but don't check what follows it.
6107 Set this_mod and this_mod_end to record what we find. */
6109 switch (SREF (name
, i
))
6111 #define SINGLE_LETTER_MOD(BIT) \
6112 (this_mod_end = i + 1, this_mod = BIT)
6115 SINGLE_LETTER_MOD (alt_modifier
);
6119 SINGLE_LETTER_MOD (ctrl_modifier
);
6123 SINGLE_LETTER_MOD (hyper_modifier
);
6127 SINGLE_LETTER_MOD (meta_modifier
);
6131 SINGLE_LETTER_MOD (shift_modifier
);
6135 SINGLE_LETTER_MOD (super_modifier
);
6138 #undef SINGLE_LETTER_MOD
6140 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6141 if (i + LEN + 1 <= SBYTES (name) \
6142 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6144 this_mod_end = i + LEN; \
6149 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6150 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6151 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6155 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6157 #undef MULTI_LETTER_MOD
6161 /* If we found no modifier, stop looking for them. */
6162 if (this_mod_end
== 0)
6165 /* Check there is a dash after the modifier, so that it
6166 really is a modifier. */
6167 if (this_mod_end
>= SBYTES (name
)
6168 || SREF (name
, this_mod_end
) != '-')
6171 /* This modifier is real; look for another. */
6172 modifiers
|= this_mod
;
6173 i
= this_mod_end
+ 1;
6176 /* Should we include the `click' modifier? */
6177 if (! (modifiers
& (down_modifier
| drag_modifier
6178 | double_modifier
| triple_modifier
))
6179 && i
+ 7 == SBYTES (name
)
6180 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6181 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6182 modifiers
|= click_modifier
;
6184 if (! (modifiers
& (double_modifier
| triple_modifier
))
6185 && i
+ 6 < SBYTES (name
)
6186 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6187 modifiers
|= click_modifier
;
6195 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6196 prepended to the string BASE[0..BASE_LEN-1].
6197 This doesn't use any caches. */
6199 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6201 /* Since BASE could contain nulls, we can't use intern here; we have
6202 to use Fintern, which expects a genuine Lisp_String, and keeps a
6204 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6210 /* Only the event queue may use the `up' modifier; it should always
6211 be turned into a click or drag event before presented to lisp code. */
6212 if (modifiers
& up_modifier
)
6215 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6216 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6217 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6218 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6219 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6220 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6221 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6222 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6223 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6224 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6225 /* The click modifier is denoted by the absence of other modifiers. */
6229 mod_len
= p
- new_mods
;
6233 Lisp_Object new_name
;
6235 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6236 mod_len
+ base_len_byte
);
6237 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6238 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6240 return Fintern (new_name
, Qnil
);
6245 static const char *const modifier_names
[] =
6247 "up", "down", "drag", "click", "double", "triple", 0, 0,
6248 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6249 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6251 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6253 static Lisp_Object modifier_symbols
;
6255 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6257 lispy_modifier_list (int modifiers
)
6259 Lisp_Object modifier_list
;
6262 modifier_list
= Qnil
;
6263 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6264 if (modifiers
& (1<<i
))
6265 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6268 return modifier_list
;
6272 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6273 where UNMODIFIED is the unmodified form of SYMBOL,
6274 MASK is the set of modifiers present in SYMBOL's name.
6275 This is similar to parse_modifiers_uncached, but uses the cache in
6276 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6277 Qevent_symbol_elements property. */
6279 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6282 parse_modifiers (Lisp_Object symbol
)
6284 Lisp_Object elements
;
6286 if (INTEGERP (symbol
))
6287 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6288 else if (!SYMBOLP (symbol
))
6291 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6292 if (CONSP (elements
))
6297 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6298 Lisp_Object unmodified
;
6301 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6302 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6305 if (modifiers
& ~INTMASK
)
6307 XSETFASTINT (mask
, modifiers
);
6308 elements
= list2 (unmodified
, mask
);
6310 /* Cache the parsing results on SYMBOL. */
6311 Fput (symbol
, Qevent_symbol_element_mask
,
6313 Fput (symbol
, Qevent_symbol_elements
,
6314 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6316 /* Since we know that SYMBOL is modifiers applied to unmodified,
6317 it would be nice to put that in unmodified's cache.
6318 But we can't, since we're not sure that parse_modifiers is
6325 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6326 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6327 doc
: /* Parse the event symbol. For internal use. */)
6328 (Lisp_Object symbol
)
6330 /* Fill the cache if needed. */
6331 parse_modifiers (symbol
);
6332 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6333 and use the Lispier representation stored on Qevent_symbol_elements
6335 return Fget (symbol
, Qevent_symbol_elements
);
6338 /* Apply the modifiers MODIFIERS to the symbol BASE.
6339 BASE must be unmodified.
6341 This is like apply_modifiers_uncached, but uses BASE's
6342 Qmodifier_cache property, if present. It also builds
6343 Qevent_symbol_elements properties, since it has that info anyway.
6345 apply_modifiers copies the value of BASE's Qevent_kind property to
6346 the modified symbol. */
6348 apply_modifiers (int modifiers
, Lisp_Object base
)
6350 Lisp_Object cache
, idx
, entry
, new_symbol
;
6352 /* Mask out upper bits. We don't know where this value's been. */
6353 modifiers
&= INTMASK
;
6355 if (INTEGERP (base
))
6356 return make_number (XINT (base
) | modifiers
);
6358 /* The click modifier never figures into cache indices. */
6359 cache
= Fget (base
, Qmodifier_cache
);
6360 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6361 entry
= assq_no_quit (idx
, cache
);
6364 new_symbol
= XCDR (entry
);
6367 /* We have to create the symbol ourselves. */
6368 new_symbol
= apply_modifiers_uncached (modifiers
,
6369 SSDATA (SYMBOL_NAME (base
)),
6370 SCHARS (SYMBOL_NAME (base
)),
6371 SBYTES (SYMBOL_NAME (base
)));
6373 /* Add the new symbol to the base's cache. */
6374 entry
= Fcons (idx
, new_symbol
);
6375 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6377 /* We have the parsing info now for free, so we could add it to
6379 XSETFASTINT (idx, modifiers);
6380 Fput (new_symbol, Qevent_symbol_element_mask,
6382 Fput (new_symbol, Qevent_symbol_elements,
6383 Fcons (base, lispy_modifier_list (modifiers)));
6384 Sadly, this is only correct if `base' is indeed a base event,
6385 which is not necessarily the case. -stef */
6388 /* Make sure this symbol is of the same kind as BASE.
6390 You'd think we could just set this once and for all when we
6391 intern the symbol above, but reorder_modifiers may call us when
6392 BASE's property isn't set right; we can't assume that just
6393 because it has a Qmodifier_cache property it must have its
6394 Qevent_kind set right as well. */
6395 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6399 kind
= Fget (base
, Qevent_kind
);
6401 Fput (new_symbol
, Qevent_kind
, kind
);
6408 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6409 return a symbol with the modifiers placed in the canonical order.
6410 Canonical order is alphabetical, except for down and drag, which
6411 always come last. The 'click' modifier is never written out.
6413 Fdefine_key calls this to make sure that (for example) C-M-foo
6414 and M-C-foo end up being equivalent in the keymap. */
6417 reorder_modifiers (Lisp_Object symbol
)
6419 /* It's hopefully okay to write the code this way, since everything
6420 will soon be in caches, and no consing will be done at all. */
6423 parsed
= parse_modifiers (symbol
);
6424 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6429 /* For handling events, we often want to produce a symbol whose name
6430 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6431 to some base, like the name of a function key or mouse button.
6432 modify_event_symbol produces symbols of this sort.
6434 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6435 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6438 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6439 into symbol names, or a string specifying a name stem used to
6440 construct a symbol name or the form `STEM-N', where N is the decimal
6441 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6442 non-nil; otherwise NAME_TABLE is used.
6444 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6445 persist between calls to modify_event_symbol that it can use to
6446 store a cache of the symbols it's generated for this NAME_TABLE
6447 before. The object stored there may be a vector or an alist.
6449 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6451 MODIFIERS is a set of modifier bits (as given in struct input_events)
6452 whose prefixes should be applied to the symbol name.
6454 SYMBOL_KIND is the value to be placed in the event_kind property of
6455 the returned symbol.
6457 The symbols we create are supposed to have an
6458 `event-symbol-elements' property, which lists the modifiers present
6459 in the symbol's name. */
6462 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6463 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6464 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6467 Lisp_Object symbol_int
;
6469 /* Get rid of the "vendor-specific" bit here. */
6470 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6472 /* Is this a request for a valid symbol? */
6473 if (symbol_num
< 0 || symbol_num
>= table_size
)
6476 if (CONSP (*symbol_table
))
6477 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6479 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6480 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6481 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6482 we've never used that symbol before. */
6485 if (! VECTORP (*symbol_table
)
6486 || ASIZE (*symbol_table
) != table_size
)
6490 XSETFASTINT (size
, table_size
);
6491 *symbol_table
= Fmake_vector (size
, Qnil
);
6494 value
= AREF (*symbol_table
, symbol_num
);
6497 /* Have we already used this symbol before? */
6500 /* No; let's create it. */
6501 if (CONSP (name_alist_or_stem
))
6502 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6503 else if (STRINGP (name_alist_or_stem
))
6506 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6507 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6509 buf
= SAFE_ALLOCA (len
);
6510 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6511 XINT (symbol_int
) + 1);
6512 value
= intern (buf
);
6515 else if (name_table
!= 0 && name_table
[symbol_num
])
6516 value
= intern (name_table
[symbol_num
]);
6518 #ifdef HAVE_WINDOW_SYSTEM
6521 char *name
= x_get_keysym_name (symbol_num
);
6523 value
= intern (name
);
6529 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6530 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6531 value
= intern (buf
);
6534 if (CONSP (*symbol_table
))
6535 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6537 ASET (*symbol_table
, symbol_num
, value
);
6539 /* Fill in the cache entries for this symbol; this also
6540 builds the Qevent_symbol_elements property, which the user
6542 apply_modifiers (modifiers
& click_modifier
, value
);
6543 Fput (value
, Qevent_kind
, symbol_kind
);
6546 /* Apply modifiers to that symbol. */
6547 return apply_modifiers (modifiers
, value
);
6550 /* Convert a list that represents an event type,
6551 such as (ctrl meta backspace), into the usual representation of that
6552 event type as a number or a symbol. */
6554 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6555 doc
: /* Convert the event description list EVENT-DESC to an event type.
6556 EVENT-DESC should contain one base event type (a character or symbol)
6557 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6558 drag, down, double or triple). The base must be last.
6559 The return value is an event type (a character or symbol) which
6560 has the same base event type and all the specified modifiers. */)
6561 (Lisp_Object event_desc
)
6569 while (CONSP (rest
))
6577 /* Given a symbol, see if it is a modifier name. */
6578 if (SYMBOLP (elt
) && CONSP (rest
))
6579 this = parse_solitary_modifier (elt
);
6583 else if (!NILP (base
))
6584 error ("Two bases given in one event");
6590 /* Let the symbol A refer to the character A. */
6591 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6592 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6594 if (INTEGERP (base
))
6596 /* Turn (shift a) into A. */
6597 if ((modifiers
& shift_modifier
) != 0
6598 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6600 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6601 modifiers
&= ~shift_modifier
;
6604 /* Turn (control a) into C-a. */
6605 if (modifiers
& ctrl_modifier
)
6606 return make_number ((modifiers
& ~ctrl_modifier
)
6607 | make_ctrl_char (XINT (base
)));
6609 return make_number (modifiers
| XINT (base
));
6611 else if (SYMBOLP (base
))
6612 return apply_modifiers (modifiers
, base
);
6614 error ("Invalid base event");
6617 /* Try to recognize SYMBOL as a modifier name.
6618 Return the modifier flag bit, or 0 if not recognized. */
6621 parse_solitary_modifier (Lisp_Object symbol
)
6623 Lisp_Object name
= SYMBOL_NAME (symbol
);
6625 switch (SREF (name
, 0))
6627 #define SINGLE_LETTER_MOD(BIT) \
6628 if (SBYTES (name) == 1) \
6631 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6632 if (LEN == SBYTES (name) \
6633 && ! memcmp (SDATA (name), NAME, LEN)) \
6637 SINGLE_LETTER_MOD (alt_modifier
);
6641 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6645 SINGLE_LETTER_MOD (ctrl_modifier
);
6649 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6650 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6654 SINGLE_LETTER_MOD (hyper_modifier
);
6658 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6662 SINGLE_LETTER_MOD (meta_modifier
);
6666 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6670 SINGLE_LETTER_MOD (shift_modifier
);
6674 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6675 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6676 SINGLE_LETTER_MOD (super_modifier
);
6680 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6681 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6682 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6686 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6689 #undef SINGLE_LETTER_MOD
6690 #undef MULTI_LETTER_MOD
6696 /* Return true if EVENT is a list whose elements are all integers or symbols.
6697 Such a list is not valid as an event,
6698 but it can be a Lucid-style event type list. */
6701 lucid_event_type_list_p (Lisp_Object object
)
6705 if (! CONSP (object
))
6708 if (EQ (XCAR (object
), Qhelp_echo
)
6709 || EQ (XCAR (object
), Qvertical_line
)
6710 || EQ (XCAR (object
), Qmode_line
)
6711 || EQ (XCAR (object
), Qheader_line
))
6714 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6718 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6725 /* Return true if terminal input chars are available.
6726 Also, store the return value into INPUT_PENDING.
6728 Serves the purpose of ioctl (0, FIONREAD, ...)
6729 but works even if FIONREAD does not exist.
6730 (In fact, this may actually read some input.)
6732 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6733 timer events that are ripe.
6734 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6735 events (FOCUS_IN_EVENT).
6736 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6737 movements and toolkit scroll bar thumb drags. */
6740 get_input_pending (int flags
)
6742 /* First of all, have we already counted some input? */
6743 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6745 /* If input is being read as it arrives, and we have none, there is none. */
6746 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6748 /* Try to read some input and see how much we get. */
6750 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6753 return input_pending
;
6756 /* Put a BUFFER_SWITCH_EVENT in the buffer
6757 so that read_key_sequence will notice the new current buffer. */
6760 record_asynch_buffer_change (void)
6762 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6763 The purpose of the event is to make read_key_sequence look up the
6764 keymaps again. If we aren't in read_key_sequence, we don't need one,
6765 and the event could cause trouble by messing up (input-pending-p).
6766 Note: Fwaiting_for_user_input_p always returns nil when async
6767 subprocesses aren't supported. */
6768 if (!NILP (Fwaiting_for_user_input_p ()))
6770 struct input_event event
;
6773 event
.kind
= BUFFER_SWITCH_EVENT
;
6774 event
.frame_or_window
= Qnil
;
6777 /* Make sure no interrupt happens while storing the event. */
6779 if (interrupt_input
)
6780 kbd_buffer_store_event (&event
);
6785 kbd_buffer_store_event (&event
);
6791 /* Read any terminal input already buffered up by the system
6792 into the kbd_buffer, but do not wait.
6794 Return the number of keyboard chars read, or -1 meaning
6795 this is a bad time to try to read input. */
6804 /* Store pending user signal events, if any. */
6805 store_user_signal_events ();
6807 /* Loop through the available terminals, and call their input hooks. */
6811 struct terminal
*next
= t
->next_terminal
;
6813 if (t
->read_socket_hook
)
6816 struct input_event hold_quit
;
6818 if (input_blocked_p ())
6820 pending_signals
= 1;
6824 EVENT_INIT (hold_quit
);
6825 hold_quit
.kind
= NO_EVENT
;
6827 /* No need for FIONREAD or fcntl; just say don't wait. */
6828 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6831 if (nr
== -1) /* Not OK to read input now. */
6835 else if (nr
== -2) /* Non-transient error. */
6837 /* The terminal device terminated; it should be closed. */
6839 /* Kill Emacs if this was our last terminal. */
6840 if (!terminal_list
->next_terminal
)
6841 /* Formerly simply reported no input, but that
6842 sometimes led to a failure of Emacs to terminate.
6843 SIGHUP seems appropriate if we can't reach the
6845 /* ??? Is it really right to send the signal just to
6846 this process rather than to the whole process
6847 group? Perhaps on systems with FIONREAD Emacs is
6848 alone in its group. */
6849 terminate_due_to_signal (SIGHUP
, 10);
6851 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6854 XSETTERMINAL (tmp
, t
);
6855 Fdelete_terminal (tmp
, Qnoelisp
);
6859 if (hold_quit
.kind
!= NO_EVENT
)
6860 kbd_buffer_store_event (&hold_quit
);
6869 frame_make_pointer_visible ();
6874 /* This is the tty way of reading available input.
6876 Note that each terminal device has its own `struct terminal' object,
6877 and so this function is called once for each individual termcap
6878 terminal. The first parameter indicates which terminal to read from. */
6881 tty_read_avail_input (struct terminal
*terminal
,
6882 struct input_event
*hold_quit
)
6884 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6885 the kbd_buffer can really hold. That may prevent loss
6886 of characters on some systems when input is stuffed at us. */
6887 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6889 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6892 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6894 if (kbd_on_hold_p () || buffer_free
<= 0)
6896 #endif /* subprocesses */
6898 if (!terminal
->name
) /* Don't read from a dead terminal. */
6901 if (terminal
->type
!= output_termcap
6902 && terminal
->type
!= output_msdos_raw
)
6905 /* XXX I think the following code should be moved to separate hook
6906 functions in system-dependent files. */
6908 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6909 code sets read_socket_hook to w32_console_read_socket instead! */
6911 #else /* not WINDOWSNT */
6912 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6916 return 0; /* The terminal is suspended. */
6919 n_to_read
= dos_keysns ();
6923 cbuf
[0] = dos_keyread ();
6926 #else /* not MSDOS */
6931 struct input_event gpm_hold_quit
;
6932 int gpm
, fd
= gpm_fd
;
6934 EVENT_INIT (gpm_hold_quit
);
6935 gpm_hold_quit
.kind
= NO_EVENT
;
6937 /* gpm==1 if event received.
6938 gpm==0 if the GPM daemon has closed the connection, in which case
6939 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6940 we save it in `fd' so close_gpm can remove it from the
6942 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6943 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6944 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6947 /* Presumably the GPM daemon has closed the connection. */
6949 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6950 kbd_buffer_store_event (&gpm_hold_quit
);
6954 #endif /* HAVE_GPM */
6956 /* Determine how many characters we should *try* to read. */
6957 #ifdef USABLE_FIONREAD
6958 /* Find out how much input is available. */
6959 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6961 if (! noninteractive
)
6962 return -2; /* Close this terminal. */
6968 if (n_to_read
> sizeof cbuf
)
6969 n_to_read
= sizeof cbuf
;
6970 #elif defined USG || defined CYGWIN
6971 /* Read some input if available, but don't wait. */
6972 n_to_read
= sizeof cbuf
;
6973 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6975 # error "Cannot read without possibly delaying"
6979 /* Don't read more than we can store. */
6980 if (n_to_read
> buffer_free
)
6981 n_to_read
= buffer_free
;
6982 #endif /* subprocesses */
6984 /* Now read; for one reason or another, this will not block.
6985 NREAD is set to the number of chars read. */
6988 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6989 /* POSIX infers that processes which are not in the session leader's
6990 process group won't get SIGHUPs at logout time. BSDI adheres to
6991 this part standard and returns -1 from read (0) with errno==EIO
6992 when the control tty is taken away.
6993 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6994 if (nread
== -1 && errno
== EIO
)
6995 return -2; /* Close this terminal. */
6996 #if defined (AIX) && defined (_BSD)
6997 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6998 This looks incorrect, but it isn't, because _BSD causes
6999 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7000 and that causes a value other than 0 when there is no input. */
7002 return -2; /* Close this terminal. */
7006 /* We used to retry the read if it was interrupted.
7007 But this does the wrong thing when O_NONBLOCK causes
7008 an EAGAIN error. Does anybody know of a situation
7009 where a retry is actually needed? */
7011 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7021 #ifndef USABLE_FIONREAD
7022 #if defined (USG) || defined (CYGWIN)
7023 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7024 #endif /* USG or CYGWIN */
7025 #endif /* no FIONREAD */
7030 #endif /* not MSDOS */
7031 #endif /* not WINDOWSNT */
7033 for (i
= 0; i
< nread
; i
++)
7035 struct input_event buf
;
7037 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7039 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7040 buf
.modifiers
= meta_modifier
;
7041 if (tty
->meta_key
!= 2)
7045 /* Set the frame corresponding to the active tty. Note that the
7046 value of selected_frame is not reliable here, redisplay tends
7047 to temporarily change it. */
7048 buf
.frame_or_window
= tty
->top_frame
;
7051 kbd_buffer_store_event (&buf
);
7052 /* Don't look at input that follows a C-g too closely.
7053 This reduces lossage due to autorepeat on C-g. */
7054 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7055 && buf
.code
== quit_char
)
7063 handle_async_input (void)
7068 int nread
= gobble_input ();
7069 /* -1 means it's not ok to read the input now.
7070 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7071 0 means there was no keyboard input available. */
7079 process_pending_signals (void)
7081 pending_signals
= 0;
7082 handle_async_input ();
7083 do_pending_atimers ();
7086 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7087 and also (if the level is now 0) reinvoke any pending signal. */
7090 unblock_input_to (int level
)
7092 interrupt_input_blocked
= level
;
7095 if (pending_signals
)
7096 process_pending_signals ();
7102 /* End critical section.
7104 If doing signal-driven input, and a signal came in when input was
7105 blocked, reinvoke the signal handler now to deal with it. */
7108 unblock_input (void)
7110 unblock_input_to (interrupt_input_blocked
- 1);
7113 /* Undo any number of BLOCK_INPUT calls,
7114 and also reinvoke any pending signal. */
7117 totally_unblock_input (void)
7119 unblock_input_to (0);
7125 handle_input_available_signal (int sig
)
7127 pending_signals
= 1;
7129 if (input_available_clear_time
)
7130 *input_available_clear_time
= make_timespec (0, 0);
7134 deliver_input_available_signal (int sig
)
7136 deliver_process_signal (sig
, handle_input_available_signal
);
7138 #endif /* USABLE_SIGIO */
7141 /* User signal events. */
7143 struct user_signal_info
7145 /* Signal number. */
7148 /* Name of the signal. */
7151 /* Number of pending signals. */
7154 struct user_signal_info
*next
;
7157 /* List of user signals. */
7158 static struct user_signal_info
*user_signals
= NULL
;
7161 add_user_signal (int sig
, const char *name
)
7163 struct sigaction action
;
7164 struct user_signal_info
*p
;
7166 for (p
= user_signals
; p
; p
= p
->next
)
7168 /* Already added. */
7171 p
= xmalloc (sizeof *p
);
7173 p
->name
= xstrdup (name
);
7175 p
->next
= user_signals
;
7178 emacs_sigaction_init (&action
, deliver_user_signal
);
7179 sigaction (sig
, &action
, 0);
7183 handle_user_signal (int sig
)
7185 struct user_signal_info
*p
;
7186 const char *special_event_name
= NULL
;
7188 if (SYMBOLP (Vdebug_on_event
))
7189 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7191 for (p
= user_signals
; p
; p
= p
->next
)
7194 if (special_event_name
7195 && strcmp (special_event_name
, p
->name
) == 0)
7197 /* Enter the debugger in many ways. */
7198 debug_on_next_call
= 1;
7201 Vinhibit_quit
= Qnil
;
7203 /* Eat the event. */
7209 if (interrupt_input
)
7210 handle_input_available_signal (sig
);
7214 /* Tell wait_reading_process_output that it needs to wake
7215 up and look around. */
7216 if (input_available_clear_time
)
7217 *input_available_clear_time
= make_timespec (0, 0);
7224 deliver_user_signal (int sig
)
7226 deliver_process_signal (sig
, handle_user_signal
);
7230 find_user_signal_name (int sig
)
7232 struct user_signal_info
*p
;
7234 for (p
= user_signals
; p
; p
= p
->next
)
7242 store_user_signal_events (void)
7244 struct user_signal_info
*p
;
7245 struct input_event buf
;
7246 bool buf_initialized
= 0;
7248 for (p
= user_signals
; p
; p
= p
->next
)
7249 if (p
->npending
> 0)
7251 if (! buf_initialized
)
7253 memset (&buf
, 0, sizeof buf
);
7254 buf
.kind
= USER_SIGNAL_EVENT
;
7255 buf
.frame_or_window
= selected_frame
;
7256 buf_initialized
= 1;
7262 kbd_buffer_store_event (&buf
);
7265 while (p
->npending
> 0);
7270 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7271 static Lisp_Object menu_bar_one_keymap_changed_items
;
7273 /* These variables hold the vector under construction within
7274 menu_bar_items and its subroutines, and the current index
7275 for storing into that vector. */
7276 static Lisp_Object menu_bar_items_vector
;
7277 static int menu_bar_items_index
;
7280 static const char* separator_names
[] = {
7285 "single-dashed-line",
7286 "double-dashed-line",
7288 "shadow-etched-out",
7289 "shadow-etched-in-dash",
7290 "shadow-etched-out-dash",
7291 "shadow-double-etched-in",
7292 "shadow-double-etched-out",
7293 "shadow-double-etched-in-dash",
7294 "shadow-double-etched-out-dash",
7298 /* Return true if LABEL specifies a separator. */
7301 menu_separator_name_p (const char *label
)
7305 else if (strlen (label
) > 3
7306 && memcmp (label
, "--", 2) == 0
7311 for (i
= 0; separator_names
[i
]; ++i
)
7312 if (strcmp (label
, separator_names
[i
]) == 0)
7317 /* It's a separator if it contains only dashes. */
7318 while (*label
== '-')
7320 return (*label
== 0);
7327 /* Return a vector of menu items for a menu bar, appropriate
7328 to the current buffer. Each item has three elements in the vector:
7331 OLD is an old vector we can optionally reuse, or nil. */
7334 menu_bar_items (Lisp_Object old
)
7336 /* The number of keymaps we're scanning right now, and the number of
7337 keymaps we have allocated space for. */
7340 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7341 in the current keymaps, or nil where it is not a prefix. */
7344 Lisp_Object def
, tail
;
7349 /* In order to build the menus, we need to call the keymap
7350 accessors. They all call QUIT. But this function is called
7351 during redisplay, during which a quit is fatal. So inhibit
7352 quitting while building the menus.
7353 We do this instead of specbind because (1) errors will clear it anyway
7354 and (2) this avoids risk of specpdl overflow. */
7355 oquit
= Vinhibit_quit
;
7359 menu_bar_items_vector
= old
;
7361 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7362 menu_bar_items_index
= 0;
7364 /* Build our list of keymaps.
7365 If we recognize a function key and replace its escape sequence in
7366 keybuf with its symbol, or if the sequence starts with a mouse
7367 click and we need to switch buffers, we jump back here to rebuild
7368 the initial keymaps from the current buffer. */
7372 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7373 if (!NILP (Voverriding_local_map_menu_flag
)
7374 && !NILP (Voverriding_local_map
))
7376 /* Yes, use them (if non-nil) as well as the global map. */
7377 maps
= alloca (3 * sizeof (maps
[0]));
7379 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7380 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7381 if (!NILP (Voverriding_local_map
))
7382 maps
[nmaps
++] = Voverriding_local_map
;
7386 /* No, so use major and minor mode keymaps and keymap property.
7387 Note that menu-bar bindings in the local-map and keymap
7388 properties may not work reliable, as they are only
7389 recognized when the menu-bar (or mode-line) is updated,
7390 which does not normally happen after every command. */
7393 nminor
= current_minor_maps (NULL
, &tmaps
);
7394 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7396 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7397 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7398 maps
[nmaps
++] = tem
;
7399 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7400 maps
[nmaps
++] = tem
;
7401 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7403 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7405 maps
[nmaps
++] = current_global_map
;
7408 /* Look up in each map the dummy prefix key `menu-bar'. */
7410 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7411 if (!NILP (maps
[mapno
]))
7413 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7417 menu_bar_one_keymap_changed_items
= Qnil
;
7418 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7422 /* Move to the end those items that should be at the end. */
7424 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7427 int end
= menu_bar_items_index
;
7429 for (i
= 0; i
< end
; i
+= 4)
7430 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7432 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7433 /* Move the item at index I to the end,
7434 shifting all the others forward. */
7435 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7436 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7437 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7438 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7440 memmove (aref_addr (menu_bar_items_vector
, i
),
7441 aref_addr (menu_bar_items_vector
, i
+ 4),
7442 (end
- i
- 4) * word_size
);
7443 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7444 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7445 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7446 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7451 /* Add nil, nil, nil, nil at the end. */
7453 int i
= menu_bar_items_index
;
7454 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7455 menu_bar_items_vector
=
7456 larger_vector (menu_bar_items_vector
, 4, -1);
7457 /* Add this item. */
7458 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7459 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7460 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7461 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7462 menu_bar_items_index
= i
;
7465 Vinhibit_quit
= oquit
;
7466 return menu_bar_items_vector
;
7469 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7470 If there's already an item for KEY, add this DEF to it. */
7472 Lisp_Object item_properties
;
7475 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7477 struct gcpro gcpro1
;
7482 if (EQ (item
, Qundefined
))
7484 /* If a map has an explicit `undefined' as definition,
7485 discard any previously made menu bar item. */
7487 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7488 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7490 if (menu_bar_items_index
> i
+ 4)
7491 memmove (aref_addr (menu_bar_items_vector
, i
),
7492 aref_addr (menu_bar_items_vector
, i
+ 4),
7493 (menu_bar_items_index
- i
- 4) * word_size
);
7494 menu_bar_items_index
-= 4;
7498 /* If this keymap has already contributed to this KEY,
7499 don't contribute to it a second time. */
7500 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7501 if (!NILP (tem
) || NILP (item
))
7504 menu_bar_one_keymap_changed_items
7505 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7507 /* We add to menu_bar_one_keymap_changed_items before doing the
7508 parse_menu_item, so that if it turns out it wasn't a menu item,
7509 it still correctly hides any further menu item. */
7511 parsed
= parse_menu_item (item
, 1);
7516 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7518 /* Find any existing item for this KEY. */
7519 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7520 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7523 /* If we did not find this KEY, add it at the end. */
7524 if (i
== menu_bar_items_index
)
7526 /* If vector is too small, get a bigger one. */
7527 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7528 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7529 /* Add this item. */
7530 ASET (menu_bar_items_vector
, i
, key
); i
++;
7531 ASET (menu_bar_items_vector
, i
,
7532 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7533 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7534 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7535 menu_bar_items_index
= i
;
7537 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7541 old
= AREF (menu_bar_items_vector
, i
+ 2);
7542 /* If the new and the old items are not both keymaps,
7543 the lookup will only find `item'. */
7544 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7545 ASET (menu_bar_items_vector
, i
+ 2, item
);
7549 /* This is used as the handler when calling menu_item_eval_property. */
7551 menu_item_eval_property_1 (Lisp_Object arg
)
7553 /* If we got a quit from within the menu computation,
7554 quit all the way out of it. This takes care of C-] in the debugger. */
7555 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7556 Fsignal (Qquit
, Qnil
);
7562 eval_dyn (Lisp_Object form
)
7564 return Feval (form
, Qnil
);
7567 /* Evaluate an expression and return the result (or nil if something
7568 went wrong). Used to evaluate dynamic parts of menu items. */
7570 menu_item_eval_property (Lisp_Object sexpr
)
7572 ptrdiff_t count
= SPECPDL_INDEX ();
7574 specbind (Qinhibit_redisplay
, Qt
);
7575 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7576 menu_item_eval_property_1
);
7577 return unbind_to (count
, val
);
7580 /* This function parses a menu item and leaves the result in the
7581 vector item_properties.
7582 ITEM is a key binding, a possible menu item.
7583 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7585 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7586 parse_menu_item returns true if the item is a menu item and false
7590 parse_menu_item (Lisp_Object item
, int inmenubar
)
7592 Lisp_Object def
, tem
, item_string
, start
;
7594 Lisp_Object keyhint
;
7603 /* Create item_properties vector if necessary. */
7604 if (NILP (item_properties
))
7606 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7608 /* Initialize optional entries. */
7609 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7610 ASET (item_properties
, i
, Qnil
);
7611 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7613 /* Save the item here to protect it from GC. */
7614 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7616 item_string
= XCAR (item
);
7620 if (STRINGP (item_string
))
7622 /* Old format menu item. */
7623 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7625 /* Maybe help string. */
7626 if (CONSP (item
) && STRINGP (XCAR (item
)))
7628 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7633 /* Maybe an obsolete key binding cache. */
7634 if (CONSP (item
) && CONSP (XCAR (item
))
7635 && (NILP (XCAR (XCAR (item
)))
7636 || VECTORP (XCAR (XCAR (item
)))))
7639 /* This is the real definition--the function to run. */
7640 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7642 /* Get enable property, if any. */
7645 tem
= Fget (item
, Qmenu_enable
);
7646 if (!NILP (Venable_disabled_menus_and_buttons
))
7647 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7648 else if (!NILP (tem
))
7649 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7652 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7654 /* New format menu item. */
7655 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7656 start
= XCDR (item
);
7659 /* We have a real binding. */
7660 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7662 item
= XCDR (start
);
7663 /* Is there an obsolete cache list with key equivalences. */
7664 if (CONSP (item
) && CONSP (XCAR (item
)))
7667 /* Parse properties. */
7668 while (CONSP (item
) && CONSP (XCDR (item
)))
7673 if (EQ (tem
, QCenable
))
7675 if (!NILP (Venable_disabled_menus_and_buttons
))
7676 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7678 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7680 else if (EQ (tem
, QCvisible
))
7682 /* If got a visible property and that evaluates to nil
7683 then ignore this item. */
7684 tem
= menu_item_eval_property (XCAR (item
));
7688 else if (EQ (tem
, QChelp
))
7689 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7690 else if (EQ (tem
, QCfilter
))
7692 else if (EQ (tem
, QCkey_sequence
))
7695 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7696 /* Be GC protected. Set keyhint to item instead of tem. */
7699 else if (EQ (tem
, QCkeys
))
7702 if (CONSP (tem
) || STRINGP (tem
))
7703 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7705 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7710 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7712 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7714 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7720 else if (inmenubar
|| !NILP (start
))
7724 return 0; /* not a menu item */
7726 /* If item string is not a string, evaluate it to get string.
7727 If we don't get a string, skip this item. */
7728 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7729 if (!(STRINGP (item_string
)))
7731 item_string
= menu_item_eval_property (item_string
);
7732 if (!STRINGP (item_string
))
7734 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7737 /* If got a filter apply it on definition. */
7738 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7741 def
= menu_item_eval_property (list2 (XCAR (filter
),
7742 list2 (Qquote
, def
)));
7744 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7747 /* Enable or disable selection of item. */
7748 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7751 tem
= menu_item_eval_property (tem
);
7752 if (inmenubar
&& NILP (tem
))
7753 return 0; /* Ignore disabled items in menu bar. */
7754 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7757 /* If we got no definition, this item is just unselectable text which
7758 is OK in a submenu but not in the menubar. */
7760 return (!inmenubar
);
7762 /* See if this is a separate pane or a submenu. */
7763 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7764 tem
= get_keymap (def
, 0, 1);
7765 /* For a subkeymap, just record its details and exit. */
7768 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7769 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7773 /* At the top level in the menu bar, do likewise for commands also.
7774 The menu bar does not display equivalent key bindings anyway.
7775 ITEM_PROPERTY_DEF is already set up properly. */
7779 { /* This is a command. See if there is an equivalent key binding. */
7780 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7782 /* The previous code preferred :key-sequence to :keys, so we
7783 preserve this behavior. */
7784 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7785 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7788 Lisp_Object prefix
= keyeq
;
7789 Lisp_Object keys
= Qnil
;
7793 def
= XCAR (prefix
);
7794 prefix
= XCDR (prefix
);
7797 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7799 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7801 keys
= XCAR (keyhint
);
7802 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7804 /* We have a suggested key. Is it bound to the command? */
7807 /* If the command is an alias for another
7808 (such as lmenu.el set it up), check if the
7809 original command matches the cached command. */
7811 && EQ (tem
, XSYMBOL (def
)->function
))))
7816 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7820 tem
= Fkey_description (keys
, Qnil
);
7823 if (STRINGP (XCAR (prefix
)))
7824 tem
= concat2 (XCAR (prefix
), tem
);
7825 if (STRINGP (XCDR (prefix
)))
7826 tem
= concat2 (tem
, XCDR (prefix
));
7828 keyeq
= concat2 (build_string (" "), tem
);
7829 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7835 /* If we have an equivalent key binding, use that. */
7836 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7839 /* Include this when menu help is implemented.
7840 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7841 if (!(NILP (tem) || STRINGP (tem)))
7843 tem = menu_item_eval_property (tem);
7846 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7850 /* Handle radio buttons or toggle boxes. */
7851 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7853 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7854 menu_item_eval_property (tem
));
7861 /***********************************************************************
7863 ***********************************************************************/
7865 /* A vector holding tool bar items while they are parsed in function
7866 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7869 static Lisp_Object tool_bar_items_vector
;
7871 /* A vector holding the result of parse_tool_bar_item. Layout is like
7872 the one for a single item in tool_bar_items_vector. */
7874 static Lisp_Object tool_bar_item_properties
;
7876 /* Next free index in tool_bar_items_vector. */
7878 static int ntool_bar_items
;
7880 /* The symbols `:image' and `:rtl'. */
7882 static Lisp_Object QCimage
;
7883 static Lisp_Object QCrtl
;
7885 /* Function prototypes. */
7887 static void init_tool_bar_items (Lisp_Object
);
7888 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7889 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7890 static void append_tool_bar_item (void);
7893 /* Return a vector of tool bar items for keymaps currently in effect.
7894 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7895 tool bar items found. */
7898 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7907 /* In order to build the menus, we need to call the keymap
7908 accessors. They all call QUIT. But this function is called
7909 during redisplay, during which a quit is fatal. So inhibit
7910 quitting while building the menus. We do this instead of
7911 specbind because (1) errors will clear it anyway and (2) this
7912 avoids risk of specpdl overflow. */
7913 oquit
= Vinhibit_quit
;
7916 /* Initialize tool_bar_items_vector and protect it from GC. */
7917 init_tool_bar_items (reuse
);
7919 /* Build list of keymaps in maps. Set nmaps to the number of maps
7922 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7923 if (!NILP (Voverriding_local_map_menu_flag
)
7924 && !NILP (Voverriding_local_map
))
7926 /* Yes, use them (if non-nil) as well as the global map. */
7927 maps
= alloca (3 * sizeof *maps
);
7929 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7930 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7931 if (!NILP (Voverriding_local_map
))
7932 maps
[nmaps
++] = Voverriding_local_map
;
7936 /* No, so use major and minor mode keymaps and keymap property.
7937 Note that tool-bar bindings in the local-map and keymap
7938 properties may not work reliable, as they are only
7939 recognized when the tool-bar (or mode-line) is updated,
7940 which does not normally happen after every command. */
7943 nminor
= current_minor_maps (NULL
, &tmaps
);
7944 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7946 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7947 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7948 maps
[nmaps
++] = tem
;
7949 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7950 maps
[nmaps
++] = tem
;
7951 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7953 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7956 /* Add global keymap at the end. */
7957 maps
[nmaps
++] = current_global_map
;
7959 /* Process maps in reverse order and look up in each map the prefix
7961 for (i
= nmaps
- 1; i
>= 0; --i
)
7962 if (!NILP (maps
[i
]))
7966 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7968 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7971 Vinhibit_quit
= oquit
;
7972 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7973 return tool_bar_items_vector
;
7977 /* Process the definition of KEY which is DEF. */
7980 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7983 struct gcpro gcpro1
, gcpro2
;
7985 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7989 if (EQ (def
, Qundefined
))
7991 /* If a map has an explicit `undefined' as definition,
7992 discard any previously made item. */
7993 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7995 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7997 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7999 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8000 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8001 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8003 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8008 else if (parse_tool_bar_item (key
, def
))
8009 /* Append a new tool bar item to tool_bar_items_vector. Accept
8010 more than one definition for the same key. */
8011 append_tool_bar_item ();
8016 /* Access slot with index IDX of vector tool_bar_item_properties. */
8017 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8019 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8021 ASET (tool_bar_item_properties
, idx
, val
);
8025 /* Parse a tool bar item specification ITEM for key KEY and return the
8026 result in tool_bar_item_properties. Value is false if ITEM is
8029 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8031 CAPTION is the caption of the item, If it's not a string, it is
8032 evaluated to get a string.
8034 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8035 as binding are currently ignored.
8037 The following properties are recognized:
8041 FORM is evaluated and specifies whether the tool bar item is
8042 enabled or disabled.
8046 FORM is evaluated and specifies whether the tool bar item is visible.
8048 - `:filter FUNCTION'
8050 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8051 result is stored as the new binding.
8053 - `:button (TYPE SELECTED)'
8055 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8056 and specifies whether the button is selected (pressed) or not.
8060 IMAGES is either a single image specification or a vector of four
8061 image specifications. See enum tool_bar_item_images.
8063 - `:help HELP-STRING'.
8065 Gives a help string to display for the tool bar item.
8067 - `:label LABEL-STRING'.
8069 A text label to show with the tool bar button if labels are enabled. */
8072 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8074 Lisp_Object filter
= Qnil
;
8075 Lisp_Object caption
;
8077 bool have_label
= 0;
8079 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8080 Rule out items that aren't lists, don't start with
8081 `menu-item' or whose rest following `tool-bar-item' is not a
8086 /* As an exception, allow old-style menu separators. */
8087 if (STRINGP (XCAR (item
)))
8088 item
= list1 (XCAR (item
));
8089 else if (!EQ (XCAR (item
), Qmenu_item
)
8090 || (item
= XCDR (item
), !CONSP (item
)))
8093 /* Create tool_bar_item_properties vector if necessary. Reset it to
8095 if (VECTORP (tool_bar_item_properties
))
8097 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8101 tool_bar_item_properties
8102 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8105 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8106 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8108 /* Get the caption of the item. If the caption is not a string,
8109 evaluate it to get a string. If we don't get a string, skip this
8111 caption
= XCAR (item
);
8112 if (!STRINGP (caption
))
8114 caption
= menu_item_eval_property (caption
);
8115 if (!STRINGP (caption
))
8118 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8120 /* If the rest following the caption is not a list, the menu item is
8121 either a separator, or invalid. */
8125 if (menu_separator_name_p (SSDATA (caption
)))
8127 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8128 #if !defined (USE_GTK) && !defined (HAVE_NS)
8129 /* If we use build_desired_tool_bar_string to render the
8130 tool bar, the separator is rendered as an image. */
8131 set_prop (TOOL_BAR_ITEM_IMAGES
,
8132 (menu_item_eval_property
8133 (Vtool_bar_separator_image_expression
)));
8134 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8135 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8136 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8143 /* Store the binding. */
8144 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8147 /* Ignore cached key binding, if any. */
8148 if (CONSP (item
) && CONSP (XCAR (item
)))
8151 /* Process the rest of the properties. */
8152 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8154 Lisp_Object ikey
, value
;
8157 value
= XCAR (XCDR (item
));
8159 if (EQ (ikey
, QCenable
))
8161 /* `:enable FORM'. */
8162 if (!NILP (Venable_disabled_menus_and_buttons
))
8163 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8165 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8167 else if (EQ (ikey
, QCvisible
))
8169 /* `:visible FORM'. If got a visible property and that
8170 evaluates to nil then ignore this item. */
8171 if (NILP (menu_item_eval_property (value
)))
8174 else if (EQ (ikey
, QChelp
))
8175 /* `:help HELP-STRING'. */
8176 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8177 else if (EQ (ikey
, QCvert_only
))
8178 /* `:vert-only t/nil'. */
8179 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8180 else if (EQ (ikey
, QClabel
))
8182 const char *bad_label
= "!!?GARBLED ITEM?!!";
8183 /* `:label LABEL-STRING'. */
8184 set_prop (TOOL_BAR_ITEM_LABEL
,
8185 STRINGP (value
) ? value
: build_string (bad_label
));
8188 else if (EQ (ikey
, QCfilter
))
8189 /* ':filter FORM'. */
8191 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8193 /* `:button (TYPE . SELECTED)'. */
8194 Lisp_Object type
, selected
;
8196 type
= XCAR (value
);
8197 selected
= XCDR (value
);
8198 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8200 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8201 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8204 else if (EQ (ikey
, QCimage
)
8206 || (VECTORP (value
) && ASIZE (value
) == 4)))
8207 /* Value is either a single image specification or a vector
8208 of 4 such specifications for the different button states. */
8209 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8210 else if (EQ (ikey
, QCrtl
))
8212 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8218 /* Try to make one from caption and key. */
8219 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8220 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8221 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8222 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8224 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8225 char *buf
= xmalloc (max_lbl
+ 1);
8226 Lisp_Object new_lbl
;
8227 ptrdiff_t caption_len
= strlen (capt
);
8229 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8232 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8234 buf
[caption_len
] = '\0';
8238 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8242 strcpy (buf
, label
);
8244 for (j
= 0; buf
[j
] != '\0'; ++j
)
8252 new_lbl
= Fupcase_initials (build_string (label
));
8253 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8254 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8256 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8260 /* If got a filter apply it on binding. */
8262 set_prop (TOOL_BAR_ITEM_BINDING
,
8263 (menu_item_eval_property
8266 PROP (TOOL_BAR_ITEM_BINDING
))))));
8268 /* See if the binding is a keymap. Give up if it is. */
8269 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8272 /* Enable or disable selection of item. */
8273 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8274 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8275 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8277 /* Handle radio buttons or toggle boxes. */
8278 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8279 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8280 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8288 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8289 that can be reused. */
8292 init_tool_bar_items (Lisp_Object reuse
)
8294 if (VECTORP (reuse
))
8295 tool_bar_items_vector
= reuse
;
8297 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8298 ntool_bar_items
= 0;
8302 /* Append parsed tool bar item properties from
8303 tool_bar_item_properties */
8306 append_tool_bar_item (void)
8310 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8312 /* Enlarge tool_bar_items_vector if necessary. */
8314 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8316 /* Append entries from tool_bar_item_properties to the end of
8317 tool_bar_items_vector. */
8318 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8319 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8320 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8327 /* Read a character using menus based on the keymap MAP.
8328 Return nil if there are no menus in the maps.
8329 Return t if we displayed a menu but the user rejected it.
8331 PREV_EVENT is the previous input event, or nil if we are reading
8332 the first event of a key sequence.
8334 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8335 if we used a mouse menu to read the input, or false otherwise. If
8336 USED_MOUSE_MENU is null, don't dereference it.
8338 The prompting is done based on the prompt-string of the map
8339 and the strings associated with various map elements.
8341 This can be done with X menus or with menus put in the minibuf.
8342 These are done in different ways, depending on how the input will be read.
8343 Menus using X are done after auto-saving in read-char, getting the input
8344 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8345 and do auto-saving in the inner call of read_char. */
8348 read_char_x_menu_prompt (Lisp_Object map
,
8349 Lisp_Object prev_event
, bool *used_mouse_menu
)
8351 if (used_mouse_menu
)
8352 *used_mouse_menu
= 0;
8354 /* Use local over global Menu maps. */
8356 if (! menu_prompting
)
8360 /* If we got to this point via a mouse click,
8361 use a real menu for mouse selection. */
8362 if (EVENT_HAS_PARAMETERS (prev_event
)
8363 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8364 && !EQ (XCAR (prev_event
), Qtool_bar
))
8366 /* Display the menu and get the selection. */
8369 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8374 record_menu_key (XCAR (value
));
8376 /* If we got multiple events, unread all but
8378 There is no way to prevent those unread events
8379 from showing up later in last_nonmenu_event.
8380 So turn symbol and integer events into lists,
8381 to indicate that they came from a mouse menu,
8382 so that when present in last_nonmenu_event
8383 they won't confuse things. */
8384 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8386 record_menu_key (XCAR (tem
));
8387 if (SYMBOLP (XCAR (tem
))
8388 || INTEGERP (XCAR (tem
)))
8389 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8392 /* If we got more than one event, put all but the first
8393 onto this list to be read later.
8394 Return just the first event now. */
8395 Vunread_command_events
8396 = nconc2 (XCDR (value
), Vunread_command_events
);
8397 value
= XCAR (value
);
8399 else if (NILP (value
))
8401 if (used_mouse_menu
)
8402 *used_mouse_menu
= 1;
8405 #endif /* HAVE_MENUS */
8410 read_char_minibuf_menu_prompt (int commandflag
,
8413 register Lisp_Object name
;
8415 /* FIXME: Use the minibuffer's frame width. */
8416 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8418 bool nobindings
= 1;
8419 Lisp_Object rest
, vector
;
8420 Lisp_Object prompt_strings
= Qnil
;
8424 if (! menu_prompting
)
8427 map
= get_keymap (map
, 0, 1);
8428 name
= Fkeymap_prompt (map
);
8430 /* If we don't have any menus, just read a character normally. */
8431 if (!STRINGP (name
))
8434 #define PUSH_C_STR(str, listvar) \
8435 listvar = Fcons (build_unibyte_string (str), listvar)
8437 /* Prompt string always starts with map's prompt, and a space. */
8438 prompt_strings
= Fcons (name
, prompt_strings
);
8439 PUSH_C_STR (": ", prompt_strings
);
8440 nlength
= SCHARS (name
) + 2;
8444 /* Present the documented bindings, a line at a time. */
8448 Lisp_Object menu_strings
= prompt_strings
;
8449 ptrdiff_t i
= nlength
;
8451 Lisp_Object orig_defn_macro
;
8453 /* Loop over elements of map. */
8458 /* FIXME: Use map_keymap to handle new keymap formats. */
8460 /* At end of map, wrap around if just starting,
8461 or end this line if already have something on it. */
8464 if (notfirst
|| nobindings
)
8470 /* Look at the next element of the map. */
8472 elt
= AREF (vector
, idx
);
8474 elt
= Fcar_safe (rest
);
8476 if (idx
< 0 && VECTORP (elt
))
8478 /* If we found a dense table in the keymap,
8479 advanced past it, but start scanning its contents. */
8480 rest
= Fcdr_safe (rest
);
8486 /* An ordinary element. */
8487 Lisp_Object event
, tem
;
8491 event
= Fcar_safe (elt
); /* alist */
8492 elt
= Fcdr_safe (elt
);
8496 XSETINT (event
, idx
); /* vector */
8499 /* Ignore the element if it has no prompt string. */
8500 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8502 /* True if the char to type matches the string. */
8504 Lisp_Object upcased_event
, downcased_event
;
8505 Lisp_Object desc
= Qnil
;
8507 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8509 upcased_event
= Fupcase (event
);
8510 downcased_event
= Fdowncase (event
);
8511 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8512 || XINT (downcased_event
) == SREF (s
, 0));
8514 desc
= Fsingle_key_description (event
, Qnil
);
8516 #if 0 /* It is redundant to list the equivalent key bindings because
8517 the prefix is what the user has already typed. */
8519 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8521 /* Insert equivalent keybinding. */
8522 s
= concat2 (s
, tem
);
8525 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8526 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8528 /* Insert button prefix. */
8529 Lisp_Object selected
8530 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8531 if (EQ (tem
, QCradio
))
8532 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8534 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8535 s
= concat2 (tem
, s
);
8539 /* If we have room for the prompt string, add it to this line.
8540 If this is the first on the line, always add it. */
8541 if ((SCHARS (s
) + i
+ 2
8542 + (char_matches
? 0 : SCHARS (desc
) + 3))
8546 ptrdiff_t thiswidth
;
8548 /* Punctuate between strings. */
8551 PUSH_C_STR (", ", menu_strings
);
8557 /* If the char to type doesn't match the string's
8558 first char, explicitly show what char to type. */
8561 /* Add as much of string as fits. */
8562 thiswidth
= min (SCHARS (desc
), width
- i
);
8564 = Fcons (Fsubstring (desc
, make_number (0),
8565 make_number (thiswidth
)),
8568 PUSH_C_STR (" = ", menu_strings
);
8572 /* Add as much of string as fits. */
8573 thiswidth
= min (SCHARS (s
), width
- i
);
8575 = Fcons (Fsubstring (s
, make_number (0),
8576 make_number (thiswidth
)),
8582 /* If this element does not fit, end the line now,
8583 and save the element for the next line. */
8584 PUSH_C_STR ("...", menu_strings
);
8589 /* Move past this element. */
8590 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8591 /* Handle reaching end of dense table. */
8596 rest
= Fcdr_safe (rest
);
8600 /* Prompt with that and read response. */
8601 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8603 /* Make believe it's not a keyboard macro in case the help char
8604 is pressed. Help characters are not recorded because menu prompting
8605 is not used on replay. */
8606 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8607 kset_defining_kbd_macro (current_kboard
, Qnil
);
8609 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8610 while (BUFFERP (obj
));
8611 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8613 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8616 if (! EQ (obj
, menu_prompt_more_char
)
8617 && (!INTEGERP (menu_prompt_more_char
)
8618 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8620 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8621 store_kbd_macro_char (obj
);
8624 /* Help char - go round again. */
8628 /* Reading key sequences. */
8631 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8633 return access_keymap (get_keymap (keymap
, 0, 1),
8638 active_maps (Lisp_Object first_event
)
8640 Lisp_Object position
8641 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8642 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8645 /* Structure used to keep track of partial application of key remapping
8646 such as Vfunction_key_map and Vkey_translation_map. */
8647 typedef struct keyremap
8649 /* This is the map originally specified for this use. */
8651 /* This is a submap reached by looking up, in PARENT,
8652 the events from START to END. */
8654 /* Positions [START, END) in the key sequence buffer
8655 are the key that we have scanned so far.
8656 Those events are the ones that we will replace
8657 if PARENT maps them into a key sequence. */
8661 /* Lookup KEY in MAP.
8662 MAP is a keymap mapping keys to key vectors or functions.
8663 If the mapping is a function and DO_FUNCALL is true,
8664 the function is called with PROMPT as parameter and its return
8665 value is used as the return value of this function (after checking
8666 that it is indeed a vector). */
8669 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8674 next
= access_keymap (map
, key
, 1, 0, 1);
8676 /* Handle a symbol whose function definition is a keymap
8678 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8679 && (ARRAYP (XSYMBOL (next
)->function
)
8680 || KEYMAPP (XSYMBOL (next
)->function
)))
8681 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8683 /* If the keymap gives a function, not an
8684 array, then call the function with one arg and use
8685 its value instead. */
8686 if (do_funcall
&& FUNCTIONP (next
))
8691 next
= call1 (next
, prompt
);
8692 /* If the function returned something invalid,
8693 barf--don't ignore it.
8694 (To ignore it safely, we would need to gcpro a bunch of
8695 other variables.) */
8696 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8697 error ("Function %s returns invalid key sequence",
8698 SSDATA (SYMBOL_NAME (tem
)));
8703 /* Do one step of the key remapping used for function-key-map and
8704 key-translation-map:
8705 KEYBUF is the buffer holding the input events.
8706 BUFSIZE is its maximum size.
8707 FKEY is a pointer to the keyremap structure to use.
8708 INPUT is the index of the last element in KEYBUF.
8709 DOIT if true says that the remapping can actually take place.
8710 DIFF is used to return the number of keys added/removed by the remapping.
8711 PARENT is the root of the keymap.
8712 PROMPT is the prompt to use if the remapping happens through a function.
8713 Return true if the remapping actually took place. */
8716 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8717 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8719 Lisp_Object next
, key
;
8721 key
= keybuf
[fkey
->end
++];
8723 if (KEYMAPP (fkey
->parent
))
8724 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8728 /* If keybuf[fkey->start..fkey->end] is bound in the
8729 map and we're in a position to do the key remapping, replace it with
8730 the binding and restart with fkey->start at the end. */
8731 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8733 int len
= XFASTINT (Flength (next
));
8736 *diff
= len
- (fkey
->end
- fkey
->start
);
8738 if (bufsize
- input
<= *diff
)
8739 error ("Key sequence too long");
8741 /* Shift the keys that follow fkey->end. */
8743 for (i
= fkey
->end
; i
< input
; i
++)
8744 keybuf
[i
+ *diff
] = keybuf
[i
];
8746 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8747 keybuf
[i
+ *diff
] = keybuf
[i
];
8748 /* Overwrite the old keys with the new ones. */
8749 for (i
= 0; i
< len
; i
++)
8750 keybuf
[fkey
->start
+ i
]
8751 = Faref (next
, make_number (i
));
8753 fkey
->start
= fkey
->end
+= *diff
;
8754 fkey
->map
= fkey
->parent
;
8759 fkey
->map
= get_keymap (next
, 0, 1);
8761 /* If we no longer have a bound suffix, try a new position for
8763 if (!CONSP (fkey
->map
))
8765 fkey
->end
= ++fkey
->start
;
8766 fkey
->map
= fkey
->parent
;
8772 test_undefined (Lisp_Object binding
)
8774 return (NILP (binding
)
8775 || EQ (binding
, Qundefined
)
8776 || (SYMBOLP (binding
)
8777 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8780 /* Read a sequence of keys that ends with a non prefix character,
8781 storing it in KEYBUF, a buffer of size BUFSIZE.
8783 Return the length of the key sequence stored.
8784 Return -1 if the user rejected a command menu.
8786 Echo starting immediately unless `prompt' is 0.
8788 Where a key sequence ends depends on the currently active keymaps.
8789 These include any minor mode keymaps active in the current buffer,
8790 the current buffer's local map, and the global map.
8792 If a key sequence has no other bindings, we check Vfunction_key_map
8793 to see if some trailing subsequence might be the beginning of a
8794 function key's sequence. If so, we try to read the whole function
8795 key, and substitute its symbolic name into the key sequence.
8797 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8798 `double-' events into similar click events, if that would make them
8799 bound. We try to turn `triple-' events first into `double-' events,
8802 If we get a mouse click in a mode line, vertical divider, or other
8803 non-text area, we treat the click as if it were prefixed by the
8804 symbol denoting that area - `mode-line', `vertical-line', or
8807 If the sequence starts with a mouse click, we read the key sequence
8808 with respect to the buffer clicked on, not the current buffer.
8810 If the user switches frames in the midst of a key sequence, we put
8811 off the switch-frame event until later; the next call to
8812 read_char will return it.
8814 If FIX_CURRENT_BUFFER, we restore current_buffer
8815 from the selected window's buffer. */
8818 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8819 bool dont_downcase_last
, bool can_return_switch_frame
,
8820 bool fix_current_buffer
)
8822 ptrdiff_t count
= SPECPDL_INDEX ();
8824 /* How many keys there are in the current key sequence. */
8827 /* The length of the echo buffer when we started reading, and
8828 the length of this_command_keys when we started reading. */
8829 ptrdiff_t echo_start
IF_LINT (= 0);
8830 ptrdiff_t keys_start
;
8832 Lisp_Object current_binding
= Qnil
;
8833 Lisp_Object first_event
= Qnil
;
8835 /* Index of the first key that has no binding.
8836 It is useless to try fkey.start larger than that. */
8839 /* If t < mock_input, then KEYBUF[t] should be read as the next
8842 We use this to recover after recognizing a function key. Once we
8843 realize that a suffix of the current key sequence is actually a
8844 function key's escape sequence, we replace the suffix with the
8845 function key's binding from Vfunction_key_map. Now keybuf
8846 contains a new and different key sequence, so the echo area,
8847 this_command_keys, and the submaps and defs arrays are wrong. In
8848 this situation, we set mock_input to t, set t to 0, and jump to
8849 restart_sequence; the loop will read keys from keybuf up until
8850 mock_input, thus rebuilding the state; and then it will resume
8851 reading characters from the keyboard. */
8854 /* If the sequence is unbound in submaps[], then
8855 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8856 and fkey.map is its binding.
8858 These might be > t, indicating that all function key scanning
8859 should hold off until t reaches them. We do this when we've just
8860 recognized a function key, to avoid searching for the function
8861 key's again in Vfunction_key_map. */
8864 /* Likewise, for key_translation_map and input-decode-map. */
8865 keyremap keytran
, indec
;
8867 /* True if we are trying to map a key by changing an upper-case
8868 letter to lower case, or a shifted function key to an unshifted
8870 bool shift_translated
= 0;
8872 /* If we receive a `switch-frame' or `select-window' event in the middle of
8873 a key sequence, we put it off for later.
8874 While we're reading, we keep the event here. */
8875 Lisp_Object delayed_switch_frame
;
8877 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8878 int original_uppercase_position
= -1;
8880 /* Gets around Microsoft compiler limitations. */
8883 struct buffer
*starting_buffer
;
8885 /* List of events for which a fake prefix key has been generated. */
8886 Lisp_Object fake_prefixed_keys
= Qnil
;
8888 struct gcpro gcpro1
;
8890 GCPRO1 (fake_prefixed_keys
);
8891 raw_keybuf_count
= 0;
8893 last_nonmenu_event
= Qnil
;
8895 delayed_switch_frame
= Qnil
;
8901 /* Install the string STR as the beginning of the string of
8902 echoing, so that it serves as a prompt for the next
8904 kset_echo_string (current_kboard
, prompt
);
8905 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8908 else if (cursor_in_echo_area
8909 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8910 && NILP (Fzerop (Vecho_keystrokes
)))
8911 /* This doesn't put in a dash if the echo buffer is empty, so
8912 you don't always see a dash hanging out in the minibuffer. */
8916 /* Record the initial state of the echo area and this_command_keys;
8917 we will need to restore them if we replay a key sequence. */
8919 echo_start
= echo_length ();
8920 keys_start
= this_command_key_count
;
8921 this_single_command_key_start
= keys_start
;
8923 /* We jump here when we need to reinitialize fkey and keytran; this
8924 happens if we switch keyboards between rescans. */
8925 replay_entire_sequence
:
8927 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8928 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8929 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8930 indec
.start
= indec
.end
= 0;
8931 fkey
.start
= fkey
.end
= 0;
8932 keytran
.start
= keytran
.end
= 0;
8934 /* We jump here when the key sequence has been thoroughly changed, and
8935 we need to rescan it starting from the beginning. When we jump here,
8936 keybuf[0..mock_input] holds the sequence we should reread. */
8939 starting_buffer
= current_buffer
;
8940 first_unbound
= bufsize
+ 1;
8942 /* Build our list of keymaps.
8943 If we recognize a function key and replace its escape sequence in
8944 keybuf with its symbol, or if the sequence starts with a mouse
8945 click and we need to switch buffers, we jump back here to rebuild
8946 the initial keymaps from the current buffer. */
8947 current_binding
= active_maps (first_event
);
8949 /* Start from the beginning in keybuf. */
8952 /* These are no-ops the first time through, but if we restart, they
8953 revert the echo area and this_command_keys to their original state. */
8954 this_command_key_count
= keys_start
;
8955 if (INTERACTIVE
&& t
< mock_input
)
8956 echo_truncate (echo_start
);
8958 /* If the best binding for the current key sequence is a keymap, or
8959 we may be looking at a function key's escape sequence, keep on
8961 while (!NILP (current_binding
)
8962 /* Keep reading as long as there's a prefix binding. */
8963 ? KEYMAPP (current_binding
)
8964 /* Don't return in the middle of a possible function key sequence,
8965 if the only bindings we found were via case conversion.
8966 Thus, if ESC O a has a function-key-map translation
8967 and ESC o has a binding, don't return after ESC O,
8968 so that we can translate ESC O plus the next character. */
8969 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8972 bool used_mouse_menu
= 0;
8974 /* Where the last real key started. If we need to throw away a
8975 key that has expanded into more than one element of keybuf
8976 (say, a mouse click on the mode line which is being treated
8977 as [mode-line (mouse-...)], then we backtrack to this point
8979 int last_real_key_start
;
8981 /* These variables are analogous to echo_start and keys_start;
8982 while those allow us to restart the entire key sequence,
8983 echo_local_start and keys_local_start allow us to throw away
8985 ptrdiff_t echo_local_start
IF_LINT (= 0);
8986 int keys_local_start
;
8987 Lisp_Object new_binding
;
8989 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8990 eassert (indec
.start
<= indec
.end
);
8991 eassert (fkey
.start
<= fkey
.end
);
8992 eassert (keytran
.start
<= keytran
.end
);
8993 /* key-translation-map is applied *after* function-key-map
8994 which is itself applied *after* input-decode-map. */
8995 eassert (fkey
.end
<= indec
.start
);
8996 eassert (keytran
.end
<= fkey
.start
);
8998 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8999 first_unbound
< keytran
.start
)
9000 { /* The prefix upto first_unbound has no binding and has
9001 no translation left to do either, so we know it's unbound.
9002 If we don't stop now, we risk staying here indefinitely
9003 (if the user keeps entering fkey or keytran prefixes
9004 like C-c ESC ESC ESC ESC ...) */
9006 for (i
= first_unbound
+ 1; i
< t
; i
++)
9007 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9008 mock_input
= t
- first_unbound
- 1;
9009 indec
.end
= indec
.start
-= first_unbound
+ 1;
9010 indec
.map
= indec
.parent
;
9011 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9012 fkey
.map
= fkey
.parent
;
9013 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9014 keytran
.map
= keytran
.parent
;
9015 goto replay_sequence
;
9019 error ("Key sequence too long");
9022 echo_local_start
= echo_length ();
9023 keys_local_start
= this_command_key_count
;
9026 /* These are no-ops, unless we throw away a keystroke below and
9027 jumped back up to replay_key; in that case, these restore the
9028 variables to their original state, allowing us to replay the
9030 if (INTERACTIVE
&& t
< mock_input
)
9031 echo_truncate (echo_local_start
);
9032 this_command_key_count
= keys_local_start
;
9034 /* By default, assume each event is "real". */
9035 last_real_key_start
= t
;
9037 /* Does mock_input indicate that we are re-reading a key sequence? */
9041 add_command_key (key
);
9042 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9043 && NILP (Fzerop (Vecho_keystrokes
))
9044 && current_kboard
->immediate_echo
)
9051 /* If not, we should actually read a character. */
9055 KBOARD
*interrupted_kboard
= current_kboard
;
9056 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9057 key
= read_char (NILP (prompt
),
9058 current_binding
, last_nonmenu_event
,
9059 &used_mouse_menu
, NULL
);
9060 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9061 /* When switching to a new tty (with a new keyboard),
9062 read_char returns the new buffer, rather than -2
9063 (Bug#5095). This is because `terminal-init-xterm'
9064 calls read-char, which eats the wrong_kboard_jmpbuf
9065 return. Any better way to fix this? -- cyd */
9066 || (interrupted_kboard
!= current_kboard
))
9071 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9072 if (k
== interrupted_kboard
)
9077 /* Don't touch interrupted_kboard when it's been
9079 delayed_switch_frame
= Qnil
;
9080 goto replay_entire_sequence
;
9083 if (!NILP (delayed_switch_frame
))
9086 (interrupted_kboard
,
9087 Fcons (delayed_switch_frame
,
9088 KVAR (interrupted_kboard
, kbd_queue
)));
9089 delayed_switch_frame
= Qnil
;
9094 (interrupted_kboard
,
9095 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9097 /* If the side queue is non-empty, ensure it begins with a
9098 switch-frame, so we'll replay it in the right context. */
9099 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9100 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9101 !(EVENT_HAS_PARAMETERS (key
)
9102 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9106 XSETFRAME (frame
, interrupted_frame
);
9108 (interrupted_kboard
,
9109 Fcons (make_lispy_switch_frame (frame
),
9110 KVAR (interrupted_kboard
, kbd_queue
)));
9113 goto replay_entire_sequence
;
9117 /* read_char returns t when it shows a menu and the user rejects it.
9121 unbind_to (count
, Qnil
);
9126 /* read_char returns -1 at the end of a macro.
9127 Emacs 18 handles this by returning immediately with a
9128 zero, so that's what we'll do. */
9129 if (INTEGERP (key
) && XINT (key
) == -1)
9132 /* The Microsoft C compiler can't handle the goto that
9138 /* If the current buffer has been changed from under us, the
9139 keymap may have changed, so replay the sequence. */
9142 timer_resume_idle ();
9145 /* Reset the current buffer from the selected window
9146 in case something changed the former and not the latter.
9147 This is to be more consistent with the behavior
9148 of the command_loop_1. */
9149 if (fix_current_buffer
)
9151 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9153 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9155 Fset_buffer (XWINDOW (selected_window
)->contents
);
9158 goto replay_sequence
;
9161 /* If we have a quit that was typed in another frame, and
9162 quit_throw_to_read_char switched buffers,
9163 replay to get the right keymap. */
9165 && XINT (key
) == quit_char
9166 && current_buffer
!= starting_buffer
)
9169 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9174 goto replay_sequence
;
9179 if (EVENT_HAS_PARAMETERS (key
)
9180 /* Either a `switch-frame' or a `select-window' event. */
9181 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9183 /* If we're at the beginning of a key sequence, and the caller
9184 says it's okay, go ahead and return this event. If we're
9185 in the midst of a key sequence, delay it until the end. */
9186 if (t
> 0 || !can_return_switch_frame
)
9188 delayed_switch_frame
= key
;
9193 if (NILP (first_event
))
9196 /* Even if first_event does not specify a particular
9197 window/position, it's important to recompute the maps here
9198 since a long time might have passed since we entered
9199 read_key_sequence, and a timer (or process-filter or
9200 special-event-map, ...) might have switched the current buffer
9201 or the selected window from under us in the mean time. */
9202 if (fix_current_buffer
9203 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9205 Fset_buffer (XWINDOW (selected_window
)->contents
);
9206 current_binding
= active_maps (first_event
);
9210 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9214 /* Clicks in non-text areas get prefixed by the symbol
9215 in their CHAR-ADDRESS field. For example, a click on
9216 the mode line is prefixed by the symbol `mode-line'.
9218 Furthermore, key sequences beginning with mouse clicks
9219 are read using the keymaps of the buffer clicked on, not
9220 the current buffer. So we may have to switch the buffer
9223 When we turn one event into two events, we must make sure
9224 that neither of the two looks like the original--so that,
9225 if we replay the events, they won't be expanded again.
9226 If not for this, such reexpansion could happen either here
9227 or when user programs play with this-command-keys. */
9228 if (EVENT_HAS_PARAMETERS (key
))
9230 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9231 if (EQ (kind
, Qmouse_click
))
9233 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9234 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9237 || (!NILP (fake_prefixed_keys
)
9238 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9240 /* We're looking a second time at an event for which
9241 we generated a fake prefix key. Set
9242 last_real_key_start appropriately. */
9244 last_real_key_start
= t
- 1;
9247 if (last_real_key_start
== 0)
9249 /* Key sequences beginning with mouse clicks are
9250 read using the keymaps in the buffer clicked on,
9251 not the current buffer. If we're at the
9252 beginning of a key sequence, switch buffers. */
9253 if (WINDOWP (window
)
9254 && BUFFERP (XWINDOW (window
)->contents
)
9255 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9257 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9262 /* Arrange to go back to the original buffer once we're
9263 done reading the key sequence. Note that we can't
9264 use save_excursion_{save,restore} here, because they
9265 save point as well as the current buffer; we don't
9266 want to save point, because redisplay may change it,
9267 to accommodate a Fset_window_start or something. We
9268 don't want to do this at the top of the function,
9269 because we may get input from a subprocess which
9270 wants to change the selected window and stuff (say,
9272 record_unwind_current_buffer ();
9274 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9276 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9277 goto replay_sequence
;
9281 /* Expand mode-line and scroll-bar events into two events:
9282 use posn as a fake prefix key. */
9284 && (NILP (fake_prefixed_keys
)
9285 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9287 if (bufsize
- t
<= 1)
9288 error ("Key sequence too long");
9291 keybuf
[t
+ 1] = key
;
9294 /* Record that a fake prefix key has been generated
9295 for KEY. Don't modify the event; this would
9296 prevent proper action when the event is pushed
9297 back into unread-command-events. */
9298 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9302 else if (CONSP (XCDR (key
))
9303 && CONSP (EVENT_START (key
))
9304 && CONSP (XCDR (EVENT_START (key
))))
9308 posn
= POSN_POSN (EVENT_START (key
));
9309 /* Handle menu-bar events:
9310 insert the dummy prefix event `menu-bar'. */
9311 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9313 if (bufsize
- t
<= 1)
9314 error ("Key sequence too long");
9316 keybuf
[t
+ 1] = key
;
9318 /* Zap the position in key, so we know that we've
9319 expanded it, and don't try to do so again. */
9320 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9323 goto replay_sequence
;
9325 else if (CONSP (posn
))
9327 /* We're looking at the second event of a
9328 sequence which we expanded before. Set
9329 last_real_key_start appropriately. */
9330 if (last_real_key_start
== t
&& t
> 0)
9331 last_real_key_start
= t
- 1;
9336 /* We have finally decided that KEY is something we might want
9338 new_binding
= follow_key (current_binding
, key
);
9340 /* If KEY wasn't bound, we'll try some fallbacks. */
9341 if (!NILP (new_binding
))
9342 /* This is needed for the following scenario:
9343 event 0: a down-event that gets dropped by calling replay_key.
9344 event 1: some normal prefix like C-h.
9345 After event 0, first_unbound is 0, after event 1 indec.start,
9346 fkey.start, and keytran.start are all 1, so when we see that
9347 C-h is bound, we need to update first_unbound. */
9348 first_unbound
= max (t
+ 1, first_unbound
);
9353 /* Remember the position to put an upper bound on indec.start. */
9354 first_unbound
= min (t
, first_unbound
);
9356 head
= EVENT_HEAD (key
);
9357 if (help_char_p (head
) && t
> 0)
9359 read_key_sequence_cmd
= Vprefix_help_command
;
9361 last_nonmenu_event
= key
;
9362 /* The Microsoft C compiler can't handle the goto that
9370 Lisp_Object breakdown
;
9373 breakdown
= parse_modifiers (head
);
9374 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9375 /* Attempt to reduce an unbound mouse event to a simpler
9376 event that is bound:
9377 Drags reduce to clicks.
9378 Double-clicks reduce to clicks.
9379 Triple-clicks reduce to double-clicks, then to clicks.
9380 Down-clicks are eliminated.
9381 Double-downs reduce to downs, then are eliminated.
9382 Triple-downs reduce to double-downs, then to downs,
9383 then are eliminated. */
9384 if (modifiers
& (down_modifier
| drag_modifier
9385 | double_modifier
| triple_modifier
))
9387 while (modifiers
& (down_modifier
| drag_modifier
9388 | double_modifier
| triple_modifier
))
9390 Lisp_Object new_head
, new_click
;
9391 if (modifiers
& triple_modifier
)
9392 modifiers
^= (double_modifier
| triple_modifier
);
9393 else if (modifiers
& double_modifier
)
9394 modifiers
&= ~double_modifier
;
9395 else if (modifiers
& drag_modifier
)
9396 modifiers
&= ~drag_modifier
;
9399 /* Dispose of this `down' event by simply jumping
9400 back to replay_key, to get another event.
9402 Note that if this event came from mock input,
9403 then just jumping back to replay_key will just
9404 hand it to us again. So we have to wipe out any
9407 We could delete keybuf[t] and shift everything
9408 after that to the left by one spot, but we'd also
9409 have to fix up any variable that points into
9410 keybuf, and shifting isn't really necessary
9413 Adding prefixes for non-textual mouse clicks
9414 creates two characters of mock input, and both
9415 must be thrown away. If we're only looking at
9416 the prefix now, we can just jump back to
9417 replay_key. On the other hand, if we've already
9418 processed the prefix, and now the actual click
9419 itself is giving us trouble, then we've lost the
9420 state of the keymaps we want to backtrack to, and
9421 we need to replay the whole sequence to rebuild
9424 Beyond that, only function key expansion could
9425 create more than two keys, but that should never
9426 generate mouse events, so it's okay to zero
9427 mock_input in that case too.
9429 FIXME: The above paragraph seems just plain
9430 wrong, if you consider things like
9431 xterm-mouse-mode. -stef
9433 Isn't this just the most wonderful code ever? */
9435 /* If mock_input > t + 1, the above simplification
9436 will actually end up dropping keys on the floor.
9437 This is probably OK for now, but even
9438 if mock_input <= t + 1, we need to adjust indec,
9440 Typical case [header-line down-mouse-N]:
9441 mock_input = 2, t = 1, fkey.end = 1,
9442 last_real_key_start = 0. */
9443 if (indec
.end
> last_real_key_start
)
9445 indec
.end
= indec
.start
9446 = min (last_real_key_start
, indec
.start
);
9447 indec
.map
= indec
.parent
;
9448 if (fkey
.end
> last_real_key_start
)
9450 fkey
.end
= fkey
.start
9451 = min (last_real_key_start
, fkey
.start
);
9452 fkey
.map
= fkey
.parent
;
9453 if (keytran
.end
> last_real_key_start
)
9455 keytran
.end
= keytran
.start
9456 = min (last_real_key_start
, keytran
.start
);
9457 keytran
.map
= keytran
.parent
;
9461 if (t
== last_real_key_start
)
9468 mock_input
= last_real_key_start
;
9469 goto replay_sequence
;
9474 = apply_modifiers (modifiers
, XCAR (breakdown
));
9475 new_click
= list2 (new_head
, EVENT_START (key
));
9477 /* Look for a binding for this new key. */
9478 new_binding
= follow_key (current_binding
, new_click
);
9480 /* If that click is bound, go for it. */
9481 if (!NILP (new_binding
))
9483 current_binding
= new_binding
;
9487 /* Otherwise, we'll leave key set to the drag event. */
9492 current_binding
= new_binding
;
9495 /* Normally, last_nonmenu_event gets the previous key we read.
9496 But when a mouse popup menu is being used,
9497 we don't update last_nonmenu_event; it continues to hold the mouse
9498 event that preceded the first level of menu. */
9499 if (!used_mouse_menu
)
9500 last_nonmenu_event
= key
;
9502 /* Record what part of this_command_keys is the current key sequence. */
9503 this_single_command_key_start
= this_command_key_count
- t
;
9505 /* Look for this sequence in input-decode-map.
9506 Scan from indec.end until we find a bound suffix. */
9507 while (indec
.end
< t
)
9509 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9513 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9514 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9519 mock_input
= diff
+ max (t
, mock_input
);
9520 goto replay_sequence
;
9524 if (!KEYMAPP (current_binding
)
9525 && !test_undefined (current_binding
)
9526 && indec
.start
>= t
)
9527 /* There is a binding and it's not a prefix.
9528 (and it doesn't have any input-decode-map translation pending).
9529 There is thus no function-key in this sequence.
9530 Moving fkey.start is important in this case to allow keytran.start
9531 to go over the sequence before we return (since we keep the
9532 invariant that keytran.end <= fkey.start). */
9535 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9538 /* If the sequence is unbound, see if we can hang a function key
9539 off the end of it. */
9540 /* Continue scan from fkey.end until we find a bound suffix. */
9541 while (fkey
.end
< indec
.start
)
9543 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9547 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9548 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9549 max (t
, mock_input
),
9550 /* If there's a binding (i.e.
9551 first_binding >= nmaps) we don't want
9552 to apply this function-key-mapping. */
9554 && (test_undefined (current_binding
)),
9559 mock_input
= diff
+ max (t
, mock_input
);
9560 /* Adjust the input-decode-map counters. */
9562 indec
.start
+= diff
;
9564 goto replay_sequence
;
9568 /* Look for this sequence in key-translation-map.
9569 Scan from keytran.end until we find a bound suffix. */
9570 while (keytran
.end
< fkey
.start
)
9572 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9576 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9577 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9582 mock_input
= diff
+ max (t
, mock_input
);
9583 /* Adjust the function-key-map and input-decode-map counters. */
9585 indec
.start
+= diff
;
9589 goto replay_sequence
;
9593 /* If KEY is not defined in any of the keymaps,
9594 and cannot be part of a function key or translation,
9595 and is an upper case letter
9596 use the corresponding lower-case letter instead. */
9597 if (NILP (current_binding
)
9598 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9600 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9601 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9602 || (XINT (key
) & shift_modifier
)))
9604 Lisp_Object new_key
;
9606 original_uppercase
= key
;
9607 original_uppercase_position
= t
- 1;
9609 if (XINT (key
) & shift_modifier
)
9610 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9612 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9613 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9615 /* We have to do this unconditionally, regardless of whether
9616 the lower-case char is defined in the keymaps, because they
9617 might get translated through function-key-map. */
9618 keybuf
[t
- 1] = new_key
;
9619 mock_input
= max (t
, mock_input
);
9620 shift_translated
= 1;
9622 goto replay_sequence
;
9624 /* If KEY is not defined in any of the keymaps,
9625 and cannot be part of a function key or translation,
9626 and is a shifted function key,
9627 use the corresponding unshifted function key instead. */
9628 if (NILP (current_binding
)
9629 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9631 Lisp_Object breakdown
= parse_modifiers (key
);
9633 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9635 if (modifiers
& shift_modifier
9636 /* Treat uppercase keys as shifted. */
9638 && (KEY_TO_CHAR (key
)
9639 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9640 && uppercasep (KEY_TO_CHAR (key
))))
9643 = (modifiers
& shift_modifier
9644 ? apply_modifiers (modifiers
& ~shift_modifier
,
9646 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9648 original_uppercase
= key
;
9649 original_uppercase_position
= t
- 1;
9651 /* We have to do this unconditionally, regardless of whether
9652 the lower-case char is defined in the keymaps, because they
9653 might get translated through function-key-map. */
9654 keybuf
[t
- 1] = new_key
;
9655 mock_input
= max (t
, mock_input
);
9656 /* Reset fkey (and consequently keytran) to apply
9657 function-key-map on the result, so that S-backspace is
9658 correctly mapped to DEL (via backspace). OTOH,
9659 input-decode-map doesn't need to go through it again. */
9660 fkey
.start
= fkey
.end
= 0;
9661 keytran
.start
= keytran
.end
= 0;
9662 shift_translated
= 1;
9664 goto replay_sequence
;
9669 read_key_sequence_cmd
= current_binding
;
9670 read_key_sequence_remapped
9671 /* Remap command through active keymaps.
9672 Do the remapping here, before the unbind_to so it uses the keymaps
9673 of the appropriate buffer. */
9674 = SYMBOLP (read_key_sequence_cmd
)
9675 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9678 unread_switch_frame
= delayed_switch_frame
;
9679 unbind_to (count
, Qnil
);
9681 /* Don't downcase the last character if the caller says don't.
9682 Don't downcase it if the result is undefined, either. */
9683 if ((dont_downcase_last
|| NILP (current_binding
))
9685 && t
- 1 == original_uppercase_position
)
9687 keybuf
[t
- 1] = original_uppercase
;
9688 shift_translated
= 0;
9691 if (shift_translated
)
9692 Vthis_command_keys_shift_translated
= Qt
;
9694 /* Occasionally we fabricate events, perhaps by expanding something
9695 according to function-key-map, or by adding a prefix symbol to a
9696 mouse click in the scroll bar or modeline. In this cases, return
9697 the entire generated key sequence, even if we hit an unbound
9698 prefix or a definition before the end. This means that you will
9699 be able to push back the event properly, and also means that
9700 read-key-sequence will always return a logical unit.
9703 for (; t
< mock_input
; t
++)
9705 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9706 && NILP (Fzerop (Vecho_keystrokes
)))
9707 echo_char (keybuf
[t
]);
9708 add_command_key (keybuf
[t
]);
9716 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9717 Lisp_Object dont_downcase_last
,
9718 Lisp_Object can_return_switch_frame
,
9719 Lisp_Object cmd_loop
, bool allow_string
)
9721 Lisp_Object keybuf
[30];
9723 struct gcpro gcpro1
;
9724 ptrdiff_t count
= SPECPDL_INDEX ();
9727 CHECK_STRING (prompt
);
9730 specbind (Qinput_method_exit_on_first_char
,
9731 (NILP (cmd_loop
) ? Qt
: Qnil
));
9732 specbind (Qinput_method_use_echo_area
,
9733 (NILP (cmd_loop
) ? Qt
: Qnil
));
9735 memset (keybuf
, 0, sizeof keybuf
);
9737 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9739 if (NILP (continue_echo
))
9741 this_command_key_count
= 0;
9742 this_command_key_count_reset
= 0;
9743 this_single_command_key_start
= 0;
9746 #ifdef HAVE_WINDOW_SYSTEM
9747 if (display_hourglass_p
)
9748 cancel_hourglass ();
9751 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9752 prompt
, ! NILP (dont_downcase_last
),
9753 ! NILP (can_return_switch_frame
), 0);
9755 #if 0 /* The following is fine for code reading a key sequence and
9756 then proceeding with a lengthy computation, but it's not good
9757 for code reading keys in a loop, like an input method. */
9758 #ifdef HAVE_WINDOW_SYSTEM
9759 if (display_hourglass_p
)
9770 return unbind_to (count
,
9771 ((allow_string
? make_event_array
: Fvector
)
9775 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9776 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9777 The sequence is sufficient to specify a non-prefix command in the
9778 current local and global maps.
9780 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9781 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9782 as a continuation of the previous key.
9784 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9785 convert the last event to lower case. (Normally any upper case event
9786 is converted to lower case if the original event is undefined and the lower
9787 case equivalent is defined.) A non-nil value is appropriate for reading
9788 a key sequence to be defined.
9790 A C-g typed while in this function is treated like any other character,
9791 and `quit-flag' is not set.
9793 If the key sequence starts with a mouse click, then the sequence is read
9794 using the keymaps of the buffer of the window clicked in, not the buffer
9795 of the selected window as normal.
9797 `read-key-sequence' drops unbound button-down events, since you normally
9798 only care about the click or drag events which follow them. If a drag
9799 or multi-click event is unbound, but the corresponding click event would
9800 be bound, `read-key-sequence' turns the event into a click event at the
9801 drag's starting position. This means that you don't have to distinguish
9802 between click and drag, double, or triple events unless you want to.
9804 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9805 lines separating windows, and scroll bars with imaginary keys
9806 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9808 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9809 function will process a switch-frame event if the user switches frames
9810 before typing anything. If the user switches frames in the middle of a
9811 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9812 is nil, then the event will be put off until after the current key sequence.
9814 `read-key-sequence' checks `function-key-map' for function key
9815 sequences, where they wouldn't conflict with ordinary bindings. See
9816 `function-key-map' for more details.
9818 The optional fifth argument CMD-LOOP, if non-nil, means
9819 that this key sequence is being read by something that will
9820 read commands one after another. It should be nil if the caller
9821 will read just one key sequence. */)
9822 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9824 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9825 can_return_switch_frame
, cmd_loop
, true);
9828 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9829 Sread_key_sequence_vector
, 1, 5, 0,
9830 doc
: /* Like `read-key-sequence' but always return a vector. */)
9831 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9833 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9834 can_return_switch_frame
, cmd_loop
, false);
9837 /* Return true if input events are pending. */
9840 detect_input_pending (void)
9842 return input_pending
|| get_input_pending (0);
9845 /* Return true if input events other than mouse movements are
9849 detect_input_pending_ignore_squeezables (void)
9851 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9854 /* Return true if input events are pending, and run any pending timers. */
9857 detect_input_pending_run_timers (bool do_display
)
9859 unsigned old_timers_run
= timers_run
;
9862 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9864 if (old_timers_run
!= timers_run
&& do_display
)
9866 redisplay_preserve_echo_area (8);
9867 /* The following fixes a bug when using lazy-lock with
9868 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9869 from an idle timer function. The symptom of the bug is that
9870 the cursor sometimes doesn't become visible until the next X
9871 event is processed. --gerd. */
9873 Lisp_Object tail
, frame
;
9874 FOR_EACH_FRAME (tail
, frame
)
9875 if (FRAME_RIF (XFRAME (frame
)))
9876 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9880 return input_pending
;
9883 /* This is called in some cases before a possible quit.
9884 It cases the next call to detect_input_pending to recompute input_pending.
9885 So calling this function unnecessarily can't do any harm. */
9888 clear_input_pending (void)
9893 /* Return true if there are pending requeued events.
9894 This isn't used yet. The hope is to make wait_reading_process_output
9895 call it, and return if it runs Lisp code that unreads something.
9896 The problem is, kbd_buffer_get_event needs to be fixed to know what
9897 to do in that case. It isn't trivial. */
9900 requeued_events_pending_p (void)
9902 return (!NILP (Vunread_command_events
));
9906 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9907 doc
: /* Return t if command input is currently available with no wait.
9908 Actually, the value is nil only if we can be sure that no input is available;
9909 if there is a doubt, the value is t. */)
9912 if (!NILP (Vunread_command_events
)
9913 || !NILP (Vunread_post_input_method_events
)
9914 || !NILP (Vunread_input_method_events
))
9917 /* Process non-user-visible events (Bug#10195). */
9918 process_special_events ();
9920 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9921 | READABLE_EVENTS_FILTER_EVENTS
)
9925 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9926 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9929 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9932 if (total_keys
< NUM_RECENT_KEYS
)
9933 return Fvector (total_keys
, keys
);
9936 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9937 vcopy (val
, 0, keys
+ recent_keys_index
,
9938 NUM_RECENT_KEYS
- recent_keys_index
);
9939 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9940 keys
, recent_keys_index
);
9945 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9946 doc
: /* Return the key sequence that invoked this command.
9947 However, if the command has called `read-key-sequence', it returns
9948 the last key sequence that has been read.
9949 The value is a string or a vector.
9951 See also `this-command-keys-vector'. */)
9954 return make_event_array (this_command_key_count
,
9955 XVECTOR (this_command_keys
)->contents
);
9958 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9959 doc
: /* Return the key sequence that invoked this command, as a vector.
9960 However, if the command has called `read-key-sequence', it returns
9961 the last key sequence that has been read.
9963 See also `this-command-keys'. */)
9966 return Fvector (this_command_key_count
,
9967 XVECTOR (this_command_keys
)->contents
);
9970 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9971 Sthis_single_command_keys
, 0, 0, 0,
9972 doc
: /* Return the key sequence that invoked this command.
9973 More generally, it returns the last key sequence read, either by
9974 the command loop or by `read-key-sequence'.
9975 Unlike `this-command-keys', this function's value
9976 does not include prefix arguments.
9977 The value is always a vector. */)
9980 return Fvector (this_command_key_count
9981 - this_single_command_key_start
,
9982 (XVECTOR (this_command_keys
)->contents
9983 + this_single_command_key_start
));
9986 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9987 Sthis_single_command_raw_keys
, 0, 0, 0,
9988 doc
: /* Return the raw events that were read for this command.
9989 More generally, it returns the last key sequence read, either by
9990 the command loop or by `read-key-sequence'.
9991 Unlike `this-single-command-keys', this function's value
9992 shows the events before all translations (except for input methods).
9993 The value is always a vector. */)
9996 return Fvector (raw_keybuf_count
,
9997 (XVECTOR (raw_keybuf
)->contents
));
10000 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10001 Sreset_this_command_lengths
, 0, 0, 0,
10002 doc
: /* Make the unread events replace the last command and echo.
10003 Used in `universal-argument-other-key'.
10005 `universal-argument-other-key' rereads the event just typed.
10006 It then gets translated through `function-key-map'.
10007 The translated event has to replace the real events,
10008 both in the value of (this-command-keys) and in echoing.
10009 To achieve this, `universal-argument-other-key' calls
10010 `reset-this-command-lengths', which discards the record of reading
10011 these events the first time. */)
10014 this_command_key_count
= before_command_key_count
;
10015 if (this_command_key_count
< this_single_command_key_start
)
10016 this_single_command_key_start
= this_command_key_count
;
10018 echo_truncate (before_command_echo_length
);
10020 /* Cause whatever we put into unread-command-events
10021 to echo as if it were being freshly read from the keyboard. */
10022 this_command_key_count_reset
= 1;
10027 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10028 Sclear_this_command_keys
, 0, 1, 0,
10029 doc
: /* Clear out the vector that `this-command-keys' returns.
10030 Also clear the record of the last 100 events, unless optional arg
10031 KEEP-RECORD is non-nil. */)
10032 (Lisp_Object keep_record
)
10036 this_command_key_count
= 0;
10037 this_command_key_count_reset
= 0;
10039 if (NILP (keep_record
))
10041 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10042 ASET (recent_keys
, i
, Qnil
);
10044 recent_keys_index
= 0;
10049 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10050 doc
: /* Return the current depth in recursive edits. */)
10054 /* Wrap around reliably on integer overflow. */
10055 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10056 XSETINT (temp
, sum
);
10060 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10061 "FOpen dribble file: ",
10062 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10063 If FILE is nil, close any open dribble file.
10064 The file will be closed when Emacs exits. */)
10076 file
= Fexpand_file_name (file
, Qnil
);
10077 dribble
= emacs_fopen (SSDATA (file
), "w");
10079 report_file_error ("Opening dribble", file
);
10084 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10085 doc
: /* Discard the contents of the terminal input buffer.
10086 Also end any kbd macro being defined. */)
10089 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10091 /* Discard the last command from the macro. */
10092 Fcancel_kbd_macro_events ();
10096 Vunread_command_events
= Qnil
;
10098 discard_tty_input ();
10100 kbd_fetch_ptr
= kbd_store_ptr
;
10106 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10107 doc
: /* Stop Emacs and return to superior process. You can resume later.
10108 If `cannot-suspend' is non-nil, or if the system doesn't support job
10109 control, run a subshell instead.
10111 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10112 to be read as terminal input by Emacs's parent, after suspension.
10114 Before suspending, run the normal hook `suspend-hook'.
10115 After resumption run the normal hook `suspend-resume-hook'.
10117 Some operating systems cannot stop the Emacs process and resume it later.
10118 On such systems, Emacs starts a subshell instead of suspending. */)
10119 (Lisp_Object stuffstring
)
10121 ptrdiff_t count
= SPECPDL_INDEX ();
10122 int old_height
, old_width
;
10124 struct gcpro gcpro1
;
10127 if (tty_list
&& tty_list
->next
)
10128 error ("There are other tty frames open; close them before suspending Emacs");
10130 if (!NILP (stuffstring
))
10131 CHECK_STRING (stuffstring
);
10133 /* Run the functions in suspend-hook. */
10134 hook
= intern ("suspend-hook");
10135 Frun_hooks (1, &hook
);
10137 GCPRO1 (stuffstring
);
10138 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10139 reset_all_sys_modes ();
10140 /* sys_suspend can get an error if it tries to fork a subshell
10141 and the system resources aren't available for that. */
10142 record_unwind_protect_void (init_all_sys_modes
);
10143 stuff_buffered_input (stuffstring
);
10144 if (cannot_suspend
)
10148 unbind_to (count
, Qnil
);
10150 /* Check if terminal/window size has changed.
10151 Note that this is not useful when we are running directly
10152 with a window system; but suspend should be disabled in that case. */
10153 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10154 if (width
!= old_width
|| height
!= old_height
)
10155 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10157 /* Run suspend-resume-hook. */
10158 hook
= intern ("suspend-resume-hook");
10159 Frun_hooks (1, &hook
);
10165 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10166 Then in any case stuff anything Emacs has read ahead and not used. */
10169 stuff_buffered_input (Lisp_Object stuffstring
)
10171 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10172 register unsigned char *p
;
10174 if (STRINGP (stuffstring
))
10176 register ptrdiff_t count
;
10178 p
= SDATA (stuffstring
);
10179 count
= SBYTES (stuffstring
);
10180 while (count
-- > 0)
10185 /* Anything we have read ahead, put back for the shell to read. */
10186 /* ?? What should this do when we have multiple keyboards??
10187 Should we ignore anything that was typed in at the "wrong" kboard?
10189 rms: we should stuff everything back into the kboard
10191 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10194 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10195 kbd_fetch_ptr
= kbd_buffer
;
10196 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10197 stuff_char (kbd_fetch_ptr
->code
);
10199 clear_event (kbd_fetch_ptr
);
10203 #endif /* SIGTSTP */
10207 set_waiting_for_input (struct timespec
*time_to_clear
)
10209 input_available_clear_time
= time_to_clear
;
10211 /* Tell handle_interrupt to throw back to read_char, */
10212 waiting_for_input
= 1;
10214 /* If handle_interrupt was called before and buffered a C-g,
10215 make it run again now, to avoid timing error. */
10216 if (!NILP (Vquit_flag
))
10217 quit_throw_to_read_char (0);
10221 clear_waiting_for_input (void)
10223 /* Tell handle_interrupt not to throw back to read_char, */
10224 waiting_for_input
= 0;
10225 input_available_clear_time
= 0;
10228 /* The SIGINT handler.
10230 If we have a frame on the controlling tty, we assume that the
10231 SIGINT was generated by C-g, so we call handle_interrupt.
10232 Otherwise, tell QUIT to kill Emacs. */
10235 handle_interrupt_signal (int sig
)
10237 /* See if we have an active terminal on our controlling tty. */
10238 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10241 /* If there are no frames there, let's pretend that we are a
10242 well-behaving UN*X program and quit. We must not call Lisp
10243 in a signal handler, so tell QUIT to exit when it is
10245 Vquit_flag
= Qkill_emacs
;
10249 /* Otherwise, the SIGINT was probably generated by C-g. */
10251 /* Set internal_last_event_frame to the top frame of the
10252 controlling tty, if we have a frame there. We disable the
10253 interrupt key on secondary ttys, so the SIGINT must have come
10254 from the controlling tty. */
10255 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10257 handle_interrupt (1);
10262 deliver_interrupt_signal (int sig
)
10264 deliver_process_signal (sig
, handle_interrupt_signal
);
10268 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10269 of the number of times C-g has been requested. If C-g is pressed
10270 enough times, then quit anyway. See bug#6585. */
10271 static int volatile force_quit_count
;
10273 /* This routine is called at interrupt level in response to C-g.
10275 It is called from the SIGINT handler or kbd_buffer_store_event.
10277 If `waiting_for_input' is non zero, then unless `echoing' is
10278 nonzero, immediately throw back to read_char.
10280 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10281 eval to throw, when it gets a chance. If quit-flag is already
10282 non-nil, it stops the job right away. */
10285 handle_interrupt (bool in_signal_handler
)
10291 /* XXX This code needs to be revised for multi-tty support. */
10292 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10294 if (! in_signal_handler
)
10296 /* If SIGINT isn't blocked, don't let us be interrupted by
10297 a SIGINT. It might be harmful due to non-reentrancy
10298 in I/O functions. */
10300 sigemptyset (&blocked
);
10301 sigaddset (&blocked
, SIGINT
);
10302 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10306 reset_all_sys_modes ();
10310 * On systems which can suspend the current process and return to the original
10311 * shell, this command causes the user to end up back at the shell.
10312 * The "Auto-save" and "Abort" questions are not asked until
10313 * the user elects to return to emacs, at which point he can save the current
10314 * job and either dump core or continue.
10318 /* Perhaps should really fork an inferior shell?
10319 But that would not provide any way to get back
10320 to the original shell, ever. */
10321 printf ("No support for stopping a process on this operating system;\n");
10322 printf ("you can continue or abort.\n");
10323 #endif /* not SIGTSTP */
10325 /* We must remain inside the screen area when the internal terminal
10326 is used. Note that [Enter] is not echoed by dos. */
10327 cursor_to (SELECTED_FRAME (), 0, 0);
10329 /* It doesn't work to autosave while GC is in progress;
10330 the code used for auto-saving doesn't cope with the mark bit. */
10331 if (!gc_in_progress
)
10333 printf ("Auto-save? (y or n) ");
10335 if (((c
= getchar ()) & ~040) == 'Y')
10337 Fdo_auto_save (Qt
, Qnil
);
10339 printf ("\r\nAuto-save done");
10340 #else /* not MSDOS */
10341 printf ("Auto-save done\n");
10342 #endif /* not MSDOS */
10344 while (c
!= '\n') c
= getchar ();
10348 /* During GC, it must be safe to reenable quitting again. */
10349 Vinhibit_quit
= Qnil
;
10352 #endif /* not MSDOS */
10353 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10354 printf ("but will instead do a real quit after garbage collection ends\r\n");
10359 printf ("\r\nAbort? (y or n) ");
10360 #else /* not MSDOS */
10361 printf ("Abort (and dump core)? (y or n) ");
10362 #endif /* not MSDOS */
10364 if (((c
= getchar ()) & ~040) == 'Y')
10366 while (c
!= '\n') c
= getchar ();
10368 printf ("\r\nContinuing...\r\n");
10369 #else /* not MSDOS */
10370 printf ("Continuing...\n");
10371 #endif /* not MSDOS */
10373 init_all_sys_modes ();
10377 /* If executing a function that wants to be interrupted out of
10378 and the user has not deferred quitting by binding `inhibit-quit'
10379 then quit right away. */
10380 if (immediate_quit
&& NILP (Vinhibit_quit
))
10382 struct gl_state_s saved
;
10383 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10385 immediate_quit
= 0;
10386 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10388 GCPRO4 (saved
.object
, saved
.global_code
,
10389 saved
.current_syntax_table
, saved
.old_prop
);
10390 Fsignal (Qquit
, Qnil
);
10395 { /* Else request quit when it's safe. */
10396 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10397 force_quit_count
= count
;
10400 immediate_quit
= 1;
10401 Vinhibit_quit
= Qnil
;
10407 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10409 /* TODO: The longjmp in this call throws the NS event loop integration off,
10410 and it seems to do fine without this. Probably some attention
10411 needs to be paid to the setting of waiting_for_input in
10412 wait_reading_process_output() under HAVE_NS because of the call
10413 to ns_select there (needed because otherwise events aren't picked up
10414 outside of polling since we don't get SIGIO like X and we don't have a
10415 separate event loop thread like W32. */
10417 if (waiting_for_input
&& !echoing
)
10418 quit_throw_to_read_char (in_signal_handler
);
10422 /* Handle a C-g by making read_char return C-g. */
10425 quit_throw_to_read_char (bool from_signal
)
10427 /* When not called from a signal handler it is safe to call
10429 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10430 Fkill_emacs (Qnil
);
10432 /* Prevent another signal from doing this before we finish. */
10433 clear_waiting_for_input ();
10436 Vunread_command_events
= Qnil
;
10438 if (FRAMEP (internal_last_event_frame
)
10439 && !EQ (internal_last_event_frame
, selected_frame
))
10440 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10443 sys_longjmp (getcjmp
, 1);
10446 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10447 Sset_input_interrupt_mode
, 1, 1, 0,
10448 doc
: /* Set interrupt mode of reading keyboard input.
10449 If INTERRUPT is non-nil, Emacs will use input interrupts;
10450 otherwise Emacs uses CBREAK mode.
10452 See also `current-input-mode'. */)
10453 (Lisp_Object interrupt
)
10455 bool new_interrupt_input
;
10456 #ifdef USABLE_SIGIO
10457 #ifdef HAVE_X_WINDOWS
10458 if (x_display_list
!= NULL
)
10460 /* When using X, don't give the user a real choice,
10461 because we haven't implemented the mechanisms to support it. */
10462 new_interrupt_input
= 1;
10465 #endif /* HAVE_X_WINDOWS */
10466 new_interrupt_input
= !NILP (interrupt
);
10467 #else /* not USABLE_SIGIO */
10468 new_interrupt_input
= 0;
10469 #endif /* not USABLE_SIGIO */
10471 if (new_interrupt_input
!= interrupt_input
)
10473 #ifdef POLL_FOR_INPUT
10477 /* this causes startup screen to be restored and messes with the mouse */
10478 reset_all_sys_modes ();
10479 interrupt_input
= new_interrupt_input
;
10480 init_all_sys_modes ();
10482 interrupt_input
= new_interrupt_input
;
10485 #ifdef POLL_FOR_INPUT
10486 poll_suppress_count
= 1;
10493 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10494 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10495 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10496 C-q in key sequences.
10498 This setting only has an effect on tty terminals and only when
10499 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10501 See also `current-input-mode'. */)
10502 (Lisp_Object flow
, Lisp_Object terminal
)
10504 struct terminal
*t
= get_terminal (terminal
, 1);
10505 struct tty_display_info
*tty
;
10506 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10508 tty
= t
->display_info
.tty
;
10510 if (tty
->flow_control
!= !NILP (flow
))
10513 /* This causes startup screen to be restored and messes with the mouse. */
10514 reset_sys_modes (tty
);
10517 tty
->flow_control
= !NILP (flow
);
10520 init_sys_modes (tty
);
10526 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10527 doc
: /* Enable or disable 8-bit input on TERMINAL.
10528 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10529 bit as the Meta modifier.
10531 If META is nil, Emacs will ignore the top bit, on the assumption it is
10534 Otherwise, Emacs will accept and pass through 8-bit input without
10535 specially interpreting the top bit.
10537 This setting only has an effect on tty terminal devices.
10539 Optional parameter TERMINAL specifies the tty terminal device to use.
10540 It may be a terminal object, a frame, or nil for the terminal used by
10541 the currently selected frame.
10543 See also `current-input-mode'. */)
10544 (Lisp_Object meta
, Lisp_Object terminal
)
10546 struct terminal
*t
= get_terminal (terminal
, 1);
10547 struct tty_display_info
*tty
;
10550 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10552 tty
= t
->display_info
.tty
;
10556 else if (EQ (meta
, Qt
))
10561 if (tty
->meta_key
!= new_meta
)
10564 /* this causes startup screen to be restored and messes with the mouse */
10565 reset_sys_modes (tty
);
10568 tty
->meta_key
= new_meta
;
10571 init_sys_modes (tty
);
10577 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10578 doc
: /* Specify character used for quitting.
10579 QUIT must be an ASCII character.
10581 This function only has an effect on the controlling tty of the Emacs
10584 See also `current-input-mode'. */)
10587 struct terminal
*t
= get_named_tty ("/dev/tty");
10588 struct tty_display_info
*tty
;
10589 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10591 tty
= t
->display_info
.tty
;
10593 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10594 error ("QUIT must be an ASCII character");
10597 /* this causes startup screen to be restored and messes with the mouse */
10598 reset_sys_modes (tty
);
10601 /* Don't let this value be out of range. */
10602 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10605 init_sys_modes (tty
);
10611 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10612 doc
: /* Set mode of reading keyboard input.
10613 First arg INTERRUPT non-nil means use input interrupts;
10614 nil means use CBREAK mode.
10615 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10616 (no effect except in CBREAK mode).
10617 Third arg META t means accept 8-bit input (for a Meta key).
10618 META nil means ignore the top bit, on the assumption it is parity.
10619 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10620 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10621 See also `current-input-mode'. */)
10622 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10624 Fset_input_interrupt_mode (interrupt
);
10625 Fset_output_flow_control (flow
, Qnil
);
10626 Fset_input_meta_mode (meta
, Qnil
);
10628 Fset_quit_char (quit
);
10632 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10633 doc
: /* Return information about the way Emacs currently reads keyboard input.
10634 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10635 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10636 nil, Emacs is using CBREAK mode.
10637 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10638 terminal; this does not apply if Emacs uses interrupt-driven input.
10639 META is t if accepting 8-bit input with 8th bit as Meta flag.
10640 META nil means ignoring the top bit, on the assumption it is parity.
10641 META is neither t nor nil if accepting 8-bit input and using
10642 all 8 bits as the character code.
10643 QUIT is the character Emacs currently uses to quit.
10644 The elements of this list correspond to the arguments of
10645 `set-input-mode'. */)
10648 Lisp_Object val
[4];
10649 struct frame
*sf
= XFRAME (selected_frame
);
10651 val
[0] = interrupt_input
? Qt
: Qnil
;
10652 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10654 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10655 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10657 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10664 XSETFASTINT (val
[3], quit_char
);
10666 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10669 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10670 doc
: /* Return position information for pixel coordinates X and Y.
10671 By default, X and Y are relative to text area of the selected window.
10672 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10673 If optional fourth arg WHOLE is non-nil, X is relative to the left
10674 edge of the window.
10676 The return value is similar to a mouse click position:
10677 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10678 IMAGE (DX . DY) (WIDTH . HEIGHT))
10679 The `posn-' functions access elements of such lists. */)
10680 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10685 if (NILP (frame_or_window
))
10686 frame_or_window
= selected_window
;
10688 if (WINDOWP (frame_or_window
))
10690 struct window
*w
= decode_live_window (frame_or_window
);
10692 XSETINT (x
, (XINT (x
)
10693 + WINDOW_LEFT_EDGE_X (w
)
10695 ? window_box_left_offset (w
, TEXT_AREA
)
10697 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10698 frame_or_window
= w
->frame
;
10701 CHECK_LIVE_FRAME (frame_or_window
);
10703 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10706 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10707 doc
: /* Return position information for buffer POS in WINDOW.
10708 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10710 Return nil if position is not visible in window. Otherwise,
10711 the return value is similar to that returned by `event-start' for
10712 a mouse click at the upper left corner of the glyph corresponding
10713 to the given buffer position:
10714 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10715 IMAGE (DX . DY) (WIDTH . HEIGHT))
10716 The `posn-' functions access elements of such lists. */)
10717 (Lisp_Object pos
, Lisp_Object window
)
10722 window
= selected_window
;
10724 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10727 Lisp_Object x
= XCAR (tem
);
10728 Lisp_Object y
= XCAR (XCDR (tem
));
10730 /* Point invisible due to hscrolling? */
10733 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10741 * Set up a new kboard object with reasonable initial values.
10744 init_kboard (KBOARD
*kb
)
10746 kset_overriding_terminal_local_map (kb
, Qnil
);
10747 kset_last_command (kb
, Qnil
);
10748 kset_real_last_command (kb
, Qnil
);
10749 kset_keyboard_translate_table (kb
, Qnil
);
10750 kset_last_repeatable_command (kb
, Qnil
);
10751 kset_prefix_arg (kb
, Qnil
);
10752 kset_last_prefix_arg (kb
, Qnil
);
10753 kset_kbd_queue (kb
, Qnil
);
10754 kb
->kbd_queue_has_data
= 0;
10755 kb
->immediate_echo
= 0;
10756 kset_echo_string (kb
, Qnil
);
10757 kb
->echo_after_prompt
= -1;
10758 kb
->kbd_macro_buffer
= 0;
10759 kb
->kbd_macro_bufsize
= 0;
10760 kset_defining_kbd_macro (kb
, Qnil
);
10761 kset_last_kbd_macro (kb
, Qnil
);
10762 kb
->reference_count
= 0;
10763 kset_system_key_alist (kb
, Qnil
);
10764 kset_system_key_syms (kb
, Qnil
);
10765 kset_window_system (kb
, Qt
); /* Unset. */
10766 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10767 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10768 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10769 kset_default_minibuffer_frame (kb
, Qnil
);
10773 * Destroy the contents of a kboard object, but not the object itself.
10774 * We use this just before deleting it, or if we're going to initialize
10775 * it a second time.
10778 wipe_kboard (KBOARD
*kb
)
10780 xfree (kb
->kbd_macro_buffer
);
10783 /* Free KB and memory referenced from it. */
10786 delete_kboard (KBOARD
*kb
)
10790 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10793 *kbp
= kb
->next_kboard
;
10795 /* Prevent a dangling reference to KB. */
10796 if (kb
== current_kboard
10797 && FRAMEP (selected_frame
)
10798 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10800 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10802 if (current_kboard
== kb
)
10811 init_keyboard (void)
10813 /* This is correct before outermost invocation of the editor loop. */
10814 command_loop_level
= -1;
10815 immediate_quit
= 0;
10816 quit_char
= Ctl ('g');
10817 Vunread_command_events
= Qnil
;
10818 timer_idleness_start_time
= invalid_timespec ();
10820 recent_keys_index
= 0;
10821 kbd_fetch_ptr
= kbd_buffer
;
10822 kbd_store_ptr
= kbd_buffer
;
10823 do_mouse_tracking
= Qnil
;
10825 interrupt_input_blocked
= 0;
10826 pending_signals
= 0;
10828 /* This means that command_loop_1 won't try to select anything the first
10830 internal_last_event_frame
= Qnil
;
10831 Vlast_event_frame
= internal_last_event_frame
;
10833 current_kboard
= initial_kboard
;
10834 /* Re-initialize the keyboard again. */
10835 wipe_kboard (current_kboard
);
10836 init_kboard (current_kboard
);
10837 /* A value of nil for Vwindow_system normally means a tty, but we also use
10838 it for the initial terminal since there is no window system there. */
10839 kset_window_system (current_kboard
, Qnil
);
10841 if (!noninteractive
)
10843 /* Before multi-tty support, these handlers used to be installed
10844 only if the current session was a tty session. Now an Emacs
10845 session may have multiple display types, so we always handle
10846 SIGINT. There is special code in handle_interrupt_signal to exit
10847 Emacs on SIGINT when there are no termcap frames on the
10848 controlling terminal. */
10849 struct sigaction action
;
10850 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10851 sigaction (SIGINT
, &action
, 0);
10853 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10854 SIGQUIT and we can't tell which one it will give us. */
10855 sigaction (SIGQUIT
, &action
, 0);
10856 #endif /* not DOS_NT */
10858 #ifdef USABLE_SIGIO
10859 if (!noninteractive
)
10861 struct sigaction action
;
10862 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10863 sigaction (SIGIO
, &action
, 0);
10867 /* Use interrupt input by default, if it works and noninterrupt input
10868 has deficiencies. */
10870 #ifdef INTERRUPT_INPUT
10871 interrupt_input
= 1;
10873 interrupt_input
= 0;
10876 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10879 if (keyboard_init_hook
)
10880 (*keyboard_init_hook
) ();
10882 #ifdef POLL_FOR_INPUT
10884 poll_suppress_count
= 1;
10889 /* This type's only use is in syms_of_keyboard, to initialize the
10890 event header symbols and put properties on them. */
10891 struct event_head
{
10897 static const struct event_head head_table
[] = {
10898 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10899 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10900 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10901 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10902 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10903 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10904 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10905 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10906 /* `select-window' should be handled just like `switch-frame'
10907 in read_key_sequence. */
10908 {&Qselect_window
, "select-window", &Qswitch_frame
}
10912 syms_of_keyboard (void)
10914 pending_funcalls
= Qnil
;
10915 staticpro (&pending_funcalls
);
10917 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10918 staticpro (&Vlispy_mouse_stem
);
10921 DEFSYM (QCimage
, ":image");
10922 DEFSYM (Qhelp_echo
, "help-echo");
10923 DEFSYM (QCrtl
, ":rtl");
10925 staticpro (&item_properties
);
10926 item_properties
= Qnil
;
10928 staticpro (&tool_bar_item_properties
);
10929 tool_bar_item_properties
= Qnil
;
10930 staticpro (&tool_bar_items_vector
);
10931 tool_bar_items_vector
= Qnil
;
10933 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10934 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10935 DEFSYM (Qself_insert_command
, "self-insert-command");
10936 DEFSYM (Qforward_char
, "forward-char");
10937 DEFSYM (Qbackward_char
, "backward-char");
10938 DEFSYM (Qdisabled
, "disabled");
10939 DEFSYM (Qundefined
, "undefined");
10940 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10941 DEFSYM (Qpost_command_hook
, "post-command-hook");
10942 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10943 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10944 DEFSYM (Qfunction_key
, "function-key");
10945 DEFSYM (Qmouse_click
, "mouse-click");
10946 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10947 DEFSYM (Qsave_session
, "save-session");
10948 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10949 DEFSYM (Qmenu_enable
, "menu-enable");
10952 DEFSYM (Qlanguage_change
, "language-change");
10956 DEFSYM (Qdbus_event
, "dbus-event");
10959 #ifdef USE_FILE_NOTIFY
10960 DEFSYM (Qfile_notify
, "file-notify");
10961 #endif /* USE_FILE_NOTIFY */
10963 DEFSYM (QCenable
, ":enable");
10964 DEFSYM (QCvisible
, ":visible");
10965 DEFSYM (QChelp
, ":help");
10966 DEFSYM (QCfilter
, ":filter");
10967 DEFSYM (QCbutton
, ":button");
10968 DEFSYM (QCkeys
, ":keys");
10969 DEFSYM (QCkey_sequence
, ":key-sequence");
10970 DEFSYM (QCtoggle
, ":toggle");
10971 DEFSYM (QCradio
, ":radio");
10972 DEFSYM (QClabel
, ":label");
10973 DEFSYM (QCvert_only
, ":vert-only");
10975 DEFSYM (Qmode_line
, "mode-line");
10976 DEFSYM (Qvertical_line
, "vertical-line");
10977 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
10978 DEFSYM (Qmenu_bar
, "menu-bar");
10980 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
10982 DEFSYM (Qabove_handle
, "above-handle");
10983 DEFSYM (Qhandle
, "handle");
10984 DEFSYM (Qbelow_handle
, "below-handle");
10985 DEFSYM (Qup
, "up");
10986 DEFSYM (Qdown
, "down");
10987 DEFSYM (Qtop
, "top");
10988 DEFSYM (Qbottom
, "bottom");
10989 DEFSYM (Qend_scroll
, "end-scroll");
10990 DEFSYM (Qratio
, "ratio");
10992 DEFSYM (Qevent_kind
, "event-kind");
10993 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
10994 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
10995 DEFSYM (Qmodifier_cache
, "modifier-cache");
10997 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
10998 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11000 DEFSYM (Qpolling_period
, "polling-period");
11002 DEFSYM (Qx_set_selection
, "x-set-selection");
11003 DEFSYM (QPRIMARY
, "PRIMARY");
11004 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11005 DEFSYM (Qhandle_select_window
, "handle-select-window");
11007 DEFSYM (Qinput_method_function
, "input-method-function");
11008 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11009 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11011 DEFSYM (Qhelp_form_show
, "help-form-show");
11013 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11014 Fset (Qinput_method_use_echo_area
, Qnil
);
11018 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11020 for (i
= 0; i
< len
; i
++)
11022 const struct event_head
*p
= &head_table
[i
];
11023 *p
->var
= intern_c_string (p
->name
);
11024 staticpro (p
->var
);
11025 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11026 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11030 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11031 staticpro (&button_down_location
);
11032 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11033 staticpro (&mouse_syms
);
11034 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11035 / sizeof (lispy_wheel_names
[0])),
11037 staticpro (&wheel_syms
);
11041 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11043 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11044 for (i
= 0; i
< len
; i
++)
11045 if (modifier_names
[i
])
11046 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11047 staticpro (&modifier_symbols
);
11050 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11051 staticpro (&recent_keys
);
11053 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11054 staticpro (&this_command_keys
);
11056 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11057 staticpro (&raw_keybuf
);
11059 DEFSYM (Qcommand_execute
, "command-execute");
11061 accent_key_syms
= Qnil
;
11062 staticpro (&accent_key_syms
);
11064 func_key_syms
= Qnil
;
11065 staticpro (&func_key_syms
);
11067 drag_n_drop_syms
= Qnil
;
11068 staticpro (&drag_n_drop_syms
);
11070 unread_switch_frame
= Qnil
;
11071 staticpro (&unread_switch_frame
);
11073 internal_last_event_frame
= Qnil
;
11074 staticpro (&internal_last_event_frame
);
11076 read_key_sequence_cmd
= Qnil
;
11077 staticpro (&read_key_sequence_cmd
);
11078 read_key_sequence_remapped
= Qnil
;
11079 staticpro (&read_key_sequence_remapped
);
11081 menu_bar_one_keymap_changed_items
= Qnil
;
11082 staticpro (&menu_bar_one_keymap_changed_items
);
11084 menu_bar_items_vector
= Qnil
;
11085 staticpro (&menu_bar_items_vector
);
11087 help_form_saved_window_configs
= Qnil
;
11088 staticpro (&help_form_saved_window_configs
);
11090 defsubr (&Scurrent_idle_time
);
11091 defsubr (&Sevent_symbol_parse_modifiers
);
11092 defsubr (&Sevent_convert_list
);
11093 defsubr (&Sread_key_sequence
);
11094 defsubr (&Sread_key_sequence_vector
);
11095 defsubr (&Srecursive_edit
);
11096 defsubr (&Strack_mouse
);
11097 defsubr (&Sinput_pending_p
);
11098 defsubr (&Srecent_keys
);
11099 defsubr (&Sthis_command_keys
);
11100 defsubr (&Sthis_command_keys_vector
);
11101 defsubr (&Sthis_single_command_keys
);
11102 defsubr (&Sthis_single_command_raw_keys
);
11103 defsubr (&Sreset_this_command_lengths
);
11104 defsubr (&Sclear_this_command_keys
);
11105 defsubr (&Ssuspend_emacs
);
11106 defsubr (&Sabort_recursive_edit
);
11107 defsubr (&Sexit_recursive_edit
);
11108 defsubr (&Srecursion_depth
);
11109 defsubr (&Stop_level
);
11110 defsubr (&Sdiscard_input
);
11111 defsubr (&Sopen_dribble_file
);
11112 defsubr (&Sset_input_interrupt_mode
);
11113 defsubr (&Sset_output_flow_control
);
11114 defsubr (&Sset_input_meta_mode
);
11115 defsubr (&Sset_quit_char
);
11116 defsubr (&Sset_input_mode
);
11117 defsubr (&Scurrent_input_mode
);
11118 defsubr (&Sposn_at_point
);
11119 defsubr (&Sposn_at_x_y
);
11121 DEFVAR_LISP ("last-command-event", last_command_event
,
11122 doc
: /* Last input event that was part of a command. */);
11124 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11125 doc
: /* Last input event in a command, except for mouse menu events.
11126 Mouse menus give back keys that don't look like mouse events;
11127 this variable holds the actual mouse event that led to the menu,
11128 so that you can determine whether the command was run by mouse or not. */);
11130 DEFVAR_LISP ("last-input-event", last_input_event
,
11131 doc
: /* Last input event. */);
11133 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11134 doc
: /* List of events to be read as the command input.
11135 These events are processed first, before actual keyboard input.
11136 Events read from this list are not normally added to `this-command-keys',
11137 as they will already have been added once as they were read for the first time.
11138 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11139 Vunread_command_events
= Qnil
;
11141 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11142 doc
: /* List of events to be processed as input by input methods.
11143 These events are processed before `unread-command-events'
11144 and actual keyboard input, but are not given to `input-method-function'. */);
11145 Vunread_post_input_method_events
= Qnil
;
11147 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11148 doc
: /* List of events to be processed as input by input methods.
11149 These events are processed after `unread-command-events', but
11150 before actual keyboard input.
11151 If there's an active input method, the events are given to
11152 `input-method-function'. */);
11153 Vunread_input_method_events
= Qnil
;
11155 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11156 doc
: /* Meta-prefix character code.
11157 Meta-foo as command input turns into this character followed by foo. */);
11158 XSETINT (meta_prefix_char
, 033);
11160 DEFVAR_KBOARD ("last-command", Vlast_command
,
11161 doc
: /* The last command executed.
11162 Normally a symbol with a function definition, but can be whatever was found
11163 in the keymap, or whatever the variable `this-command' was set to by that
11166 The value `mode-exit' is special; it means that the previous command
11167 read an event that told it to exit, and it did so and unread that event.
11168 In other words, the present command is the event that made the previous
11171 The value `kill-region' is special; it means that the previous command
11172 was a kill command.
11174 `last-command' has a separate binding for each terminal device.
11175 See Info node `(elisp)Multiple Terminals'. */);
11177 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11178 doc
: /* Same as `last-command', but never altered by Lisp code.
11179 Taken from the previous value of `real-this-command'. */);
11181 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11182 doc
: /* Last command that may be repeated.
11183 The last command executed that was not bound to an input event.
11184 This is the command `repeat' will try to repeat.
11185 Taken from a previous value of `real-this-command'. */);
11187 DEFVAR_LISP ("this-command", Vthis_command
,
11188 doc
: /* The command now being executed.
11189 The command can set this variable; whatever is put here
11190 will be in `last-command' during the following command. */);
11191 Vthis_command
= Qnil
;
11193 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11194 doc
: /* This is like `this-command', except that commands should never modify it. */);
11195 Vreal_this_command
= Qnil
;
11197 DEFVAR_LISP ("this-command-keys-shift-translated",
11198 Vthis_command_keys_shift_translated
,
11199 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11200 Shift-translation occurs when there is no binding for the key sequence
11201 as entered, but a binding was found by changing an upper-case letter
11202 to lower-case, or a shifted function key to an unshifted one. */);
11203 Vthis_command_keys_shift_translated
= Qnil
;
11205 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11206 doc
: /* The command bound to the current key sequence before remapping.
11207 It equals `this-command' if the original command was not remapped through
11208 any of the active keymaps. Otherwise, the value of `this-command' is the
11209 result of looking up the original command in the active keymaps. */);
11210 Vthis_original_command
= Qnil
;
11212 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11213 doc
: /* Number of input events between auto-saves.
11214 Zero means disable autosaving due to number of characters typed. */);
11215 auto_save_interval
= 300;
11217 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11218 doc
: /* Number of seconds idle time before auto-save.
11219 Zero or nil means disable auto-saving due to idleness.
11220 After auto-saving due to this many seconds of idle time,
11221 Emacs also does a garbage collection if that seems to be warranted. */);
11222 XSETFASTINT (Vauto_save_timeout
, 30);
11224 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11225 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11226 The value may be integer or floating point.
11227 If the value is zero, don't echo at all. */);
11228 Vecho_keystrokes
= make_number (1);
11230 DEFVAR_INT ("polling-period", polling_period
,
11231 doc
: /* Interval between polling for input during Lisp execution.
11232 The reason for polling is to make C-g work to stop a running program.
11233 Polling is needed only when using X windows and SIGIO does not work.
11234 Polling is automatically disabled in all other cases. */);
11235 polling_period
= 2;
11237 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11238 doc
: /* Maximum time between mouse clicks to make a double-click.
11239 Measured in milliseconds. The value nil means disable double-click
11240 recognition; t means double-clicks have no time limit and are detected
11241 by position only. */);
11242 Vdouble_click_time
= make_number (500);
11244 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11245 doc
: /* Maximum mouse movement between clicks to make a double-click.
11246 On window-system frames, value is the number of pixels the mouse may have
11247 moved horizontally or vertically between two clicks to make a double-click.
11248 On non window-system frames, value is interpreted in units of 1/8 characters
11251 This variable is also the threshold for motion of the mouse
11252 to count as a drag. */);
11253 double_click_fuzz
= 3;
11255 DEFVAR_INT ("num-input-keys", num_input_keys
,
11256 doc
: /* Number of complete key sequences read as input so far.
11257 This includes key sequences read from keyboard macros.
11258 The number is effectively the number of interactive command invocations. */);
11259 num_input_keys
= 0;
11261 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11262 doc
: /* Number of input events read from the keyboard so far.
11263 This does not include events generated by keyboard macros. */);
11264 num_nonmacro_input_events
= 0;
11266 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11267 doc
: /* The frame in which the most recently read event occurred.
11268 If the last event came from a keyboard macro, this is set to `macro'. */);
11269 Vlast_event_frame
= Qnil
;
11271 /* This variable is set up in sysdep.c. */
11272 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11273 doc
: /* The ERASE character as set by the user with stty. */);
11275 DEFVAR_LISP ("help-char", Vhelp_char
,
11276 doc
: /* Character to recognize as meaning Help.
11277 When it is read, do `(eval help-form)', and display result if it's a string.
11278 If the value of `help-form' is nil, this char can be read normally. */);
11279 XSETINT (Vhelp_char
, Ctl ('H'));
11281 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11282 doc
: /* List of input events to recognize as meaning Help.
11283 These work just like the value of `help-char' (see that). */);
11284 Vhelp_event_list
= Qnil
;
11286 DEFVAR_LISP ("help-form", Vhelp_form
,
11287 doc
: /* Form to execute when character `help-char' is read.
11288 If the form returns a string, that string is displayed.
11289 If `help-form' is nil, the help char is not recognized. */);
11292 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11293 doc
: /* Command to run when `help-char' character follows a prefix key.
11294 This command is used only when there is no actual binding
11295 for that character after that prefix key. */);
11296 Vprefix_help_command
= Qnil
;
11298 DEFVAR_LISP ("top-level", Vtop_level
,
11299 doc
: /* Form to evaluate when Emacs starts up.
11300 Useful to set before you dump a modified Emacs. */);
11303 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11304 doc
: /* Translate table for local keyboard input, or nil.
11305 If non-nil, the value should be a char-table. Each character read
11306 from the keyboard is looked up in this char-table. If the value found
11307 there is non-nil, then it is used instead of the actual input character.
11309 The value can also be a string or vector, but this is considered obsolete.
11310 If it is a string or vector of length N, character codes N and up are left
11311 untranslated. In a vector, an element which is nil means "no translation".
11313 This is applied to the characters supplied to input methods, not their
11314 output. See also `translation-table-for-input'.
11316 This variable has a separate binding for each terminal.
11317 See Info node `(elisp)Multiple Terminals'. */);
11319 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11320 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11321 \(Even if the operating system has support for stopping a process.\) */);
11322 cannot_suspend
= 0;
11324 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11325 doc
: /* Non-nil means prompt with menus when appropriate.
11326 This is done when reading from a keymap that has a prompt string,
11327 for elements that have prompt strings.
11328 The menu is displayed on the screen
11329 if X menus were enabled at configuration
11330 time and the previous event was a mouse click prefix key.
11331 Otherwise, menu prompting uses the echo area. */);
11332 menu_prompting
= 1;
11334 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11335 doc
: /* Character to see next line of menu prompt.
11336 Type this character while in a menu prompt to rotate around the lines of it. */);
11337 XSETINT (menu_prompt_more_char
, ' ');
11339 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11340 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11341 Emacs applies the modifiers of the character stored here to each keyboard
11342 character it reads. For example, after evaluating the expression
11343 (setq extra-keyboard-modifiers ?\\C-x)
11344 all input characters will have the control modifier applied to them.
11346 Note that the character ?\\C-@, equivalent to the integer zero, does
11347 not count as a control character; rather, it counts as a character
11348 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11349 cancels any modification. */);
11350 extra_keyboard_modifiers
= 0;
11352 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11353 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11354 The command loop sets this to nil before each command,
11355 and tests the value when the command returns.
11356 Buffer modification stores t in this variable. */);
11357 Vdeactivate_mark
= Qnil
;
11358 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11360 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11361 doc
: /* Normal hook run before each command is executed.
11362 If an unhandled error happens in running this hook,
11363 the function in which the error occurred is unconditionally removed, since
11364 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11365 Vpre_command_hook
= Qnil
;
11367 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11368 doc
: /* Normal hook run after each command is executed.
11369 If an unhandled error happens in running this hook,
11370 the function in which the error occurred is unconditionally removed, since
11371 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11372 Vpost_command_hook
= Qnil
;
11375 DEFVAR_LISP ("echo-area-clear-hook", ...,
11376 doc
: /* Normal hook run when clearing the echo area. */);
11378 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11379 Fset (Qecho_area_clear_hook
, Qnil
);
11381 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11382 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11383 Vlucid_menu_bar_dirty_flag
= Qnil
;
11385 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11386 doc
: /* List of menu bar items to move to the end of the menu bar.
11387 The elements of the list are event types that may have menu bar bindings. */);
11388 Vmenu_bar_final_items
= Qnil
;
11390 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11391 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11392 This is used internally by graphical displays that do not render
11393 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11394 Vtool_bar_separator_image_expression
= Qnil
;
11396 DEFVAR_KBOARD ("overriding-terminal-local-map",
11397 Voverriding_terminal_local_map
,
11398 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11400 This variable is intended to let commands such as `universal-argument'
11401 set up a different keymap for reading the next command.
11403 `overriding-terminal-local-map' has a separate binding for each
11405 See Info node `(elisp)Multiple Terminals'. */);
11407 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11408 doc
: /* Keymap that overrides almost all other local keymaps.
11409 If this variable is non-nil, it is used as a keymap--replacing the
11410 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11411 Voverriding_local_map
= Qnil
;
11413 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11414 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11415 Otherwise, the menu bar continues to reflect the buffer's local map
11416 and the minor mode maps regardless of `overriding-local-map'. */);
11417 Voverriding_local_map_menu_flag
= Qnil
;
11419 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11420 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11421 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11423 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11424 doc
: /* Non-nil means generate motion events for mouse motion. */);
11426 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11427 doc
: /* Alist of system-specific X windows key symbols.
11428 Each element should have the form (N . SYMBOL) where N is the
11429 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11430 and SYMBOL is its name.
11432 `system-key-alist' has a separate binding for each terminal device.
11433 See Info node `(elisp)Multiple Terminals'. */);
11435 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11436 doc
: /* Keymap that translates key sequences to key sequences during input.
11437 This is used mainly for mapping key sequences into some preferred
11438 key events (symbols).
11440 The `read-key-sequence' function replaces any subsequence bound by
11441 `local-function-key-map' with its binding. More precisely, when the
11442 active keymaps have no binding for the current key sequence but
11443 `local-function-key-map' binds a suffix of the sequence to a vector or
11444 string, `read-key-sequence' replaces the matching suffix with its
11445 binding, and continues with the new sequence.
11447 If the binding is a function, it is called with one argument (the prompt)
11448 and its return value (a key sequence) is used.
11450 The events that come from bindings in `local-function-key-map' are not
11451 themselves looked up in `local-function-key-map'.
11453 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11454 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11455 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11456 typing `ESC O P x' would return [f1 x].
11458 `local-function-key-map' has a separate binding for each terminal
11459 device. See Info node `(elisp)Multiple Terminals'. If you need to
11460 define a binding on all terminals, change `function-key-map'
11461 instead. Initially, `local-function-key-map' is an empty keymap that
11462 has `function-key-map' as its parent on all terminal devices. */);
11464 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11465 doc
: /* Keymap that decodes input escape sequences.
11466 This is used mainly for mapping ASCII function key sequences into
11467 real Emacs function key events (symbols).
11469 The `read-key-sequence' function replaces any subsequence bound by
11470 `input-decode-map' with its binding. Contrary to `function-key-map',
11471 this map applies its rebinding regardless of the presence of an ordinary
11472 binding. So it is more like `key-translation-map' except that it applies
11473 before `function-key-map' rather than after.
11475 If the binding is a function, it is called with one argument (the prompt)
11476 and its return value (a key sequence) is used.
11478 The events that come from bindings in `input-decode-map' are not
11479 themselves looked up in `input-decode-map'. */);
11481 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11482 doc
: /* The parent keymap of all `local-function-key-map' instances.
11483 Function key definitions that apply to all terminal devices should go
11484 here. If a mapping is defined in both the current
11485 `local-function-key-map' binding and this variable, then the local
11486 definition will take precedence. */);
11487 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11489 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11490 doc
: /* Keymap of key translations that can override keymaps.
11491 This keymap works like `input-decode-map', but comes after `function-key-map'.
11492 Another difference is that it is global rather than terminal-local. */);
11493 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11495 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11496 doc
: /* List of deferred actions to be performed at a later time.
11497 The precise format isn't relevant here; we just check whether it is nil. */);
11498 Vdeferred_action_list
= Qnil
;
11500 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11501 doc
: /* Function to call to handle deferred actions, after each command.
11502 This function is called with no arguments after each command
11503 whenever `deferred-action-list' is non-nil. */);
11504 Vdeferred_action_function
= Qnil
;
11506 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11507 doc
: /* List of warnings to be displayed after this command.
11508 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11509 as per the args of `display-warning' (which see).
11510 If this variable is non-nil, `delayed-warnings-hook' will be run
11511 immediately after running `post-command-hook'. */);
11512 Vdelayed_warnings_list
= Qnil
;
11514 DEFVAR_LISP ("timer-list", Vtimer_list
,
11515 doc
: /* List of active absolute time timers in order of increasing time. */);
11516 Vtimer_list
= Qnil
;
11518 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11519 doc
: /* List of active idle-time timers in order of increasing time. */);
11520 Vtimer_idle_list
= Qnil
;
11522 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11523 doc
: /* If non-nil, the function that implements the current input method.
11524 It's called with one argument, a printing character that was just read.
11525 \(That means a character with code 040...0176.)
11526 Typically this function uses `read-event' to read additional events.
11527 When it does so, it should first bind `input-method-function' to nil
11528 so it will not be called recursively.
11530 The function should return a list of zero or more events
11531 to be used as input. If it wants to put back some events
11532 to be reconsidered, separately, by the input method,
11533 it can add them to the beginning of `unread-command-events'.
11535 The input method function can find in `input-method-previous-message'
11536 the previous echo area message.
11538 The input method function should refer to the variables
11539 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11540 for guidance on what to do. */);
11541 Vinput_method_function
= Qnil
;
11543 DEFVAR_LISP ("input-method-previous-message",
11544 Vinput_method_previous_message
,
11545 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11546 This variable exists because `read-event' clears the echo area
11547 before running the input method. It is nil if there was no message. */);
11548 Vinput_method_previous_message
= Qnil
;
11550 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11551 doc
: /* If non-nil, the function that implements the display of help.
11552 It's called with one argument, the help string to display. */);
11553 Vshow_help_function
= Qnil
;
11555 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11556 doc
: /* If non-nil, suppress point adjustment after executing a command.
11558 After a command is executed, if point is moved into a region that has
11559 special properties (e.g. composition, display), we adjust point to
11560 the boundary of the region. But, when a command sets this variable to
11561 non-nil, we suppress the point adjustment.
11563 This variable is set to nil before reading a command, and is checked
11564 just after executing the command. */);
11565 Vdisable_point_adjustment
= Qnil
;
11567 DEFVAR_LISP ("global-disable-point-adjustment",
11568 Vglobal_disable_point_adjustment
,
11569 doc
: /* If non-nil, always suppress point adjustment.
11571 The default value is nil, in which case, point adjustment are
11572 suppressed only after special commands that set
11573 `disable-point-adjustment' (which see) to non-nil. */);
11574 Vglobal_disable_point_adjustment
= Qnil
;
11576 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11577 doc
: /* How long to display an echo-area message when the minibuffer is active.
11578 If the value is not a number, such messages don't time out. */);
11579 Vminibuffer_message_timeout
= make_number (2);
11581 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11582 doc
: /* If non-nil, any keyboard input throws to this symbol.
11583 The value of that variable is passed to `quit-flag' and later causes a
11584 peculiar kind of quitting. */);
11585 Vthrow_on_input
= Qnil
;
11587 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11588 doc
: /* If non-nil, function to output error messages.
11589 The arguments are the error data, a list of the form
11590 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11591 such as just as `condition-case' would bind its variable to,
11592 the context (a string which normally goes at the start of the message),
11593 and the Lisp function within which the error was signaled. */);
11594 Vcommand_error_function
= Qnil
;
11596 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11597 Venable_disabled_menus_and_buttons
,
11598 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11600 Help functions bind this to allow help on disabled menu items
11601 and tool-bar buttons. */);
11602 Venable_disabled_menus_and_buttons
= Qnil
;
11604 DEFVAR_LISP ("select-active-regions",
11605 Vselect_active_regions
,
11606 doc
: /* If non-nil, an active region automatically sets the primary selection.
11607 If the value is `only', only temporarily active regions (usually made
11608 by mouse-dragging or shift-selection) set the window selection.
11610 This takes effect only when Transient Mark mode is enabled. */);
11611 Vselect_active_regions
= Qt
;
11613 DEFVAR_LISP ("saved-region-selection",
11614 Vsaved_region_selection
,
11615 doc
: /* Contents of active region prior to buffer modification.
11616 If `select-active-regions' is non-nil, Emacs sets this to the
11617 text in the region before modifying the buffer. The next call to
11618 the function `deactivate-mark' uses this to set the window selection. */);
11619 Vsaved_region_selection
= Qnil
;
11621 DEFVAR_LISP ("selection-inhibit-update-commands",
11622 Vselection_inhibit_update_commands
,
11623 doc
: /* List of commands which should not update the selection.
11624 Normally, if `select-active-regions' is non-nil and the mark remains
11625 active after a command (i.e. the mark was not deactivated), the Emacs
11626 command loop sets the selection to the text in the region. However,
11627 if the command is in this list, the selection is not updated. */);
11628 Vselection_inhibit_update_commands
11629 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11631 DEFVAR_LISP ("debug-on-event",
11633 doc
: /* Enter debugger on this event. When Emacs
11634 receives the special event specified by this variable, it will try to
11635 break into the debugger as soon as possible instead of processing the
11636 event normally through `special-event-map'.
11638 Currently, the only supported values for this
11639 variable are `sigusr1' and `sigusr2'. */);
11640 Vdebug_on_event
= intern_c_string ("sigusr2");
11642 /* Create the initial keyboard. */
11643 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11644 init_kboard (initial_kboard
);
11645 /* Vwindow_system is left at t for now. */
11646 initial_kboard
->next_kboard
= all_kboards
;
11647 all_kboards
= initial_kboard
;
11651 keys_of_keyboard (void)
11653 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11654 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11655 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11656 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11657 initial_define_key (meta_map
, 'x', "execute-extended-command");
11659 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11660 "handle-delete-frame");
11661 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11662 "ns-put-working-text");
11663 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11664 "ns-unput-working-text");
11665 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11666 current-prefix-arg, as is done in `handle-switch-frame'.
11667 But `handle-switch-frame is not run from the special-map.
11668 Commands from that map are run in a special way that automatically
11669 preserves the prefix-arg. Restoring the prefix arg here is not just
11670 redundant but harmful:
11672 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11673 - after the first prompt, the exit-minibuffer-hook is run which may
11674 iconify a frame and thus push a `iconify-frame' event.
11675 - after running exit-minibuffer-hook, current-prefix-arg is
11676 restored to the non-nil value it had before the prompt.
11677 - we enter the second prompt.
11678 current-prefix-arg is non-nil, prefix-arg is nil.
11679 - before running the first real event, we run the special iconify-frame
11680 event, but we pass the `special' arg to execute-command so
11681 current-prefix-arg and prefix-arg are left untouched.
11682 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11683 - the next key event will have a spuriously non-nil current-prefix-arg. */
11684 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11686 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11688 /* Handling it at such a low-level causes read_key_sequence to get
11689 * confused because it doesn't realize that the current_buffer was
11690 * changed by read_char.
11692 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11693 * "handle-select-window"); */
11694 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11695 "handle-save-session");
11698 /* Define a special event which is raised for dbus callback
11700 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11701 "dbus-handle-event");
11704 #ifdef USE_FILE_NOTIFY
11705 /* Define a special event which is raised for notification callback
11707 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11708 "file-notify-handle-event");
11709 #endif /* USE_FILE_NOTIFY */
11711 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11713 #if defined (WINDOWSNT)
11714 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11717 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11718 "handle-focus-in");
11719 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11720 "handle-focus-out");
11723 /* Mark the pointers in the kboard objects.
11724 Called by Fgarbage_collect. */
11726 mark_kboards (void)
11730 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11732 if (kb
->kbd_macro_buffer
)
11733 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11735 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11736 mark_object (KVAR (kb
, Vlast_command
));
11737 mark_object (KVAR (kb
, Vreal_last_command
));
11738 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11739 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11740 mark_object (KVAR (kb
, Vprefix_arg
));
11741 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11742 mark_object (KVAR (kb
, kbd_queue
));
11743 mark_object (KVAR (kb
, defining_kbd_macro
));
11744 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11745 mark_object (KVAR (kb
, Vsystem_key_alist
));
11746 mark_object (KVAR (kb
, system_key_syms
));
11747 mark_object (KVAR (kb
, Vwindow_system
));
11748 mark_object (KVAR (kb
, Vinput_decode_map
));
11749 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11750 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11751 mark_object (KVAR (kb
, echo_string
));
11754 struct input_event
*event
;
11755 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11757 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11758 event
= kbd_buffer
;
11759 /* These two special event types has no Lisp_Objects to mark. */
11760 if (event
->kind
!= SELECTION_REQUEST_EVENT
11761 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11763 mark_object (event
->x
);
11764 mark_object (event
->y
);
11765 mark_object (event
->frame_or_window
);
11766 mark_object (event
->arg
);