1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
201 uintmax_t num_input_events
;
203 /* Value of num_nonmacro_input_events as of last auto save. */
205 static EMACS_INT last_auto_save
;
207 /* The value of point when the last command was started. */
208 static ptrdiff_t last_point_position
;
210 /* The frame in which the last input event occurred, or Qmacro if the
211 last event came from a macro. We use this to determine when to
212 generate switch-frame events. This may be cleared by functions
213 like Fselect_frame, to make sure that a switch-frame event is
214 generated by the next character.
216 FIXME: This is modified by a signal handler so it should be volatile.
217 It's exported to Lisp, though, so it can't simply be marked
219 Lisp_Object internal_last_event_frame
;
221 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
222 static Lisp_Object Qhandle_select_window
;
223 Lisp_Object QPRIMARY
;
225 static Lisp_Object Qself_insert_command
;
226 static Lisp_Object Qforward_char
;
227 static Lisp_Object Qbackward_char
;
228 Lisp_Object Qundefined
;
229 static Lisp_Object Qtimer_event_handler
;
231 /* `read_key_sequence' stores here the command definition of the
232 key sequence that it reads. */
233 static Lisp_Object read_key_sequence_cmd
;
234 static Lisp_Object read_key_sequence_remapped
;
236 static Lisp_Object Qinput_method_function
;
238 static Lisp_Object Qdeactivate_mark
;
240 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
242 static Lisp_Object Qecho_area_clear_hook
;
244 /* Hooks to run before and after each command. */
245 static Lisp_Object Qpre_command_hook
;
246 static Lisp_Object Qpost_command_hook
;
248 static Lisp_Object Qdeferred_action_function
;
250 static Lisp_Object Qdelayed_warnings_hook
;
252 static Lisp_Object Qinput_method_exit_on_first_char
;
253 static Lisp_Object Qinput_method_use_echo_area
;
255 static Lisp_Object Qhelp_form_show
;
257 /* File in which we write all commands we read. */
258 static FILE *dribble
;
260 /* Nonzero if input is available. */
263 /* Circular buffer for pre-read keyboard input. */
265 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
267 /* Pointer to next available character in kbd_buffer.
268 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
269 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
270 next available char is in kbd_buffer[0]. */
271 static struct input_event
*kbd_fetch_ptr
;
273 /* Pointer to next place to store character in kbd_buffer. This
274 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
275 character should go in kbd_buffer[0]. */
276 static struct input_event
* volatile kbd_store_ptr
;
278 /* The above pair of variables forms a "queue empty" flag. When we
279 enqueue a non-hook event, we increment kbd_store_ptr. When we
280 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
281 there is input available if the two pointers are not equal.
283 Why not just have a flag set and cleared by the enqueuing and
284 dequeuing functions? Such a flag could be screwed up by interrupts
285 at inopportune times. */
287 /* Symbols to head events. */
288 static Lisp_Object Qmouse_movement
;
289 static Lisp_Object Qscroll_bar_movement
;
290 Lisp_Object Qswitch_frame
;
291 static Lisp_Object Qfocus_in
, Qfocus_out
;
292 static Lisp_Object Qdelete_frame
;
293 static Lisp_Object Qiconify_frame
;
294 static Lisp_Object Qmake_frame_visible
;
295 static Lisp_Object Qselect_window
;
296 Lisp_Object Qhelp_echo
;
298 static Lisp_Object Qmouse_fixup_help_message
;
300 /* Symbols to denote kinds of events. */
301 static Lisp_Object Qfunction_key
;
302 Lisp_Object Qmouse_click
;
304 Lisp_Object Qlanguage_change
;
306 static Lisp_Object Qdrag_n_drop
;
307 static Lisp_Object Qsave_session
;
309 static Lisp_Object Qdbus_event
;
311 #ifdef USE_FILE_NOTIFY
312 static Lisp_Object Qfile_notify
;
313 #endif /* USE_FILE_NOTIFY */
314 static Lisp_Object Qconfig_changed_event
;
316 /* Lisp_Object Qmouse_movement; - also an event header */
318 /* Properties of event headers. */
319 Lisp_Object Qevent_kind
;
320 static Lisp_Object Qevent_symbol_elements
;
322 /* Menu and tool bar item parts. */
323 static Lisp_Object Qmenu_enable
;
324 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
325 Lisp_Object QCfilter
;
327 /* Non-nil disable property on a command means
328 do not execute it; call disabled-command-function's value instead. */
329 Lisp_Object QCtoggle
, QCradio
;
330 static Lisp_Object QCbutton
, QClabel
;
332 static Lisp_Object QCvert_only
;
334 /* An event header symbol HEAD may have a property named
335 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
336 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
337 mask of modifiers applied to it. If present, this is used to help
338 speed up parse_modifiers. */
339 Lisp_Object Qevent_symbol_element_mask
;
341 /* An unmodified event header BASE may have a property named
342 Qmodifier_cache, which is an alist mapping modifier masks onto
343 modified versions of BASE. If present, this helps speed up
345 static Lisp_Object Qmodifier_cache
;
347 /* Symbols to use for parts of windows. */
348 Lisp_Object Qmode_line
;
349 Lisp_Object Qvertical_line
;
350 Lisp_Object Qright_divider
, Qbottom_divider
;
351 static Lisp_Object Qvertical_scroll_bar
;
352 Lisp_Object Qmenu_bar
;
354 static Lisp_Object Qecho_keystrokes
;
356 static void recursive_edit_unwind (Lisp_Object buffer
);
357 static Lisp_Object
command_loop (void);
358 static Lisp_Object Qcommand_execute
;
359 struct timespec
timer_check (void);
361 static void echo_now (void);
362 static ptrdiff_t echo_length (void);
364 static Lisp_Object Qpolling_period
;
366 /* Incremented whenever a timer is run. */
369 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
371 struct timespec
*input_available_clear_time
;
373 /* True means use SIGIO interrupts; false means use CBREAK mode.
374 Default is true if INTERRUPT_INPUT is defined. */
375 bool interrupt_input
;
377 /* Nonzero while interrupts are temporarily deferred during redisplay. */
378 bool interrupts_deferred
;
380 /* The time when Emacs started being idle. */
382 static struct timespec timer_idleness_start_time
;
384 /* After Emacs stops being idle, this saves the last value
385 of timer_idleness_start_time from when it was idle. */
387 static struct timespec timer_last_idleness_start_time
;
390 /* Global variable declarations. */
392 /* Flags for readable_events. */
393 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
394 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
395 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
397 /* Function for init_keyboard to call with no args (if nonzero). */
398 static void (*keyboard_init_hook
) (void);
400 static bool get_input_pending (int);
401 static bool readable_events (int);
402 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
403 Lisp_Object
, bool *);
404 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
405 static Lisp_Object
make_lispy_event (struct input_event
*);
406 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
407 enum scroll_bar_part
,
408 Lisp_Object
, Lisp_Object
,
410 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
411 Lisp_Object
, const char *const *,
412 Lisp_Object
*, ptrdiff_t);
413 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
414 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
415 #ifdef HAVE_WINDOW_SYSTEM
416 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
417 #endif /* HAVE_WINDOW_SYSTEM */
418 static bool help_char_p (Lisp_Object
);
419 static void save_getcjmp (sys_jmp_buf
);
420 static void restore_getcjmp (sys_jmp_buf
);
421 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
422 static void clear_event (struct input_event
*);
423 static void restore_kboard_configuration (int);
425 static void deliver_input_available_signal (int signo
);
427 static void handle_interrupt (bool);
428 static _Noreturn
void quit_throw_to_read_char (bool);
429 static void process_special_events (void);
430 static void timer_start_idle (void);
431 static void timer_stop_idle (void);
432 static void timer_resume_idle (void);
433 static void deliver_user_signal (int);
434 static char *find_user_signal_name (int);
435 static void store_user_signal_events (void);
437 /* These setters are used only in this file, so they can be private. */
439 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
441 kb
->INTERNAL_FIELD (echo_string
) = val
;
444 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
446 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
449 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
451 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
454 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
456 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
459 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
461 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
464 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
466 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
469 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
471 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
474 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
476 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
479 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
481 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
485 /* Add C to the echo string, without echoing it immediately. C can be
486 a character, which is pretty-printed, or a symbol, whose name is
490 echo_add_key (Lisp_Object c
)
492 int size
= KEY_DESCRIPTION_SIZE
+ 100;
493 char *buffer
= alloca (size
);
495 Lisp_Object echo_string
;
497 echo_string
= KVAR (current_kboard
, echo_string
);
499 /* If someone has passed us a composite event, use its head symbol. */
503 ptr
= push_key_description (XINT (c
), ptr
);
504 else if (SYMBOLP (c
))
506 Lisp_Object name
= SYMBOL_NAME (c
);
507 int nbytes
= SBYTES (name
);
509 if (size
- (ptr
- buffer
) < nbytes
)
511 int offset
= ptr
- buffer
;
512 size
= max (2 * size
, size
+ nbytes
);
513 buffer
= alloca (size
);
514 ptr
= buffer
+ offset
;
517 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
518 STRING_MULTIBYTE (name
), 1);
521 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
524 const char *text
= " (Type ? for further options)";
525 int len
= strlen (text
);
527 if (size
- (ptr
- buffer
) < len
)
529 int offset
= ptr
- buffer
;
531 buffer
= alloca (size
);
532 ptr
= buffer
+ offset
;
535 memcpy (ptr
, text
, len
);
539 /* Replace a dash from echo_dash with a space, otherwise add a space
540 at the end as a separator between keys. */
541 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
543 Lisp_Object last_char
, prev_char
, idx
;
545 idx
= make_number (SCHARS (echo_string
) - 2);
546 prev_char
= Faref (echo_string
, idx
);
548 idx
= make_number (SCHARS (echo_string
) - 1);
549 last_char
= Faref (echo_string
, idx
);
551 /* We test PREV_CHAR to make sure this isn't the echoing of a
553 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
554 Faset (echo_string
, idx
, make_number (' '));
556 echo_string
= concat2 (echo_string
, build_string (" "));
558 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
559 echo_string
= concat2 (echo_string
, build_string (" "));
563 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
566 /* Add C to the echo string, if echoing is going on. C can be a
567 character or a symbol. */
570 echo_char (Lisp_Object c
)
572 if (current_kboard
->immediate_echo
)
579 /* Temporarily add a dash to the end of the echo string if it's not
580 empty, so that it serves as a mini-prompt for the very next
586 /* Do nothing if not echoing at all. */
587 if (NILP (KVAR (current_kboard
, echo_string
)))
590 if (this_command_key_count
== 0)
593 if (!current_kboard
->immediate_echo
594 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
597 /* Do nothing if we just printed a prompt. */
598 if (current_kboard
->echo_after_prompt
599 == SCHARS (KVAR (current_kboard
, echo_string
)))
602 /* Do nothing if we have already put a dash at the end. */
603 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
605 Lisp_Object last_char
, prev_char
, idx
;
607 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
608 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
610 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
611 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
613 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
617 /* Put a dash at the end of the buffer temporarily,
618 but make it go away when the next character is added. */
621 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
625 /* Display the current echo string, and begin echoing if not already
631 if (!current_kboard
->immediate_echo
)
634 current_kboard
->immediate_echo
= 1;
636 for (i
= 0; i
< this_command_key_count
; i
++)
640 /* Set before_command_echo_length to the value that would
641 have been saved before the start of this subcommand in
642 command_loop_1, if we had already been echoing then. */
643 if (i
== this_single_command_key_start
)
644 before_command_echo_length
= echo_length ();
646 c
= AREF (this_command_keys
, i
);
647 if (! (EVENT_HAS_PARAMETERS (c
)
648 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
652 /* Set before_command_echo_length to the value that would
653 have been saved before the start of this subcommand in
654 command_loop_1, if we had already been echoing then. */
655 if (this_command_key_count
== this_single_command_key_start
)
656 before_command_echo_length
= echo_length ();
658 /* Put a dash at the end to invite the user to type more. */
663 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
664 message3_nolog (KVAR (current_kboard
, echo_string
));
667 /* Record in what buffer we echoed, and from which kboard. */
668 echo_message_buffer
= echo_area_buffer
[0];
669 echo_kboard
= current_kboard
;
671 if (waiting_for_input
&& !NILP (Vquit_flag
))
672 quit_throw_to_read_char (0);
675 /* Turn off echoing, for the start of a new command. */
678 cancel_echoing (void)
680 current_kboard
->immediate_echo
= 0;
681 current_kboard
->echo_after_prompt
= -1;
682 kset_echo_string (current_kboard
, Qnil
);
683 ok_to_echo_at_next_pause
= NULL
;
685 echo_message_buffer
= Qnil
;
688 /* Return the length of the current echo string. */
693 return (STRINGP (KVAR (current_kboard
, echo_string
))
694 ? SCHARS (KVAR (current_kboard
, echo_string
))
698 /* Truncate the current echo message to its first LEN chars.
699 This and echo_char get used by read_key_sequence when the user
700 switches frames while entering a key sequence. */
703 echo_truncate (ptrdiff_t nchars
)
705 if (STRINGP (KVAR (current_kboard
, echo_string
)))
706 kset_echo_string (current_kboard
,
707 Fsubstring (KVAR (current_kboard
, echo_string
),
708 make_number (0), make_number (nchars
)));
709 truncate_echo_area (nchars
);
713 /* Functions for manipulating this_command_keys. */
715 add_command_key (Lisp_Object key
)
717 #if 0 /* Not needed after we made Freset_this_command_lengths
718 do the job immediately. */
719 /* If reset-this-command-length was called recently, obey it now.
720 See the doc string of that function for an explanation of why. */
721 if (before_command_restore_flag
)
723 this_command_key_count
= before_command_key_count_1
;
724 if (this_command_key_count
< this_single_command_key_start
)
725 this_single_command_key_start
= this_command_key_count
;
726 echo_truncate (before_command_echo_length_1
);
727 before_command_restore_flag
= 0;
731 if (this_command_key_count
>= ASIZE (this_command_keys
))
732 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
734 ASET (this_command_keys
, this_command_key_count
, key
);
735 ++this_command_key_count
;
740 recursive_edit_1 (void)
742 ptrdiff_t count
= SPECPDL_INDEX ();
745 if (command_loop_level
> 0)
747 specbind (Qstandard_output
, Qt
);
748 specbind (Qstandard_input
, Qt
);
751 #ifdef HAVE_WINDOW_SYSTEM
752 /* The command loop has started an hourglass timer, so we have to
753 cancel it here, otherwise it will fire because the recursive edit
754 can take some time. Do not check for display_hourglass_p here,
755 because it could already be nil. */
759 /* This function may have been called from a debugger called from
760 within redisplay, for instance by Edebugging a function called
761 from fontification-functions. We want to allow redisplay in
762 the debugging session.
764 The recursive edit is left with a `(throw exit ...)'. The `exit'
765 tag is not caught anywhere in redisplay, i.e. when we leave the
766 recursive edit, the original redisplay leading to the recursive
767 edit will be unwound. The outcome should therefore be safe. */
768 specbind (Qinhibit_redisplay
, Qnil
);
771 val
= command_loop ();
773 Fsignal (Qquit
, Qnil
);
774 /* Handle throw from read_minibuf when using minibuffer
775 while it's active but we're in another window. */
777 xsignal1 (Qerror
, val
);
779 return unbind_to (count
, Qnil
);
782 /* When an auto-save happens, record the "time", and don't do again soon. */
785 record_auto_save (void)
787 last_auto_save
= num_nonmacro_input_events
;
790 /* Make an auto save happen as soon as possible at command level. */
794 force_auto_save_soon (void)
796 last_auto_save
= - auto_save_interval
- 1;
798 record_asynch_buffer_change ();
802 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
803 doc
: /* Invoke the editor command loop recursively.
804 To get out of the recursive edit, a command can throw to `exit' -- for
805 instance `(throw 'exit nil)'.
806 If you throw a value other than t, `recursive-edit' returns normally
807 to the function that called it. Throwing a t value causes
808 `recursive-edit' to quit, so that control returns to the command loop
811 This function is called by the editor initialization to begin editing. */)
814 ptrdiff_t count
= SPECPDL_INDEX ();
817 /* If we enter while input is blocked, don't lock up here.
818 This may happen through the debugger during redisplay. */
819 if (input_blocked_p ())
822 if (command_loop_level
>= 0
823 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
824 buffer
= Fcurrent_buffer ();
828 /* Don't do anything interesting between the increment and the
829 record_unwind_protect! Otherwise, we could get distracted and
830 never decrement the counter again. */
831 command_loop_level
++;
832 update_mode_lines
= 17;
833 record_unwind_protect (recursive_edit_unwind
, 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 ());
843 return unbind_to (count
, Qnil
);
847 recursive_edit_unwind (Lisp_Object buffer
)
849 if (BUFFERP (buffer
))
850 Fset_buffer (buffer
);
852 command_loop_level
--;
853 update_mode_lines
= 18;
857 #if 0 /* These two functions are now replaced with
858 temporarily_switch_to_single_kboard. */
862 #if 0 /* Theory: if there's anything in Vunread_command_events,
863 it will right away be read by read_key_sequence,
864 and then if we do switch KBOARDS, it will go into the side
865 queue then. So we don't need to do anything special here -- rms. */
866 if (CONSP (Vunread_command_events
))
868 current_kboard
->kbd_queue
869 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
870 current_kboard
->kbd_queue_has_data
= 1;
872 Vunread_command_events
= Qnil
;
877 /* Switch to the single-kboard state, making current_kboard
878 the only KBOARD from which further input is accepted. */
881 single_kboard_state ()
887 /* If we're in single_kboard state for kboard KBOARD,
891 not_single_kboard_state (KBOARD
*kboard
)
893 if (kboard
== current_kboard
)
897 /* Maintain a stack of kboards, so other parts of Emacs
898 can switch temporarily to the kboard of a given frame
899 and then revert to the previous status. */
904 struct kboard_stack
*next
;
907 static struct kboard_stack
*kboard_stack
;
910 push_kboard (struct kboard
*k
)
912 struct kboard_stack
*p
= xmalloc (sizeof *p
);
914 p
->next
= kboard_stack
;
915 p
->kboard
= current_kboard
;
925 struct kboard_stack
*p
= kboard_stack
;
927 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
929 if (t
->kboard
== p
->kboard
)
931 current_kboard
= p
->kboard
;
938 /* The terminal we remembered has been deleted. */
939 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
942 kboard_stack
= p
->next
;
946 /* Switch to single_kboard mode, making current_kboard the only KBOARD
947 from which further input is accepted. If F is non-nil, set its
948 KBOARD as the current keyboard.
950 This function uses record_unwind_protect_int to return to the previous
953 If Emacs is already in single_kboard mode, and F's keyboard is
954 locked, then this function will throw an error. */
957 temporarily_switch_to_single_kboard (struct frame
*f
)
959 bool was_locked
= single_kboard
;
962 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
963 /* We can not switch keyboards while in single_kboard mode.
964 In rare cases, Lisp code may call `recursive-edit' (or
965 `read-minibuffer' or `y-or-n-p') after it switched to a
966 locked frame. For example, this is likely to happen
967 when server.el connects to a new terminal while Emacs is in
968 single_kboard mode. It is best to throw an error instead
969 of presenting the user with a frozen screen. */
970 error ("Terminal %d is locked, cannot read from it",
971 FRAME_TERMINAL (f
)->id
);
973 /* This call is unnecessary, but helps
974 `restore_kboard_configuration' discover if somebody changed
975 `current_kboard' behind our back. */
976 push_kboard (current_kboard
);
979 current_kboard
= FRAME_KBOARD (f
);
981 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
984 #if 0 /* This function is not needed anymore. */
986 record_single_kboard_state ()
989 push_kboard (current_kboard
);
990 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
995 restore_kboard_configuration (int was_locked
)
997 single_kboard
= was_locked
;
1000 struct kboard
*prev
= current_kboard
;
1002 /* The pop should not change the kboard. */
1003 if (single_kboard
&& current_kboard
!= prev
)
1009 /* Handle errors that are not handled at inner levels
1010 by printing an error message and returning to the editor command loop. */
1013 cmd_error (Lisp_Object data
)
1015 Lisp_Object old_level
, old_length
;
1016 char macroerror
[sizeof "After..kbd macro iterations: "
1017 + INT_STRLEN_BOUND (EMACS_INT
)];
1019 #ifdef HAVE_WINDOW_SYSTEM
1020 if (display_hourglass_p
)
1021 cancel_hourglass ();
1024 if (!NILP (executing_kbd_macro
))
1026 if (executing_kbd_macro_iterations
== 1)
1027 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1029 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1030 executing_kbd_macro_iterations
);
1035 Vstandard_output
= Qt
;
1036 Vstandard_input
= Qt
;
1037 Vexecuting_kbd_macro
= Qnil
;
1038 executing_kbd_macro
= Qnil
;
1039 kset_prefix_arg (current_kboard
, Qnil
);
1040 kset_last_prefix_arg (current_kboard
, Qnil
);
1043 /* Avoid unquittable loop if data contains a circular list. */
1044 old_level
= Vprint_level
;
1045 old_length
= Vprint_length
;
1046 XSETFASTINT (Vprint_level
, 10);
1047 XSETFASTINT (Vprint_length
, 10);
1048 cmd_error_internal (data
, macroerror
);
1049 Vprint_level
= old_level
;
1050 Vprint_length
= old_length
;
1053 Vinhibit_quit
= Qnil
;
1055 return make_number (0);
1058 /* Take actions on handling an error. DATA is the data that describes
1061 CONTEXT is a C-string containing ASCII characters only which
1062 describes the context in which the error happened. If we need to
1063 generalize CONTEXT to allow multibyte characters, make it a Lisp
1067 cmd_error_internal (Lisp_Object data
, const char *context
)
1069 /* The immediate context is not interesting for Quits,
1070 since they are asynchronous. */
1071 if (EQ (XCAR (data
), Qquit
))
1072 Vsignaling_function
= Qnil
;
1077 /* Use user's specified output function if any. */
1078 if (!NILP (Vcommand_error_function
))
1079 call3 (Vcommand_error_function
, data
,
1080 context
? build_string (context
) : empty_unibyte_string
,
1081 Vsignaling_function
);
1083 Vsignaling_function
= Qnil
;
1086 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1087 Scommand_error_default_function
, 3, 3, 0,
1088 doc
: /* Produce default output for unhandled error message.
1089 Default value of `command-error-function'. */)
1090 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1092 struct frame
*sf
= SELECTED_FRAME ();
1094 CHECK_STRING (context
);
1096 /* If the window system or terminal frame hasn't been initialized
1097 yet, or we're not interactive, write the message to stderr and exit. */
1098 if (!sf
->glyphs_initialized_p
1099 /* The initial frame is a special non-displaying frame. It
1100 will be current in daemon mode when there are no frames
1101 to display, and in non-daemon mode before the real frame
1102 has finished initializing. If an error is thrown in the
1103 latter case while creating the frame, then the frame
1104 will never be displayed, so the safest thing to do is
1105 write to stderr and quit. In daemon mode, there are
1106 many other potential errors that do not prevent frames
1107 from being created, so continuing as normal is better in
1109 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1112 print_error_message (data
, Qexternal_debugging_output
,
1113 SSDATA (context
), signal
);
1114 Fterpri (Qexternal_debugging_output
);
1115 Fkill_emacs (make_number (-1));
1119 clear_message (1, 0);
1121 message_log_maybe_newline ();
1124 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1129 static Lisp_Object
command_loop_2 (Lisp_Object
);
1130 static Lisp_Object
top_level_1 (Lisp_Object
);
1132 /* Entry to editor-command-loop.
1133 This level has the catches for exiting/returning to editor command loop.
1134 It returns nil to exit recursive edit, t to abort it. */
1139 if (command_loop_level
> 0 || minibuf_level
> 0)
1142 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1143 executing_kbd_macro
= Qnil
;
1149 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1150 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1151 executing_kbd_macro
= Qnil
;
1153 /* End of file in -batch run causes exit here. */
1159 /* Here we catch errors in execution of commands within the
1160 editing loop, and reenter the editing loop.
1161 When there is an error, cmd_error runs and returns a non-nil
1162 value to us. A value of nil means that command_loop_1 itself
1163 returned due to end of file (or end of kbd macro). */
1166 command_loop_2 (Lisp_Object ignore
)
1168 register Lisp_Object val
;
1171 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1172 while (!NILP (val
));
1180 return Feval (Vtop_level
, Qnil
);
1184 top_level_1 (Lisp_Object ignore
)
1186 /* On entry to the outer level, run the startup file. */
1187 if (!NILP (Vtop_level
))
1188 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1189 else if (!NILP (Vpurify_flag
))
1190 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1192 message1 ("Bare Emacs (standard Lisp code not loaded)");
1196 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1197 doc
: /* Exit all recursive editing levels.
1198 This also exits all active minibuffers. */)
1201 #ifdef HAVE_WINDOW_SYSTEM
1202 if (display_hourglass_p
)
1203 cancel_hourglass ();
1206 /* Unblock input if we enter with input blocked. This may happen if
1207 redisplay traps e.g. during tool-bar update with input blocked. */
1208 totally_unblock_input ();
1210 Fthrow (Qtop_level
, Qnil
);
1213 static _Noreturn
void
1214 user_error (const char *msg
)
1216 xsignal1 (Quser_error
, build_string (msg
));
1220 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1221 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1224 if (command_loop_level
> 0 || minibuf_level
> 0)
1225 Fthrow (Qexit
, Qnil
);
1227 user_error ("No recursive edit is in progress");
1231 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1232 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1235 if (command_loop_level
> 0 || minibuf_level
> 0)
1238 user_error ("No recursive edit is in progress");
1241 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1242 of this function. */
1245 tracking_off (Lisp_Object old_value
)
1247 do_mouse_tracking
= old_value
;
1248 if (NILP (old_value
))
1250 /* Redisplay may have been preempted because there was input
1251 available, and it assumes it will be called again after the
1252 input has been processed. If the only input available was
1253 the sort that we have just disabled, then we need to call
1255 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1257 redisplay_preserve_echo_area (6);
1258 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1263 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1264 doc
: /* Evaluate BODY with mouse movement events enabled.
1265 Within a `track-mouse' form, mouse motion generates input events that
1266 you can read with `read-event'.
1267 Normally, mouse motion is ignored.
1268 usage: (track-mouse BODY...) */)
1271 ptrdiff_t count
= SPECPDL_INDEX ();
1274 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1276 do_mouse_tracking
= Qt
;
1278 val
= Fprogn (args
);
1279 return unbind_to (count
, val
);
1282 /* If mouse has moved on some frame, return one of those frames.
1286 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1287 after resizing the tool-bar window. */
1289 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1292 bool ignore_mouse_drag_p
;
1294 static struct frame
*
1295 some_mouse_moved (void)
1297 Lisp_Object tail
, frame
;
1299 if (ignore_mouse_drag_p
)
1301 /* ignore_mouse_drag_p = 0; */
1305 FOR_EACH_FRAME (tail
, frame
)
1307 if (XFRAME (frame
)->mouse_moved
)
1308 return XFRAME (frame
);
1315 /* This is the actual command reading loop,
1316 sans error-handling encapsulation. */
1318 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1319 bool, bool, bool, bool);
1320 void safe_run_hooks (Lisp_Object
);
1321 static void adjust_point_for_property (ptrdiff_t, bool);
1323 /* The last boundary auto-added to buffer-undo-list. */
1324 Lisp_Object last_undo_boundary
;
1326 extern Lisp_Object Qregion_extract_function
;
1328 /* FIXME: This is wrong rather than test window-system, we should call
1329 a new set-selection, which will then dispatch to x-set-selection, or
1330 tty-set-selection, or w32-set-selection, ... */
1333 command_loop_1 (void)
1336 Lisp_Object keybuf
[30];
1338 EMACS_INT prev_modiff
= 0;
1339 struct buffer
*prev_buffer
= NULL
;
1340 bool already_adjusted
= 0;
1342 kset_prefix_arg (current_kboard
, Qnil
);
1343 kset_last_prefix_arg (current_kboard
, Qnil
);
1344 Vdeactivate_mark
= Qnil
;
1345 waiting_for_input
= 0;
1348 this_command_key_count
= 0;
1349 this_command_key_count_reset
= 0;
1350 this_single_command_key_start
= 0;
1352 if (NILP (Vmemory_full
))
1354 /* Make sure this hook runs after commands that get errors and
1355 throw to top level. */
1356 /* Note that the value cell will never directly contain nil
1357 if the symbol is a local variable. */
1358 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1359 safe_run_hooks (Qpost_command_hook
);
1361 /* If displaying a message, resize the echo area window to fit
1362 that message's size exactly. */
1363 if (!NILP (echo_area_buffer
[0]))
1364 resize_echo_area_exactly ();
1366 /* If there are warnings waiting, process them. */
1367 if (!NILP (Vdelayed_warnings_list
))
1368 safe_run_hooks (Qdelayed_warnings_hook
);
1370 if (!NILP (Vdeferred_action_list
))
1371 safe_run_hooks (Qdeferred_action_function
);
1374 /* Do this after running Vpost_command_hook, for consistency. */
1375 kset_last_command (current_kboard
, Vthis_command
);
1376 kset_real_last_command (current_kboard
, Vreal_this_command
);
1377 if (!CONSP (last_command_event
))
1378 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1382 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1385 /* Make sure the current window's buffer is selected. */
1386 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1388 /* Display any malloc warning that just came out. Use while because
1389 displaying one warning can cause another. */
1391 while (pending_malloc_warning
)
1392 display_malloc_warning ();
1394 Vdeactivate_mark
= Qnil
;
1396 /* Don't ignore mouse movements for more than a single command
1397 loop. (This flag is set in xdisp.c whenever the tool bar is
1398 resized, because the resize moves text up or down, and would
1399 generate false mouse drag events if we don't ignore them.) */
1400 ignore_mouse_drag_p
= 0;
1402 /* If minibuffer on and echo area in use,
1403 wait a short time and redraw minibuffer. */
1406 && !NILP (echo_area_buffer
[0])
1407 && EQ (minibuf_window
, echo_area_window
)
1408 && NUMBERP (Vminibuffer_message_timeout
))
1410 /* Bind inhibit-quit to t so that C-g gets read in
1411 rather than quitting back to the minibuffer. */
1412 ptrdiff_t count
= SPECPDL_INDEX ();
1413 specbind (Qinhibit_quit
, Qt
);
1415 sit_for (Vminibuffer_message_timeout
, 0, 2);
1417 /* Clear the echo area. */
1419 safe_run_hooks (Qecho_area_clear_hook
);
1421 unbind_to (count
, Qnil
);
1423 /* If a C-g came in before, treat it as input now. */
1424 if (!NILP (Vquit_flag
))
1427 Vunread_command_events
= list1 (make_number (quit_char
));
1431 /* If it has changed current-menubar from previous value,
1432 really recompute the menubar from the value. */
1433 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1434 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1435 call0 (Qrecompute_lucid_menubar
);
1437 before_command_key_count
= this_command_key_count
;
1438 before_command_echo_length
= echo_length ();
1440 Vthis_command
= Qnil
;
1441 Vreal_this_command
= Qnil
;
1442 Vthis_original_command
= Qnil
;
1443 Vthis_command_keys_shift_translated
= Qnil
;
1445 /* Read next key sequence; i gets its length. */
1446 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1449 /* A filter may have run while we were reading the input. */
1450 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1452 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1456 /* Now we have read a key sequence of length I,
1457 or else I is 0 and we found end of file. */
1459 if (i
== 0) /* End of file -- happens only in */
1460 return Qnil
; /* a kbd macro, at the end. */
1461 /* -1 means read_key_sequence got a menu that was rejected.
1462 Just loop around and read another command. */
1466 this_command_key_count
= 0;
1467 this_command_key_count_reset
= 0;
1468 this_single_command_key_start
= 0;
1472 last_command_event
= keybuf
[i
- 1];
1474 /* If the previous command tried to force a specific window-start,
1475 forget about that, in case this command moves point far away
1476 from that position. But also throw away beg_unchanged and
1477 end_unchanged information in that case, so that redisplay will
1478 update the whole window properly. */
1479 if (XWINDOW (selected_window
)->force_start
)
1482 XWINDOW (selected_window
)->force_start
= 0;
1483 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1484 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1487 cmd
= read_key_sequence_cmd
;
1488 if (!NILP (Vexecuting_kbd_macro
))
1490 if (!NILP (Vquit_flag
))
1492 Vexecuting_kbd_macro
= Qt
;
1493 QUIT
; /* Make some noise. */
1494 /* Will return since macro now empty. */
1498 /* Do redisplay processing after this command except in special
1499 cases identified below. */
1500 prev_buffer
= current_buffer
;
1501 prev_modiff
= MODIFF
;
1502 last_point_position
= PT
;
1504 /* By default, we adjust point to a boundary of a region that
1505 has such a property that should be treated intangible
1506 (e.g. composition, display). But, some commands will set
1507 this variable differently. */
1508 Vdisable_point_adjustment
= Qnil
;
1510 /* Process filters and timers may have messed with deactivate-mark.
1511 reset it before we execute the command. */
1512 Vdeactivate_mark
= Qnil
;
1514 /* Remap command through active keymaps. */
1515 Vthis_original_command
= cmd
;
1516 if (!NILP (read_key_sequence_remapped
))
1517 cmd
= read_key_sequence_remapped
;
1519 /* Execute the command. */
1521 Vthis_command
= cmd
;
1522 Vreal_this_command
= cmd
;
1523 safe_run_hooks (Qpre_command_hook
);
1525 already_adjusted
= 0;
1527 if (NILP (Vthis_command
))
1528 /* nil means key is undefined. */
1532 /* Here for a command that isn't executed directly. */
1534 #ifdef HAVE_WINDOW_SYSTEM
1535 ptrdiff_t scount
= SPECPDL_INDEX ();
1537 if (display_hourglass_p
1538 && NILP (Vexecuting_kbd_macro
))
1540 record_unwind_protect_void (cancel_hourglass
);
1545 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1547 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1550 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1551 ? Qnil
: BVAR (current_buffer
, undo_list
));
1553 call1 (Qcommand_execute
, Vthis_command
);
1555 #ifdef HAVE_WINDOW_SYSTEM
1556 /* Do not check display_hourglass_p here, because
1557 `command-execute' could change it, but we should cancel
1558 hourglass cursor anyway.
1559 But don't cancel the hourglass within a macro
1560 just because a command in the macro finishes. */
1561 if (NILP (Vexecuting_kbd_macro
))
1562 unbind_to (scount
, Qnil
);
1565 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1567 safe_run_hooks (Qpost_command_hook
);
1569 /* If displaying a message, resize the echo area window to fit
1570 that message's size exactly. */
1571 if (!NILP (echo_area_buffer
[0]))
1572 resize_echo_area_exactly ();
1574 /* If there are warnings waiting, process them. */
1575 if (!NILP (Vdelayed_warnings_list
))
1576 safe_run_hooks (Qdelayed_warnings_hook
);
1578 safe_run_hooks (Qdeferred_action_function
);
1580 /* If there is a prefix argument,
1581 1) We don't want Vlast_command to be ``universal-argument''
1582 (that would be dumb), so don't set Vlast_command,
1583 2) we want to leave echoing on so that the prefix will be
1584 echoed as part of this key sequence, so don't call
1586 3) we want to leave this_command_key_count non-zero, so that
1587 read_char will realize that it is re-reading a character, and
1588 not echo it a second time.
1590 If the command didn't actually create a prefix arg,
1591 but is merely a frame event that is transparent to prefix args,
1592 then the above doesn't apply. */
1593 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1594 || CONSP (last_command_event
))
1596 kset_last_command (current_kboard
, Vthis_command
);
1597 kset_real_last_command (current_kboard
, Vreal_this_command
);
1598 if (!CONSP (last_command_event
))
1599 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1601 this_command_key_count
= 0;
1602 this_command_key_count_reset
= 0;
1603 this_single_command_key_start
= 0;
1606 if (!NILP (BVAR (current_buffer
, mark_active
))
1607 && !NILP (Vrun_hooks
))
1609 /* In Emacs 22, setting transient-mark-mode to `only' was a
1610 way of turning it on for just one command. This usage is
1611 obsolete, but support it anyway. */
1612 if (EQ (Vtransient_mark_mode
, Qidentity
))
1613 Vtransient_mark_mode
= Qnil
;
1614 else if (EQ (Vtransient_mark_mode
, Qonly
))
1615 Vtransient_mark_mode
= Qidentity
;
1617 if (!NILP (Vdeactivate_mark
))
1618 /* If `select-active-regions' is non-nil, this call to
1619 `deactivate-mark' also sets the PRIMARY selection. */
1620 call0 (Qdeactivate_mark
);
1623 /* Even if not deactivating the mark, set PRIMARY if
1624 `select-active-regions' is non-nil. */
1625 if (!NILP (Fwindow_system (Qnil
))
1626 /* Even if mark_active is non-nil, the actual buffer
1627 marker may not have been set yet (Bug#7044). */
1628 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1629 && (EQ (Vselect_active_regions
, Qonly
)
1630 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1631 : (!NILP (Vselect_active_regions
)
1632 && !NILP (Vtransient_mark_mode
)))
1633 && NILP (Fmemq (Vthis_command
,
1634 Vselection_inhibit_update_commands
)))
1637 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1638 if (XINT (Flength (txt
)) > 0)
1639 /* Don't set empty selections. */
1640 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1643 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1645 Lisp_Object hook
= intern ("activate-mark-hook");
1646 Frun_hooks (1, &hook
);
1650 Vsaved_region_selection
= Qnil
;
1655 if (current_buffer
== prev_buffer
1656 && last_point_position
!= PT
1657 && NILP (Vdisable_point_adjustment
)
1658 && NILP (Vglobal_disable_point_adjustment
))
1660 if (last_point_position
> BEGV
1661 && last_point_position
< ZV
1662 && (composition_adjust_point (last_point_position
,
1663 last_point_position
)
1664 != last_point_position
))
1665 /* The last point was temporarily set within a grapheme
1666 cluster to prevent automatic composition. To recover
1667 the automatic composition, we must update the
1669 windows_or_buffers_changed
= 21;
1670 if (!already_adjusted
)
1671 adjust_point_for_property (last_point_position
,
1672 MODIFF
!= prev_modiff
);
1675 /* Install chars successfully executed in kbd macro. */
1677 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1678 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1679 finalize_kbd_macro_chars ();
1684 read_menu_command (void)
1686 Lisp_Object keybuf
[30];
1687 ptrdiff_t count
= SPECPDL_INDEX ();
1690 /* We don't want to echo the keystrokes while navigating the
1692 specbind (Qecho_keystrokes
, make_number (0));
1694 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1697 unbind_to (count
, Qnil
);
1699 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1701 if (i
== 0 || i
== -1)
1704 return read_key_sequence_cmd
;
1707 /* Adjust point to a boundary of a region that has such a property
1708 that should be treated intangible. For the moment, we check
1709 `composition', `display' and `invisible' properties.
1710 LAST_PT is the last position of point. */
1713 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1716 Lisp_Object val
, overlay
, tmp
;
1717 /* When called after buffer modification, we should temporarily
1718 suppress the point adjustment for automatic composition so that a
1719 user can keep inserting another character at point or keep
1720 deleting characters around point. */
1721 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1722 ptrdiff_t orig_pt
= PT
;
1724 /* FIXME: cycling is probably not necessary because these properties
1725 can't be usefully combined anyway. */
1726 while (check_composition
|| check_display
|| check_invisible
)
1728 /* FIXME: check `intangible'. */
1729 if (check_composition
1730 && PT
> BEGV
&& PT
< ZV
1731 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1734 check_display
= check_invisible
= 1;
1736 check_composition
= 0;
1738 && PT
> BEGV
&& PT
< ZV
1739 && !NILP (val
= get_char_property_and_overlay
1740 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1741 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1742 && (!OVERLAYP (overlay
)
1743 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1744 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1745 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1746 && (beg
< PT
/* && end > PT <- It's always the case. */
1747 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1750 SET_PT (PT
< last_pt
1751 ? (STRINGP (val
) && SCHARS (val
) == 0
1752 ? max (beg
- 1, BEGV
)
1755 check_composition
= check_invisible
= 1;
1758 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1764 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1767 /* FIXME: We should stop if we find a spot between
1768 two runs of `invisible' where inserted text would
1769 be visible. This is important when we have two
1770 invisible boundaries that enclose an area: if the
1771 area is empty, we need this test in order to make
1772 it possible to place point in the middle rather
1773 than skip both boundaries. However, this code
1774 also stops anywhere in a non-sticky text-property,
1775 which breaks (e.g.) Org mode. */
1776 && (val
= Fget_pos_property (make_number (end
),
1778 TEXT_PROP_MEANS_INVISIBLE (val
))
1780 && !NILP (val
= get_char_property_and_overlay
1781 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1782 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1784 ellipsis
= ellipsis
|| inv
> 1
1785 || (OVERLAYP (overlay
)
1786 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1787 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1788 tmp
= Fnext_single_char_property_change
1789 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1790 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1794 && (val
= Fget_pos_property (make_number (beg
),
1796 TEXT_PROP_MEANS_INVISIBLE (val
))
1798 && !NILP (val
= get_char_property_and_overlay
1799 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1800 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1802 ellipsis
= ellipsis
|| inv
> 1
1803 || (OVERLAYP (overlay
)
1804 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1805 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1806 tmp
= Fprevious_single_char_property_change
1807 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1808 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1811 /* Move away from the inside area. */
1812 if (beg
< PT
&& end
> PT
)
1814 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1815 /* We haven't moved yet (so we don't need to fear
1816 infinite-looping) and we were outside the range
1817 before (so either end of the range still corresponds
1818 to a move in the right direction): pretend we moved
1819 less than we actually did, so that we still have
1820 more freedom below in choosing which end of the range
1822 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1823 /* We either have moved already or the last point
1824 was already in the range: we don't get to choose
1825 which end of the range we have to go to. */
1826 : (PT
< last_pt
? beg
: end
));
1827 check_composition
= check_display
= 1;
1829 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1830 the point to something other than its argument, due to
1831 point-motion hooks, intangibility, etc. */
1832 eassert (PT
== beg
|| PT
== end
);
1835 /* Pretend the area doesn't exist if the buffer is not
1837 if (!modified
&& !ellipsis
&& beg
< end
)
1839 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1840 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1841 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1842 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1843 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1844 /* We've already moved as far as we can. Trying to go
1845 to the other end would mean moving backwards and thus
1846 could lead to an infinite loop. */
1848 else if (val
= Fget_pos_property (make_number (PT
),
1850 TEXT_PROP_MEANS_INVISIBLE (val
)
1851 && (val
= (Fget_pos_property
1852 (make_number (PT
== beg
? end
: beg
),
1854 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1855 (check_composition
= check_display
= 1,
1856 SET_PT (PT
== beg
? end
: beg
));
1859 check_invisible
= 0;
1863 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1866 safe_run_hooks_1 (void)
1868 eassert (CONSP (Vinhibit_quit
));
1869 return call0 (XCDR (Vinhibit_quit
));
1872 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1876 safe_run_hooks_error (Lisp_Object error_data
)
1879 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1880 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1881 Lisp_Object args
[4];
1882 args
[0] = build_string ("Error in %s (%S): %S");
1885 args
[3] = error_data
;
1891 Lisp_Object newval
= Qnil
;
1892 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1893 if (EQ (fun
, XCAR (val
)))
1896 newval
= Fcons (XCAR (val
), newval
);
1898 return Fset (hook
, Fnreverse (newval
));
1899 /* Not found in the local part of the hook. Let's look at the global
1902 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1903 : Fdefault_value (hook
));
1904 CONSP (val
); val
= XCDR (val
))
1905 if (EQ (fun
, XCAR (val
)))
1908 newval
= Fcons (XCAR (val
), newval
);
1910 return Fset_default (hook
, Fnreverse (newval
));
1916 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1918 eassert (nargs
== 1);
1919 if (CONSP (Vinhibit_quit
))
1920 XSETCDR (Vinhibit_quit
, args
[0]);
1922 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1924 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1928 /* If we get an error while running the hook, cause the hook variable
1929 to be nil. Also inhibit quits, so that C-g won't cause the hook
1930 to mysteriously evaporate. */
1933 safe_run_hooks (Lisp_Object hook
)
1935 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1936 to its body or to its handlers other than via globals such as
1937 dynamically-bound variables ;-) */
1938 ptrdiff_t count
= SPECPDL_INDEX ();
1939 specbind (Qinhibit_quit
, hook
);
1941 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1943 unbind_to (count
, Qnil
);
1947 /* Nonzero means polling for input is temporarily suppressed. */
1949 int poll_suppress_count
;
1952 #ifdef POLL_FOR_INPUT
1954 /* Asynchronous timer for polling. */
1956 static struct atimer
*poll_timer
;
1958 /* Poll for input, so that we catch a C-g if it comes in. */
1960 poll_for_input_1 (void)
1962 if (! input_blocked_p ()
1963 && !waiting_for_input
)
1967 /* Timer callback function for poll_timer. TIMER is equal to
1971 poll_for_input (struct atimer
*timer
)
1973 if (poll_suppress_count
== 0)
1974 pending_signals
= 1;
1977 #endif /* POLL_FOR_INPUT */
1979 /* Begin signals to poll for input, if they are appropriate.
1980 This function is called unconditionally from various places. */
1983 start_polling (void)
1985 #ifdef POLL_FOR_INPUT
1986 /* XXX This condition was (read_socket_hook && !interrupt_input),
1987 but read_socket_hook is not global anymore. Let's pretend that
1989 if (!interrupt_input
)
1991 /* Turn alarm handling on unconditionally. It might have
1992 been turned off in process.c. */
1993 turn_on_atimers (1);
1995 /* If poll timer doesn't exist, or we need one with
1996 a different interval, start a new one. */
1997 if (poll_timer
== NULL
1998 || poll_timer
->interval
.tv_sec
!= polling_period
)
2000 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2001 struct timespec interval
= make_timespec (period
, 0);
2004 cancel_atimer (poll_timer
);
2006 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2007 poll_for_input
, NULL
);
2010 /* Let the timer's callback function poll for input
2011 if this becomes zero. */
2012 --poll_suppress_count
;
2017 /* True if we are using polling to handle input asynchronously. */
2020 input_polling_used (void)
2022 #ifdef POLL_FOR_INPUT
2023 /* XXX This condition was (read_socket_hook && !interrupt_input),
2024 but read_socket_hook is not global anymore. Let's pretend that
2026 return !interrupt_input
;
2032 /* Turn off polling. */
2037 #ifdef POLL_FOR_INPUT
2038 /* XXX This condition was (read_socket_hook && !interrupt_input),
2039 but read_socket_hook is not global anymore. Let's pretend that
2041 if (!interrupt_input
)
2042 ++poll_suppress_count
;
2046 /* Set the value of poll_suppress_count to COUNT
2047 and start or stop polling accordingly. */
2050 set_poll_suppress_count (int count
)
2052 #ifdef POLL_FOR_INPUT
2053 if (count
== 0 && poll_suppress_count
!= 0)
2055 poll_suppress_count
= 1;
2058 else if (count
!= 0 && poll_suppress_count
== 0)
2062 poll_suppress_count
= count
;
2066 /* Bind polling_period to a value at least N.
2067 But don't decrease it. */
2070 bind_polling_period (int n
)
2072 #ifdef POLL_FOR_INPUT
2073 EMACS_INT
new = polling_period
;
2078 stop_other_atimers (poll_timer
);
2080 specbind (Qpolling_period
, make_number (new));
2081 /* Start a new alarm with the new period. */
2086 /* Apply the control modifier to CHARACTER. */
2092 make_ctrl_char (int c
)
2094 /* Save the upper bits here. */
2095 int upper
= c
& ~0177;
2097 if (! ASCII_BYTE_P (c
))
2098 return c
|= ctrl_modifier
;
2102 /* Everything in the columns containing the upper-case letters
2103 denotes a control character. */
2104 if (c
>= 0100 && c
< 0140)
2108 /* Set the shift modifier for a control char
2109 made from a shifted letter. But only for letters! */
2110 if (oc
>= 'A' && oc
<= 'Z')
2111 c
|= shift_modifier
;
2114 /* The lower-case letters denote control characters too. */
2115 else if (c
>= 'a' && c
<= 'z')
2118 /* Include the bits for control and shift
2119 only if the basic ASCII code can't indicate them. */
2123 /* Replace the high bits. */
2124 c
|= (upper
& ~ctrl_modifier
);
2129 /* Display the help-echo property of the character after the mouse pointer.
2130 Either show it in the echo area, or call show-help-function to display
2131 it by other means (maybe in a tooltip).
2133 If HELP is nil, that means clear the previous help echo.
2135 If HELP is a string, display that string. If HELP is a function,
2136 call it with OBJECT and POS as arguments; the function should
2137 return a help string or nil for none. For all other types of HELP,
2138 evaluate it to obtain a string.
2140 WINDOW is the window in which the help was generated, if any.
2141 It is nil if not in a window.
2143 If OBJECT is a buffer, POS is the position in the buffer where the
2144 `help-echo' text property was found.
2146 If OBJECT is an overlay, that overlay has a `help-echo' property,
2147 and POS is the position in the overlay's buffer under the mouse.
2149 If OBJECT is a string (an overlay string or a string displayed with
2150 the `display' property). POS is the position in that string under
2153 Note: this function may only be called with HELP nil or a string
2154 from X code running asynchronously. */
2157 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2160 if (!NILP (help
) && !STRINGP (help
))
2162 if (FUNCTIONP (help
))
2163 help
= safe_call (4, help
, window
, object
, pos
);
2165 help
= safe_eval (help
);
2167 if (!STRINGP (help
))
2171 if (!noninteractive
&& STRINGP (help
))
2173 /* The mouse-fixup-help-message Lisp function can call
2174 mouse_position_hook, which resets the mouse_moved flags.
2175 This causes trouble if we are trying to read a mouse motion
2176 event (i.e., if we are inside a `track-mouse' form), so we
2177 restore the mouse_moved flag. */
2178 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2179 help
= call1 (Qmouse_fixup_help_message
, help
);
2184 if (STRINGP (help
) || NILP (help
))
2186 if (!NILP (Vshow_help_function
))
2187 call1 (Vshow_help_function
, help
);
2188 help_echo_showing_p
= STRINGP (help
);
2194 /* Input of single characters from keyboard */
2196 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2197 struct timespec
*end_time
);
2198 static void record_char (Lisp_Object c
);
2200 static Lisp_Object help_form_saved_window_configs
;
2202 read_char_help_form_unwind (void)
2204 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2205 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2206 if (!NILP (window_config
))
2207 Fset_window_configuration (window_config
);
2210 #define STOP_POLLING \
2211 do { if (! polling_stopped_here) stop_polling (); \
2212 polling_stopped_here = 1; } while (0)
2214 #define RESUME_POLLING \
2215 do { if (polling_stopped_here) start_polling (); \
2216 polling_stopped_here = 0; } while (0)
2219 read_event_from_main_queue (struct timespec
*end_time
,
2220 sys_jmp_buf local_getcjmp
,
2221 bool *used_mouse_menu
)
2223 Lisp_Object c
= Qnil
;
2224 sys_jmp_buf save_jump
;
2225 KBOARD
*kb
IF_LINT (= NULL
);
2229 /* Read from the main queue, and if that gives us something we can't use yet,
2230 we put it on the appropriate side queue and try again. */
2232 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2235 /* Actually read a character, waiting if necessary. */
2236 save_getcjmp (save_jump
);
2237 restore_getcjmp (local_getcjmp
);
2239 timer_start_idle ();
2240 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2241 restore_getcjmp (save_jump
);
2243 if (! NILP (c
) && (kb
!= current_kboard
))
2245 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2248 while (CONSP (XCDR (last
)))
2250 if (!NILP (XCDR (last
)))
2254 kset_kbd_queue (kb
, list1 (c
));
2256 XSETCDR (last
, list1 (c
));
2257 kb
->kbd_queue_has_data
= 1;
2261 current_kboard
= kb
;
2262 /* This is going to exit from read_char
2263 so we had better get rid of this frame's stuff. */
2264 return make_number (-2);
2267 /* Terminate Emacs in batch mode if at eof. */
2268 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2269 Fkill_emacs (make_number (1));
2273 /* Add in any extra modifiers, where appropriate. */
2274 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2275 || ((extra_keyboard_modifiers
& 0177) < ' '
2276 && (extra_keyboard_modifiers
& 0177) != 0))
2277 XSETINT (c
, make_ctrl_char (XINT (c
)));
2279 /* Transfer any other modifier bits directly from
2280 extra_keyboard_modifiers to c. Ignore the actual character code
2281 in the low 16 bits of extra_keyboard_modifiers. */
2282 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2290 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2293 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2294 sys_jmp_buf local_getcjmp
,
2295 Lisp_Object prev_event
,
2296 bool *used_mouse_menu
)
2298 #define MAX_ENCODED_BYTES 16
2300 Lisp_Object events
[MAX_ENCODED_BYTES
];
2306 = read_event_from_main_queue (end_time
, local_getcjmp
,
2309 /* w32_console already returns decoded events. It either reads
2310 Unicode characters from the Windows keyboard input, or
2311 converts characters encoded in the current codepage into
2312 Unicode. See w32inevt.c:key_event, near its end. */
2315 struct frame
*frame
= XFRAME (selected_frame
);
2316 struct terminal
*terminal
= frame
->terminal
;
2317 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2318 /* Don't apply decoding if we're just reading a raw event
2319 (e.g. reading bytes sent by the xterm to specify the position
2320 of a mouse click). */
2321 && (!EQ (prev_event
, Qt
))
2322 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2323 & CODING_REQUIRE_DECODING_MASK
)))
2324 return nextevt
; /* No decoding needed. */
2327 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2328 eassert (n
< MAX_ENCODED_BYTES
);
2329 events
[n
++] = nextevt
;
2330 if (NATNUMP (nextevt
)
2331 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2332 { /* An encoded byte sequence, let's try to decode it. */
2333 struct coding_system
*coding
2334 = TERMINAL_KEYBOARD_CODING (terminal
);
2335 unsigned char *src
= alloca (n
);
2337 for (i
= 0; i
< n
; i
++)
2338 src
[i
] = XINT (events
[i
]);
2340 for (i
= 0; i
< n
; i
++)
2342 coding
->destination
= alloca (n
* 4);
2343 coding
->dst_bytes
= n
* 4;
2344 decode_coding_c_string (coding
, src
, n
, Qnil
);
2345 eassert (coding
->produced_char
<= n
);
2346 if (coding
->produced_char
== 0)
2347 { /* The encoded sequence is incomplete. */
2348 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2349 continue; /* Read on! */
2353 const unsigned char *p
= coding
->destination
;
2354 eassert (coding
->carryover_bytes
== 0);
2356 while (n
< coding
->produced_char
)
2357 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2360 /* Now `events' should hold decoded events.
2361 Normally, n should be equal to 1, but better not rely on it.
2362 We can only return one event here, so return the first we
2363 had and keep the others (if any) for later. */
2365 Vunread_command_events
2366 = Fcons (events
[--n
], Vunread_command_events
);
2374 echo_keystrokes_p (void)
2376 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2377 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2380 /* Read a character from the keyboard; call the redisplay if needed. */
2381 /* commandflag 0 means do not autosave, but do redisplay.
2382 -1 means do not redisplay, but do autosave.
2383 -2 means do neither.
2386 /* The argument MAP is a keymap for menu prompting.
2388 PREV_EVENT is the previous input event, or nil if we are reading
2389 the first event of a key sequence (or not reading a key sequence).
2390 If PREV_EVENT is t, that is a "magic" value that says
2391 not to run input methods, but in other respects to act as if
2392 not reading a key sequence.
2394 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2395 if we used a mouse menu to read the input, or false otherwise. If
2396 USED_MOUSE_MENU is null, don't dereference it.
2398 Value is -2 when we find input on another keyboard. A second call
2399 to read_char will read it.
2401 If END_TIME is non-null, it is a pointer to a struct timespec
2402 specifying the maximum time to wait until. If no input arrives by
2403 that time, stop waiting and return nil.
2405 Value is t if we showed a menu and the user rejected it. */
2408 read_char (int commandflag
, Lisp_Object map
,
2409 Lisp_Object prev_event
,
2410 bool *used_mouse_menu
, struct timespec
*end_time
)
2414 sys_jmp_buf local_getcjmp
;
2415 sys_jmp_buf save_jump
;
2416 Lisp_Object tem
, save
;
2417 volatile Lisp_Object previous_echo_area_message
;
2418 volatile Lisp_Object also_record
;
2419 volatile bool reread
;
2420 struct gcpro gcpro1
, gcpro2
;
2421 bool volatile polling_stopped_here
= 0;
2422 struct kboard
*orig_kboard
= current_kboard
;
2426 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2427 before_command_key_count
= this_command_key_count
;
2428 before_command_echo_length
= echo_length ();
2431 previous_echo_area_message
= Qnil
;
2433 GCPRO2 (c
, previous_echo_area_message
);
2437 if (CONSP (Vunread_post_input_method_events
))
2439 c
= XCAR (Vunread_post_input_method_events
);
2440 Vunread_post_input_method_events
2441 = XCDR (Vunread_post_input_method_events
);
2443 /* Undo what read_char_x_menu_prompt did when it unread
2444 additional keys returned by Fx_popup_menu. */
2446 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2457 if (CONSP (Vunread_command_events
))
2459 bool was_disabled
= 0;
2461 c
= XCAR (Vunread_command_events
);
2462 Vunread_command_events
= XCDR (Vunread_command_events
);
2464 /* Undo what sit-for did when it unread additional keys
2465 inside universal-argument. */
2467 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2472 /* Undo what read_char_x_menu_prompt did when it unread
2473 additional keys returned by Fx_popup_menu. */
2475 && EQ (XCDR (c
), Qdisabled
)
2476 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2482 /* If the queued event is something that used the mouse,
2483 set used_mouse_menu accordingly. */
2485 /* Also check was_disabled so last-nonmenu-event won't return
2486 a bad value when submenus are involved. (Bug#447) */
2487 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2488 *used_mouse_menu
= 1;
2490 goto reread_for_input_method
;
2493 if (CONSP (Vunread_input_method_events
))
2495 c
= XCAR (Vunread_input_method_events
);
2496 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2498 /* Undo what read_char_x_menu_prompt did when it unread
2499 additional keys returned by Fx_popup_menu. */
2501 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2505 goto reread_for_input_method
;
2508 this_command_key_count_reset
= 0;
2510 if (!NILP (Vexecuting_kbd_macro
))
2512 /* We set this to Qmacro; since that's not a frame, nobody will
2513 try to switch frames on us, and the selected window will
2516 Since this event came from a macro, it would be misleading to
2517 leave internal_last_event_frame set to wherever the last
2518 real event came from. Normally, a switch-frame event selects
2519 internal_last_event_frame after each command is read, but
2520 events read from a macro should never cause a new frame to be
2522 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2524 /* Exit the macro if we are at the end.
2525 Also, some things replace the macro with t
2526 to force an early exit. */
2527 if (EQ (Vexecuting_kbd_macro
, Qt
)
2528 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2534 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2535 if (STRINGP (Vexecuting_kbd_macro
)
2536 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2537 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2539 executing_kbd_macro_index
++;
2544 if (!NILP (unread_switch_frame
))
2546 c
= unread_switch_frame
;
2547 unread_switch_frame
= Qnil
;
2549 /* This event should make it into this_command_keys, and get echoed
2550 again, so we do not set `reread'. */
2554 /* If redisplay was requested. */
2555 if (commandflag
>= 0)
2557 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2559 /* If there is pending input, process any events which are not
2560 user-visible, such as X selection_request events. */
2562 || detect_input_pending_run_timers (0))
2563 swallow_events (0); /* May clear input_pending. */
2565 /* Redisplay if no pending input. */
2566 while (!input_pending
)
2568 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2569 redisplay_preserve_echo_area (5);
2574 /* Normal case: no input arrived during redisplay. */
2577 /* Input arrived and pre-empted redisplay.
2578 Process any events which are not user-visible. */
2580 /* If that cleared input_pending, try again to redisplay. */
2583 /* Prevent the redisplay we just did
2584 from messing up echoing of the input after the prompt. */
2585 if (commandflag
== 0 && echo_current
)
2586 echo_message_buffer
= echo_area_buffer
[0];
2590 /* Message turns off echoing unless more keystrokes turn it on again.
2592 The code in 20.x for the condition was
2594 1. echo_area_glyphs && *echo_area_glyphs
2595 2. && echo_area_glyphs != current_kboard->echobuf
2596 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2598 (1) means there's a current message displayed
2600 (2) means it's not the message from echoing from the current
2603 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2604 is set to a non-null value. This is done in read_char and it is
2605 set to echo_area_glyphs after a call to echo_char. That means
2606 ok_to_echo_at_next_pause is either null or
2607 current_kboard->echobuf with the appropriate current_kboard at
2610 So, condition (3) means in clear text ok_to_echo_at_next_pause
2611 must be either null, or the current message isn't from echoing at
2612 all, or it's from echoing from a different kboard than the
2615 if (/* There currently is something in the echo area. */
2616 !NILP (echo_area_buffer
[0])
2617 && (/* It's an echo from a different kboard. */
2618 echo_kboard
!= current_kboard
2619 /* Or we explicitly allow overwriting whatever there is. */
2620 || ok_to_echo_at_next_pause
== NULL
))
2625 /* Try reading a character via menu prompting in the minibuf.
2626 Try this before the sit-for, because the sit-for
2627 would do the wrong thing if we are supposed to do
2628 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2629 after a mouse event so don't try a minibuf menu. */
2631 if (KEYMAPP (map
) && INTERACTIVE
2632 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2633 /* Don't bring up a menu if we already have another event. */
2634 && NILP (Vunread_command_events
)
2635 && !detect_input_pending_run_timers (0))
2637 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2639 if (INTEGERP (c
) && XINT (c
) == -2)
2640 return c
; /* wrong_kboard_jmpbuf */
2646 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2647 We will do that below, temporarily for short sections of code,
2648 when appropriate. local_getcjmp must be in effect
2649 around any call to sit_for or kbd_buffer_get_event;
2650 it *must not* be in effect when we call redisplay. */
2652 jmpcount
= SPECPDL_INDEX ();
2653 if (sys_setjmp (local_getcjmp
))
2655 /* Handle quits while reading the keyboard. */
2656 /* We must have saved the outer value of getcjmp here,
2657 so restore it now. */
2658 restore_getcjmp (save_jump
);
2659 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2660 unbind_to (jmpcount
, Qnil
);
2661 XSETINT (c
, quit_char
);
2662 internal_last_event_frame
= selected_frame
;
2663 Vlast_event_frame
= internal_last_event_frame
;
2664 /* If we report the quit char as an event,
2665 don't do so more than once. */
2666 if (!NILP (Vinhibit_quit
))
2670 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2671 if (kb
!= current_kboard
)
2673 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2674 /* We shouldn't get here if we were in single-kboard mode! */
2679 while (CONSP (XCDR (last
)))
2681 if (!NILP (XCDR (last
)))
2685 kset_kbd_queue (kb
, list1 (c
));
2687 XSETCDR (last
, list1 (c
));
2688 kb
->kbd_queue_has_data
= 1;
2689 current_kboard
= kb
;
2690 /* This is going to exit from read_char
2691 so we had better get rid of this frame's stuff. */
2693 return make_number (-2); /* wrong_kboard_jmpbuf */
2699 /* Start idle timers if no time limit is supplied. We don't do it
2700 if a time limit is supplied to avoid an infinite recursion in the
2701 situation where an idle timer calls `sit-for'. */
2704 timer_start_idle ();
2706 /* If in middle of key sequence and minibuffer not active,
2707 start echoing if enough time elapses. */
2709 if (minibuf_level
== 0
2711 && !current_kboard
->immediate_echo
2712 && this_command_key_count
> 0
2714 && echo_keystrokes_p ()
2715 && (/* No message. */
2716 NILP (echo_area_buffer
[0])
2717 /* Or empty message. */
2718 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2719 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2720 /* Or already echoing from same kboard. */
2721 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2722 /* Or not echoing before and echoing allowed. */
2723 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2725 /* After a mouse event, start echoing right away.
2726 This is because we are probably about to display a menu,
2727 and we don't want to delay before doing so. */
2728 if (EVENT_HAS_PARAMETERS (prev_event
))
2734 save_getcjmp (save_jump
);
2735 restore_getcjmp (local_getcjmp
);
2736 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2737 restore_getcjmp (save_jump
);
2739 && ! CONSP (Vunread_command_events
))
2744 /* Maybe auto save due to number of keystrokes. */
2746 if (commandflag
!= 0 && commandflag
!= -2
2747 && auto_save_interval
> 0
2748 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2749 && !detect_input_pending_run_timers (0))
2751 Fdo_auto_save (Qnil
, Qnil
);
2752 /* Hooks can actually change some buffers in auto save. */
2756 /* Try reading using an X menu.
2757 This is never confused with reading using the minibuf
2758 because the recursive call of read_char in read_char_minibuf_menu_prompt
2759 does not pass on any keymaps. */
2761 if (KEYMAPP (map
) && INTERACTIVE
2762 && !NILP (prev_event
)
2763 && EVENT_HAS_PARAMETERS (prev_event
)
2764 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2765 && !EQ (XCAR (prev_event
), Qtool_bar
)
2766 /* Don't bring up a menu if we already have another event. */
2767 && NILP (Vunread_command_events
))
2769 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2771 /* Now that we have read an event, Emacs is not idle. */
2778 /* Maybe autosave and/or garbage collect due to idleness. */
2780 if (INTERACTIVE
&& NILP (c
))
2783 ptrdiff_t buffer_size
;
2785 /* Slow down auto saves logarithmically in size of current buffer,
2786 and garbage collect while we're at it. */
2787 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2788 last_non_minibuf_size
= Z
- BEG
;
2789 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2791 while (buffer_size
> 64)
2792 delay_level
++, buffer_size
-= buffer_size
>> 2;
2793 if (delay_level
< 4) delay_level
= 4;
2794 /* delay_level is 4 for files under around 50k, 7 at 100k,
2795 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2797 /* Auto save if enough time goes by without input. */
2798 if (commandflag
!= 0 && commandflag
!= -2
2799 && num_nonmacro_input_events
> last_auto_save
2800 && INTEGERP (Vauto_save_timeout
)
2801 && XINT (Vauto_save_timeout
) > 0)
2804 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2806 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2807 timeout
= delay_level
* timeout
/ 4;
2808 save_getcjmp (save_jump
);
2809 restore_getcjmp (local_getcjmp
);
2810 tem0
= sit_for (make_number (timeout
), 1, 1);
2811 restore_getcjmp (save_jump
);
2814 && ! CONSP (Vunread_command_events
))
2816 Fdo_auto_save (Qnil
, Qnil
);
2821 /* If there is still no input available, ask for GC. */
2822 if (!detect_input_pending_run_timers (0))
2826 /* Notify the caller if an autosave hook, or a timer, sentinel or
2827 filter in the sit_for calls above have changed the current
2828 kboard. This could happen if they use the minibuffer or start a
2829 recursive edit, like the fancy splash screen in server.el's
2830 filter. If this longjmp wasn't here, read_key_sequence would
2831 interpret the next key sequence using the wrong translation
2832 tables and function keymaps. */
2833 if (NILP (c
) && current_kboard
!= orig_kboard
)
2836 return make_number (-2); /* wrong_kboard_jmpbuf */
2839 /* If this has become non-nil here, it has been set by a timer
2840 or sentinel or filter. */
2841 if (CONSP (Vunread_command_events
))
2843 c
= XCAR (Vunread_command_events
);
2844 Vunread_command_events
= XCDR (Vunread_command_events
);
2846 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2852 /* Read something from current KBOARD's side queue, if possible. */
2856 if (current_kboard
->kbd_queue_has_data
)
2858 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2860 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2861 kset_kbd_queue (current_kboard
,
2862 XCDR (KVAR (current_kboard
, kbd_queue
)));
2863 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2864 current_kboard
->kbd_queue_has_data
= 0;
2865 input_pending
= readable_events (0);
2866 if (EVENT_HAS_PARAMETERS (c
)
2867 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2868 internal_last_event_frame
= XCAR (XCDR (c
));
2869 Vlast_event_frame
= internal_last_event_frame
;
2873 /* If current_kboard's side queue is empty check the other kboards.
2874 If one of them has data that we have not yet seen here,
2875 switch to it and process the data waiting for it.
2877 Note: if the events queued up for another kboard
2878 have already been seen here, and therefore are not a complete command,
2879 the kbd_queue_has_data field is 0, so we skip that kboard here.
2880 That's to avoid an infinite loop switching between kboards here. */
2881 if (NILP (c
) && !single_kboard
)
2884 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2885 if (kb
->kbd_queue_has_data
)
2887 current_kboard
= kb
;
2888 /* This is going to exit from read_char
2889 so we had better get rid of this frame's stuff. */
2891 return make_number (-2); /* wrong_kboard_jmpbuf */
2901 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2902 prev_event
, used_mouse_menu
);
2903 if (NILP (c
) && end_time
2904 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2909 if (EQ (c
, make_number (-2)))
2911 /* This is going to exit from read_char
2912 so we had better get rid of this frame's stuff. */
2926 if (commandflag
>= 0
2927 && !input_pending
&& !detect_input_pending_run_timers (0))
2933 /* Buffer switch events are only for internal wakeups
2934 so don't show them to the user.
2935 Also, don't record a key if we already did. */
2939 /* Process special events within read_char
2940 and loop around to read another event. */
2943 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2948 struct buffer
*prev_buffer
= current_buffer
;
2949 last_input_event
= c
;
2950 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2952 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2953 /* We stopped being idle for this event; undo that. This
2954 prevents automatic window selection (under
2955 mouse_autoselect_window from acting as a real input event, for
2956 example banishing the mouse under mouse-avoidance-mode. */
2957 timer_resume_idle ();
2959 if (current_buffer
!= prev_buffer
)
2961 /* The command may have changed the keymaps. Pretend there
2962 is input in another keyboard and return. This will
2963 recalculate keymaps. */
2964 c
= make_number (-2);
2971 /* Handle things that only apply to characters. */
2974 /* If kbd_buffer_get_event gave us an EOF, return that. */
2978 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2979 && UNSIGNED_CMP (XFASTINT (c
), <,
2980 SCHARS (KVAR (current_kboard
,
2981 Vkeyboard_translate_table
))))
2982 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2983 && UNSIGNED_CMP (XFASTINT (c
), <,
2984 ASIZE (KVAR (current_kboard
,
2985 Vkeyboard_translate_table
))))
2986 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2990 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2991 /* nil in keyboard-translate-table means no translation. */
2997 /* If this event is a mouse click in the menu bar,
2998 return just menu-bar for now. Modify the mouse click event
2999 so we won't do this twice, then queue it up. */
3000 if (EVENT_HAS_PARAMETERS (c
)
3002 && CONSP (EVENT_START (c
))
3003 && CONSP (XCDR (EVENT_START (c
))))
3007 posn
= POSN_POSN (EVENT_START (c
));
3008 /* Handle menu-bar events:
3009 insert the dummy prefix event `menu-bar'. */
3010 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3012 /* Change menu-bar to (menu-bar) as the event "position". */
3013 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3016 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3021 /* Store these characters into recent_keys, the dribble file if any,
3022 and the keyboard macro being defined, if any. */
3024 if (! NILP (also_record
))
3025 record_char (also_record
);
3027 /* Wipe the echo area.
3028 But first, if we are about to use an input method,
3029 save the echo area contents for it to refer to. */
3031 && ! NILP (Vinput_method_function
)
3032 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3034 previous_echo_area_message
= Fcurrent_message ();
3035 Vinput_method_previous_message
= previous_echo_area_message
;
3038 /* Now wipe the echo area, except for help events which do their
3039 own stuff with the echo area. */
3041 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3042 && !(EQ (Qswitch_frame
, XCAR (c
)))
3043 /* Don't wipe echo area for select window events: These might
3044 get delayed via `mouse-autoselect-window' (Bug#11304). */
3045 && !(EQ (Qselect_window
, XCAR (c
)))))
3047 if (!NILP (echo_area_buffer
[0]))
3049 safe_run_hooks (Qecho_area_clear_hook
);
3050 clear_message (1, 0);
3054 reread_for_input_method
:
3056 /* Pass this to the input method, if appropriate. */
3058 && ! NILP (Vinput_method_function
)
3059 /* Don't run the input method within a key sequence,
3060 after the first event of the key sequence. */
3061 && NILP (prev_event
)
3062 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3065 ptrdiff_t key_count
;
3066 bool key_count_reset
;
3067 struct gcpro gcpro1
;
3068 ptrdiff_t count
= SPECPDL_INDEX ();
3070 /* Save the echo status. */
3071 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3072 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3073 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3074 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3077 if (before_command_restore_flag
)
3079 this_command_key_count
= before_command_key_count_1
;
3080 if (this_command_key_count
< this_single_command_key_start
)
3081 this_single_command_key_start
= this_command_key_count
;
3082 echo_truncate (before_command_echo_length_1
);
3083 before_command_restore_flag
= 0;
3087 /* Save the this_command_keys status. */
3088 key_count
= this_command_key_count
;
3089 key_count_reset
= this_command_key_count_reset
;
3092 keys
= Fcopy_sequence (this_command_keys
);
3097 /* Clear out this_command_keys. */
3098 this_command_key_count
= 0;
3099 this_command_key_count_reset
= 0;
3101 /* Now wipe the echo area. */
3102 if (!NILP (echo_area_buffer
[0]))
3103 safe_run_hooks (Qecho_area_clear_hook
);
3104 clear_message (1, 0);
3107 /* If we are not reading a key sequence,
3108 never use the echo area. */
3111 specbind (Qinput_method_use_echo_area
, Qt
);
3114 /* Call the input method. */
3115 tem
= call1 (Vinput_method_function
, c
);
3117 tem
= unbind_to (count
, tem
);
3119 /* Restore the saved echoing state
3120 and this_command_keys state. */
3121 this_command_key_count
= key_count
;
3122 this_command_key_count_reset
= key_count_reset
;
3124 this_command_keys
= keys
;
3127 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3128 kset_echo_string (current_kboard
, saved_echo_string
);
3129 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3130 if (saved_immediate_echo
)
3135 /* The input method can return no events. */
3138 /* Bring back the previous message, if any. */
3139 if (! NILP (previous_echo_area_message
))
3140 message_with_string ("%s", previous_echo_area_message
, 0);
3143 /* It returned one event or more. */
3145 Vunread_post_input_method_events
3146 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3151 /* Display help if not echoing. */
3152 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3154 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3155 Lisp_Object help
, object
, position
, window
, htem
;
3157 htem
= Fcdr (XCDR (c
));
3160 window
= Fcar (htem
);
3162 object
= Fcar (htem
);
3164 position
= Fcar (htem
);
3166 show_help_echo (help
, window
, object
, position
);
3168 /* We stopped being idle for this event; undo that. */
3170 timer_resume_idle ();
3174 if ((! reread
|| this_command_key_count
== 0
3175 || this_command_key_count_reset
)
3179 /* Don't echo mouse motion events. */
3180 if (echo_keystrokes_p ()
3181 && ! (EVENT_HAS_PARAMETERS (c
)
3182 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3185 if (! NILP (also_record
))
3186 echo_char (also_record
);
3187 /* Once we reread a character, echoing can happen
3188 the next time we pause to read a new one. */
3189 ok_to_echo_at_next_pause
= current_kboard
;
3192 /* Record this character as part of the current key. */
3193 add_command_key (c
);
3194 if (! NILP (also_record
))
3195 add_command_key (also_record
);
3198 last_input_event
= c
;
3201 /* Process the help character specially if enabled. */
3202 if (!NILP (Vhelp_form
) && help_char_p (c
))
3204 ptrdiff_t count
= SPECPDL_INDEX ();
3206 help_form_saved_window_configs
3207 = Fcons (Fcurrent_window_configuration (Qnil
),
3208 help_form_saved_window_configs
);
3209 record_unwind_protect_void (read_char_help_form_unwind
);
3210 call0 (Qhelp_form_show
);
3215 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3216 if (EVENT_HAS_PARAMETERS (c
)
3217 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3218 XSETCAR (help_form_saved_window_configs
, Qnil
);
3220 while (BUFFERP (c
));
3221 /* Remove the help from the frame. */
3222 unbind_to (count
, Qnil
);
3225 if (EQ (c
, make_number (040)))
3229 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3230 while (BUFFERP (c
));
3239 /* Record a key that came from a mouse menu.
3240 Record it for echoing, for this-command-keys, and so on. */
3243 record_menu_key (Lisp_Object c
)
3245 /* Wipe the echo area. */
3246 clear_message (1, 0);
3251 before_command_key_count
= this_command_key_count
;
3252 before_command_echo_length
= echo_length ();
3255 /* Don't echo mouse motion events. */
3256 if (echo_keystrokes_p ())
3260 /* Once we reread a character, echoing can happen
3261 the next time we pause to read a new one. */
3262 ok_to_echo_at_next_pause
= 0;
3265 /* Record this character as part of the current key. */
3266 add_command_key (c
);
3268 /* Re-reading in the middle of a command. */
3269 last_input_event
= c
;
3273 /* Return true if should recognize C as "the help character". */
3276 help_char_p (Lisp_Object c
)
3280 if (EQ (c
, Vhelp_char
))
3282 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3283 if (EQ (c
, XCAR (tail
)))
3288 /* Record the input event C in various ways. */
3291 record_char (Lisp_Object c
)
3295 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3297 /* To avoid filling recent_keys with help-echo and mouse-movement
3298 events, we filter out repeated help-echo events, only store the
3299 first and last in a series of mouse-movement events, and don't
3300 store repeated help-echo events which are only separated by
3301 mouse-movement events. */
3303 Lisp_Object ev1
, ev2
, ev3
;
3306 if ((ix1
= recent_keys_index
- 1) < 0)
3307 ix1
= NUM_RECENT_KEYS
- 1;
3308 ev1
= AREF (recent_keys
, ix1
);
3310 if ((ix2
= ix1
- 1) < 0)
3311 ix2
= NUM_RECENT_KEYS
- 1;
3312 ev2
= AREF (recent_keys
, ix2
);
3314 if ((ix3
= ix2
- 1) < 0)
3315 ix3
= NUM_RECENT_KEYS
- 1;
3316 ev3
= AREF (recent_keys
, ix3
);
3318 if (EQ (XCAR (c
), Qhelp_echo
))
3320 /* Don't record `help-echo' in recent_keys unless it shows some help
3321 message, and a different help than the previously recorded
3323 Lisp_Object help
, last_help
;
3325 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3326 if (!STRINGP (help
))
3328 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3329 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3331 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3332 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3333 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3335 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3336 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3337 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3338 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3341 else if (EQ (XCAR (c
), Qmouse_movement
))
3343 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3344 So additional mouse movement events replace the last element. */
3345 Lisp_Object last_window
, window
;
3347 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3348 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3349 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3350 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3351 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3353 ASET (recent_keys
, ix1
, c
);
3359 store_kbd_macro_char (c
);
3363 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3364 ASET (recent_keys
, recent_keys_index
, c
);
3365 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3366 recent_keys_index
= 0;
3368 else if (recorded
< 0)
3370 /* We need to remove one or two events from recent_keys.
3371 To do this, we simply put nil at those events and move the
3372 recent_keys_index backwards over those events. Usually,
3373 users will never see those nil events, as they will be
3374 overwritten by the command keys entered to see recent_keys
3377 while (recorded
++ < 0 && total_keys
> 0)
3379 if (total_keys
< NUM_RECENT_KEYS
)
3381 if (--recent_keys_index
< 0)
3382 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3383 ASET (recent_keys
, recent_keys_index
, Qnil
);
3387 num_nonmacro_input_events
++;
3389 /* Write c to the dribble file. If c is a lispy event, write
3390 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3391 If you, dear reader, have a better idea, you've got the source. :-) */
3397 if (XUINT (c
) < 0x100)
3398 putc (XUINT (c
), dribble
);
3400 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3404 Lisp_Object dribblee
;
3406 /* If it's a structured event, take the event header. */
3407 dribblee
= EVENT_HEAD (c
);
3409 if (SYMBOLP (dribblee
))
3411 putc ('<', dribble
);
3412 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3413 SBYTES (SYMBOL_NAME (dribblee
)),
3415 putc ('>', dribble
);
3424 /* Copy out or in the info on where C-g should throw to.
3425 This is used when running Lisp code from within get_char,
3426 in case get_char is called recursively.
3427 See read_process_output. */
3430 save_getcjmp (sys_jmp_buf temp
)
3432 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3436 restore_getcjmp (sys_jmp_buf temp
)
3438 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3441 /* Low level keyboard/mouse input.
3442 kbd_buffer_store_event places events in kbd_buffer, and
3443 kbd_buffer_get_event retrieves them. */
3445 /* Return true if there are any events in the queue that read-char
3446 would return. If this returns false, a read-char would block. */
3448 readable_events (int flags
)
3450 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3453 /* If the buffer contains only FOCUS_IN_EVENT events, and
3454 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3455 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3457 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3458 #ifdef USE_TOOLKIT_SCROLL_BARS
3459 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3463 struct input_event
*event
;
3465 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3472 #ifdef USE_TOOLKIT_SCROLL_BARS
3473 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3475 event
->kind
== FOCUS_IN_EVENT
)
3476 #ifdef USE_TOOLKIT_SCROLL_BARS
3477 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3478 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3479 && event
->part
== scroll_bar_handle
3480 && event
->modifiers
== 0)
3485 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3488 while (event
!= kbd_store_ptr
);
3494 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3495 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3499 if (current_kboard
->kbd_queue_has_data
)
3505 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3506 if (kb
->kbd_queue_has_data
)
3512 /* Set this for debugging, to have a way to get out */
3513 int stop_character EXTERNALLY_VISIBLE
;
3516 event_to_kboard (struct input_event
*event
)
3518 /* Not applicable for these special events. */
3519 if (event
->kind
== SELECTION_REQUEST_EVENT
3520 || event
->kind
== SELECTION_CLEAR_EVENT
)
3524 Lisp_Object obj
= event
->frame_or_window
;
3525 /* There are some events that set this field to nil or string. */
3527 obj
= WINDOW_FRAME (XWINDOW (obj
));
3528 /* Also ignore dead frames here. */
3529 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3530 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3535 /* Return the number of slots occupied in kbd_buffer. */
3538 kbd_buffer_nr_stored (void)
3540 return kbd_fetch_ptr
== kbd_store_ptr
3542 : (kbd_fetch_ptr
< kbd_store_ptr
3543 ? kbd_store_ptr
- kbd_fetch_ptr
3544 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3545 + (kbd_store_ptr
- kbd_buffer
)));
3547 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3550 kbd_buffer_store_event (register struct input_event
*event
)
3552 kbd_buffer_store_event_hold (event
, 0);
3555 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3557 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3558 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3559 Else, if EVENT is a quit event, store the quit event
3560 in HOLD_QUIT, and return (thus ignoring further events).
3562 This is used to postpone the processing of the quit event until all
3563 subsequent input events have been parsed (and discarded). */
3566 kbd_buffer_store_event_hold (register struct input_event
*event
,
3567 struct input_event
*hold_quit
)
3569 if (event
->kind
== NO_EVENT
)
3572 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3575 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3577 register int c
= event
->code
& 0377;
3579 if (event
->modifiers
& ctrl_modifier
)
3580 c
= make_ctrl_char (c
);
3582 c
|= (event
->modifiers
3583 & (meta_modifier
| alt_modifier
3584 | hyper_modifier
| super_modifier
));
3588 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3589 struct input_event
*sp
;
3591 if (single_kboard
&& kb
!= current_kboard
)
3594 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3596 kb
->kbd_queue_has_data
= 1;
3597 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3599 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3602 if (event_to_kboard (sp
) == kb
)
3604 sp
->kind
= NO_EVENT
;
3605 sp
->frame_or_window
= Qnil
;
3614 *hold_quit
= *event
;
3618 /* If this results in a quit_char being returned to Emacs as
3619 input, set Vlast_event_frame properly. If this doesn't
3620 get returned to Emacs as an event, the next event read
3621 will set Vlast_event_frame again, so this is safe to do. */
3625 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3627 focus
= event
->frame_or_window
;
3628 internal_last_event_frame
= focus
;
3629 Vlast_event_frame
= focus
;
3632 handle_interrupt (0);
3636 if (c
&& c
== stop_character
)
3642 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3643 Just ignore the second one. */
3644 else if (event
->kind
== BUFFER_SWITCH_EVENT
3645 && kbd_fetch_ptr
!= kbd_store_ptr
3646 && ((kbd_store_ptr
== kbd_buffer
3647 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3648 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3651 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3652 kbd_store_ptr
= kbd_buffer
;
3654 /* Don't let the very last slot in the buffer become full,
3655 since that would make the two pointers equal,
3656 and that is indistinguishable from an empty buffer.
3657 Discard the event if it would fill the last slot. */
3658 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3660 *kbd_store_ptr
= *event
;
3663 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3665 /* Don't read keyboard input until we have processed kbd_buffer.
3666 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3667 hold_keyboard_input ();
3668 if (!noninteractive
)
3672 #endif /* subprocesses */
3675 /* If we're inside while-no-input, and this event qualifies
3676 as input, set quit-flag to cause an interrupt. */
3677 if (!NILP (Vthrow_on_input
)
3678 && event
->kind
!= FOCUS_IN_EVENT
3679 && event
->kind
!= HELP_EVENT
3680 && event
->kind
!= DEICONIFY_EVENT
)
3682 Vquit_flag
= Vthrow_on_input
;
3683 /* If we're inside a function that wants immediate quits,
3685 if (immediate_quit
&& NILP (Vinhibit_quit
))
3694 /* Put an input event back in the head of the event queue. */
3697 kbd_buffer_unget_event (register struct input_event
*event
)
3699 if (kbd_fetch_ptr
== kbd_buffer
)
3700 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3702 /* Don't let the very last slot in the buffer become full, */
3703 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3706 *kbd_fetch_ptr
= *event
;
3711 /* Generate a HELP_EVENT input_event and store it in the keyboard
3714 HELP is the help form.
3716 FRAME and WINDOW are the frame and window where the help is
3717 generated. OBJECT is the Lisp object where the help was found (a
3718 buffer, a string, an overlay, or nil if neither from a string nor
3719 from a buffer). POS is the position within OBJECT where the help
3723 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3724 Lisp_Object object
, ptrdiff_t pos
)
3726 struct input_event event
;
3730 event
.kind
= HELP_EVENT
;
3731 event
.frame_or_window
= frame
;
3733 event
.x
= WINDOWP (window
) ? window
: frame
;
3736 kbd_buffer_store_event (&event
);
3740 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3743 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3745 struct input_event event
;
3747 event
.kind
= HELP_EVENT
;
3748 event
.frame_or_window
= frame
;
3753 kbd_buffer_store_event (&event
);
3757 /* Discard any mouse events in the event buffer by setting them to
3760 discard_mouse_events (void)
3762 struct input_event
*sp
;
3763 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3765 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3768 if (sp
->kind
== MOUSE_CLICK_EVENT
3769 || sp
->kind
== WHEEL_EVENT
3770 || sp
->kind
== HORIZ_WHEEL_EVENT
3772 || sp
->kind
== GPM_CLICK_EVENT
3774 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3776 sp
->kind
= NO_EVENT
;
3782 /* Return true if there are any real events waiting in the event
3783 buffer, not counting `NO_EVENT's.
3785 Discard NO_EVENT events at the front of the input queue, possibly
3786 leaving the input queue empty if there are no real input events. */
3789 kbd_buffer_events_waiting (void)
3791 struct input_event
*sp
;
3793 for (sp
= kbd_fetch_ptr
;
3794 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3797 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3802 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3806 /* Clear input event EVENT. */
3809 clear_event (struct input_event
*event
)
3811 event
->kind
= NO_EVENT
;
3815 /* Read one event from the event buffer, waiting if necessary.
3816 The value is a Lisp object representing the event.
3817 The value is nil for an event that should be ignored,
3818 or that was handled here.
3819 We always read and discard one event. */
3822 kbd_buffer_get_event (KBOARD
**kbp
,
3823 bool *used_mouse_menu
,
3824 struct timespec
*end_time
)
3829 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3831 /* Start reading input again because we have processed enough to
3832 be able to accept new events again. */
3833 unhold_keyboard_input ();
3836 #endif /* subprocesses */
3838 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3840 /* In case we are running as a daemon, only do this before
3841 detaching from the terminal. */
3842 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3846 *kbp
= current_kboard
;
3849 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3851 /* Wait until there is input available. */
3854 /* Break loop if there's an unread command event. Needed in
3855 moused window autoselection which uses a timer to insert such
3857 if (CONSP (Vunread_command_events
))
3860 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3862 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3865 /* If the quit flag is set, then read_char will return
3866 quit_char, so that counts as "available input." */
3867 if (!NILP (Vquit_flag
))
3868 quit_throw_to_read_char (0);
3870 /* One way or another, wait until input is available; then, if
3871 interrupt handlers have not read it, read it now. */
3876 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3878 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3882 struct timespec now
= current_timespec ();
3883 if (timespec_cmp (*end_time
, now
) <= 0)
3884 return Qnil
; /* Finished waiting. */
3887 struct timespec duration
= timespec_sub (*end_time
, now
);
3888 wait_reading_process_output (min (duration
.tv_sec
,
3891 -1, 1, Qnil
, NULL
, 0);
3896 bool do_display
= true;
3898 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3900 struct tty_display_info
*tty
= CURTTY ();
3902 /* When this TTY is displaying a menu, we must prevent
3903 any redisplay, because we modify the frame's glyph
3904 matrix behind the back of the display engine. */
3905 if (tty
->showing_menu
)
3909 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3912 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3916 if (CONSP (Vunread_command_events
))
3919 first
= XCAR (Vunread_command_events
);
3920 Vunread_command_events
= XCDR (Vunread_command_events
);
3921 *kbp
= current_kboard
;
3925 /* At this point, we know that there is a readable event available
3926 somewhere. If the event queue is empty, then there must be a
3927 mouse movement enabled and available. */
3928 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3930 struct input_event
*event
;
3932 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3936 *kbp
= event_to_kboard (event
);
3938 *kbp
= current_kboard
; /* Better than returning null ptr? */
3942 /* These two kinds of events get special handling
3943 and don't actually appear to the command loop.
3944 We return nil for them. */
3945 if (event
->kind
== SELECTION_REQUEST_EVENT
3946 || event
->kind
== SELECTION_CLEAR_EVENT
)
3949 struct input_event copy
;
3951 /* Remove it from the buffer before processing it,
3952 since otherwise swallow_events will see it
3953 and process it again. */
3955 kbd_fetch_ptr
= event
+ 1;
3956 input_pending
= readable_events (0);
3957 x_handle_selection_event (©
);
3959 /* We're getting selection request events, but we don't have
3965 #if defined (HAVE_NS)
3966 else if (event
->kind
== NS_TEXT_EVENT
)
3968 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3969 obj
= list1 (intern ("ns-put-working-text"));
3971 obj
= list1 (intern ("ns-unput-working-text"));
3972 kbd_fetch_ptr
= event
+ 1;
3973 if (used_mouse_menu
)
3974 *used_mouse_menu
= 1;
3978 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3979 || defined (HAVE_NS)
3980 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3982 /* Make an event (delete-frame (FRAME)). */
3983 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3984 kbd_fetch_ptr
= event
+ 1;
3987 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3988 || defined (HAVE_NS)
3989 else if (event
->kind
== ICONIFY_EVENT
)
3991 /* Make an event (iconify-frame (FRAME)). */
3992 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3993 kbd_fetch_ptr
= event
+ 1;
3995 else if (event
->kind
== DEICONIFY_EVENT
)
3997 /* Make an event (make-frame-visible (FRAME)). */
3998 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3999 kbd_fetch_ptr
= event
+ 1;
4002 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4004 /* The value doesn't matter here; only the type is tested. */
4005 XSETBUFFER (obj
, current_buffer
);
4006 kbd_fetch_ptr
= event
+ 1;
4008 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4009 || defined (HAVE_NS) || defined (USE_GTK)
4010 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4012 kbd_fetch_ptr
= event
+ 1;
4013 input_pending
= readable_events (0);
4014 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4015 x_activate_menubar (XFRAME (event
->frame_or_window
));
4019 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4021 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4022 obj
= list4 (Qlanguage_change
,
4023 event
->frame_or_window
,
4024 make_number (event
->code
),
4025 make_number (event
->modifiers
));
4026 kbd_fetch_ptr
= event
+ 1;
4029 #ifdef USE_FILE_NOTIFY
4030 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4032 #ifdef HAVE_W32NOTIFY
4033 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4034 obj
= list3 (Qfile_notify
,
4035 list3 (make_number (event
->code
),
4038 event
->frame_or_window
);
4040 obj
= make_lispy_event (event
);
4042 kbd_fetch_ptr
= event
+ 1;
4044 #endif /* USE_FILE_NOTIFY */
4045 else if (event
->kind
== SAVE_SESSION_EVENT
)
4047 obj
= list2 (Qsave_session
, event
->arg
);
4048 kbd_fetch_ptr
= event
+ 1;
4050 /* Just discard these, by returning nil.
4051 With MULTI_KBOARD, these events are used as placeholders
4052 when we need to randomly delete events from the queue.
4053 (They shouldn't otherwise be found in the buffer,
4054 but on some machines it appears they do show up
4055 even without MULTI_KBOARD.) */
4056 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4057 mouse events during a popup-menu call. */
4058 else if (event
->kind
== NO_EVENT
)
4059 kbd_fetch_ptr
= event
+ 1;
4060 else if (event
->kind
== HELP_EVENT
)
4062 Lisp_Object object
, position
, help
, frame
, window
;
4064 frame
= event
->frame_or_window
;
4065 object
= event
->arg
;
4066 position
= make_number (event
->code
);
4069 clear_event (event
);
4071 kbd_fetch_ptr
= event
+ 1;
4072 if (!WINDOWP (window
))
4074 obj
= Fcons (Qhelp_echo
,
4075 list5 (frame
, help
, window
, object
, position
));
4077 else if (event
->kind
== FOCUS_IN_EVENT
)
4079 /* Notification of a FocusIn event. The frame receiving the
4080 focus is in event->frame_or_window. Generate a
4081 switch-frame event if necessary. */
4082 Lisp_Object frame
, focus
;
4084 frame
= event
->frame_or_window
;
4085 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4094 !EQ (frame
, internal_last_event_frame
)
4095 && !EQ (frame
, selected_frame
))
4096 obj
= make_lispy_switch_frame (frame
);
4098 obj
= make_lispy_focus_in (frame
);
4100 internal_last_event_frame
= frame
;
4101 kbd_fetch_ptr
= event
+ 1;
4103 else if (event
->kind
== FOCUS_OUT_EVENT
)
4105 #ifdef HAVE_WINDOW_SYSTEM
4108 Lisp_Object frame
= event
->frame_or_window
;
4109 bool focused
= false;
4111 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4112 focused
= di
->x_highlight_frame
!= 0;
4115 obj
= make_lispy_focus_out (frame
);
4117 #endif /* HAVE_WINDOW_SYSTEM */
4119 kbd_fetch_ptr
= event
+ 1;
4122 else if (event
->kind
== DBUS_EVENT
)
4124 obj
= make_lispy_event (event
);
4125 kbd_fetch_ptr
= event
+ 1;
4128 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4130 obj
= make_lispy_event (event
);
4131 kbd_fetch_ptr
= event
+ 1;
4135 /* If this event is on a different frame, return a switch-frame this
4136 time, and leave the event in the queue for next time. */
4140 frame
= event
->frame_or_window
;
4142 frame
= XCAR (frame
);
4143 else if (WINDOWP (frame
))
4144 frame
= WINDOW_FRAME (XWINDOW (frame
));
4146 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4150 if (! EQ (frame
, internal_last_event_frame
)
4151 && !EQ (frame
, selected_frame
))
4152 obj
= make_lispy_switch_frame (frame
);
4153 internal_last_event_frame
= frame
;
4155 /* If we didn't decide to make a switch-frame event, go ahead
4156 and build a real event from the queue entry. */
4160 obj
= make_lispy_event (event
);
4162 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4163 || defined (HAVE_NS) || defined (USE_GTK)
4164 /* If this was a menu selection, then set the flag to inhibit
4165 writing to last_nonmenu_event. Don't do this if the event
4166 we're returning is (menu-bar), though; that indicates the
4167 beginning of the menu sequence, and we might as well leave
4168 that as the `event with parameters' for this selection. */
4170 && !EQ (event
->frame_or_window
, event
->arg
)
4171 && (event
->kind
== MENU_BAR_EVENT
4172 || event
->kind
== TOOL_BAR_EVENT
))
4173 *used_mouse_menu
= 1;
4176 /* Certain system events are non-key events. */
4178 && event
->kind
== NS_NONKEY_EVENT
)
4179 *used_mouse_menu
= 1;
4182 /* Wipe out this event, to catch bugs. */
4183 clear_event (event
);
4184 kbd_fetch_ptr
= event
+ 1;
4188 /* Try generating a mouse motion event. */
4189 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4191 struct frame
*f
= some_mouse_moved ();
4192 Lisp_Object bar_window
;
4193 enum scroll_bar_part part
;
4197 *kbp
= current_kboard
;
4198 /* Note that this uses F to determine which terminal to look at.
4199 If there is no valid info, it does not store anything
4200 so x remains nil. */
4203 /* XXX Can f or mouse_position_hook be NULL here? */
4204 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4205 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4210 /* Decide if we should generate a switch-frame event. Don't
4211 generate switch-frame events for motion outside of all Emacs
4217 frame
= FRAME_FOCUS_FRAME (f
);
4219 XSETFRAME (frame
, f
);
4221 if (! EQ (frame
, internal_last_event_frame
)
4222 && !EQ (frame
, selected_frame
))
4223 obj
= make_lispy_switch_frame (frame
);
4224 internal_last_event_frame
= frame
;
4227 /* If we didn't decide to make a switch-frame event, go ahead and
4228 return a mouse-motion event. */
4229 if (!NILP (x
) && NILP (obj
))
4230 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4233 /* We were promised by the above while loop that there was
4234 something for us to read! */
4237 input_pending
= readable_events (0);
4239 Vlast_event_frame
= internal_last_event_frame
;
4244 /* Process any non-user-visible events (currently X selection events),
4245 without reading any user-visible events. */
4248 process_special_events (void)
4250 struct input_event
*event
;
4252 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4254 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4257 if (event
== kbd_store_ptr
)
4261 /* If we find a stored X selection request, handle it now. */
4262 if (event
->kind
== SELECTION_REQUEST_EVENT
4263 || event
->kind
== SELECTION_CLEAR_EVENT
)
4267 /* Remove the event from the fifo buffer before processing;
4268 otherwise swallow_events called recursively could see it
4269 and process it again. To do this, we move the events
4270 between kbd_fetch_ptr and EVENT one slot to the right,
4273 struct input_event copy
= *event
;
4274 struct input_event
*beg
4275 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4276 ? kbd_buffer
: kbd_fetch_ptr
;
4279 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4280 else if (event
< beg
)
4282 if (event
> kbd_buffer
)
4283 memmove (kbd_buffer
+ 1, kbd_buffer
,
4284 (event
- kbd_buffer
) * sizeof (struct input_event
));
4285 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4286 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4287 memmove (beg
+ 1, beg
,
4288 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4289 * sizeof (struct input_event
));
4292 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4293 kbd_fetch_ptr
= kbd_buffer
+ 1;
4297 input_pending
= readable_events (0);
4298 x_handle_selection_event (©
);
4300 /* We're getting selection request events, but we don't have
4308 /* Process any events that are not user-visible, run timer events that
4309 are ripe, and return, without reading any user-visible events. */
4312 swallow_events (bool do_display
)
4314 unsigned old_timers_run
;
4316 process_special_events ();
4318 old_timers_run
= timers_run
;
4319 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4321 if (timers_run
!= old_timers_run
&& do_display
)
4322 redisplay_preserve_echo_area (7);
4325 /* Record the start of when Emacs is idle,
4326 for the sake of running idle-time timers. */
4329 timer_start_idle (void)
4331 /* If we are already in the idle state, do nothing. */
4332 if (timespec_valid_p (timer_idleness_start_time
))
4335 timer_idleness_start_time
= current_timespec ();
4336 timer_last_idleness_start_time
= timer_idleness_start_time
;
4338 /* Mark all idle-time timers as once again candidates for running. */
4339 call0 (intern ("internal-timer-start-idle"));
4342 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4345 timer_stop_idle (void)
4347 timer_idleness_start_time
= invalid_timespec ();
4350 /* Resume idle timer from last idle start time. */
4353 timer_resume_idle (void)
4355 if (timespec_valid_p (timer_idleness_start_time
))
4358 timer_idleness_start_time
= timer_last_idleness_start_time
;
4361 /* This is only for debugging. */
4362 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4364 /* List of elisp functions to call, delayed because they were generated in
4365 a context where Elisp could not be safely run (e.g. redisplay, signal,
4366 ...). Each element has the form (FUN . ARGS). */
4367 Lisp_Object pending_funcalls
;
4369 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4371 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4373 Lisp_Object
*vector
;
4375 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4377 vector
= XVECTOR (timer
)->contents
;
4378 if (! NILP (vector
[0]))
4381 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4386 /* Check whether a timer has fired. To prevent larger problems we simply
4387 disregard elements that are not proper timers. Do not make a circular
4388 timer list for the time being.
4390 Returns the time to wait until the next timer fires. If a
4391 timer is triggering now, return zero.
4392 If no timer is active, return -1.
4394 If a timer is ripe, we run it, with quitting turned off.
4395 In that case we return 0 to indicate that a new timer_check_2 call
4398 static struct timespec
4399 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4401 struct timespec nexttime
;
4402 struct timespec now
;
4403 struct timespec idleness_now
;
4404 Lisp_Object chosen_timer
;
4405 struct gcpro gcpro1
;
4407 nexttime
= invalid_timespec ();
4409 chosen_timer
= Qnil
;
4410 GCPRO1 (chosen_timer
);
4412 /* First run the code that was delayed. */
4413 while (CONSP (pending_funcalls
))
4415 Lisp_Object funcall
= XCAR (pending_funcalls
);
4416 pending_funcalls
= XCDR (pending_funcalls
);
4417 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4420 if (CONSP (timers
) || CONSP (idle_timers
))
4422 now
= current_timespec ();
4423 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4424 ? timespec_sub (now
, timer_idleness_start_time
)
4425 : make_timespec (0, 0));
4428 while (CONSP (timers
) || CONSP (idle_timers
))
4430 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4431 struct timespec timer_time
, idle_timer_time
;
4432 struct timespec difference
;
4433 struct timespec timer_difference
= invalid_timespec ();
4434 struct timespec idle_timer_difference
= invalid_timespec ();
4435 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4437 /* Set TIMER and TIMER_DIFFERENCE
4438 based on the next ordinary timer.
4439 TIMER_DIFFERENCE is the distance in time from NOW to when
4440 this timer becomes ripe (negative if it's already ripe).
4441 Skip past invalid timers and timers already handled. */
4444 timer
= XCAR (timers
);
4445 if (! decode_timer (timer
, &timer_time
))
4447 timers
= XCDR (timers
);
4451 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4452 timer_difference
= (timer_ripe
4453 ? timespec_sub (now
, timer_time
)
4454 : timespec_sub (timer_time
, now
));
4457 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4458 based on the next idle timer. */
4459 if (CONSP (idle_timers
))
4461 idle_timer
= XCAR (idle_timers
);
4462 if (! decode_timer (idle_timer
, &idle_timer_time
))
4464 idle_timers
= XCDR (idle_timers
);
4468 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4469 idle_timer_difference
4471 ? timespec_sub (idleness_now
, idle_timer_time
)
4472 : timespec_sub (idle_timer_time
, idleness_now
));
4475 /* Decide which timer is the next timer,
4476 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4477 Also step down the list where we found that timer. */
4479 if (timespec_valid_p (timer_difference
)
4480 && (! timespec_valid_p (idle_timer_difference
)
4481 || idle_timer_ripe
< timer_ripe
4482 || (idle_timer_ripe
== timer_ripe
4484 ? timespec_cmp (idle_timer_difference
,
4486 : timespec_cmp (timer_difference
,
4487 idle_timer_difference
))
4490 chosen_timer
= timer
;
4491 timers
= XCDR (timers
);
4492 difference
= timer_difference
;
4497 chosen_timer
= idle_timer
;
4498 idle_timers
= XCDR (idle_timers
);
4499 difference
= idle_timer_difference
;
4500 ripe
= idle_timer_ripe
;
4503 /* If timer is ripe, run it if it hasn't been run. */
4506 if (NILP (AREF (chosen_timer
, 0)))
4508 ptrdiff_t count
= SPECPDL_INDEX ();
4509 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4511 /* Mark the timer as triggered to prevent problems if the lisp
4512 code fails to reschedule it right. */
4513 ASET (chosen_timer
, 0, Qt
);
4515 specbind (Qinhibit_quit
, Qt
);
4517 call1 (Qtimer_event_handler
, chosen_timer
);
4518 Vdeactivate_mark
= old_deactivate_mark
;
4520 unbind_to (count
, Qnil
);
4522 /* Since we have handled the event,
4523 we don't need to tell the caller to wake up and do it. */
4524 /* But the caller must still wait for the next timer, so
4525 return 0 to indicate that. */
4528 nexttime
= make_timespec (0, 0);
4532 /* When we encounter a timer that is still waiting,
4533 return the amount of time to wait before it is ripe. */
4540 /* No timers are pending in the future. */
4541 /* Return 0 if we generated an event, and -1 if not. */
4547 /* Check whether a timer has fired. To prevent larger problems we simply
4548 disregard elements that are not proper timers. Do not make a circular
4549 timer list for the time being.
4551 Returns the time to wait until the next timer fires.
4552 If no timer is active, return an invalid value.
4554 As long as any timer is ripe, we run it. */
4559 struct timespec nexttime
;
4560 Lisp_Object timers
, idle_timers
;
4561 struct gcpro gcpro1
, gcpro2
;
4563 Lisp_Object tem
= Vinhibit_quit
;
4566 /* We use copies of the timers' lists to allow a timer to add itself
4567 again, without locking up Emacs if the newly added timer is
4568 already ripe when added. */
4570 /* Always consider the ordinary timers. */
4571 timers
= Fcopy_sequence (Vtimer_list
);
4572 /* Consider the idle timers only if Emacs is idle. */
4573 if (timespec_valid_p (timer_idleness_start_time
))
4574 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4578 Vinhibit_quit
= tem
;
4580 GCPRO2 (timers
, idle_timers
);
4584 nexttime
= timer_check_2 (timers
, idle_timers
);
4586 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4592 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4593 doc
: /* Return the current length of Emacs idleness, or nil.
4594 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4595 in the same style as (current-time).
4597 The value when Emacs is not idle is nil.
4599 PSEC is a multiple of the system clock resolution. */)
4602 if (timespec_valid_p (timer_idleness_start_time
))
4603 return make_lisp_time (timespec_sub (current_timespec (),
4604 timer_idleness_start_time
));
4609 /* Caches for modify_event_symbol. */
4610 static Lisp_Object accent_key_syms
;
4611 static Lisp_Object func_key_syms
;
4612 static Lisp_Object mouse_syms
;
4613 static Lisp_Object wheel_syms
;
4614 static Lisp_Object drag_n_drop_syms
;
4616 /* This is a list of keysym codes for special "accent" characters.
4617 It parallels lispy_accent_keys. */
4619 static const int lispy_accent_codes
[] =
4621 #ifdef XK_dead_circumflex
4626 #ifdef XK_dead_grave
4631 #ifdef XK_dead_tilde
4636 #ifdef XK_dead_diaeresis
4641 #ifdef XK_dead_macron
4646 #ifdef XK_dead_degree
4651 #ifdef XK_dead_acute
4656 #ifdef XK_dead_cedilla
4661 #ifdef XK_dead_breve
4666 #ifdef XK_dead_ogonek
4671 #ifdef XK_dead_caron
4676 #ifdef XK_dead_doubleacute
4677 XK_dead_doubleacute
,
4681 #ifdef XK_dead_abovedot
4686 #ifdef XK_dead_abovering
4696 #ifdef XK_dead_belowdot
4701 #ifdef XK_dead_voiced_sound
4702 XK_dead_voiced_sound
,
4706 #ifdef XK_dead_semivoiced_sound
4707 XK_dead_semivoiced_sound
,
4723 /* This is a list of Lisp names for special "accent" characters.
4724 It parallels lispy_accent_codes. */
4726 static const char *const lispy_accent_keys
[] =
4744 "dead-voiced-sound",
4745 "dead-semivoiced-sound",
4751 #define FUNCTION_KEY_OFFSET 0x0
4753 const char *const lispy_function_keys
[] =
4757 0, /* VK_LBUTTON 0x01 */
4758 0, /* VK_RBUTTON 0x02 */
4759 "cancel", /* VK_CANCEL 0x03 */
4760 0, /* VK_MBUTTON 0x04 */
4762 0, 0, 0, /* 0x05 .. 0x07 */
4764 "backspace", /* VK_BACK 0x08 */
4765 "tab", /* VK_TAB 0x09 */
4767 0, 0, /* 0x0A .. 0x0B */
4769 "clear", /* VK_CLEAR 0x0C */
4770 "return", /* VK_RETURN 0x0D */
4772 0, 0, /* 0x0E .. 0x0F */
4774 0, /* VK_SHIFT 0x10 */
4775 0, /* VK_CONTROL 0x11 */
4776 0, /* VK_MENU 0x12 */
4777 "pause", /* VK_PAUSE 0x13 */
4778 "capslock", /* VK_CAPITAL 0x14 */
4779 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4781 "junja", /* VK_JUNJA 0x17 */
4782 "final", /* VK_FINAL 0x18 */
4783 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4785 "escape", /* VK_ESCAPE 0x1B */
4786 "convert", /* VK_CONVERT 0x1C */
4787 "non-convert", /* VK_NONCONVERT 0x1D */
4788 "accept", /* VK_ACCEPT 0x1E */
4789 "mode-change", /* VK_MODECHANGE 0x1F */
4790 0, /* VK_SPACE 0x20 */
4791 "prior", /* VK_PRIOR 0x21 */
4792 "next", /* VK_NEXT 0x22 */
4793 "end", /* VK_END 0x23 */
4794 "home", /* VK_HOME 0x24 */
4795 "left", /* VK_LEFT 0x25 */
4796 "up", /* VK_UP 0x26 */
4797 "right", /* VK_RIGHT 0x27 */
4798 "down", /* VK_DOWN 0x28 */
4799 "select", /* VK_SELECT 0x29 */
4800 "print", /* VK_PRINT 0x2A */
4801 "execute", /* VK_EXECUTE 0x2B */
4802 "snapshot", /* VK_SNAPSHOT 0x2C */
4803 "insert", /* VK_INSERT 0x2D */
4804 "delete", /* VK_DELETE 0x2E */
4805 "help", /* VK_HELP 0x2F */
4807 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4809 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4811 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4813 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4815 0, 0, 0, 0, 0, 0, 0, 0, 0,
4816 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, 0,
4819 "lwindow", /* VK_LWIN 0x5B */
4820 "rwindow", /* VK_RWIN 0x5C */
4821 "apps", /* VK_APPS 0x5D */
4824 "kp-0", /* VK_NUMPAD0 0x60 */
4825 "kp-1", /* VK_NUMPAD1 0x61 */
4826 "kp-2", /* VK_NUMPAD2 0x62 */
4827 "kp-3", /* VK_NUMPAD3 0x63 */
4828 "kp-4", /* VK_NUMPAD4 0x64 */
4829 "kp-5", /* VK_NUMPAD5 0x65 */
4830 "kp-6", /* VK_NUMPAD6 0x66 */
4831 "kp-7", /* VK_NUMPAD7 0x67 */
4832 "kp-8", /* VK_NUMPAD8 0x68 */
4833 "kp-9", /* VK_NUMPAD9 0x69 */
4834 "kp-multiply", /* VK_MULTIPLY 0x6A */
4835 "kp-add", /* VK_ADD 0x6B */
4836 "kp-separator", /* VK_SEPARATOR 0x6C */
4837 "kp-subtract", /* VK_SUBTRACT 0x6D */
4838 "kp-decimal", /* VK_DECIMAL 0x6E */
4839 "kp-divide", /* VK_DIVIDE 0x6F */
4840 "f1", /* VK_F1 0x70 */
4841 "f2", /* VK_F2 0x71 */
4842 "f3", /* VK_F3 0x72 */
4843 "f4", /* VK_F4 0x73 */
4844 "f5", /* VK_F5 0x74 */
4845 "f6", /* VK_F6 0x75 */
4846 "f7", /* VK_F7 0x76 */
4847 "f8", /* VK_F8 0x77 */
4848 "f9", /* VK_F9 0x78 */
4849 "f10", /* VK_F10 0x79 */
4850 "f11", /* VK_F11 0x7A */
4851 "f12", /* VK_F12 0x7B */
4852 "f13", /* VK_F13 0x7C */
4853 "f14", /* VK_F14 0x7D */
4854 "f15", /* VK_F15 0x7E */
4855 "f16", /* VK_F16 0x7F */
4856 "f17", /* VK_F17 0x80 */
4857 "f18", /* VK_F18 0x81 */
4858 "f19", /* VK_F19 0x82 */
4859 "f20", /* VK_F20 0x83 */
4860 "f21", /* VK_F21 0x84 */
4861 "f22", /* VK_F22 0x85 */
4862 "f23", /* VK_F23 0x86 */
4863 "f24", /* VK_F24 0x87 */
4865 0, 0, 0, 0, /* 0x88 .. 0x8B */
4866 0, 0, 0, 0, /* 0x8C .. 0x8F */
4868 "kp-numlock", /* VK_NUMLOCK 0x90 */
4869 "scroll", /* VK_SCROLL 0x91 */
4870 /* Not sure where the following block comes from.
4871 Windows headers have NEC and Fujitsu specific keys in
4872 this block, but nothing generic. */
4873 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4874 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4875 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4876 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4877 "kp-end", /* VK_NUMPAD_END 0x96 */
4878 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4879 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4880 "kp-up", /* VK_NUMPAD_UP 0x99 */
4881 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4882 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4883 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4884 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4886 0, 0, /* 0x9E .. 0x9F */
4889 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4890 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4891 * No other API or message will distinguish left and right keys this way.
4896 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4897 to enable them selectively, and gives access to a few more functions.
4898 See lispy_multimedia_keys below. */
4899 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4900 0, 0, 0, /* 0xAD .. 0xAF Volume */
4901 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4902 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4904 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4905 0, 0, 0, 0, 0, 0, 0, 0, 0,
4907 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4908 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4909 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4912 "ax", /* VK_OEM_AX 0xE1 */
4913 0, /* VK_OEM_102 0xE2 */
4914 "ico-help", /* VK_ICO_HELP 0xE3 */
4915 "ico-00", /* VK_ICO_00 0xE4 */
4916 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4917 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4918 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4920 "reset", /* VK_OEM_RESET 0xE9 */
4921 "jump", /* VK_OEM_JUMP 0xEA */
4922 "oem-pa1", /* VK_OEM_PA1 0xEB */
4923 "oem-pa2", /* VK_OEM_PA2 0xEC */
4924 "oem-pa3", /* VK_OEM_PA3 0xED */
4925 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4926 "cusel", /* VK_OEM_CUSEL 0xEF */
4927 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4928 "finish", /* VK_OEM_FINISH 0xF1 */
4929 "copy", /* VK_OEM_COPY 0xF2 */
4930 "auto", /* VK_OEM_AUTO 0xF3 */
4931 "enlw", /* VK_OEM_ENLW 0xF4 */
4932 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4933 "attn", /* VK_ATTN 0xF6 */
4934 "crsel", /* VK_CRSEL 0xF7 */
4935 "exsel", /* VK_EXSEL 0xF8 */
4936 "ereof", /* VK_EREOF 0xF9 */
4937 "play", /* VK_PLAY 0xFA */
4938 "zoom", /* VK_ZOOM 0xFB */
4939 "noname", /* VK_NONAME 0xFC */
4940 "pa1", /* VK_PA1 0xFD */
4941 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4945 /* Some of these duplicate the "Media keys" on newer keyboards,
4946 but they are delivered to the application in a different way. */
4947 static const char *const lispy_multimedia_keys
[] =
4955 "browser-favorites",
4992 "toggle-dictate-command",
4998 "media-fast-forward",
5001 "media-channel-down"
5004 #else /* not HAVE_NTGUI */
5006 /* This should be dealt with in XTread_socket now, and that doesn't
5007 depend on the client system having the Kana syms defined. See also
5008 the XK_kana_A case below. */
5011 static const char *const lispy_kana_keys
[] =
5013 /* X Keysym value */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5024 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5025 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5026 "kana-i", "kana-u", "kana-e", "kana-o",
5027 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5028 "prolongedsound", "kana-A", "kana-I", "kana-U",
5029 "kana-E", "kana-O", "kana-KA", "kana-KI",
5030 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5031 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5032 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5033 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5034 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5035 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5036 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5037 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5038 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5039 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5043 #endif /* XK_kana_A */
5046 #define FUNCTION_KEY_OFFSET 0xff00
5048 /* You'll notice that this table is arranged to be conveniently
5049 indexed by X Windows keysym values. */
5050 static const char *const lispy_function_keys
[] =
5052 /* X Keysym value */
5054 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5055 "backspace", "tab", "linefeed", "clear",
5057 0, 0, 0, "pause", /* 0xff10...1f */
5058 0, 0, 0, 0, 0, 0, 0, "escape",
5060 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5061 "romaji", "hiragana", "katakana", "hiragana-katakana",
5062 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5063 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5064 "eisu-toggle", /* 0xff30...3f */
5065 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5066 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5068 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5069 "down", "prior", "next", "end",
5070 "begin", 0, 0, 0, 0, 0, 0, 0,
5071 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5082 "break", /* 0xff6b */
5085 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5086 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5087 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5088 0, 0, 0, 0, 0, 0, 0, 0,
5089 "kp-tab", /* 0xff89 */
5091 "kp-enter", /* 0xff8d */
5093 "kp-f1", /* 0xff91 */
5097 "kp-home", /* 0xff95 */
5102 "kp-prior", /* kp-page-up */
5103 "kp-next", /* kp-page-down */
5109 0, 0, 0, 0, 0, 0, 0, 0, 0,
5110 "kp-multiply", /* 0xffaa */
5115 "kp-divide", /* 0xffaf */
5116 "kp-0", /* 0xffb0 */
5117 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5120 "kp-equal", /* 0xffbd */
5121 "f1", /* 0xffbe */ /* IsFunctionKey */
5123 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5124 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5125 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5126 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5127 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5128 0, 0, 0, 0, 0, 0, 0, 0,
5129 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5130 0, 0, 0, 0, 0, 0, 0, "delete"
5133 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5134 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5136 static const char *const iso_lispy_function_keys
[] =
5138 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5139 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5140 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5141 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5142 "iso-lefttab", /* 0xfe20 */
5143 "iso-move-line-up", "iso-move-line-down",
5144 "iso-partial-line-up", "iso-partial-line-down",
5145 "iso-partial-space-left", "iso-partial-space-right",
5146 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5147 "iso-release-margin-left", "iso-release-margin-right",
5148 "iso-release-both-margins",
5149 "iso-fast-cursor-left", "iso-fast-cursor-right",
5150 "iso-fast-cursor-up", "iso-fast-cursor-down",
5151 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5152 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5155 #endif /* not HAVE_NTGUI */
5157 static Lisp_Object Vlispy_mouse_stem
;
5159 static const char *const lispy_wheel_names
[] =
5161 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5164 /* drag-n-drop events are generated when a set of selected files are
5165 dragged from another application and dropped onto an Emacs window. */
5166 static const char *const lispy_drag_n_drop_names
[] =
5171 /* Scroll bar parts. */
5172 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5173 Lisp_Object Qup
, Qdown
, Qbottom
;
5174 static Lisp_Object Qend_scroll
;
5176 static Lisp_Object Qratio
;
5178 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5179 static Lisp_Object
*const scroll_bar_parts
[] = {
5180 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5181 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5184 /* A vector, indexed by button number, giving the down-going location
5185 of currently depressed buttons, both scroll bar and non-scroll bar.
5187 The elements have the form
5188 (BUTTON-NUMBER MODIFIER-MASK . REST)
5189 where REST is the cdr of a position as it would be reported in the event.
5191 The make_lispy_event function stores positions here to tell the
5192 difference between click and drag events, and to store the starting
5193 location to be included in drag events. */
5195 static Lisp_Object button_down_location
;
5197 /* Information about the most recent up-going button event: Which
5198 button, what location, and what time. */
5200 static int last_mouse_button
;
5201 static int last_mouse_x
;
5202 static int last_mouse_y
;
5203 static Time button_down_time
;
5205 /* The number of clicks in this multiple-click. */
5207 static int double_click_count
;
5209 /* X and Y are frame-relative coordinates for a click or wheel event.
5210 Return a Lisp-style event list. */
5213 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5216 enum window_part part
;
5217 Lisp_Object posn
= Qnil
;
5218 Lisp_Object extra_info
= Qnil
;
5219 /* Coordinate pixel positions to return. */
5220 int xret
= 0, yret
= 0;
5221 /* The window under frame pixel coordinates (x,y) */
5222 Lisp_Object window
= f
5223 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5226 if (WINDOWP (window
))
5228 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5229 struct window
*w
= XWINDOW (window
);
5230 Lisp_Object string_info
= Qnil
;
5231 ptrdiff_t textpos
= 0;
5232 int col
= -1, row
= -1;
5233 int dx
= -1, dy
= -1;
5234 int width
= -1, height
= -1;
5235 Lisp_Object object
= Qnil
;
5237 /* Pixel coordinates relative to the window corner. */
5238 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5239 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5241 /* For text area clicks, return X, Y relative to the corner of
5242 this text area. Note that dX, dY etc are set below, by
5243 buffer_posn_from_coords. */
5244 if (part
== ON_TEXT
)
5246 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5247 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5249 /* For mode line and header line clicks, return X, Y relative to
5250 the left window edge. Use mode_line_string to look for a
5251 string on the click position. */
5252 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5257 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5258 /* Note that mode_line_string takes COL, ROW as pixels and
5259 converts them to characters. */
5262 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5263 &object
, &dx
, &dy
, &width
, &height
);
5264 if (STRINGP (string
))
5265 string_info
= Fcons (string
, make_number (charpos
));
5271 /* For fringes and margins, Y is relative to the area's (and the
5272 window's) top edge, while X is meaningless. */
5273 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5278 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5281 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5282 &object
, &dx
, &dy
, &width
, &height
);
5283 if (STRINGP (string
))
5284 string_info
= Fcons (string
, make_number (charpos
));
5285 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5287 else if (part
== ON_LEFT_FRINGE
)
5289 posn
= Qleft_fringe
;
5292 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5293 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5294 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5296 else if (part
== ON_RIGHT_FRINGE
)
5298 posn
= Qright_fringe
;
5301 - window_box_width (w
, LEFT_MARGIN_AREA
)
5302 - window_box_width (w
, TEXT_AREA
)
5303 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5304 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5306 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5308 else if (part
== ON_VERTICAL_BORDER
)
5310 posn
= Qvertical_line
;
5315 /* Nothing special for part == ON_SCROLL_BAR. */
5316 else if (part
== ON_RIGHT_DIVIDER
)
5318 posn
= Qright_divider
;
5319 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5323 else if (part
== ON_BOTTOM_DIVIDER
)
5325 posn
= Qbottom_divider
;
5326 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5331 /* For clicks in the text area, fringes, or margins, call
5332 buffer_posn_from_coords to extract TEXTPOS, the buffer
5333 position nearest to the click. */
5336 Lisp_Object string2
, object2
= Qnil
;
5337 struct display_pos p
;
5339 int width2
, height2
;
5340 /* The pixel X coordinate passed to buffer_posn_from_coords
5341 is the X coordinate relative to the text area for
5342 text-area and right-margin clicks, zero otherwise. */
5344 = (part
== ON_TEXT
) ? xret
5345 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5346 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5350 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5351 &object2
, &dx2
, &dy2
,
5353 textpos
= CHARPOS (p
.pos
);
5354 if (col
< 0) col
= x2
;
5355 if (row
< 0) row
= y2
;
5356 if (dx
< 0) dx
= dx2
;
5357 if (dy
< 0) dy
= dy2
;
5358 if (width
< 0) width
= width2
;
5359 if (height
< 0) height
= height2
;
5363 posn
= make_number (textpos
);
5364 if (STRINGP (string2
))
5365 string_info
= Fcons (string2
,
5366 make_number (CHARPOS (p
.string_pos
)));
5372 #ifdef HAVE_WINDOW_SYSTEM
5373 if (IMAGEP (object
))
5375 Lisp_Object image_map
, hotspot
;
5376 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5378 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5380 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5381 posn
= XCAR (hotspot
);
5388 Fcons (make_number (dx
), make_number (dy
)),
5389 Fcons (make_number (width
), make_number (height
)));
5392 extra_info
= Fcons (string_info
,
5393 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5394 Fcons (Fcons (make_number (col
),
5399 XSETFRAME (window
, f
);
5403 return Fcons (window
,
5405 Fcons (Fcons (make_number (xret
),
5406 make_number (yret
)),
5407 Fcons (make_number (t
),
5411 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5412 menu bar. This really means that Emacs draws and manages the menu
5413 bar as part of its normal display, and therefore can compute its
5416 toolkit_menubar_in_use (struct frame
*f
)
5418 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5419 return !(!FRAME_WINDOW_P (f
));
5425 /* Given a struct input_event, build the lisp event which represents
5426 it. If EVENT is 0, build a mouse movement event from the mouse
5427 movement buffer, which should have a movement event in it.
5429 Note that events must be passed to this function in the order they
5430 are received; this function stores the location of button presses
5431 in order to build drag events when the button is released. */
5434 make_lispy_event (struct input_event
*event
)
5438 switch (event
->kind
)
5440 /* A simple keystroke. */
5441 case ASCII_KEYSTROKE_EVENT
:
5442 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5444 Lisp_Object lispy_c
;
5445 EMACS_INT c
= event
->code
;
5446 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5449 eassert (c
== event
->code
);
5450 /* Turn ASCII characters into control characters
5452 if (event
->modifiers
& ctrl_modifier
)
5454 c
= make_ctrl_char (c
);
5455 event
->modifiers
&= ~ctrl_modifier
;
5459 /* Add in the other modifier bits. The shift key was taken care
5460 of by the X code. */
5461 c
|= (event
->modifiers
5462 & (meta_modifier
| alt_modifier
5463 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5464 /* Distinguish Shift-SPC from SPC. */
5465 if ((event
->code
) == 040
5466 && event
->modifiers
& shift_modifier
)
5467 c
|= shift_modifier
;
5468 button_down_time
= 0;
5469 XSETFASTINT (lispy_c
, c
);
5474 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5475 except that they are non-key events (last-nonmenu-event is nil). */
5476 case NS_NONKEY_EVENT
:
5479 /* A function key. The symbol may need to have modifier prefixes
5481 case NON_ASCII_KEYSTROKE_EVENT
:
5482 button_down_time
= 0;
5484 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5485 if (event
->code
== lispy_accent_codes
[i
])
5486 return modify_event_symbol (i
,
5488 Qfunction_key
, Qnil
,
5489 lispy_accent_keys
, &accent_key_syms
,
5490 ARRAYELTS (lispy_accent_keys
));
5494 if (event
->code
>= 0x400 && event
->code
< 0x500)
5495 return modify_event_symbol (event
->code
- 0x400,
5496 event
->modifiers
& ~shift_modifier
,
5497 Qfunction_key
, Qnil
,
5498 lispy_kana_keys
, &func_key_syms
,
5499 ARRAYELTS (lispy_kana_keys
));
5500 #endif /* XK_kana_A */
5503 #ifdef ISO_FUNCTION_KEY_OFFSET
5504 if (event
->code
< FUNCTION_KEY_OFFSET
5505 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5506 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5508 Qfunction_key
, Qnil
,
5509 iso_lispy_function_keys
, &func_key_syms
,
5510 ARRAYELTS (iso_lispy_function_keys
));
5513 /* Handle system-specific or unknown keysyms. */
5514 if (event
->code
& (1 << 28)
5515 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5516 || (event
->code
- FUNCTION_KEY_OFFSET
5517 >= ARRAYELTS (lispy_function_keys
))
5518 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5520 /* We need to use an alist rather than a vector as the cache
5521 since we can't make a vector long enough. */
5522 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5523 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5524 return modify_event_symbol (event
->code
,
5527 KVAR (current_kboard
, Vsystem_key_alist
),
5528 0, &KVAR (current_kboard
, system_key_syms
),
5532 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5534 Qfunction_key
, Qnil
,
5535 lispy_function_keys
, &func_key_syms
,
5536 ARRAYELTS (lispy_function_keys
));
5539 case MULTIMEDIA_KEY_EVENT
:
5540 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5541 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5543 return modify_event_symbol (event
->code
, event
->modifiers
,
5544 Qfunction_key
, Qnil
,
5545 lispy_multimedia_keys
, &func_key_syms
,
5546 ARRAYELTS (lispy_multimedia_keys
));
5551 /* A mouse click. Figure out where it is, decide whether it's
5552 a press, click or drag, and build the appropriate structure. */
5553 case MOUSE_CLICK_EVENT
:
5555 case GPM_CLICK_EVENT
:
5557 #ifndef USE_TOOLKIT_SCROLL_BARS
5558 case SCROLL_BAR_CLICK_EVENT
:
5561 int button
= event
->code
;
5563 Lisp_Object position
;
5564 Lisp_Object
*start_pos_ptr
;
5565 Lisp_Object start_pos
;
5569 /* Build the position as appropriate for this mouse click. */
5570 if (event
->kind
== MOUSE_CLICK_EVENT
5572 || event
->kind
== GPM_CLICK_EVENT
5576 struct frame
*f
= XFRAME (event
->frame_or_window
);
5579 /* Ignore mouse events that were made on frame that
5580 have been deleted. */
5581 if (! FRAME_LIVE_P (f
))
5584 /* EVENT->x and EVENT->y are frame-relative pixel
5585 coordinates at this place. Under old redisplay, COLUMN
5586 and ROW are set to frame relative glyph coordinates
5587 which are then used to determine whether this click is
5588 in a menu (non-toolkit version). */
5589 if (!toolkit_menubar_in_use (f
))
5591 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5592 &column
, &row
, NULL
, 1);
5594 /* In the non-toolkit version, clicks on the menu bar
5595 are ordinary button events in the event buffer.
5596 Distinguish them, and invoke the menu.
5598 (In the toolkit version, the toolkit handles the
5599 menu bar and Emacs doesn't know about it until
5600 after the user makes a selection.) */
5601 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5602 && (event
->modifiers
& down_modifier
))
5604 Lisp_Object items
, item
;
5606 /* Find the menu bar item under `column'. */
5608 items
= FRAME_MENU_BAR_ITEMS (f
);
5609 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5611 Lisp_Object pos
, string
;
5612 string
= AREF (items
, i
+ 1);
5613 pos
= AREF (items
, i
+ 3);
5616 if (column
>= XINT (pos
)
5617 && column
< XINT (pos
) + SCHARS (string
))
5619 item
= AREF (items
, i
);
5624 /* ELisp manual 2.4b says (x y) are window
5625 relative but code says they are
5627 position
= list4 (event
->frame_or_window
,
5629 Fcons (event
->x
, event
->y
),
5630 make_number (event
->timestamp
));
5632 return list2 (item
, position
);
5636 position
= make_lispy_position (f
, event
->x
, event
->y
,
5639 #ifndef USE_TOOLKIT_SCROLL_BARS
5642 /* It's a scrollbar click. */
5644 Lisp_Object portion_whole
;
5647 window
= event
->frame_or_window
;
5648 portion_whole
= Fcons (event
->x
, event
->y
);
5649 part
= *scroll_bar_parts
[(int) event
->part
];
5651 position
= list5 (window
, Qvertical_scroll_bar
,
5652 portion_whole
, make_number (event
->timestamp
),
5655 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5657 if (button
>= ASIZE (button_down_location
))
5659 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5660 button_down_location
= larger_vector (button_down_location
,
5662 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5665 start_pos_ptr
= aref_addr (button_down_location
, button
);
5666 start_pos
= *start_pos_ptr
;
5667 *start_pos_ptr
= Qnil
;
5670 /* On window-system frames, use the value of
5671 double-click-fuzz as is. On other frames, interpret it
5672 as a multiple of 1/8 characters. */
5676 if (WINDOWP (event
->frame_or_window
))
5677 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5678 else if (FRAMEP (event
->frame_or_window
))
5679 f
= XFRAME (event
->frame_or_window
);
5683 if (FRAME_WINDOW_P (f
))
5684 fuzz
= double_click_fuzz
;
5686 fuzz
= double_click_fuzz
/ 8;
5688 is_double
= (button
== last_mouse_button
5689 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5690 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5691 && button_down_time
!= 0
5692 && (EQ (Vdouble_click_time
, Qt
)
5693 || (NATNUMP (Vdouble_click_time
)
5694 && (event
->timestamp
- button_down_time
5695 < XFASTINT (Vdouble_click_time
)))));
5698 last_mouse_button
= button
;
5699 last_mouse_x
= XINT (event
->x
);
5700 last_mouse_y
= XINT (event
->y
);
5702 /* If this is a button press, squirrel away the location, so
5703 we can decide later whether it was a click or a drag. */
5704 if (event
->modifiers
& down_modifier
)
5708 double_click_count
++;
5709 event
->modifiers
|= ((double_click_count
> 2)
5714 double_click_count
= 1;
5715 button_down_time
= event
->timestamp
;
5716 *start_pos_ptr
= Fcopy_alist (position
);
5717 ignore_mouse_drag_p
= 0;
5720 /* Now we're releasing a button - check the co-ordinates to
5721 see if this was a click or a drag. */
5722 else if (event
->modifiers
& up_modifier
)
5724 /* If we did not see a down before this up, ignore the up.
5725 Probably this happened because the down event chose a
5726 menu item. It would be an annoyance to treat the
5727 release of the button that chose the menu item as a
5730 if (!CONSP (start_pos
))
5733 event
->modifiers
&= ~up_modifier
;
5736 Lisp_Object new_down
, down
;
5737 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5739 /* The third element of every position
5740 should be the (x,y) pair. */
5741 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5742 new_down
= Fcar (Fcdr (Fcdr (position
)));
5745 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5747 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5748 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5751 if (ignore_mouse_drag_p
)
5753 event
->modifiers
|= click_modifier
;
5754 ignore_mouse_drag_p
= 0;
5756 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5757 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5758 /* Maybe the mouse has moved a lot, caused scrolling, and
5759 eventually ended up at the same screen position (but
5760 not buffer position) in which case it is a drag, not
5762 /* FIXME: OTOH if the buffer position has changed
5763 because of a timer or process filter rather than
5764 because of mouse movement, it should be considered as
5765 a click. But mouse-drag-region completely ignores
5766 this case and it hasn't caused any real problem, so
5767 it's probably OK to ignore it as well. */
5768 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5769 /* Mouse hasn't moved (much). */
5770 event
->modifiers
|= click_modifier
;
5773 button_down_time
= 0;
5774 event
->modifiers
|= drag_modifier
;
5777 /* Don't check is_double; treat this as multiple
5778 if the down-event was multiple. */
5779 if (double_click_count
> 1)
5780 event
->modifiers
|= ((double_click_count
> 2)
5786 /* Every mouse event should either have the down_modifier or
5787 the up_modifier set. */
5791 /* Get the symbol we should use for the mouse click. */
5794 head
= modify_event_symbol (button
,
5796 Qmouse_click
, Vlispy_mouse_stem
,
5799 ASIZE (mouse_syms
));
5800 if (event
->modifiers
& drag_modifier
)
5801 return list3 (head
, start_pos
, position
);
5802 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5803 return list3 (head
, position
, make_number (double_click_count
));
5805 return list2 (head
, position
);
5810 case HORIZ_WHEEL_EVENT
:
5812 Lisp_Object position
;
5815 /* Build the position as appropriate for this mouse click. */
5816 struct frame
*f
= XFRAME (event
->frame_or_window
);
5818 /* Ignore wheel events that were made on frame that have been
5820 if (! FRAME_LIVE_P (f
))
5823 position
= make_lispy_position (f
, event
->x
, event
->y
,
5826 /* Set double or triple modifiers to indicate the wheel speed. */
5828 /* On window-system frames, use the value of
5829 double-click-fuzz as is. On other frames, interpret it
5830 as a multiple of 1/8 characters. */
5836 if (WINDOWP (event
->frame_or_window
))
5837 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5838 else if (FRAMEP (event
->frame_or_window
))
5839 fr
= XFRAME (event
->frame_or_window
);
5843 fuzz
= FRAME_WINDOW_P (fr
)
5844 ? double_click_fuzz
: double_click_fuzz
/ 8;
5846 if (event
->modifiers
& up_modifier
)
5848 /* Emit a wheel-up event. */
5849 event
->modifiers
&= ~up_modifier
;
5852 else if (event
->modifiers
& down_modifier
)
5854 /* Emit a wheel-down event. */
5855 event
->modifiers
&= ~down_modifier
;
5859 /* Every wheel event should either have the down_modifier or
5860 the up_modifier set. */
5863 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5866 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5867 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5868 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5869 && button_down_time
!= 0
5870 && (EQ (Vdouble_click_time
, Qt
)
5871 || (NATNUMP (Vdouble_click_time
)
5872 && (event
->timestamp
- button_down_time
5873 < XFASTINT (Vdouble_click_time
)))));
5876 double_click_count
++;
5877 event
->modifiers
|= ((double_click_count
> 2)
5883 double_click_count
= 1;
5884 event
->modifiers
|= click_modifier
;
5887 button_down_time
= event
->timestamp
;
5888 /* Use a negative value to distinguish wheel from mouse button. */
5889 last_mouse_button
= - (1 + symbol_num
);
5890 last_mouse_x
= XINT (event
->x
);
5891 last_mouse_y
= XINT (event
->y
);
5893 /* Get the symbol we should use for the wheel event. */
5894 head
= modify_event_symbol (symbol_num
,
5900 ASIZE (wheel_syms
));
5903 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5904 return list3 (head
, position
, make_number (double_click_count
));
5906 return list2 (head
, position
);
5910 #ifdef USE_TOOLKIT_SCROLL_BARS
5912 /* We don't have down and up events if using toolkit scroll bars,
5913 so make this always a click event. Store in the `part' of
5914 the Lisp event a symbol which maps to the following actions:
5916 `above_handle' page up
5917 `below_handle' page down
5921 `bottom' bottom of buffer
5922 `handle' thumb has been dragged.
5923 `end-scroll' end of interaction with scroll bar
5925 The incoming input_event contains in its `part' member an
5926 index of type `enum scroll_bar_part' which we can use as an
5927 index in scroll_bar_parts to get the appropriate symbol. */
5929 case SCROLL_BAR_CLICK_EVENT
:
5931 Lisp_Object position
, head
, window
, portion_whole
, part
;
5933 window
= event
->frame_or_window
;
5934 portion_whole
= Fcons (event
->x
, event
->y
);
5935 part
= *scroll_bar_parts
[(int) event
->part
];
5937 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5938 make_number (event
->timestamp
), part
);
5940 /* Always treat scroll bar events as clicks. */
5941 event
->modifiers
|= click_modifier
;
5942 event
->modifiers
&= ~up_modifier
;
5944 if (event
->code
>= ASIZE (mouse_syms
))
5945 mouse_syms
= larger_vector (mouse_syms
,
5946 event
->code
- ASIZE (mouse_syms
) + 1,
5949 /* Get the symbol we should use for the mouse click. */
5950 head
= modify_event_symbol (event
->code
,
5955 ASIZE (mouse_syms
));
5956 return list2 (head
, position
);
5959 #endif /* USE_TOOLKIT_SCROLL_BARS */
5961 case DRAG_N_DROP_EVENT
:
5964 Lisp_Object head
, position
;
5967 f
= XFRAME (event
->frame_or_window
);
5970 /* Ignore mouse events that were made on frames that
5971 have been deleted. */
5972 if (! FRAME_LIVE_P (f
))
5975 position
= make_lispy_position (f
, event
->x
, event
->y
,
5978 head
= modify_event_symbol (0, event
->modifiers
,
5980 lispy_drag_n_drop_names
,
5981 &drag_n_drop_syms
, 1);
5982 return list3 (head
, position
, files
);
5985 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5986 || defined (HAVE_NS) || defined (USE_GTK)
5987 case MENU_BAR_EVENT
:
5988 if (EQ (event
->arg
, event
->frame_or_window
))
5989 /* This is the prefix key. We translate this to
5990 `(menu_bar)' because the code in keyboard.c for menu
5991 events, which we use, relies on this. */
5992 return list1 (Qmenu_bar
);
5996 case SELECT_WINDOW_EVENT
:
5997 /* Make an event (select-window (WINDOW)). */
5998 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6000 case TOOL_BAR_EVENT
:
6001 if (EQ (event
->arg
, event
->frame_or_window
))
6002 /* This is the prefix key. We translate this to
6003 `(tool_bar)' because the code in keyboard.c for tool bar
6004 events, which we use, relies on this. */
6005 return list1 (Qtool_bar
);
6006 else if (SYMBOLP (event
->arg
))
6007 return apply_modifiers (event
->modifiers
, event
->arg
);
6010 case USER_SIGNAL_EVENT
:
6011 /* A user signal. */
6013 char *name
= find_user_signal_name (event
->code
);
6016 return intern (name
);
6019 case SAVE_SESSION_EVENT
:
6020 return Qsave_session
;
6025 return Fcons (Qdbus_event
, event
->arg
);
6027 #endif /* HAVE_DBUS */
6029 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6030 case FILE_NOTIFY_EVENT
:
6032 return Fcons (Qfile_notify
, event
->arg
);
6034 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6036 case CONFIG_CHANGED_EVENT
:
6037 return list3 (Qconfig_changed_event
,
6038 event
->arg
, event
->frame_or_window
);
6040 /* The 'kind' field of the event is something we don't recognize. */
6047 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6048 Lisp_Object x
, Lisp_Object y
, Time t
)
6050 /* Is it a scroll bar movement? */
6051 if (frame
&& ! NILP (bar_window
))
6053 Lisp_Object part_sym
;
6055 part_sym
= *scroll_bar_parts
[(int) part
];
6056 return list2 (Qscroll_bar_movement
,
6058 Qvertical_scroll_bar
,
6063 /* Or is it an ordinary mouse movement? */
6066 Lisp_Object position
;
6067 position
= make_lispy_position (frame
, x
, y
, t
);
6068 return list2 (Qmouse_movement
, position
);
6072 /* Construct a switch frame event. */
6074 make_lispy_switch_frame (Lisp_Object frame
)
6076 return list2 (Qswitch_frame
, frame
);
6080 make_lispy_focus_in (Lisp_Object frame
)
6082 return list2 (Qfocus_in
, frame
);
6085 #ifdef HAVE_WINDOW_SYSTEM
6088 make_lispy_focus_out (Lisp_Object frame
)
6090 return list2 (Qfocus_out
, frame
);
6093 #endif /* HAVE_WINDOW_SYSTEM */
6095 /* Manipulating modifiers. */
6097 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6099 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6100 SYMBOL's name of the end of the modifiers; the string from this
6101 position is the unmodified symbol name.
6103 This doesn't use any caches. */
6106 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6112 CHECK_SYMBOL (symbol
);
6115 name
= SYMBOL_NAME (symbol
);
6117 for (i
= 0; i
< SBYTES (name
) - 1; )
6119 ptrdiff_t this_mod_end
= 0;
6122 /* See if the name continues with a modifier word.
6123 Check that the word appears, but don't check what follows it.
6124 Set this_mod and this_mod_end to record what we find. */
6126 switch (SREF (name
, i
))
6128 #define SINGLE_LETTER_MOD(BIT) \
6129 (this_mod_end = i + 1, this_mod = BIT)
6132 SINGLE_LETTER_MOD (alt_modifier
);
6136 SINGLE_LETTER_MOD (ctrl_modifier
);
6140 SINGLE_LETTER_MOD (hyper_modifier
);
6144 SINGLE_LETTER_MOD (meta_modifier
);
6148 SINGLE_LETTER_MOD (shift_modifier
);
6152 SINGLE_LETTER_MOD (super_modifier
);
6155 #undef SINGLE_LETTER_MOD
6157 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6158 if (i + LEN + 1 <= SBYTES (name) \
6159 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6161 this_mod_end = i + LEN; \
6166 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6167 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6168 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6172 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6174 #undef MULTI_LETTER_MOD
6178 /* If we found no modifier, stop looking for them. */
6179 if (this_mod_end
== 0)
6182 /* Check there is a dash after the modifier, so that it
6183 really is a modifier. */
6184 if (this_mod_end
>= SBYTES (name
)
6185 || SREF (name
, this_mod_end
) != '-')
6188 /* This modifier is real; look for another. */
6189 modifiers
|= this_mod
;
6190 i
= this_mod_end
+ 1;
6193 /* Should we include the `click' modifier? */
6194 if (! (modifiers
& (down_modifier
| drag_modifier
6195 | double_modifier
| triple_modifier
))
6196 && i
+ 7 == SBYTES (name
)
6197 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6198 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6199 modifiers
|= click_modifier
;
6201 if (! (modifiers
& (double_modifier
| triple_modifier
))
6202 && i
+ 6 < SBYTES (name
)
6203 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6204 modifiers
|= click_modifier
;
6212 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6213 prepended to the string BASE[0..BASE_LEN-1].
6214 This doesn't use any caches. */
6216 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6218 /* Since BASE could contain nulls, we can't use intern here; we have
6219 to use Fintern, which expects a genuine Lisp_String, and keeps a
6221 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6227 /* Only the event queue may use the `up' modifier; it should always
6228 be turned into a click or drag event before presented to lisp code. */
6229 if (modifiers
& up_modifier
)
6232 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6233 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6234 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6235 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6236 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6237 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6238 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6239 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6240 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6241 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6242 /* The click modifier is denoted by the absence of other modifiers. */
6246 mod_len
= p
- new_mods
;
6250 Lisp_Object new_name
;
6252 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6253 mod_len
+ base_len_byte
);
6254 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6255 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6257 return Fintern (new_name
, Qnil
);
6262 static const char *const modifier_names
[] =
6264 "up", "down", "drag", "click", "double", "triple", 0, 0,
6265 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6266 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6268 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6270 static Lisp_Object modifier_symbols
;
6272 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6274 lispy_modifier_list (int modifiers
)
6276 Lisp_Object modifier_list
;
6279 modifier_list
= Qnil
;
6280 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6281 if (modifiers
& (1<<i
))
6282 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6285 return modifier_list
;
6289 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6290 where UNMODIFIED is the unmodified form of SYMBOL,
6291 MASK is the set of modifiers present in SYMBOL's name.
6292 This is similar to parse_modifiers_uncached, but uses the cache in
6293 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6294 Qevent_symbol_elements property. */
6296 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6299 parse_modifiers (Lisp_Object symbol
)
6301 Lisp_Object elements
;
6303 if (INTEGERP (symbol
))
6304 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6305 else if (!SYMBOLP (symbol
))
6308 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6309 if (CONSP (elements
))
6314 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6315 Lisp_Object unmodified
;
6318 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6319 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6322 if (modifiers
& ~INTMASK
)
6324 XSETFASTINT (mask
, modifiers
);
6325 elements
= list2 (unmodified
, mask
);
6327 /* Cache the parsing results on SYMBOL. */
6328 Fput (symbol
, Qevent_symbol_element_mask
,
6330 Fput (symbol
, Qevent_symbol_elements
,
6331 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6333 /* Since we know that SYMBOL is modifiers applied to unmodified,
6334 it would be nice to put that in unmodified's cache.
6335 But we can't, since we're not sure that parse_modifiers is
6342 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6343 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6344 doc
: /* Parse the event symbol. For internal use. */)
6345 (Lisp_Object symbol
)
6347 /* Fill the cache if needed. */
6348 parse_modifiers (symbol
);
6349 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6350 and use the Lispier representation stored on Qevent_symbol_elements
6352 return Fget (symbol
, Qevent_symbol_elements
);
6355 /* Apply the modifiers MODIFIERS to the symbol BASE.
6356 BASE must be unmodified.
6358 This is like apply_modifiers_uncached, but uses BASE's
6359 Qmodifier_cache property, if present. It also builds
6360 Qevent_symbol_elements properties, since it has that info anyway.
6362 apply_modifiers copies the value of BASE's Qevent_kind property to
6363 the modified symbol. */
6365 apply_modifiers (int modifiers
, Lisp_Object base
)
6367 Lisp_Object cache
, idx
, entry
, new_symbol
;
6369 /* Mask out upper bits. We don't know where this value's been. */
6370 modifiers
&= INTMASK
;
6372 if (INTEGERP (base
))
6373 return make_number (XINT (base
) | modifiers
);
6375 /* The click modifier never figures into cache indices. */
6376 cache
= Fget (base
, Qmodifier_cache
);
6377 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6378 entry
= assq_no_quit (idx
, cache
);
6381 new_symbol
= XCDR (entry
);
6384 /* We have to create the symbol ourselves. */
6385 new_symbol
= apply_modifiers_uncached (modifiers
,
6386 SSDATA (SYMBOL_NAME (base
)),
6387 SCHARS (SYMBOL_NAME (base
)),
6388 SBYTES (SYMBOL_NAME (base
)));
6390 /* Add the new symbol to the base's cache. */
6391 entry
= Fcons (idx
, new_symbol
);
6392 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6394 /* We have the parsing info now for free, so we could add it to
6396 XSETFASTINT (idx, modifiers);
6397 Fput (new_symbol, Qevent_symbol_element_mask,
6399 Fput (new_symbol, Qevent_symbol_elements,
6400 Fcons (base, lispy_modifier_list (modifiers)));
6401 Sadly, this is only correct if `base' is indeed a base event,
6402 which is not necessarily the case. -stef */
6405 /* Make sure this symbol is of the same kind as BASE.
6407 You'd think we could just set this once and for all when we
6408 intern the symbol above, but reorder_modifiers may call us when
6409 BASE's property isn't set right; we can't assume that just
6410 because it has a Qmodifier_cache property it must have its
6411 Qevent_kind set right as well. */
6412 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6416 kind
= Fget (base
, Qevent_kind
);
6418 Fput (new_symbol
, Qevent_kind
, kind
);
6425 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6426 return a symbol with the modifiers placed in the canonical order.
6427 Canonical order is alphabetical, except for down and drag, which
6428 always come last. The 'click' modifier is never written out.
6430 Fdefine_key calls this to make sure that (for example) C-M-foo
6431 and M-C-foo end up being equivalent in the keymap. */
6434 reorder_modifiers (Lisp_Object symbol
)
6436 /* It's hopefully okay to write the code this way, since everything
6437 will soon be in caches, and no consing will be done at all. */
6440 parsed
= parse_modifiers (symbol
);
6441 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6446 /* For handling events, we often want to produce a symbol whose name
6447 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6448 to some base, like the name of a function key or mouse button.
6449 modify_event_symbol produces symbols of this sort.
6451 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6452 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6455 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6456 into symbol names, or a string specifying a name stem used to
6457 construct a symbol name or the form `STEM-N', where N is the decimal
6458 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6459 non-nil; otherwise NAME_TABLE is used.
6461 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6462 persist between calls to modify_event_symbol that it can use to
6463 store a cache of the symbols it's generated for this NAME_TABLE
6464 before. The object stored there may be a vector or an alist.
6466 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6468 MODIFIERS is a set of modifier bits (as given in struct input_events)
6469 whose prefixes should be applied to the symbol name.
6471 SYMBOL_KIND is the value to be placed in the event_kind property of
6472 the returned symbol.
6474 The symbols we create are supposed to have an
6475 `event-symbol-elements' property, which lists the modifiers present
6476 in the symbol's name. */
6479 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6480 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6481 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6484 Lisp_Object symbol_int
;
6486 /* Get rid of the "vendor-specific" bit here. */
6487 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6489 /* Is this a request for a valid symbol? */
6490 if (symbol_num
< 0 || symbol_num
>= table_size
)
6493 if (CONSP (*symbol_table
))
6494 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6496 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6497 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6498 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6499 we've never used that symbol before. */
6502 if (! VECTORP (*symbol_table
)
6503 || ASIZE (*symbol_table
) != table_size
)
6507 XSETFASTINT (size
, table_size
);
6508 *symbol_table
= Fmake_vector (size
, Qnil
);
6511 value
= AREF (*symbol_table
, symbol_num
);
6514 /* Have we already used this symbol before? */
6517 /* No; let's create it. */
6518 if (CONSP (name_alist_or_stem
))
6519 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6520 else if (STRINGP (name_alist_or_stem
))
6523 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6524 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6526 buf
= SAFE_ALLOCA (len
);
6527 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6528 XINT (symbol_int
) + 1);
6529 value
= intern (buf
);
6532 else if (name_table
!= 0 && name_table
[symbol_num
])
6533 value
= intern (name_table
[symbol_num
]);
6535 #ifdef HAVE_WINDOW_SYSTEM
6538 char *name
= x_get_keysym_name (symbol_num
);
6540 value
= intern (name
);
6546 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6547 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6548 value
= intern (buf
);
6551 if (CONSP (*symbol_table
))
6552 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6554 ASET (*symbol_table
, symbol_num
, value
);
6556 /* Fill in the cache entries for this symbol; this also
6557 builds the Qevent_symbol_elements property, which the user
6559 apply_modifiers (modifiers
& click_modifier
, value
);
6560 Fput (value
, Qevent_kind
, symbol_kind
);
6563 /* Apply modifiers to that symbol. */
6564 return apply_modifiers (modifiers
, value
);
6567 /* Convert a list that represents an event type,
6568 such as (ctrl meta backspace), into the usual representation of that
6569 event type as a number or a symbol. */
6571 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6572 doc
: /* Convert the event description list EVENT-DESC to an event type.
6573 EVENT-DESC should contain one base event type (a character or symbol)
6574 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6575 drag, down, double or triple). The base must be last.
6576 The return value is an event type (a character or symbol) which
6577 has the same base event type and all the specified modifiers. */)
6578 (Lisp_Object event_desc
)
6586 while (CONSP (rest
))
6594 /* Given a symbol, see if it is a modifier name. */
6595 if (SYMBOLP (elt
) && CONSP (rest
))
6596 this = parse_solitary_modifier (elt
);
6600 else if (!NILP (base
))
6601 error ("Two bases given in one event");
6607 /* Let the symbol A refer to the character A. */
6608 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6609 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6611 if (INTEGERP (base
))
6613 /* Turn (shift a) into A. */
6614 if ((modifiers
& shift_modifier
) != 0
6615 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6617 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6618 modifiers
&= ~shift_modifier
;
6621 /* Turn (control a) into C-a. */
6622 if (modifiers
& ctrl_modifier
)
6623 return make_number ((modifiers
& ~ctrl_modifier
)
6624 | make_ctrl_char (XINT (base
)));
6626 return make_number (modifiers
| XINT (base
));
6628 else if (SYMBOLP (base
))
6629 return apply_modifiers (modifiers
, base
);
6631 error ("Invalid base event");
6634 /* Try to recognize SYMBOL as a modifier name.
6635 Return the modifier flag bit, or 0 if not recognized. */
6638 parse_solitary_modifier (Lisp_Object symbol
)
6640 Lisp_Object name
= SYMBOL_NAME (symbol
);
6642 switch (SREF (name
, 0))
6644 #define SINGLE_LETTER_MOD(BIT) \
6645 if (SBYTES (name) == 1) \
6648 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6649 if (LEN == SBYTES (name) \
6650 && ! memcmp (SDATA (name), NAME, LEN)) \
6654 SINGLE_LETTER_MOD (alt_modifier
);
6658 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6662 SINGLE_LETTER_MOD (ctrl_modifier
);
6666 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6667 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6671 SINGLE_LETTER_MOD (hyper_modifier
);
6675 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6679 SINGLE_LETTER_MOD (meta_modifier
);
6683 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6687 SINGLE_LETTER_MOD (shift_modifier
);
6691 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6692 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6693 SINGLE_LETTER_MOD (super_modifier
);
6697 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6698 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6699 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6703 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6706 #undef SINGLE_LETTER_MOD
6707 #undef MULTI_LETTER_MOD
6713 /* Return true if EVENT is a list whose elements are all integers or symbols.
6714 Such a list is not valid as an event,
6715 but it can be a Lucid-style event type list. */
6718 lucid_event_type_list_p (Lisp_Object object
)
6722 if (! CONSP (object
))
6725 if (EQ (XCAR (object
), Qhelp_echo
)
6726 || EQ (XCAR (object
), Qvertical_line
)
6727 || EQ (XCAR (object
), Qmode_line
)
6728 || EQ (XCAR (object
), Qheader_line
))
6731 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6735 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6742 /* Return true if terminal input chars are available.
6743 Also, store the return value into INPUT_PENDING.
6745 Serves the purpose of ioctl (0, FIONREAD, ...)
6746 but works even if FIONREAD does not exist.
6747 (In fact, this may actually read some input.)
6749 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6750 timer events that are ripe.
6751 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6752 events (FOCUS_IN_EVENT).
6753 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6754 movements and toolkit scroll bar thumb drags. */
6757 get_input_pending (int flags
)
6759 /* First of all, have we already counted some input? */
6760 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6762 /* If input is being read as it arrives, and we have none, there is none. */
6763 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6765 /* Try to read some input and see how much we get. */
6767 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6770 return input_pending
;
6773 /* Put a BUFFER_SWITCH_EVENT in the buffer
6774 so that read_key_sequence will notice the new current buffer. */
6777 record_asynch_buffer_change (void)
6779 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6780 The purpose of the event is to make read_key_sequence look up the
6781 keymaps again. If we aren't in read_key_sequence, we don't need one,
6782 and the event could cause trouble by messing up (input-pending-p).
6783 Note: Fwaiting_for_user_input_p always returns nil when async
6784 subprocesses aren't supported. */
6785 if (!NILP (Fwaiting_for_user_input_p ()))
6787 struct input_event event
;
6790 event
.kind
= BUFFER_SWITCH_EVENT
;
6791 event
.frame_or_window
= Qnil
;
6794 /* Make sure no interrupt happens while storing the event. */
6796 if (interrupt_input
)
6797 kbd_buffer_store_event (&event
);
6802 kbd_buffer_store_event (&event
);
6808 /* Read any terminal input already buffered up by the system
6809 into the kbd_buffer, but do not wait.
6811 Return the number of keyboard chars read, or -1 meaning
6812 this is a bad time to try to read input. */
6821 /* Store pending user signal events, if any. */
6822 store_user_signal_events ();
6824 /* Loop through the available terminals, and call their input hooks. */
6828 struct terminal
*next
= t
->next_terminal
;
6830 if (t
->read_socket_hook
)
6833 struct input_event hold_quit
;
6835 if (input_blocked_p ())
6837 pending_signals
= 1;
6841 EVENT_INIT (hold_quit
);
6842 hold_quit
.kind
= NO_EVENT
;
6844 /* No need for FIONREAD or fcntl; just say don't wait. */
6845 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6848 if (nr
== -1) /* Not OK to read input now. */
6852 else if (nr
== -2) /* Non-transient error. */
6854 /* The terminal device terminated; it should be closed. */
6856 /* Kill Emacs if this was our last terminal. */
6857 if (!terminal_list
->next_terminal
)
6858 /* Formerly simply reported no input, but that
6859 sometimes led to a failure of Emacs to terminate.
6860 SIGHUP seems appropriate if we can't reach the
6862 /* ??? Is it really right to send the signal just to
6863 this process rather than to the whole process
6864 group? Perhaps on systems with FIONREAD Emacs is
6865 alone in its group. */
6866 terminate_due_to_signal (SIGHUP
, 10);
6868 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6871 XSETTERMINAL (tmp
, t
);
6872 Fdelete_terminal (tmp
, Qnoelisp
);
6876 /* If there was no error, make sure the pointer
6877 is visible for all frames on this terminal. */
6880 Lisp_Object tail
, frame
;
6882 FOR_EACH_FRAME (tail
, frame
)
6884 struct frame
*f
= XFRAME (frame
);
6885 if (FRAME_TERMINAL (f
) == t
)
6886 frame_make_pointer_visible (f
);
6890 if (hold_quit
.kind
!= NO_EVENT
)
6891 kbd_buffer_store_event (&hold_quit
);
6903 /* This is the tty way of reading available input.
6905 Note that each terminal device has its own `struct terminal' object,
6906 and so this function is called once for each individual termcap
6907 terminal. The first parameter indicates which terminal to read from. */
6910 tty_read_avail_input (struct terminal
*terminal
,
6911 struct input_event
*hold_quit
)
6913 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6914 the kbd_buffer can really hold. That may prevent loss
6915 of characters on some systems when input is stuffed at us. */
6916 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6918 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6921 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6923 if (kbd_on_hold_p () || buffer_free
<= 0)
6925 #endif /* subprocesses */
6927 if (!terminal
->name
) /* Don't read from a dead terminal. */
6930 if (terminal
->type
!= output_termcap
6931 && terminal
->type
!= output_msdos_raw
)
6934 /* XXX I think the following code should be moved to separate hook
6935 functions in system-dependent files. */
6937 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6938 code sets read_socket_hook to w32_console_read_socket instead! */
6940 #else /* not WINDOWSNT */
6941 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6945 return 0; /* The terminal is suspended. */
6948 n_to_read
= dos_keysns ();
6952 cbuf
[0] = dos_keyread ();
6955 #else /* not MSDOS */
6960 struct input_event gpm_hold_quit
;
6961 int gpm
, fd
= gpm_fd
;
6963 EVENT_INIT (gpm_hold_quit
);
6964 gpm_hold_quit
.kind
= NO_EVENT
;
6966 /* gpm==1 if event received.
6967 gpm==0 if the GPM daemon has closed the connection, in which case
6968 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6969 we save it in `fd' so close_gpm can remove it from the
6971 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6972 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6973 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6976 /* Presumably the GPM daemon has closed the connection. */
6978 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6979 kbd_buffer_store_event (&gpm_hold_quit
);
6983 #endif /* HAVE_GPM */
6985 /* Determine how many characters we should *try* to read. */
6986 #ifdef USABLE_FIONREAD
6987 /* Find out how much input is available. */
6988 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6990 if (! noninteractive
)
6991 return -2; /* Close this terminal. */
6997 if (n_to_read
> sizeof cbuf
)
6998 n_to_read
= sizeof cbuf
;
6999 #elif defined USG || defined CYGWIN
7000 /* Read some input if available, but don't wait. */
7001 n_to_read
= sizeof cbuf
;
7002 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7004 # error "Cannot read without possibly delaying"
7008 /* Don't read more than we can store. */
7009 if (n_to_read
> buffer_free
)
7010 n_to_read
= buffer_free
;
7011 #endif /* subprocesses */
7013 /* Now read; for one reason or another, this will not block.
7014 NREAD is set to the number of chars read. */
7017 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7018 /* POSIX infers that processes which are not in the session leader's
7019 process group won't get SIGHUPs at logout time. BSDI adheres to
7020 this part standard and returns -1 from read (0) with errno==EIO
7021 when the control tty is taken away.
7022 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7023 if (nread
== -1 && errno
== EIO
)
7024 return -2; /* Close this terminal. */
7025 #if defined (AIX) && defined (_BSD)
7026 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7027 This looks incorrect, but it isn't, because _BSD causes
7028 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7029 and that causes a value other than 0 when there is no input. */
7031 return -2; /* Close this terminal. */
7035 /* We used to retry the read if it was interrupted.
7036 But this does the wrong thing when O_NONBLOCK causes
7037 an EAGAIN error. Does anybody know of a situation
7038 where a retry is actually needed? */
7040 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7050 #ifndef USABLE_FIONREAD
7051 #if defined (USG) || defined (CYGWIN)
7052 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7053 #endif /* USG or CYGWIN */
7054 #endif /* no FIONREAD */
7059 #endif /* not MSDOS */
7060 #endif /* not WINDOWSNT */
7062 for (i
= 0; i
< nread
; i
++)
7064 struct input_event buf
;
7066 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7068 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7069 buf
.modifiers
= meta_modifier
;
7070 if (tty
->meta_key
!= 2)
7074 /* Set the frame corresponding to the active tty. Note that the
7075 value of selected_frame is not reliable here, redisplay tends
7076 to temporarily change it. */
7077 buf
.frame_or_window
= tty
->top_frame
;
7080 kbd_buffer_store_event (&buf
);
7081 /* Don't look at input that follows a C-g too closely.
7082 This reduces lossage due to autorepeat on C-g. */
7083 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7084 && buf
.code
== quit_char
)
7092 handle_async_input (void)
7097 int nread
= gobble_input ();
7098 /* -1 means it's not ok to read the input now.
7099 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7100 0 means there was no keyboard input available. */
7108 process_pending_signals (void)
7110 pending_signals
= 0;
7111 handle_async_input ();
7112 do_pending_atimers ();
7115 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7116 and reinvoke any pending signal if the level is now 0 and
7117 a fatal error is not already in progress. */
7120 unblock_input_to (int level
)
7122 interrupt_input_blocked
= level
;
7125 if (pending_signals
&& !fatal_error_in_progress
)
7126 process_pending_signals ();
7132 /* End critical section.
7134 If doing signal-driven input, and a signal came in when input was
7135 blocked, reinvoke the signal handler now to deal with it.
7137 It will also process queued input, if it was not read before.
7138 When a longer code sequence does not use block/unblock input
7139 at all, the whole input gathered up to the next call to
7140 unblock_input will be processed inside that call. */
7143 unblock_input (void)
7145 unblock_input_to (interrupt_input_blocked
- 1);
7148 /* Undo any number of BLOCK_INPUT calls,
7149 and also reinvoke any pending signal. */
7152 totally_unblock_input (void)
7154 unblock_input_to (0);
7160 handle_input_available_signal (int sig
)
7162 pending_signals
= 1;
7164 if (input_available_clear_time
)
7165 *input_available_clear_time
= make_timespec (0, 0);
7169 deliver_input_available_signal (int sig
)
7171 deliver_process_signal (sig
, handle_input_available_signal
);
7173 #endif /* USABLE_SIGIO */
7176 /* User signal events. */
7178 struct user_signal_info
7180 /* Signal number. */
7183 /* Name of the signal. */
7186 /* Number of pending signals. */
7189 struct user_signal_info
*next
;
7192 /* List of user signals. */
7193 static struct user_signal_info
*user_signals
= NULL
;
7196 add_user_signal (int sig
, const char *name
)
7198 struct sigaction action
;
7199 struct user_signal_info
*p
;
7201 for (p
= user_signals
; p
; p
= p
->next
)
7203 /* Already added. */
7206 p
= xmalloc (sizeof *p
);
7208 p
->name
= xstrdup (name
);
7210 p
->next
= user_signals
;
7213 emacs_sigaction_init (&action
, deliver_user_signal
);
7214 sigaction (sig
, &action
, 0);
7218 handle_user_signal (int sig
)
7220 struct user_signal_info
*p
;
7221 const char *special_event_name
= NULL
;
7223 if (SYMBOLP (Vdebug_on_event
))
7224 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7226 for (p
= user_signals
; p
; p
= p
->next
)
7229 if (special_event_name
7230 && strcmp (special_event_name
, p
->name
) == 0)
7232 /* Enter the debugger in many ways. */
7233 debug_on_next_call
= 1;
7236 Vinhibit_quit
= Qnil
;
7238 /* Eat the event. */
7244 if (interrupt_input
)
7245 handle_input_available_signal (sig
);
7249 /* Tell wait_reading_process_output that it needs to wake
7250 up and look around. */
7251 if (input_available_clear_time
)
7252 *input_available_clear_time
= make_timespec (0, 0);
7259 deliver_user_signal (int sig
)
7261 deliver_process_signal (sig
, handle_user_signal
);
7265 find_user_signal_name (int sig
)
7267 struct user_signal_info
*p
;
7269 for (p
= user_signals
; p
; p
= p
->next
)
7277 store_user_signal_events (void)
7279 struct user_signal_info
*p
;
7280 struct input_event buf
;
7281 bool buf_initialized
= 0;
7283 for (p
= user_signals
; p
; p
= p
->next
)
7284 if (p
->npending
> 0)
7286 if (! buf_initialized
)
7288 memset (&buf
, 0, sizeof buf
);
7289 buf
.kind
= USER_SIGNAL_EVENT
;
7290 buf
.frame_or_window
= selected_frame
;
7291 buf_initialized
= 1;
7297 kbd_buffer_store_event (&buf
);
7300 while (p
->npending
> 0);
7305 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7306 static Lisp_Object menu_bar_one_keymap_changed_items
;
7308 /* These variables hold the vector under construction within
7309 menu_bar_items and its subroutines, and the current index
7310 for storing into that vector. */
7311 static Lisp_Object menu_bar_items_vector
;
7312 static int menu_bar_items_index
;
7315 static const char *separator_names
[] = {
7320 "single-dashed-line",
7321 "double-dashed-line",
7323 "shadow-etched-out",
7324 "shadow-etched-in-dash",
7325 "shadow-etched-out-dash",
7326 "shadow-double-etched-in",
7327 "shadow-double-etched-out",
7328 "shadow-double-etched-in-dash",
7329 "shadow-double-etched-out-dash",
7333 /* Return true if LABEL specifies a separator. */
7336 menu_separator_name_p (const char *label
)
7340 else if (strlen (label
) > 3
7341 && memcmp (label
, "--", 2) == 0
7346 for (i
= 0; separator_names
[i
]; ++i
)
7347 if (strcmp (label
, separator_names
[i
]) == 0)
7352 /* It's a separator if it contains only dashes. */
7353 while (*label
== '-')
7355 return (*label
== 0);
7362 /* Return a vector of menu items for a menu bar, appropriate
7363 to the current buffer. Each item has three elements in the vector:
7366 OLD is an old vector we can optionally reuse, or nil. */
7369 menu_bar_items (Lisp_Object old
)
7371 /* The number of keymaps we're scanning right now, and the number of
7372 keymaps we have allocated space for. */
7375 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7376 in the current keymaps, or nil where it is not a prefix. */
7379 Lisp_Object def
, tail
;
7384 /* In order to build the menus, we need to call the keymap
7385 accessors. They all call QUIT. But this function is called
7386 during redisplay, during which a quit is fatal. So inhibit
7387 quitting while building the menus.
7388 We do this instead of specbind because (1) errors will clear it anyway
7389 and (2) this avoids risk of specpdl overflow. */
7390 oquit
= Vinhibit_quit
;
7394 menu_bar_items_vector
= old
;
7396 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7397 menu_bar_items_index
= 0;
7399 /* Build our list of keymaps.
7400 If we recognize a function key and replace its escape sequence in
7401 keybuf with its symbol, or if the sequence starts with a mouse
7402 click and we need to switch buffers, we jump back here to rebuild
7403 the initial keymaps from the current buffer. */
7407 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7408 if (!NILP (Voverriding_local_map_menu_flag
)
7409 && !NILP (Voverriding_local_map
))
7411 /* Yes, use them (if non-nil) as well as the global map. */
7412 maps
= alloca (3 * sizeof (maps
[0]));
7414 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7415 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7416 if (!NILP (Voverriding_local_map
))
7417 maps
[nmaps
++] = Voverriding_local_map
;
7421 /* No, so use major and minor mode keymaps and keymap property.
7422 Note that menu-bar bindings in the local-map and keymap
7423 properties may not work reliable, as they are only
7424 recognized when the menu-bar (or mode-line) is updated,
7425 which does not normally happen after every command. */
7428 nminor
= current_minor_maps (NULL
, &tmaps
);
7429 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7431 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7432 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7433 maps
[nmaps
++] = tem
;
7434 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7435 maps
[nmaps
++] = tem
;
7436 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7438 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7440 maps
[nmaps
++] = current_global_map
;
7443 /* Look up in each map the dummy prefix key `menu-bar'. */
7445 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7446 if (!NILP (maps
[mapno
]))
7448 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7452 menu_bar_one_keymap_changed_items
= Qnil
;
7453 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7457 /* Move to the end those items that should be at the end. */
7459 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7462 int end
= menu_bar_items_index
;
7464 for (i
= 0; i
< end
; i
+= 4)
7465 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7467 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7468 /* Move the item at index I to the end,
7469 shifting all the others forward. */
7470 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7471 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7472 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7473 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7475 memmove (aref_addr (menu_bar_items_vector
, i
),
7476 aref_addr (menu_bar_items_vector
, i
+ 4),
7477 (end
- i
- 4) * word_size
);
7478 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7479 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7480 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7481 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7486 /* Add nil, nil, nil, nil at the end. */
7488 int i
= menu_bar_items_index
;
7489 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7490 menu_bar_items_vector
=
7491 larger_vector (menu_bar_items_vector
, 4, -1);
7492 /* Add this item. */
7493 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7494 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7495 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7496 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7497 menu_bar_items_index
= i
;
7500 Vinhibit_quit
= oquit
;
7501 return menu_bar_items_vector
;
7504 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7505 If there's already an item for KEY, add this DEF to it. */
7507 Lisp_Object item_properties
;
7510 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7512 struct gcpro gcpro1
;
7517 if (EQ (item
, Qundefined
))
7519 /* If a map has an explicit `undefined' as definition,
7520 discard any previously made menu bar item. */
7522 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7523 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7525 if (menu_bar_items_index
> i
+ 4)
7526 memmove (aref_addr (menu_bar_items_vector
, i
),
7527 aref_addr (menu_bar_items_vector
, i
+ 4),
7528 (menu_bar_items_index
- i
- 4) * word_size
);
7529 menu_bar_items_index
-= 4;
7533 /* If this keymap has already contributed to this KEY,
7534 don't contribute to it a second time. */
7535 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7536 if (!NILP (tem
) || NILP (item
))
7539 menu_bar_one_keymap_changed_items
7540 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7542 /* We add to menu_bar_one_keymap_changed_items before doing the
7543 parse_menu_item, so that if it turns out it wasn't a menu item,
7544 it still correctly hides any further menu item. */
7546 parsed
= parse_menu_item (item
, 1);
7551 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7553 /* Find any existing item for this KEY. */
7554 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7555 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7558 /* If we did not find this KEY, add it at the end. */
7559 if (i
== menu_bar_items_index
)
7561 /* If vector is too small, get a bigger one. */
7562 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7563 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7564 /* Add this item. */
7565 ASET (menu_bar_items_vector
, i
, key
); i
++;
7566 ASET (menu_bar_items_vector
, i
,
7567 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7568 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7569 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7570 menu_bar_items_index
= i
;
7572 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7576 old
= AREF (menu_bar_items_vector
, i
+ 2);
7577 /* If the new and the old items are not both keymaps,
7578 the lookup will only find `item'. */
7579 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7580 ASET (menu_bar_items_vector
, i
+ 2, item
);
7584 /* This is used as the handler when calling menu_item_eval_property. */
7586 menu_item_eval_property_1 (Lisp_Object arg
)
7588 /* If we got a quit from within the menu computation,
7589 quit all the way out of it. This takes care of C-] in the debugger. */
7590 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7591 Fsignal (Qquit
, Qnil
);
7597 eval_dyn (Lisp_Object form
)
7599 return Feval (form
, Qnil
);
7602 /* Evaluate an expression and return the result (or nil if something
7603 went wrong). Used to evaluate dynamic parts of menu items. */
7605 menu_item_eval_property (Lisp_Object sexpr
)
7607 ptrdiff_t count
= SPECPDL_INDEX ();
7609 specbind (Qinhibit_redisplay
, Qt
);
7610 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7611 menu_item_eval_property_1
);
7612 return unbind_to (count
, val
);
7615 /* This function parses a menu item and leaves the result in the
7616 vector item_properties.
7617 ITEM is a key binding, a possible menu item.
7618 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7620 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7621 parse_menu_item returns true if the item is a menu item and false
7625 parse_menu_item (Lisp_Object item
, int inmenubar
)
7627 Lisp_Object def
, tem
, item_string
, start
;
7629 Lisp_Object keyhint
;
7638 /* Create item_properties vector if necessary. */
7639 if (NILP (item_properties
))
7641 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7643 /* Initialize optional entries. */
7644 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7645 ASET (item_properties
, i
, Qnil
);
7646 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7648 /* Save the item here to protect it from GC. */
7649 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7651 item_string
= XCAR (item
);
7655 if (STRINGP (item_string
))
7657 /* Old format menu item. */
7658 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7660 /* Maybe help string. */
7661 if (CONSP (item
) && STRINGP (XCAR (item
)))
7663 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7668 /* Maybe an obsolete key binding cache. */
7669 if (CONSP (item
) && CONSP (XCAR (item
))
7670 && (NILP (XCAR (XCAR (item
)))
7671 || VECTORP (XCAR (XCAR (item
)))))
7674 /* This is the real definition--the function to run. */
7675 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7677 /* Get enable property, if any. */
7680 tem
= Fget (item
, Qmenu_enable
);
7681 if (!NILP (Venable_disabled_menus_and_buttons
))
7682 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7683 else if (!NILP (tem
))
7684 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7687 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7689 /* New format menu item. */
7690 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7691 start
= XCDR (item
);
7694 /* We have a real binding. */
7695 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7697 item
= XCDR (start
);
7698 /* Is there an obsolete cache list with key equivalences. */
7699 if (CONSP (item
) && CONSP (XCAR (item
)))
7702 /* Parse properties. */
7703 while (CONSP (item
) && CONSP (XCDR (item
)))
7708 if (EQ (tem
, QCenable
))
7710 if (!NILP (Venable_disabled_menus_and_buttons
))
7711 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7713 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7715 else if (EQ (tem
, QCvisible
))
7717 /* If got a visible property and that evaluates to nil
7718 then ignore this item. */
7719 tem
= menu_item_eval_property (XCAR (item
));
7723 else if (EQ (tem
, QChelp
))
7724 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7725 else if (EQ (tem
, QCfilter
))
7727 else if (EQ (tem
, QCkey_sequence
))
7730 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7731 /* Be GC protected. Set keyhint to item instead of tem. */
7734 else if (EQ (tem
, QCkeys
))
7737 if (CONSP (tem
) || STRINGP (tem
))
7738 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7740 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7745 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7747 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7749 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7755 else if (inmenubar
|| !NILP (start
))
7759 return 0; /* not a menu item */
7761 /* If item string is not a string, evaluate it to get string.
7762 If we don't get a string, skip this item. */
7763 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7764 if (!(STRINGP (item_string
)))
7766 item_string
= menu_item_eval_property (item_string
);
7767 if (!STRINGP (item_string
))
7769 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7772 /* If got a filter apply it on definition. */
7773 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7776 def
= menu_item_eval_property (list2 (XCAR (filter
),
7777 list2 (Qquote
, def
)));
7779 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7782 /* Enable or disable selection of item. */
7783 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7786 tem
= menu_item_eval_property (tem
);
7787 if (inmenubar
&& NILP (tem
))
7788 return 0; /* Ignore disabled items in menu bar. */
7789 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7792 /* If we got no definition, this item is just unselectable text which
7793 is OK in a submenu but not in the menubar. */
7795 return (!inmenubar
);
7797 /* See if this is a separate pane or a submenu. */
7798 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7799 tem
= get_keymap (def
, 0, 1);
7800 /* For a subkeymap, just record its details and exit. */
7803 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7804 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7808 /* At the top level in the menu bar, do likewise for commands also.
7809 The menu bar does not display equivalent key bindings anyway.
7810 ITEM_PROPERTY_DEF is already set up properly. */
7814 { /* This is a command. See if there is an equivalent key binding. */
7815 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7817 /* The previous code preferred :key-sequence to :keys, so we
7818 preserve this behavior. */
7819 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7820 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7823 Lisp_Object prefix
= keyeq
;
7824 Lisp_Object keys
= Qnil
;
7828 def
= XCAR (prefix
);
7829 prefix
= XCDR (prefix
);
7832 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7834 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7836 keys
= XCAR (keyhint
);
7837 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7839 /* We have a suggested key. Is it bound to the command? */
7842 /* If the command is an alias for another
7843 (such as lmenu.el set it up), check if the
7844 original command matches the cached command. */
7846 && EQ (tem
, XSYMBOL (def
)->function
))))
7851 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7855 tem
= Fkey_description (keys
, Qnil
);
7858 if (STRINGP (XCAR (prefix
)))
7859 tem
= concat2 (XCAR (prefix
), tem
);
7860 if (STRINGP (XCDR (prefix
)))
7861 tem
= concat2 (tem
, XCDR (prefix
));
7863 keyeq
= concat2 (build_string (" "), tem
);
7864 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7870 /* If we have an equivalent key binding, use that. */
7871 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7874 /* Include this when menu help is implemented.
7875 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7876 if (!(NILP (tem) || STRINGP (tem)))
7878 tem = menu_item_eval_property (tem);
7881 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7885 /* Handle radio buttons or toggle boxes. */
7886 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7888 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7889 menu_item_eval_property (tem
));
7896 /***********************************************************************
7898 ***********************************************************************/
7900 /* A vector holding tool bar items while they are parsed in function
7901 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7904 static Lisp_Object tool_bar_items_vector
;
7906 /* A vector holding the result of parse_tool_bar_item. Layout is like
7907 the one for a single item in tool_bar_items_vector. */
7909 static Lisp_Object tool_bar_item_properties
;
7911 /* Next free index in tool_bar_items_vector. */
7913 static int ntool_bar_items
;
7915 /* The symbols `:image' and `:rtl'. */
7917 static Lisp_Object QCimage
;
7918 static Lisp_Object QCrtl
;
7920 /* Function prototypes. */
7922 static void init_tool_bar_items (Lisp_Object
);
7923 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7925 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7926 static void append_tool_bar_item (void);
7929 /* Return a vector of tool bar items for keymaps currently in effect.
7930 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7931 tool bar items found. */
7934 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7943 /* In order to build the menus, we need to call the keymap
7944 accessors. They all call QUIT. But this function is called
7945 during redisplay, during which a quit is fatal. So inhibit
7946 quitting while building the menus. We do this instead of
7947 specbind because (1) errors will clear it anyway and (2) this
7948 avoids risk of specpdl overflow. */
7949 oquit
= Vinhibit_quit
;
7952 /* Initialize tool_bar_items_vector and protect it from GC. */
7953 init_tool_bar_items (reuse
);
7955 /* Build list of keymaps in maps. Set nmaps to the number of maps
7958 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7959 if (!NILP (Voverriding_local_map_menu_flag
)
7960 && !NILP (Voverriding_local_map
))
7962 /* Yes, use them (if non-nil) as well as the global map. */
7963 maps
= alloca (3 * sizeof *maps
);
7965 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7966 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7967 if (!NILP (Voverriding_local_map
))
7968 maps
[nmaps
++] = Voverriding_local_map
;
7972 /* No, so use major and minor mode keymaps and keymap property.
7973 Note that tool-bar bindings in the local-map and keymap
7974 properties may not work reliable, as they are only
7975 recognized when the tool-bar (or mode-line) is updated,
7976 which does not normally happen after every command. */
7979 nminor
= current_minor_maps (NULL
, &tmaps
);
7980 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7982 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7983 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7984 maps
[nmaps
++] = tem
;
7985 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7986 maps
[nmaps
++] = tem
;
7987 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7989 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7992 /* Add global keymap at the end. */
7993 maps
[nmaps
++] = current_global_map
;
7995 /* Process maps in reverse order and look up in each map the prefix
7997 for (i
= nmaps
- 1; i
>= 0; --i
)
7998 if (!NILP (maps
[i
]))
8002 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8004 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8007 Vinhibit_quit
= oquit
;
8008 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8009 return tool_bar_items_vector
;
8013 /* Process the definition of KEY which is DEF. */
8016 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8019 struct gcpro gcpro1
, gcpro2
;
8021 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8025 if (EQ (def
, Qundefined
))
8027 /* If a map has an explicit `undefined' as definition,
8028 discard any previously made item. */
8029 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8031 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8033 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8035 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8036 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8037 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8039 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8044 else if (parse_tool_bar_item (key
, def
))
8045 /* Append a new tool bar item to tool_bar_items_vector. Accept
8046 more than one definition for the same key. */
8047 append_tool_bar_item ();
8052 /* Access slot with index IDX of vector tool_bar_item_properties. */
8053 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8055 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8057 ASET (tool_bar_item_properties
, idx
, val
);
8061 /* Parse a tool bar item specification ITEM for key KEY and return the
8062 result in tool_bar_item_properties. Value is false if ITEM is
8065 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8067 CAPTION is the caption of the item, If it's not a string, it is
8068 evaluated to get a string.
8070 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8071 as binding are currently ignored.
8073 The following properties are recognized:
8077 FORM is evaluated and specifies whether the tool bar item is
8078 enabled or disabled.
8082 FORM is evaluated and specifies whether the tool bar item is visible.
8084 - `:filter FUNCTION'
8086 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8087 result is stored as the new binding.
8089 - `:button (TYPE SELECTED)'
8091 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8092 and specifies whether the button is selected (pressed) or not.
8096 IMAGES is either a single image specification or a vector of four
8097 image specifications. See enum tool_bar_item_images.
8099 - `:help HELP-STRING'.
8101 Gives a help string to display for the tool bar item.
8103 - `:label LABEL-STRING'.
8105 A text label to show with the tool bar button if labels are enabled. */
8108 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8110 Lisp_Object filter
= Qnil
;
8111 Lisp_Object caption
;
8113 bool have_label
= 0;
8115 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8116 Rule out items that aren't lists, don't start with
8117 `menu-item' or whose rest following `tool-bar-item' is not a
8122 /* As an exception, allow old-style menu separators. */
8123 if (STRINGP (XCAR (item
)))
8124 item
= list1 (XCAR (item
));
8125 else if (!EQ (XCAR (item
), Qmenu_item
)
8126 || (item
= XCDR (item
), !CONSP (item
)))
8129 /* Create tool_bar_item_properties vector if necessary. Reset it to
8131 if (VECTORP (tool_bar_item_properties
))
8133 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8137 tool_bar_item_properties
8138 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8141 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8142 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8144 /* Get the caption of the item. If the caption is not a string,
8145 evaluate it to get a string. If we don't get a string, skip this
8147 caption
= XCAR (item
);
8148 if (!STRINGP (caption
))
8150 caption
= menu_item_eval_property (caption
);
8151 if (!STRINGP (caption
))
8154 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8156 /* If the rest following the caption is not a list, the menu item is
8157 either a separator, or invalid. */
8161 if (menu_separator_name_p (SSDATA (caption
)))
8163 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8164 #if !defined (USE_GTK) && !defined (HAVE_NS)
8165 /* If we use build_desired_tool_bar_string to render the
8166 tool bar, the separator is rendered as an image. */
8167 set_prop (TOOL_BAR_ITEM_IMAGES
,
8168 (menu_item_eval_property
8169 (Vtool_bar_separator_image_expression
)));
8170 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8171 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8172 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8179 /* Store the binding. */
8180 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8183 /* Ignore cached key binding, if any. */
8184 if (CONSP (item
) && CONSP (XCAR (item
)))
8187 /* Process the rest of the properties. */
8188 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8190 Lisp_Object ikey
, value
;
8193 value
= XCAR (XCDR (item
));
8195 if (EQ (ikey
, QCenable
))
8197 /* `:enable FORM'. */
8198 if (!NILP (Venable_disabled_menus_and_buttons
))
8199 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8201 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8203 else if (EQ (ikey
, QCvisible
))
8205 /* `:visible FORM'. If got a visible property and that
8206 evaluates to nil then ignore this item. */
8207 if (NILP (menu_item_eval_property (value
)))
8210 else if (EQ (ikey
, QChelp
))
8211 /* `:help HELP-STRING'. */
8212 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8213 else if (EQ (ikey
, QCvert_only
))
8214 /* `:vert-only t/nil'. */
8215 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8216 else if (EQ (ikey
, QClabel
))
8218 const char *bad_label
= "!!?GARBLED ITEM?!!";
8219 /* `:label LABEL-STRING'. */
8220 set_prop (TOOL_BAR_ITEM_LABEL
,
8221 STRINGP (value
) ? value
: build_string (bad_label
));
8224 else if (EQ (ikey
, QCfilter
))
8225 /* ':filter FORM'. */
8227 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8229 /* `:button (TYPE . SELECTED)'. */
8230 Lisp_Object type
, selected
;
8232 type
= XCAR (value
);
8233 selected
= XCDR (value
);
8234 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8236 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8237 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8240 else if (EQ (ikey
, QCimage
)
8242 || (VECTORP (value
) && ASIZE (value
) == 4)))
8243 /* Value is either a single image specification or a vector
8244 of 4 such specifications for the different button states. */
8245 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8246 else if (EQ (ikey
, QCrtl
))
8248 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8254 /* Try to make one from caption and key. */
8255 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8256 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8257 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8258 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8260 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8261 char *buf
= xmalloc (max_lbl
+ 1);
8262 Lisp_Object new_lbl
;
8263 ptrdiff_t caption_len
= strlen (capt
);
8265 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8268 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8270 buf
[caption_len
] = '\0';
8274 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8278 strcpy (buf
, label
);
8280 for (j
= 0; buf
[j
] != '\0'; ++j
)
8288 new_lbl
= Fupcase_initials (build_string (label
));
8289 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8290 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8292 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8296 /* If got a filter apply it on binding. */
8298 set_prop (TOOL_BAR_ITEM_BINDING
,
8299 (menu_item_eval_property
8302 PROP (TOOL_BAR_ITEM_BINDING
))))));
8304 /* See if the binding is a keymap. Give up if it is. */
8305 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8308 /* Enable or disable selection of item. */
8309 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8310 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8311 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8313 /* Handle radio buttons or toggle boxes. */
8314 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8315 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8316 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8324 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8325 that can be reused. */
8328 init_tool_bar_items (Lisp_Object reuse
)
8330 if (VECTORP (reuse
))
8331 tool_bar_items_vector
= reuse
;
8333 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8334 ntool_bar_items
= 0;
8338 /* Append parsed tool bar item properties from
8339 tool_bar_item_properties */
8342 append_tool_bar_item (void)
8346 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8348 /* Enlarge tool_bar_items_vector if necessary. */
8350 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8352 /* Append entries from tool_bar_item_properties to the end of
8353 tool_bar_items_vector. */
8354 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8355 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8356 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8363 /* Read a character using menus based on the keymap MAP.
8364 Return nil if there are no menus in the maps.
8365 Return t if we displayed a menu but the user rejected it.
8367 PREV_EVENT is the previous input event, or nil if we are reading
8368 the first event of a key sequence.
8370 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8371 if we used a mouse menu to read the input, or false otherwise. If
8372 USED_MOUSE_MENU is null, don't dereference it.
8374 The prompting is done based on the prompt-string of the map
8375 and the strings associated with various map elements.
8377 This can be done with X menus or with menus put in the minibuf.
8378 These are done in different ways, depending on how the input will be read.
8379 Menus using X are done after auto-saving in read-char, getting the input
8380 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8381 and do auto-saving in the inner call of read_char. */
8384 read_char_x_menu_prompt (Lisp_Object map
,
8385 Lisp_Object prev_event
, bool *used_mouse_menu
)
8387 if (used_mouse_menu
)
8388 *used_mouse_menu
= 0;
8390 /* Use local over global Menu maps. */
8392 if (! menu_prompting
)
8395 /* If we got to this point via a mouse click,
8396 use a real menu for mouse selection. */
8397 if (EVENT_HAS_PARAMETERS (prev_event
)
8398 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8399 && !EQ (XCAR (prev_event
), Qtool_bar
))
8401 /* Display the menu and get the selection. */
8404 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8409 record_menu_key (XCAR (value
));
8411 /* If we got multiple events, unread all but
8413 There is no way to prevent those unread events
8414 from showing up later in last_nonmenu_event.
8415 So turn symbol and integer events into lists,
8416 to indicate that they came from a mouse menu,
8417 so that when present in last_nonmenu_event
8418 they won't confuse things. */
8419 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8421 record_menu_key (XCAR (tem
));
8422 if (SYMBOLP (XCAR (tem
))
8423 || INTEGERP (XCAR (tem
)))
8424 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8427 /* If we got more than one event, put all but the first
8428 onto this list to be read later.
8429 Return just the first event now. */
8430 Vunread_command_events
8431 = nconc2 (XCDR (value
), Vunread_command_events
);
8432 value
= XCAR (value
);
8434 else if (NILP (value
))
8436 if (used_mouse_menu
)
8437 *used_mouse_menu
= 1;
8444 read_char_minibuf_menu_prompt (int commandflag
,
8447 register Lisp_Object name
;
8449 /* FIXME: Use the minibuffer's frame width. */
8450 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8452 bool nobindings
= 1;
8453 Lisp_Object rest
, vector
;
8454 Lisp_Object prompt_strings
= Qnil
;
8458 if (! menu_prompting
)
8461 map
= get_keymap (map
, 0, 1);
8462 name
= Fkeymap_prompt (map
);
8464 /* If we don't have any menus, just read a character normally. */
8465 if (!STRINGP (name
))
8468 #define PUSH_C_STR(str, listvar) \
8469 listvar = Fcons (build_unibyte_string (str), listvar)
8471 /* Prompt string always starts with map's prompt, and a space. */
8472 prompt_strings
= Fcons (name
, prompt_strings
);
8473 PUSH_C_STR (": ", prompt_strings
);
8474 nlength
= SCHARS (name
) + 2;
8478 /* Present the documented bindings, a line at a time. */
8482 Lisp_Object menu_strings
= prompt_strings
;
8483 ptrdiff_t i
= nlength
;
8485 Lisp_Object orig_defn_macro
;
8487 /* Loop over elements of map. */
8492 /* FIXME: Use map_keymap to handle new keymap formats. */
8494 /* At end of map, wrap around if just starting,
8495 or end this line if already have something on it. */
8498 if (notfirst
|| nobindings
)
8504 /* Look at the next element of the map. */
8506 elt
= AREF (vector
, idx
);
8508 elt
= Fcar_safe (rest
);
8510 if (idx
< 0 && VECTORP (elt
))
8512 /* If we found a dense table in the keymap,
8513 advanced past it, but start scanning its contents. */
8514 rest
= Fcdr_safe (rest
);
8520 /* An ordinary element. */
8521 Lisp_Object event
, tem
;
8525 event
= Fcar_safe (elt
); /* alist */
8526 elt
= Fcdr_safe (elt
);
8530 XSETINT (event
, idx
); /* vector */
8533 /* Ignore the element if it has no prompt string. */
8534 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8536 /* True if the char to type matches the string. */
8538 Lisp_Object upcased_event
, downcased_event
;
8539 Lisp_Object desc
= Qnil
;
8541 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8543 upcased_event
= Fupcase (event
);
8544 downcased_event
= Fdowncase (event
);
8545 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8546 || XINT (downcased_event
) == SREF (s
, 0));
8548 desc
= Fsingle_key_description (event
, Qnil
);
8550 #if 0 /* It is redundant to list the equivalent key bindings because
8551 the prefix is what the user has already typed. */
8553 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8555 /* Insert equivalent keybinding. */
8556 s
= concat2 (s
, tem
);
8559 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8560 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8562 /* Insert button prefix. */
8563 Lisp_Object selected
8564 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8565 if (EQ (tem
, QCradio
))
8566 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8568 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8569 s
= concat2 (tem
, s
);
8573 /* If we have room for the prompt string, add it to this line.
8574 If this is the first on the line, always add it. */
8575 if ((SCHARS (s
) + i
+ 2
8576 + (char_matches
? 0 : SCHARS (desc
) + 3))
8580 ptrdiff_t thiswidth
;
8582 /* Punctuate between strings. */
8585 PUSH_C_STR (", ", menu_strings
);
8591 /* If the char to type doesn't match the string's
8592 first char, explicitly show what char to type. */
8595 /* Add as much of string as fits. */
8596 thiswidth
= min (SCHARS (desc
), width
- i
);
8598 = Fcons (Fsubstring (desc
, make_number (0),
8599 make_number (thiswidth
)),
8602 PUSH_C_STR (" = ", menu_strings
);
8606 /* Add as much of string as fits. */
8607 thiswidth
= min (SCHARS (s
), width
- i
);
8609 = Fcons (Fsubstring (s
, make_number (0),
8610 make_number (thiswidth
)),
8616 /* If this element does not fit, end the line now,
8617 and save the element for the next line. */
8618 PUSH_C_STR ("...", menu_strings
);
8623 /* Move past this element. */
8624 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8625 /* Handle reaching end of dense table. */
8630 rest
= Fcdr_safe (rest
);
8634 /* Prompt with that and read response. */
8635 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8637 /* Make believe it's not a keyboard macro in case the help char
8638 is pressed. Help characters are not recorded because menu prompting
8639 is not used on replay. */
8640 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8641 kset_defining_kbd_macro (current_kboard
, Qnil
);
8643 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8644 while (BUFFERP (obj
));
8645 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8647 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8650 if (! EQ (obj
, menu_prompt_more_char
)
8651 && (!INTEGERP (menu_prompt_more_char
)
8652 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8654 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8655 store_kbd_macro_char (obj
);
8658 /* Help char - go round again. */
8662 /* Reading key sequences. */
8665 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8667 return access_keymap (get_keymap (keymap
, 0, 1),
8672 active_maps (Lisp_Object first_event
)
8674 Lisp_Object position
8675 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8676 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8679 /* Structure used to keep track of partial application of key remapping
8680 such as Vfunction_key_map and Vkey_translation_map. */
8681 typedef struct keyremap
8683 /* This is the map originally specified for this use. */
8685 /* This is a submap reached by looking up, in PARENT,
8686 the events from START to END. */
8688 /* Positions [START, END) in the key sequence buffer
8689 are the key that we have scanned so far.
8690 Those events are the ones that we will replace
8691 if PARENT maps them into a key sequence. */
8695 /* Lookup KEY in MAP.
8696 MAP is a keymap mapping keys to key vectors or functions.
8697 If the mapping is a function and DO_FUNCALL is true,
8698 the function is called with PROMPT as parameter and its return
8699 value is used as the return value of this function (after checking
8700 that it is indeed a vector). */
8703 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8708 next
= access_keymap (map
, key
, 1, 0, 1);
8710 /* Handle a symbol whose function definition is a keymap
8712 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8713 && (ARRAYP (XSYMBOL (next
)->function
)
8714 || KEYMAPP (XSYMBOL (next
)->function
)))
8715 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8717 /* If the keymap gives a function, not an
8718 array, then call the function with one arg and use
8719 its value instead. */
8720 if (do_funcall
&& FUNCTIONP (next
))
8725 next
= call1 (next
, prompt
);
8726 /* If the function returned something invalid,
8727 barf--don't ignore it.
8728 (To ignore it safely, we would need to gcpro a bunch of
8729 other variables.) */
8730 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8731 error ("Function %s returns invalid key sequence",
8732 SSDATA (SYMBOL_NAME (tem
)));
8737 /* Do one step of the key remapping used for function-key-map and
8738 key-translation-map:
8739 KEYBUF is the buffer holding the input events.
8740 BUFSIZE is its maximum size.
8741 FKEY is a pointer to the keyremap structure to use.
8742 INPUT is the index of the last element in KEYBUF.
8743 DOIT if true says that the remapping can actually take place.
8744 DIFF is used to return the number of keys added/removed by the remapping.
8745 PARENT is the root of the keymap.
8746 PROMPT is the prompt to use if the remapping happens through a function.
8747 Return true if the remapping actually took place. */
8750 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8751 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8753 Lisp_Object next
, key
;
8755 key
= keybuf
[fkey
->end
++];
8757 if (KEYMAPP (fkey
->parent
))
8758 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8762 /* If keybuf[fkey->start..fkey->end] is bound in the
8763 map and we're in a position to do the key remapping, replace it with
8764 the binding and restart with fkey->start at the end. */
8765 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8767 int len
= XFASTINT (Flength (next
));
8770 *diff
= len
- (fkey
->end
- fkey
->start
);
8772 if (bufsize
- input
<= *diff
)
8773 error ("Key sequence too long");
8775 /* Shift the keys that follow fkey->end. */
8777 for (i
= fkey
->end
; i
< input
; i
++)
8778 keybuf
[i
+ *diff
] = keybuf
[i
];
8780 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8781 keybuf
[i
+ *diff
] = keybuf
[i
];
8782 /* Overwrite the old keys with the new ones. */
8783 for (i
= 0; i
< len
; i
++)
8784 keybuf
[fkey
->start
+ i
]
8785 = Faref (next
, make_number (i
));
8787 fkey
->start
= fkey
->end
+= *diff
;
8788 fkey
->map
= fkey
->parent
;
8793 fkey
->map
= get_keymap (next
, 0, 1);
8795 /* If we no longer have a bound suffix, try a new position for
8797 if (!CONSP (fkey
->map
))
8799 fkey
->end
= ++fkey
->start
;
8800 fkey
->map
= fkey
->parent
;
8806 test_undefined (Lisp_Object binding
)
8808 return (NILP (binding
)
8809 || EQ (binding
, Qundefined
)
8810 || (SYMBOLP (binding
)
8811 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8814 /* Read a sequence of keys that ends with a non prefix character,
8815 storing it in KEYBUF, a buffer of size BUFSIZE.
8817 Return the length of the key sequence stored.
8818 Return -1 if the user rejected a command menu.
8820 Echo starting immediately unless `prompt' is 0.
8822 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8823 read_char with a suitable COMMANDFLAG argument.
8825 Where a key sequence ends depends on the currently active keymaps.
8826 These include any minor mode keymaps active in the current buffer,
8827 the current buffer's local map, and the global map.
8829 If a key sequence has no other bindings, we check Vfunction_key_map
8830 to see if some trailing subsequence might be the beginning of a
8831 function key's sequence. If so, we try to read the whole function
8832 key, and substitute its symbolic name into the key sequence.
8834 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8835 `double-' events into similar click events, if that would make them
8836 bound. We try to turn `triple-' events first into `double-' events,
8839 If we get a mouse click in a mode line, vertical divider, or other
8840 non-text area, we treat the click as if it were prefixed by the
8841 symbol denoting that area - `mode-line', `vertical-line', or
8844 If the sequence starts with a mouse click, we read the key sequence
8845 with respect to the buffer clicked on, not the current buffer.
8847 If the user switches frames in the midst of a key sequence, we put
8848 off the switch-frame event until later; the next call to
8849 read_char will return it.
8851 If FIX_CURRENT_BUFFER, we restore current_buffer
8852 from the selected window's buffer. */
8855 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8856 bool dont_downcase_last
, bool can_return_switch_frame
,
8857 bool fix_current_buffer
, bool prevent_redisplay
)
8859 ptrdiff_t count
= SPECPDL_INDEX ();
8861 /* How many keys there are in the current key sequence. */
8864 /* The length of the echo buffer when we started reading, and
8865 the length of this_command_keys when we started reading. */
8866 ptrdiff_t echo_start
IF_LINT (= 0);
8867 ptrdiff_t keys_start
;
8869 Lisp_Object current_binding
= Qnil
;
8870 Lisp_Object first_event
= Qnil
;
8872 /* Index of the first key that has no binding.
8873 It is useless to try fkey.start larger than that. */
8876 /* If t < mock_input, then KEYBUF[t] should be read as the next
8879 We use this to recover after recognizing a function key. Once we
8880 realize that a suffix of the current key sequence is actually a
8881 function key's escape sequence, we replace the suffix with the
8882 function key's binding from Vfunction_key_map. Now keybuf
8883 contains a new and different key sequence, so the echo area,
8884 this_command_keys, and the submaps and defs arrays are wrong. In
8885 this situation, we set mock_input to t, set t to 0, and jump to
8886 restart_sequence; the loop will read keys from keybuf up until
8887 mock_input, thus rebuilding the state; and then it will resume
8888 reading characters from the keyboard. */
8891 /* If the sequence is unbound in submaps[], then
8892 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8893 and fkey.map is its binding.
8895 These might be > t, indicating that all function key scanning
8896 should hold off until t reaches them. We do this when we've just
8897 recognized a function key, to avoid searching for the function
8898 key's again in Vfunction_key_map. */
8901 /* Likewise, for key_translation_map and input-decode-map. */
8902 keyremap keytran
, indec
;
8904 /* True if we are trying to map a key by changing an upper-case
8905 letter to lower case, or a shifted function key to an unshifted
8907 bool shift_translated
= 0;
8909 /* If we receive a `switch-frame' or `select-window' event in the middle of
8910 a key sequence, we put it off for later.
8911 While we're reading, we keep the event here. */
8912 Lisp_Object delayed_switch_frame
;
8914 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8915 int original_uppercase_position
= -1;
8917 /* Gets around Microsoft compiler limitations. */
8920 struct buffer
*starting_buffer
;
8922 /* List of events for which a fake prefix key has been generated. */
8923 Lisp_Object fake_prefixed_keys
= Qnil
;
8925 struct gcpro gcpro1
;
8927 GCPRO1 (fake_prefixed_keys
);
8928 raw_keybuf_count
= 0;
8930 last_nonmenu_event
= Qnil
;
8932 delayed_switch_frame
= Qnil
;
8938 /* Install the string PROMPT as the beginning of the string
8939 of echoing, so that it serves as a prompt for the next
8941 kset_echo_string (current_kboard
, prompt
);
8942 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8945 else if (cursor_in_echo_area
8946 && echo_keystrokes_p ())
8947 /* This doesn't put in a dash if the echo buffer is empty, so
8948 you don't always see a dash hanging out in the minibuffer. */
8952 /* Record the initial state of the echo area and this_command_keys;
8953 we will need to restore them if we replay a key sequence. */
8955 echo_start
= echo_length ();
8956 keys_start
= this_command_key_count
;
8957 this_single_command_key_start
= keys_start
;
8959 /* We jump here when we need to reinitialize fkey and keytran; this
8960 happens if we switch keyboards between rescans. */
8961 replay_entire_sequence
:
8963 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8964 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8965 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8966 indec
.start
= indec
.end
= 0;
8967 fkey
.start
= fkey
.end
= 0;
8968 keytran
.start
= keytran
.end
= 0;
8970 /* We jump here when the key sequence has been thoroughly changed, and
8971 we need to rescan it starting from the beginning. When we jump here,
8972 keybuf[0..mock_input] holds the sequence we should reread. */
8975 starting_buffer
= current_buffer
;
8976 first_unbound
= bufsize
+ 1;
8978 /* Build our list of keymaps.
8979 If we recognize a function key and replace its escape sequence in
8980 keybuf with its symbol, or if the sequence starts with a mouse
8981 click and we need to switch buffers, we jump back here to rebuild
8982 the initial keymaps from the current buffer. */
8983 current_binding
= active_maps (first_event
);
8985 /* Start from the beginning in keybuf. */
8988 /* These are no-ops the first time through, but if we restart, they
8989 revert the echo area and this_command_keys to their original state. */
8990 this_command_key_count
= keys_start
;
8991 if (INTERACTIVE
&& t
< mock_input
)
8992 echo_truncate (echo_start
);
8994 /* If the best binding for the current key sequence is a keymap, or
8995 we may be looking at a function key's escape sequence, keep on
8997 while (!NILP (current_binding
)
8998 /* Keep reading as long as there's a prefix binding. */
8999 ? KEYMAPP (current_binding
)
9000 /* Don't return in the middle of a possible function key sequence,
9001 if the only bindings we found were via case conversion.
9002 Thus, if ESC O a has a function-key-map translation
9003 and ESC o has a binding, don't return after ESC O,
9004 so that we can translate ESC O plus the next character. */
9005 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9008 bool used_mouse_menu
= 0;
9010 /* Where the last real key started. If we need to throw away a
9011 key that has expanded into more than one element of keybuf
9012 (say, a mouse click on the mode line which is being treated
9013 as [mode-line (mouse-...)], then we backtrack to this point
9015 int last_real_key_start
;
9017 /* These variables are analogous to echo_start and keys_start;
9018 while those allow us to restart the entire key sequence,
9019 echo_local_start and keys_local_start allow us to throw away
9021 ptrdiff_t echo_local_start
IF_LINT (= 0);
9022 int keys_local_start
;
9023 Lisp_Object new_binding
;
9025 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9026 eassert (indec
.start
<= indec
.end
);
9027 eassert (fkey
.start
<= fkey
.end
);
9028 eassert (keytran
.start
<= keytran
.end
);
9029 /* key-translation-map is applied *after* function-key-map
9030 which is itself applied *after* input-decode-map. */
9031 eassert (fkey
.end
<= indec
.start
);
9032 eassert (keytran
.end
<= fkey
.start
);
9034 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9035 first_unbound
< keytran
.start
)
9036 { /* The prefix upto first_unbound has no binding and has
9037 no translation left to do either, so we know it's unbound.
9038 If we don't stop now, we risk staying here indefinitely
9039 (if the user keeps entering fkey or keytran prefixes
9040 like C-c ESC ESC ESC ESC ...) */
9042 for (i
= first_unbound
+ 1; i
< t
; i
++)
9043 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9044 mock_input
= t
- first_unbound
- 1;
9045 indec
.end
= indec
.start
-= first_unbound
+ 1;
9046 indec
.map
= indec
.parent
;
9047 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9048 fkey
.map
= fkey
.parent
;
9049 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9050 keytran
.map
= keytran
.parent
;
9051 goto replay_sequence
;
9055 error ("Key sequence too long");
9058 echo_local_start
= echo_length ();
9059 keys_local_start
= this_command_key_count
;
9062 /* These are no-ops, unless we throw away a keystroke below and
9063 jumped back up to replay_key; in that case, these restore the
9064 variables to their original state, allowing us to replay the
9066 if (INTERACTIVE
&& t
< mock_input
)
9067 echo_truncate (echo_local_start
);
9068 this_command_key_count
= keys_local_start
;
9070 /* By default, assume each event is "real". */
9071 last_real_key_start
= t
;
9073 /* Does mock_input indicate that we are re-reading a key sequence? */
9077 add_command_key (key
);
9078 if (echo_keystrokes_p ()
9079 && current_kboard
->immediate_echo
)
9086 /* If not, we should actually read a character. */
9090 KBOARD
*interrupted_kboard
= current_kboard
;
9091 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9092 /* Calling read_char with COMMANDFLAG = -2 avoids
9093 redisplay in read_char and its subroutines. */
9094 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9095 current_binding
, last_nonmenu_event
,
9096 &used_mouse_menu
, NULL
);
9097 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9098 /* When switching to a new tty (with a new keyboard),
9099 read_char returns the new buffer, rather than -2
9100 (Bug#5095). This is because `terminal-init-xterm'
9101 calls read-char, which eats the wrong_kboard_jmpbuf
9102 return. Any better way to fix this? -- cyd */
9103 || (interrupted_kboard
!= current_kboard
))
9108 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9109 if (k
== interrupted_kboard
)
9114 /* Don't touch interrupted_kboard when it's been
9116 delayed_switch_frame
= Qnil
;
9117 goto replay_entire_sequence
;
9120 if (!NILP (delayed_switch_frame
))
9123 (interrupted_kboard
,
9124 Fcons (delayed_switch_frame
,
9125 KVAR (interrupted_kboard
, kbd_queue
)));
9126 delayed_switch_frame
= Qnil
;
9131 (interrupted_kboard
,
9132 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9134 /* If the side queue is non-empty, ensure it begins with a
9135 switch-frame, so we'll replay it in the right context. */
9136 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9137 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9138 !(EVENT_HAS_PARAMETERS (key
)
9139 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9143 XSETFRAME (frame
, interrupted_frame
);
9145 (interrupted_kboard
,
9146 Fcons (make_lispy_switch_frame (frame
),
9147 KVAR (interrupted_kboard
, kbd_queue
)));
9150 goto replay_entire_sequence
;
9154 /* read_char returns t when it shows a menu and the user rejects it.
9158 unbind_to (count
, Qnil
);
9163 /* read_char returns -1 at the end of a macro.
9164 Emacs 18 handles this by returning immediately with a
9165 zero, so that's what we'll do. */
9166 if (INTEGERP (key
) && XINT (key
) == -1)
9169 /* The Microsoft C compiler can't handle the goto that
9175 /* If the current buffer has been changed from under us, the
9176 keymap may have changed, so replay the sequence. */
9179 timer_resume_idle ();
9182 /* Reset the current buffer from the selected window
9183 in case something changed the former and not the latter.
9184 This is to be more consistent with the behavior
9185 of the command_loop_1. */
9186 if (fix_current_buffer
)
9188 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9190 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9192 Fset_buffer (XWINDOW (selected_window
)->contents
);
9195 goto replay_sequence
;
9198 /* If we have a quit that was typed in another frame, and
9199 quit_throw_to_read_char switched buffers,
9200 replay to get the right keymap. */
9202 && XINT (key
) == quit_char
9203 && current_buffer
!= starting_buffer
)
9206 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9211 goto replay_sequence
;
9216 if (EVENT_HAS_PARAMETERS (key
)
9217 /* Either a `switch-frame' or a `select-window' event. */
9218 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9220 /* If we're at the beginning of a key sequence, and the caller
9221 says it's okay, go ahead and return this event. If we're
9222 in the midst of a key sequence, delay it until the end. */
9223 if (t
> 0 || !can_return_switch_frame
)
9225 delayed_switch_frame
= key
;
9230 if (NILP (first_event
))
9233 /* Even if first_event does not specify a particular
9234 window/position, it's important to recompute the maps here
9235 since a long time might have passed since we entered
9236 read_key_sequence, and a timer (or process-filter or
9237 special-event-map, ...) might have switched the current buffer
9238 or the selected window from under us in the mean time. */
9239 if (fix_current_buffer
9240 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9242 Fset_buffer (XWINDOW (selected_window
)->contents
);
9243 current_binding
= active_maps (first_event
);
9247 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9251 /* Clicks in non-text areas get prefixed by the symbol
9252 in their CHAR-ADDRESS field. For example, a click on
9253 the mode line is prefixed by the symbol `mode-line'.
9255 Furthermore, key sequences beginning with mouse clicks
9256 are read using the keymaps of the buffer clicked on, not
9257 the current buffer. So we may have to switch the buffer
9260 When we turn one event into two events, we must make sure
9261 that neither of the two looks like the original--so that,
9262 if we replay the events, they won't be expanded again.
9263 If not for this, such reexpansion could happen either here
9264 or when user programs play with this-command-keys. */
9265 if (EVENT_HAS_PARAMETERS (key
))
9267 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9268 if (EQ (kind
, Qmouse_click
))
9270 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9271 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9274 || (!NILP (fake_prefixed_keys
)
9275 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9277 /* We're looking a second time at an event for which
9278 we generated a fake prefix key. Set
9279 last_real_key_start appropriately. */
9281 last_real_key_start
= t
- 1;
9284 if (last_real_key_start
== 0)
9286 /* Key sequences beginning with mouse clicks are
9287 read using the keymaps in the buffer clicked on,
9288 not the current buffer. If we're at the
9289 beginning of a key sequence, switch buffers. */
9290 if (WINDOWP (window
)
9291 && BUFFERP (XWINDOW (window
)->contents
)
9292 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9294 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9299 /* Arrange to go back to the original buffer once we're
9300 done reading the key sequence. Note that we can't
9301 use save_excursion_{save,restore} here, because they
9302 save point as well as the current buffer; we don't
9303 want to save point, because redisplay may change it,
9304 to accommodate a Fset_window_start or something. We
9305 don't want to do this at the top of the function,
9306 because we may get input from a subprocess which
9307 wants to change the selected window and stuff (say,
9309 record_unwind_current_buffer ();
9311 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9313 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9314 goto replay_sequence
;
9318 /* Expand mode-line and scroll-bar events into two events:
9319 use posn as a fake prefix key. */
9321 && (NILP (fake_prefixed_keys
)
9322 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9324 if (bufsize
- t
<= 1)
9325 error ("Key sequence too long");
9328 keybuf
[t
+ 1] = key
;
9331 /* Record that a fake prefix key has been generated
9332 for KEY. Don't modify the event; this would
9333 prevent proper action when the event is pushed
9334 back into unread-command-events. */
9335 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9339 else if (CONSP (XCDR (key
))
9340 && CONSP (EVENT_START (key
))
9341 && CONSP (XCDR (EVENT_START (key
))))
9345 posn
= POSN_POSN (EVENT_START (key
));
9346 /* Handle menu-bar events:
9347 insert the dummy prefix event `menu-bar'. */
9348 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9350 if (bufsize
- t
<= 1)
9351 error ("Key sequence too long");
9353 keybuf
[t
+ 1] = key
;
9355 /* Zap the position in key, so we know that we've
9356 expanded it, and don't try to do so again. */
9357 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9360 goto replay_sequence
;
9362 else if (CONSP (posn
))
9364 /* We're looking at the second event of a
9365 sequence which we expanded before. Set
9366 last_real_key_start appropriately. */
9367 if (last_real_key_start
== t
&& t
> 0)
9368 last_real_key_start
= t
- 1;
9373 /* We have finally decided that KEY is something we might want
9375 new_binding
= follow_key (current_binding
, key
);
9377 /* If KEY wasn't bound, we'll try some fallbacks. */
9378 if (!NILP (new_binding
))
9379 /* This is needed for the following scenario:
9380 event 0: a down-event that gets dropped by calling replay_key.
9381 event 1: some normal prefix like C-h.
9382 After event 0, first_unbound is 0, after event 1 indec.start,
9383 fkey.start, and keytran.start are all 1, so when we see that
9384 C-h is bound, we need to update first_unbound. */
9385 first_unbound
= max (t
+ 1, first_unbound
);
9390 /* Remember the position to put an upper bound on indec.start. */
9391 first_unbound
= min (t
, first_unbound
);
9393 head
= EVENT_HEAD (key
);
9394 if (help_char_p (head
) && t
> 0)
9396 read_key_sequence_cmd
= Vprefix_help_command
;
9398 last_nonmenu_event
= key
;
9399 /* The Microsoft C compiler can't handle the goto that
9407 Lisp_Object breakdown
;
9410 breakdown
= parse_modifiers (head
);
9411 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9412 /* Attempt to reduce an unbound mouse event to a simpler
9413 event that is bound:
9414 Drags reduce to clicks.
9415 Double-clicks reduce to clicks.
9416 Triple-clicks reduce to double-clicks, then to clicks.
9417 Down-clicks are eliminated.
9418 Double-downs reduce to downs, then are eliminated.
9419 Triple-downs reduce to double-downs, then to downs,
9420 then are eliminated. */
9421 if (modifiers
& (down_modifier
| drag_modifier
9422 | double_modifier
| triple_modifier
))
9424 while (modifiers
& (down_modifier
| drag_modifier
9425 | double_modifier
| triple_modifier
))
9427 Lisp_Object new_head
, new_click
;
9428 if (modifiers
& triple_modifier
)
9429 modifiers
^= (double_modifier
| triple_modifier
);
9430 else if (modifiers
& double_modifier
)
9431 modifiers
&= ~double_modifier
;
9432 else if (modifiers
& drag_modifier
)
9433 modifiers
&= ~drag_modifier
;
9436 /* Dispose of this `down' event by simply jumping
9437 back to replay_key, to get another event.
9439 Note that if this event came from mock input,
9440 then just jumping back to replay_key will just
9441 hand it to us again. So we have to wipe out any
9444 We could delete keybuf[t] and shift everything
9445 after that to the left by one spot, but we'd also
9446 have to fix up any variable that points into
9447 keybuf, and shifting isn't really necessary
9450 Adding prefixes for non-textual mouse clicks
9451 creates two characters of mock input, and both
9452 must be thrown away. If we're only looking at
9453 the prefix now, we can just jump back to
9454 replay_key. On the other hand, if we've already
9455 processed the prefix, and now the actual click
9456 itself is giving us trouble, then we've lost the
9457 state of the keymaps we want to backtrack to, and
9458 we need to replay the whole sequence to rebuild
9461 Beyond that, only function key expansion could
9462 create more than two keys, but that should never
9463 generate mouse events, so it's okay to zero
9464 mock_input in that case too.
9466 FIXME: The above paragraph seems just plain
9467 wrong, if you consider things like
9468 xterm-mouse-mode. -stef
9470 Isn't this just the most wonderful code ever? */
9472 /* If mock_input > t + 1, the above simplification
9473 will actually end up dropping keys on the floor.
9474 This is probably OK for now, but even
9475 if mock_input <= t + 1, we need to adjust indec,
9477 Typical case [header-line down-mouse-N]:
9478 mock_input = 2, t = 1, fkey.end = 1,
9479 last_real_key_start = 0. */
9480 if (indec
.end
> last_real_key_start
)
9482 indec
.end
= indec
.start
9483 = min (last_real_key_start
, indec
.start
);
9484 indec
.map
= indec
.parent
;
9485 if (fkey
.end
> last_real_key_start
)
9487 fkey
.end
= fkey
.start
9488 = min (last_real_key_start
, fkey
.start
);
9489 fkey
.map
= fkey
.parent
;
9490 if (keytran
.end
> last_real_key_start
)
9492 keytran
.end
= keytran
.start
9493 = min (last_real_key_start
, keytran
.start
);
9494 keytran
.map
= keytran
.parent
;
9498 if (t
== last_real_key_start
)
9505 mock_input
= last_real_key_start
;
9506 goto replay_sequence
;
9511 = apply_modifiers (modifiers
, XCAR (breakdown
));
9512 new_click
= list2 (new_head
, EVENT_START (key
));
9514 /* Look for a binding for this new key. */
9515 new_binding
= follow_key (current_binding
, new_click
);
9517 /* If that click is bound, go for it. */
9518 if (!NILP (new_binding
))
9520 current_binding
= new_binding
;
9524 /* Otherwise, we'll leave key set to the drag event. */
9529 current_binding
= new_binding
;
9532 /* Normally, last_nonmenu_event gets the previous key we read.
9533 But when a mouse popup menu is being used,
9534 we don't update last_nonmenu_event; it continues to hold the mouse
9535 event that preceded the first level of menu. */
9536 if (!used_mouse_menu
)
9537 last_nonmenu_event
= key
;
9539 /* Record what part of this_command_keys is the current key sequence. */
9540 this_single_command_key_start
= this_command_key_count
- t
;
9542 /* Look for this sequence in input-decode-map.
9543 Scan from indec.end until we find a bound suffix. */
9544 while (indec
.end
< t
)
9546 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9550 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9551 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9556 mock_input
= diff
+ max (t
, mock_input
);
9557 goto replay_sequence
;
9561 if (!KEYMAPP (current_binding
)
9562 && !test_undefined (current_binding
)
9563 && indec
.start
>= t
)
9564 /* There is a binding and it's not a prefix.
9565 (and it doesn't have any input-decode-map translation pending).
9566 There is thus no function-key in this sequence.
9567 Moving fkey.start is important in this case to allow keytran.start
9568 to go over the sequence before we return (since we keep the
9569 invariant that keytran.end <= fkey.start). */
9572 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9575 /* If the sequence is unbound, see if we can hang a function key
9576 off the end of it. */
9577 /* Continue scan from fkey.end until we find a bound suffix. */
9578 while (fkey
.end
< indec
.start
)
9580 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9584 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9585 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9586 max (t
, mock_input
),
9587 /* If there's a binding (i.e.
9588 first_binding >= nmaps) we don't want
9589 to apply this function-key-mapping. */
9591 && (test_undefined (current_binding
)),
9596 mock_input
= diff
+ max (t
, mock_input
);
9597 /* Adjust the input-decode-map counters. */
9599 indec
.start
+= diff
;
9601 goto replay_sequence
;
9605 /* Look for this sequence in key-translation-map.
9606 Scan from keytran.end until we find a bound suffix. */
9607 while (keytran
.end
< fkey
.start
)
9609 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9613 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9614 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9619 mock_input
= diff
+ max (t
, mock_input
);
9620 /* Adjust the function-key-map and input-decode-map counters. */
9622 indec
.start
+= diff
;
9626 goto replay_sequence
;
9630 /* If KEY is not defined in any of the keymaps,
9631 and cannot be part of a function key or translation,
9632 and is an upper case letter
9633 use the corresponding lower-case letter instead. */
9634 if (NILP (current_binding
)
9635 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9637 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9638 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9639 || (XINT (key
) & shift_modifier
)))
9641 Lisp_Object new_key
;
9643 original_uppercase
= key
;
9644 original_uppercase_position
= t
- 1;
9646 if (XINT (key
) & shift_modifier
)
9647 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9649 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9650 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9652 /* We have to do this unconditionally, regardless of whether
9653 the lower-case char is defined in the keymaps, because they
9654 might get translated through function-key-map. */
9655 keybuf
[t
- 1] = new_key
;
9656 mock_input
= max (t
, mock_input
);
9657 shift_translated
= 1;
9659 goto replay_sequence
;
9661 /* If KEY is not defined in any of the keymaps,
9662 and cannot be part of a function key or translation,
9663 and is a shifted function key,
9664 use the corresponding unshifted function key instead. */
9665 if (NILP (current_binding
)
9666 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9668 Lisp_Object breakdown
= parse_modifiers (key
);
9670 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9672 if (modifiers
& shift_modifier
9673 /* Treat uppercase keys as shifted. */
9675 && (KEY_TO_CHAR (key
)
9676 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9677 && uppercasep (KEY_TO_CHAR (key
))))
9680 = (modifiers
& shift_modifier
9681 ? apply_modifiers (modifiers
& ~shift_modifier
,
9683 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9685 original_uppercase
= key
;
9686 original_uppercase_position
= t
- 1;
9688 /* We have to do this unconditionally, regardless of whether
9689 the lower-case char is defined in the keymaps, because they
9690 might get translated through function-key-map. */
9691 keybuf
[t
- 1] = new_key
;
9692 mock_input
= max (t
, mock_input
);
9693 /* Reset fkey (and consequently keytran) to apply
9694 function-key-map on the result, so that S-backspace is
9695 correctly mapped to DEL (via backspace). OTOH,
9696 input-decode-map doesn't need to go through it again. */
9697 fkey
.start
= fkey
.end
= 0;
9698 keytran
.start
= keytran
.end
= 0;
9699 shift_translated
= 1;
9701 goto replay_sequence
;
9706 read_key_sequence_cmd
= current_binding
;
9707 read_key_sequence_remapped
9708 /* Remap command through active keymaps.
9709 Do the remapping here, before the unbind_to so it uses the keymaps
9710 of the appropriate buffer. */
9711 = SYMBOLP (read_key_sequence_cmd
)
9712 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9715 unread_switch_frame
= delayed_switch_frame
;
9716 unbind_to (count
, Qnil
);
9718 /* Don't downcase the last character if the caller says don't.
9719 Don't downcase it if the result is undefined, either. */
9720 if ((dont_downcase_last
|| NILP (current_binding
))
9722 && t
- 1 == original_uppercase_position
)
9724 keybuf
[t
- 1] = original_uppercase
;
9725 shift_translated
= 0;
9728 if (shift_translated
)
9729 Vthis_command_keys_shift_translated
= Qt
;
9731 /* Occasionally we fabricate events, perhaps by expanding something
9732 according to function-key-map, or by adding a prefix symbol to a
9733 mouse click in the scroll bar or modeline. In this cases, return
9734 the entire generated key sequence, even if we hit an unbound
9735 prefix or a definition before the end. This means that you will
9736 be able to push back the event properly, and also means that
9737 read-key-sequence will always return a logical unit.
9740 for (; t
< mock_input
; t
++)
9742 if (echo_keystrokes_p ())
9743 echo_char (keybuf
[t
]);
9744 add_command_key (keybuf
[t
]);
9752 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9753 Lisp_Object dont_downcase_last
,
9754 Lisp_Object can_return_switch_frame
,
9755 Lisp_Object cmd_loop
, bool allow_string
)
9757 Lisp_Object keybuf
[30];
9759 struct gcpro gcpro1
;
9760 ptrdiff_t count
= SPECPDL_INDEX ();
9763 CHECK_STRING (prompt
);
9766 specbind (Qinput_method_exit_on_first_char
,
9767 (NILP (cmd_loop
) ? Qt
: Qnil
));
9768 specbind (Qinput_method_use_echo_area
,
9769 (NILP (cmd_loop
) ? Qt
: Qnil
));
9771 memset (keybuf
, 0, sizeof keybuf
);
9773 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9775 if (NILP (continue_echo
))
9777 this_command_key_count
= 0;
9778 this_command_key_count_reset
= 0;
9779 this_single_command_key_start
= 0;
9782 #ifdef HAVE_WINDOW_SYSTEM
9783 if (display_hourglass_p
)
9784 cancel_hourglass ();
9787 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9788 prompt
, ! NILP (dont_downcase_last
),
9789 ! NILP (can_return_switch_frame
), 0, 0);
9791 #if 0 /* The following is fine for code reading a key sequence and
9792 then proceeding with a lengthy computation, but it's not good
9793 for code reading keys in a loop, like an input method. */
9794 #ifdef HAVE_WINDOW_SYSTEM
9795 if (display_hourglass_p
)
9806 return unbind_to (count
,
9807 ((allow_string
? make_event_array
: Fvector
)
9811 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9812 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9813 The sequence is sufficient to specify a non-prefix command in the
9814 current local and global maps.
9816 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9817 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9818 as a continuation of the previous key.
9820 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9821 convert the last event to lower case. (Normally any upper case event
9822 is converted to lower case if the original event is undefined and the lower
9823 case equivalent is defined.) A non-nil value is appropriate for reading
9824 a key sequence to be defined.
9826 A C-g typed while in this function is treated like any other character,
9827 and `quit-flag' is not set.
9829 If the key sequence starts with a mouse click, then the sequence is read
9830 using the keymaps of the buffer of the window clicked in, not the buffer
9831 of the selected window as normal.
9833 `read-key-sequence' drops unbound button-down events, since you normally
9834 only care about the click or drag events which follow them. If a drag
9835 or multi-click event is unbound, but the corresponding click event would
9836 be bound, `read-key-sequence' turns the event into a click event at the
9837 drag's starting position. This means that you don't have to distinguish
9838 between click and drag, double, or triple events unless you want to.
9840 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9841 lines separating windows, and scroll bars with imaginary keys
9842 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9844 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9845 function will process a switch-frame event if the user switches frames
9846 before typing anything. If the user switches frames in the middle of a
9847 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9848 is nil, then the event will be put off until after the current key sequence.
9850 `read-key-sequence' checks `function-key-map' for function key
9851 sequences, where they wouldn't conflict with ordinary bindings. See
9852 `function-key-map' for more details.
9854 The optional fifth argument CMD-LOOP, if non-nil, means
9855 that this key sequence is being read by something that will
9856 read commands one after another. It should be nil if the caller
9857 will read just one key sequence. */)
9858 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9860 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9861 can_return_switch_frame
, cmd_loop
, true);
9864 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9865 Sread_key_sequence_vector
, 1, 5, 0,
9866 doc
: /* Like `read-key-sequence' but always return a vector. */)
9867 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9869 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9870 can_return_switch_frame
, cmd_loop
, false);
9873 /* Return true if input events are pending. */
9876 detect_input_pending (void)
9878 return input_pending
|| get_input_pending (0);
9881 /* Return true if input events other than mouse movements are
9885 detect_input_pending_ignore_squeezables (void)
9887 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9890 /* Return true if input events are pending, and run any pending timers. */
9893 detect_input_pending_run_timers (bool do_display
)
9895 unsigned old_timers_run
= timers_run
;
9898 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9900 if (old_timers_run
!= timers_run
&& do_display
)
9901 redisplay_preserve_echo_area (8);
9903 return input_pending
;
9906 /* This is called in some cases before a possible quit.
9907 It cases the next call to detect_input_pending to recompute input_pending.
9908 So calling this function unnecessarily can't do any harm. */
9911 clear_input_pending (void)
9916 /* Return true if there are pending requeued events.
9917 This isn't used yet. The hope is to make wait_reading_process_output
9918 call it, and return if it runs Lisp code that unreads something.
9919 The problem is, kbd_buffer_get_event needs to be fixed to know what
9920 to do in that case. It isn't trivial. */
9923 requeued_events_pending_p (void)
9925 return (!NILP (Vunread_command_events
));
9928 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9929 doc
: /* Return t if command input is currently available with no wait.
9930 Actually, the value is nil only if we can be sure that no input is available;
9931 if there is a doubt, the value is t.
9933 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9934 (Lisp_Object check_timers
)
9936 if (!NILP (Vunread_command_events
)
9937 || !NILP (Vunread_post_input_method_events
)
9938 || !NILP (Vunread_input_method_events
))
9941 /* Process non-user-visible events (Bug#10195). */
9942 process_special_events ();
9944 return (get_input_pending ((NILP (check_timers
)
9945 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9946 | READABLE_EVENTS_FILTER_EVENTS
)
9950 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9951 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9954 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9957 if (total_keys
< NUM_RECENT_KEYS
)
9958 return Fvector (total_keys
, keys
);
9961 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9962 vcopy (val
, 0, keys
+ recent_keys_index
,
9963 NUM_RECENT_KEYS
- recent_keys_index
);
9964 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9965 keys
, recent_keys_index
);
9970 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9971 doc
: /* Return the key sequence that invoked this command.
9972 However, if the command has called `read-key-sequence', it returns
9973 the last key sequence that has been read.
9974 The value is a string or a vector.
9976 See also `this-command-keys-vector'. */)
9979 return make_event_array (this_command_key_count
,
9980 XVECTOR (this_command_keys
)->contents
);
9983 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9984 doc
: /* Return the key sequence that invoked this command, as a vector.
9985 However, if the command has called `read-key-sequence', it returns
9986 the last key sequence that has been read.
9988 See also `this-command-keys'. */)
9991 return Fvector (this_command_key_count
,
9992 XVECTOR (this_command_keys
)->contents
);
9995 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9996 Sthis_single_command_keys
, 0, 0, 0,
9997 doc
: /* Return the key sequence that invoked this command.
9998 More generally, it returns the last key sequence read, either by
9999 the command loop or by `read-key-sequence'.
10000 Unlike `this-command-keys', this function's value
10001 does not include prefix arguments.
10002 The value is always a vector. */)
10005 return Fvector (this_command_key_count
10006 - this_single_command_key_start
,
10007 (XVECTOR (this_command_keys
)->contents
10008 + this_single_command_key_start
));
10011 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10012 Sthis_single_command_raw_keys
, 0, 0, 0,
10013 doc
: /* Return the raw events that were read for this command.
10014 More generally, it returns the last key sequence read, either by
10015 the command loop or by `read-key-sequence'.
10016 Unlike `this-single-command-keys', this function's value
10017 shows the events before all translations (except for input methods).
10018 The value is always a vector. */)
10021 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10024 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10025 Sreset_this_command_lengths
, 0, 0, 0,
10026 doc
: /* Make the unread events replace the last command and echo.
10027 Used in `universal-argument-other-key'.
10029 `universal-argument-other-key' rereads the event just typed.
10030 It then gets translated through `function-key-map'.
10031 The translated event has to replace the real events,
10032 both in the value of (this-command-keys) and in echoing.
10033 To achieve this, `universal-argument-other-key' calls
10034 `reset-this-command-lengths', which discards the record of reading
10035 these events the first time. */)
10038 this_command_key_count
= before_command_key_count
;
10039 if (this_command_key_count
< this_single_command_key_start
)
10040 this_single_command_key_start
= this_command_key_count
;
10042 echo_truncate (before_command_echo_length
);
10044 /* Cause whatever we put into unread-command-events
10045 to echo as if it were being freshly read from the keyboard. */
10046 this_command_key_count_reset
= 1;
10051 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10052 Sclear_this_command_keys
, 0, 1, 0,
10053 doc
: /* Clear out the vector that `this-command-keys' returns.
10054 Also clear the record of the last 100 events, unless optional arg
10055 KEEP-RECORD is non-nil. */)
10056 (Lisp_Object keep_record
)
10060 this_command_key_count
= 0;
10061 this_command_key_count_reset
= 0;
10063 if (NILP (keep_record
))
10065 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10066 ASET (recent_keys
, i
, Qnil
);
10068 recent_keys_index
= 0;
10073 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10074 doc
: /* Return the current depth in recursive edits. */)
10078 /* Wrap around reliably on integer overflow. */
10079 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10080 XSETINT (temp
, sum
);
10084 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10085 "FOpen dribble file: ",
10086 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10087 If FILE is nil, close any open dribble file.
10088 The file will be closed when Emacs exits.
10090 Be aware that this records ALL characters you type!
10091 This may include sensitive information such as passwords. */)
10104 Lisp_Object encfile
;
10106 file
= Fexpand_file_name (file
, Qnil
);
10107 encfile
= ENCODE_FILE (file
);
10108 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10109 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10110 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10111 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10113 report_file_error ("Opening dribble", file
);
10118 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10119 doc
: /* Discard the contents of the terminal input buffer.
10120 Also end any kbd macro being defined. */)
10123 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10125 /* Discard the last command from the macro. */
10126 Fcancel_kbd_macro_events ();
10130 Vunread_command_events
= Qnil
;
10132 discard_tty_input ();
10134 kbd_fetch_ptr
= kbd_store_ptr
;
10140 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10141 doc
: /* Stop Emacs and return to superior process. You can resume later.
10142 If `cannot-suspend' is non-nil, or if the system doesn't support job
10143 control, run a subshell instead.
10145 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10146 to be read as terminal input by Emacs's parent, after suspension.
10148 Before suspending, run the normal hook `suspend-hook'.
10149 After resumption run the normal hook `suspend-resume-hook'.
10151 Some operating systems cannot stop the Emacs process and resume it later.
10152 On such systems, Emacs starts a subshell instead of suspending. */)
10153 (Lisp_Object stuffstring
)
10155 ptrdiff_t count
= SPECPDL_INDEX ();
10156 int old_height
, old_width
;
10158 struct gcpro gcpro1
;
10161 if (tty_list
&& tty_list
->next
)
10162 error ("There are other tty frames open; close them before suspending Emacs");
10164 if (!NILP (stuffstring
))
10165 CHECK_STRING (stuffstring
);
10167 /* Run the functions in suspend-hook. */
10168 hook
= intern ("suspend-hook");
10169 Frun_hooks (1, &hook
);
10171 GCPRO1 (stuffstring
);
10172 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10173 reset_all_sys_modes ();
10174 /* sys_suspend can get an error if it tries to fork a subshell
10175 and the system resources aren't available for that. */
10176 record_unwind_protect_void (init_all_sys_modes
);
10177 stuff_buffered_input (stuffstring
);
10178 if (cannot_suspend
)
10182 unbind_to (count
, Qnil
);
10184 /* Check if terminal/window size has changed.
10185 Note that this is not useful when we are running directly
10186 with a window system; but suspend should be disabled in that case. */
10187 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10188 if (width
!= old_width
|| height
!= old_height
)
10189 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10191 /* Run suspend-resume-hook. */
10192 hook
= intern ("suspend-resume-hook");
10193 Frun_hooks (1, &hook
);
10199 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10200 Then in any case stuff anything Emacs has read ahead and not used. */
10203 stuff_buffered_input (Lisp_Object stuffstring
)
10205 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10206 register unsigned char *p
;
10208 if (STRINGP (stuffstring
))
10210 register ptrdiff_t count
;
10212 p
= SDATA (stuffstring
);
10213 count
= SBYTES (stuffstring
);
10214 while (count
-- > 0)
10219 /* Anything we have read ahead, put back for the shell to read. */
10220 /* ?? What should this do when we have multiple keyboards??
10221 Should we ignore anything that was typed in at the "wrong" kboard?
10223 rms: we should stuff everything back into the kboard
10225 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10228 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10229 kbd_fetch_ptr
= kbd_buffer
;
10230 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10231 stuff_char (kbd_fetch_ptr
->code
);
10233 clear_event (kbd_fetch_ptr
);
10237 #endif /* SIGTSTP */
10241 set_waiting_for_input (struct timespec
*time_to_clear
)
10243 input_available_clear_time
= time_to_clear
;
10245 /* Tell handle_interrupt to throw back to read_char, */
10246 waiting_for_input
= 1;
10248 /* If handle_interrupt was called before and buffered a C-g,
10249 make it run again now, to avoid timing error. */
10250 if (!NILP (Vquit_flag
))
10251 quit_throw_to_read_char (0);
10255 clear_waiting_for_input (void)
10257 /* Tell handle_interrupt not to throw back to read_char, */
10258 waiting_for_input
= 0;
10259 input_available_clear_time
= 0;
10262 /* The SIGINT handler.
10264 If we have a frame on the controlling tty, we assume that the
10265 SIGINT was generated by C-g, so we call handle_interrupt.
10266 Otherwise, tell QUIT to kill Emacs. */
10269 handle_interrupt_signal (int sig
)
10271 /* See if we have an active terminal on our controlling tty. */
10272 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10275 /* If there are no frames there, let's pretend that we are a
10276 well-behaving UN*X program and quit. We must not call Lisp
10277 in a signal handler, so tell QUIT to exit when it is
10279 Vquit_flag
= Qkill_emacs
;
10283 /* Otherwise, the SIGINT was probably generated by C-g. */
10285 /* Set internal_last_event_frame to the top frame of the
10286 controlling tty, if we have a frame there. We disable the
10287 interrupt key on secondary ttys, so the SIGINT must have come
10288 from the controlling tty. */
10289 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10291 handle_interrupt (1);
10296 deliver_interrupt_signal (int sig
)
10298 deliver_process_signal (sig
, handle_interrupt_signal
);
10302 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10303 of the number of times C-g has been requested. If C-g is pressed
10304 enough times, then quit anyway. See bug#6585. */
10305 static int volatile force_quit_count
;
10307 /* This routine is called at interrupt level in response to C-g.
10309 It is called from the SIGINT handler or kbd_buffer_store_event.
10311 If `waiting_for_input' is non zero, then unless `echoing' is
10312 nonzero, immediately throw back to read_char.
10314 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10315 eval to throw, when it gets a chance. If quit-flag is already
10316 non-nil, it stops the job right away. */
10319 handle_interrupt (bool in_signal_handler
)
10325 /* XXX This code needs to be revised for multi-tty support. */
10326 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10328 if (! in_signal_handler
)
10330 /* If SIGINT isn't blocked, don't let us be interrupted by
10331 a SIGINT. It might be harmful due to non-reentrancy
10332 in I/O functions. */
10334 sigemptyset (&blocked
);
10335 sigaddset (&blocked
, SIGINT
);
10336 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10340 reset_all_sys_modes ();
10344 * On systems which can suspend the current process and return to the original
10345 * shell, this command causes the user to end up back at the shell.
10346 * The "Auto-save" and "Abort" questions are not asked until
10347 * the user elects to return to emacs, at which point he can save the current
10348 * job and either dump core or continue.
10352 /* Perhaps should really fork an inferior shell?
10353 But that would not provide any way to get back
10354 to the original shell, ever. */
10355 printf ("No support for stopping a process on this operating system;\n");
10356 printf ("you can continue or abort.\n");
10357 #endif /* not SIGTSTP */
10359 /* We must remain inside the screen area when the internal terminal
10360 is used. Note that [Enter] is not echoed by dos. */
10361 cursor_to (SELECTED_FRAME (), 0, 0);
10363 /* It doesn't work to autosave while GC is in progress;
10364 the code used for auto-saving doesn't cope with the mark bit. */
10365 if (!gc_in_progress
)
10367 printf ("Auto-save? (y or n) ");
10369 if (((c
= getchar ()) & ~040) == 'Y')
10371 Fdo_auto_save (Qt
, Qnil
);
10373 printf ("\r\nAuto-save done");
10374 #else /* not MSDOS */
10375 printf ("Auto-save done\n");
10376 #endif /* not MSDOS */
10378 while (c
!= '\n') c
= getchar ();
10382 /* During GC, it must be safe to reenable quitting again. */
10383 Vinhibit_quit
= Qnil
;
10386 #endif /* not MSDOS */
10387 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10388 printf ("but will instead do a real quit after garbage collection ends\r\n");
10393 printf ("\r\nAbort? (y or n) ");
10394 #else /* not MSDOS */
10395 printf ("Abort (and dump core)? (y or n) ");
10396 #endif /* not MSDOS */
10398 if (((c
= getchar ()) & ~040) == 'Y')
10400 while (c
!= '\n') c
= getchar ();
10402 printf ("\r\nContinuing...\r\n");
10403 #else /* not MSDOS */
10404 printf ("Continuing...\n");
10405 #endif /* not MSDOS */
10407 init_all_sys_modes ();
10411 /* If executing a function that wants to be interrupted out of
10412 and the user has not deferred quitting by binding `inhibit-quit'
10413 then quit right away. */
10414 if (immediate_quit
&& NILP (Vinhibit_quit
))
10416 struct gl_state_s saved
;
10417 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10419 immediate_quit
= 0;
10420 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10422 GCPRO4 (saved
.object
, saved
.global_code
,
10423 saved
.current_syntax_table
, saved
.old_prop
);
10424 Fsignal (Qquit
, Qnil
);
10429 { /* Else request quit when it's safe. */
10430 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10431 force_quit_count
= count
;
10434 immediate_quit
= 1;
10435 Vinhibit_quit
= Qnil
;
10441 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10443 /* TODO: The longjmp in this call throws the NS event loop integration off,
10444 and it seems to do fine without this. Probably some attention
10445 needs to be paid to the setting of waiting_for_input in
10446 wait_reading_process_output() under HAVE_NS because of the call
10447 to ns_select there (needed because otherwise events aren't picked up
10448 outside of polling since we don't get SIGIO like X and we don't have a
10449 separate event loop thread like W32. */
10451 if (waiting_for_input
&& !echoing
)
10452 quit_throw_to_read_char (in_signal_handler
);
10456 /* Handle a C-g by making read_char return C-g. */
10459 quit_throw_to_read_char (bool from_signal
)
10461 /* When not called from a signal handler it is safe to call
10463 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10464 Fkill_emacs (Qnil
);
10466 /* Prevent another signal from doing this before we finish. */
10467 clear_waiting_for_input ();
10470 Vunread_command_events
= Qnil
;
10472 if (FRAMEP (internal_last_event_frame
)
10473 && !EQ (internal_last_event_frame
, selected_frame
))
10474 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10477 sys_longjmp (getcjmp
, 1);
10480 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10481 Sset_input_interrupt_mode
, 1, 1, 0,
10482 doc
: /* Set interrupt mode of reading keyboard input.
10483 If INTERRUPT is non-nil, Emacs will use input interrupts;
10484 otherwise Emacs uses CBREAK mode.
10486 See also `current-input-mode'. */)
10487 (Lisp_Object interrupt
)
10489 bool new_interrupt_input
;
10490 #ifdef USABLE_SIGIO
10491 #ifdef HAVE_X_WINDOWS
10492 if (x_display_list
!= NULL
)
10494 /* When using X, don't give the user a real choice,
10495 because we haven't implemented the mechanisms to support it. */
10496 new_interrupt_input
= 1;
10499 #endif /* HAVE_X_WINDOWS */
10500 new_interrupt_input
= !NILP (interrupt
);
10501 #else /* not USABLE_SIGIO */
10502 new_interrupt_input
= 0;
10503 #endif /* not USABLE_SIGIO */
10505 if (new_interrupt_input
!= interrupt_input
)
10507 #ifdef POLL_FOR_INPUT
10511 /* this causes startup screen to be restored and messes with the mouse */
10512 reset_all_sys_modes ();
10513 interrupt_input
= new_interrupt_input
;
10514 init_all_sys_modes ();
10516 interrupt_input
= new_interrupt_input
;
10519 #ifdef POLL_FOR_INPUT
10520 poll_suppress_count
= 1;
10527 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10528 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10529 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10530 C-q in key sequences.
10532 This setting only has an effect on tty terminals and only when
10533 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10535 See also `current-input-mode'. */)
10536 (Lisp_Object flow
, Lisp_Object terminal
)
10538 struct terminal
*t
= get_terminal (terminal
, 1);
10539 struct tty_display_info
*tty
;
10540 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10542 tty
= t
->display_info
.tty
;
10544 if (tty
->flow_control
!= !NILP (flow
))
10547 /* This causes startup screen to be restored and messes with the mouse. */
10548 reset_sys_modes (tty
);
10551 tty
->flow_control
= !NILP (flow
);
10554 init_sys_modes (tty
);
10560 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10561 doc
: /* Enable or disable 8-bit input on TERMINAL.
10562 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10563 bit as the Meta modifier.
10565 If META is nil, Emacs will ignore the top bit, on the assumption it is
10568 Otherwise, Emacs will accept and pass through 8-bit input without
10569 specially interpreting the top bit.
10571 This setting only has an effect on tty terminal devices.
10573 Optional parameter TERMINAL specifies the tty terminal device to use.
10574 It may be a terminal object, a frame, or nil for the terminal used by
10575 the currently selected frame.
10577 See also `current-input-mode'. */)
10578 (Lisp_Object meta
, Lisp_Object terminal
)
10580 struct terminal
*t
= get_terminal (terminal
, 1);
10581 struct tty_display_info
*tty
;
10584 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10586 tty
= t
->display_info
.tty
;
10590 else if (EQ (meta
, Qt
))
10595 if (tty
->meta_key
!= new_meta
)
10598 /* this causes startup screen to be restored and messes with the mouse */
10599 reset_sys_modes (tty
);
10602 tty
->meta_key
= new_meta
;
10605 init_sys_modes (tty
);
10611 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10612 doc
: /* Specify character used for quitting.
10613 QUIT must be an ASCII character.
10615 This function only has an effect on the controlling tty of the Emacs
10618 See also `current-input-mode'. */)
10621 struct terminal
*t
= get_named_tty ("/dev/tty");
10622 struct tty_display_info
*tty
;
10623 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10625 tty
= t
->display_info
.tty
;
10627 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10628 error ("QUIT must be an ASCII character");
10631 /* this causes startup screen to be restored and messes with the mouse */
10632 reset_sys_modes (tty
);
10635 /* Don't let this value be out of range. */
10636 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10639 init_sys_modes (tty
);
10645 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10646 doc
: /* Set mode of reading keyboard input.
10647 First arg INTERRUPT non-nil means use input interrupts;
10648 nil means use CBREAK mode.
10649 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10650 (no effect except in CBREAK mode).
10651 Third arg META t means accept 8-bit input (for a Meta key).
10652 META nil means ignore the top bit, on the assumption it is parity.
10653 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10654 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10655 See also `current-input-mode'. */)
10656 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10658 Fset_input_interrupt_mode (interrupt
);
10659 Fset_output_flow_control (flow
, Qnil
);
10660 Fset_input_meta_mode (meta
, Qnil
);
10662 Fset_quit_char (quit
);
10666 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10667 doc
: /* Return information about the way Emacs currently reads keyboard input.
10668 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10669 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10670 nil, Emacs is using CBREAK mode.
10671 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10672 terminal; this does not apply if Emacs uses interrupt-driven input.
10673 META is t if accepting 8-bit input with 8th bit as Meta flag.
10674 META nil means ignoring the top bit, on the assumption it is parity.
10675 META is neither t nor nil if accepting 8-bit input and using
10676 all 8 bits as the character code.
10677 QUIT is the character Emacs currently uses to quit.
10678 The elements of this list correspond to the arguments of
10679 `set-input-mode'. */)
10682 Lisp_Object val
[4];
10683 struct frame
*sf
= XFRAME (selected_frame
);
10685 val
[0] = interrupt_input
? Qt
: Qnil
;
10686 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10688 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10689 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10691 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10698 XSETFASTINT (val
[3], quit_char
);
10700 return Flist (ARRAYELTS (val
), val
);
10703 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10704 doc
: /* Return position information for pixel coordinates X and Y.
10705 By default, X and Y are relative to text area of the selected window.
10706 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10707 If optional fourth arg WHOLE is non-nil, X is relative to the left
10708 edge of the window.
10710 The return value is similar to a mouse click position:
10711 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10712 IMAGE (DX . DY) (WIDTH . HEIGHT))
10713 The `posn-' functions access elements of such lists. */)
10714 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10719 if (NILP (frame_or_window
))
10720 frame_or_window
= selected_window
;
10722 if (WINDOWP (frame_or_window
))
10724 struct window
*w
= decode_live_window (frame_or_window
);
10726 XSETINT (x
, (XINT (x
)
10727 + WINDOW_LEFT_EDGE_X (w
)
10729 ? window_box_left_offset (w
, TEXT_AREA
)
10731 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10732 frame_or_window
= w
->frame
;
10735 CHECK_LIVE_FRAME (frame_or_window
);
10737 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10740 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10741 doc
: /* Return position information for buffer POS in WINDOW.
10742 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10744 Return nil if position is not visible in window. Otherwise,
10745 the return value is similar to that returned by `event-start' for
10746 a mouse click at the upper left corner of the glyph corresponding
10747 to the given buffer position:
10748 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10749 IMAGE (DX . DY) (WIDTH . HEIGHT))
10750 The `posn-' functions access elements of such lists. */)
10751 (Lisp_Object pos
, Lisp_Object window
)
10756 window
= selected_window
;
10758 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10761 Lisp_Object x
= XCAR (tem
);
10762 Lisp_Object y
= XCAR (XCDR (tem
));
10764 /* Point invisible due to hscrolling? */
10767 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10773 /* Set up a new kboard object with reasonable initial values.
10774 TYPE is a window system for which this keyboard is used. */
10777 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10779 kset_overriding_terminal_local_map (kb
, Qnil
);
10780 kset_last_command (kb
, Qnil
);
10781 kset_real_last_command (kb
, Qnil
);
10782 kset_keyboard_translate_table (kb
, Qnil
);
10783 kset_last_repeatable_command (kb
, Qnil
);
10784 kset_prefix_arg (kb
, Qnil
);
10785 kset_last_prefix_arg (kb
, Qnil
);
10786 kset_kbd_queue (kb
, Qnil
);
10787 kb
->kbd_queue_has_data
= 0;
10788 kb
->immediate_echo
= 0;
10789 kset_echo_string (kb
, Qnil
);
10790 kb
->echo_after_prompt
= -1;
10791 kb
->kbd_macro_buffer
= 0;
10792 kb
->kbd_macro_bufsize
= 0;
10793 kset_defining_kbd_macro (kb
, Qnil
);
10794 kset_last_kbd_macro (kb
, Qnil
);
10795 kb
->reference_count
= 0;
10796 kset_system_key_alist (kb
, Qnil
);
10797 kset_system_key_syms (kb
, Qnil
);
10798 kset_window_system (kb
, type
);
10799 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10800 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10801 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10802 kset_default_minibuffer_frame (kb
, Qnil
);
10805 /* Allocate and basically initialize keyboard
10806 object to use with window system TYPE. */
10809 allocate_kboard (Lisp_Object type
)
10811 KBOARD
*kb
= xmalloc (sizeof *kb
);
10813 init_kboard (kb
, type
);
10814 kb
->next_kboard
= all_kboards
;
10820 * Destroy the contents of a kboard object, but not the object itself.
10821 * We use this just before deleting it, or if we're going to initialize
10822 * it a second time.
10825 wipe_kboard (KBOARD
*kb
)
10827 xfree (kb
->kbd_macro_buffer
);
10830 /* Free KB and memory referenced from it. */
10833 delete_kboard (KBOARD
*kb
)
10837 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10840 *kbp
= kb
->next_kboard
;
10842 /* Prevent a dangling reference to KB. */
10843 if (kb
== current_kboard
10844 && FRAMEP (selected_frame
)
10845 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10847 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10849 if (current_kboard
== kb
)
10858 init_keyboard (void)
10860 /* This is correct before outermost invocation of the editor loop. */
10861 command_loop_level
= -1;
10862 immediate_quit
= 0;
10863 quit_char
= Ctl ('g');
10864 Vunread_command_events
= Qnil
;
10865 timer_idleness_start_time
= invalid_timespec ();
10867 recent_keys_index
= 0;
10868 kbd_fetch_ptr
= kbd_buffer
;
10869 kbd_store_ptr
= kbd_buffer
;
10870 do_mouse_tracking
= Qnil
;
10872 interrupt_input_blocked
= 0;
10873 pending_signals
= 0;
10875 /* This means that command_loop_1 won't try to select anything the first
10877 internal_last_event_frame
= Qnil
;
10878 Vlast_event_frame
= internal_last_event_frame
;
10880 current_kboard
= initial_kboard
;
10881 /* Re-initialize the keyboard again. */
10882 wipe_kboard (current_kboard
);
10883 /* A value of nil for Vwindow_system normally means a tty, but we also use
10884 it for the initial terminal since there is no window system there. */
10885 init_kboard (current_kboard
, Qnil
);
10887 if (!noninteractive
)
10889 /* Before multi-tty support, these handlers used to be installed
10890 only if the current session was a tty session. Now an Emacs
10891 session may have multiple display types, so we always handle
10892 SIGINT. There is special code in handle_interrupt_signal to exit
10893 Emacs on SIGINT when there are no termcap frames on the
10894 controlling terminal. */
10895 struct sigaction action
;
10896 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10897 sigaction (SIGINT
, &action
, 0);
10899 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10900 SIGQUIT and we can't tell which one it will give us. */
10901 sigaction (SIGQUIT
, &action
, 0);
10902 #endif /* not DOS_NT */
10904 #ifdef USABLE_SIGIO
10905 if (!noninteractive
)
10907 struct sigaction action
;
10908 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10909 sigaction (SIGIO
, &action
, 0);
10913 /* Use interrupt input by default, if it works and noninterrupt input
10914 has deficiencies. */
10916 #ifdef INTERRUPT_INPUT
10917 interrupt_input
= 1;
10919 interrupt_input
= 0;
10922 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10925 if (keyboard_init_hook
)
10926 (*keyboard_init_hook
) ();
10928 #ifdef POLL_FOR_INPUT
10930 poll_suppress_count
= 1;
10935 /* This type's only use is in syms_of_keyboard, to initialize the
10936 event header symbols and put properties on them. */
10937 struct event_head
{
10943 static const struct event_head head_table
[] = {
10944 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10945 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10946 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10947 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10948 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10949 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10950 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10951 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10952 /* `select-window' should be handled just like `switch-frame'
10953 in read_key_sequence. */
10954 {&Qselect_window
, "select-window", &Qswitch_frame
}
10958 syms_of_keyboard (void)
10960 pending_funcalls
= Qnil
;
10961 staticpro (&pending_funcalls
);
10963 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10964 staticpro (&Vlispy_mouse_stem
);
10967 DEFSYM (QCimage
, ":image");
10968 DEFSYM (Qhelp_echo
, "help-echo");
10969 DEFSYM (QCrtl
, ":rtl");
10971 staticpro (&item_properties
);
10972 item_properties
= Qnil
;
10974 staticpro (&tool_bar_item_properties
);
10975 tool_bar_item_properties
= Qnil
;
10976 staticpro (&tool_bar_items_vector
);
10977 tool_bar_items_vector
= Qnil
;
10979 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10980 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10981 DEFSYM (Qself_insert_command
, "self-insert-command");
10982 DEFSYM (Qforward_char
, "forward-char");
10983 DEFSYM (Qbackward_char
, "backward-char");
10984 DEFSYM (Qdisabled
, "disabled");
10985 DEFSYM (Qundefined
, "undefined");
10986 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10987 DEFSYM (Qpost_command_hook
, "post-command-hook");
10988 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10989 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10990 DEFSYM (Qfunction_key
, "function-key");
10991 DEFSYM (Qmouse_click
, "mouse-click");
10992 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10993 DEFSYM (Qsave_session
, "save-session");
10994 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10995 DEFSYM (Qmenu_enable
, "menu-enable");
10998 DEFSYM (Qlanguage_change
, "language-change");
11002 DEFSYM (Qdbus_event
, "dbus-event");
11005 #ifdef USE_FILE_NOTIFY
11006 DEFSYM (Qfile_notify
, "file-notify");
11007 #endif /* USE_FILE_NOTIFY */
11009 DEFSYM (QCenable
, ":enable");
11010 DEFSYM (QCvisible
, ":visible");
11011 DEFSYM (QChelp
, ":help");
11012 DEFSYM (QCfilter
, ":filter");
11013 DEFSYM (QCbutton
, ":button");
11014 DEFSYM (QCkeys
, ":keys");
11015 DEFSYM (QCkey_sequence
, ":key-sequence");
11016 DEFSYM (QCtoggle
, ":toggle");
11017 DEFSYM (QCradio
, ":radio");
11018 DEFSYM (QClabel
, ":label");
11019 DEFSYM (QCvert_only
, ":vert-only");
11021 DEFSYM (Qmode_line
, "mode-line");
11022 DEFSYM (Qvertical_line
, "vertical-line");
11023 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11024 DEFSYM (Qmenu_bar
, "menu-bar");
11025 DEFSYM (Qright_divider
, "right-divider");
11026 DEFSYM (Qbottom_divider
, "bottom-divider");
11028 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11030 DEFSYM (Qabove_handle
, "above-handle");
11031 DEFSYM (Qhandle
, "handle");
11032 DEFSYM (Qbelow_handle
, "below-handle");
11033 DEFSYM (Qup
, "up");
11034 DEFSYM (Qdown
, "down");
11035 DEFSYM (Qtop
, "top");
11036 DEFSYM (Qbottom
, "bottom");
11037 DEFSYM (Qend_scroll
, "end-scroll");
11038 DEFSYM (Qratio
, "ratio");
11040 DEFSYM (Qevent_kind
, "event-kind");
11041 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11042 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11043 DEFSYM (Qmodifier_cache
, "modifier-cache");
11045 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11046 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11048 DEFSYM (Qpolling_period
, "polling-period");
11050 DEFSYM (Qx_set_selection
, "x-set-selection");
11051 DEFSYM (QPRIMARY
, "PRIMARY");
11052 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11053 DEFSYM (Qhandle_select_window
, "handle-select-window");
11055 DEFSYM (Qinput_method_function
, "input-method-function");
11056 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11057 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11059 DEFSYM (Qhelp_form_show
, "help-form-show");
11061 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11063 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11064 Fset (Qinput_method_use_echo_area
, Qnil
);
11068 int len
= ARRAYELTS (head_table
);
11070 for (i
= 0; i
< len
; i
++)
11072 const struct event_head
*p
= &head_table
[i
];
11073 *p
->var
= intern_c_string (p
->name
);
11074 staticpro (p
->var
);
11075 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11076 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11080 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11081 staticpro (&button_down_location
);
11082 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11083 staticpro (&mouse_syms
);
11084 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11086 staticpro (&wheel_syms
);
11090 int len
= ARRAYELTS (modifier_names
);
11092 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11093 for (i
= 0; i
< len
; i
++)
11094 if (modifier_names
[i
])
11095 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11096 staticpro (&modifier_symbols
);
11099 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11100 staticpro (&recent_keys
);
11102 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11103 staticpro (&this_command_keys
);
11105 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11106 staticpro (&raw_keybuf
);
11108 DEFSYM (Qcommand_execute
, "command-execute");
11110 accent_key_syms
= Qnil
;
11111 staticpro (&accent_key_syms
);
11113 func_key_syms
= Qnil
;
11114 staticpro (&func_key_syms
);
11116 drag_n_drop_syms
= Qnil
;
11117 staticpro (&drag_n_drop_syms
);
11119 unread_switch_frame
= Qnil
;
11120 staticpro (&unread_switch_frame
);
11122 internal_last_event_frame
= Qnil
;
11123 staticpro (&internal_last_event_frame
);
11125 read_key_sequence_cmd
= Qnil
;
11126 staticpro (&read_key_sequence_cmd
);
11127 read_key_sequence_remapped
= Qnil
;
11128 staticpro (&read_key_sequence_remapped
);
11130 menu_bar_one_keymap_changed_items
= Qnil
;
11131 staticpro (&menu_bar_one_keymap_changed_items
);
11133 menu_bar_items_vector
= Qnil
;
11134 staticpro (&menu_bar_items_vector
);
11136 help_form_saved_window_configs
= Qnil
;
11137 staticpro (&help_form_saved_window_configs
);
11139 defsubr (&Scurrent_idle_time
);
11140 defsubr (&Sevent_symbol_parse_modifiers
);
11141 defsubr (&Sevent_convert_list
);
11142 defsubr (&Sread_key_sequence
);
11143 defsubr (&Sread_key_sequence_vector
);
11144 defsubr (&Srecursive_edit
);
11145 defsubr (&Strack_mouse
);
11146 defsubr (&Sinput_pending_p
);
11147 defsubr (&Srecent_keys
);
11148 defsubr (&Sthis_command_keys
);
11149 defsubr (&Sthis_command_keys_vector
);
11150 defsubr (&Sthis_single_command_keys
);
11151 defsubr (&Sthis_single_command_raw_keys
);
11152 defsubr (&Sreset_this_command_lengths
);
11153 defsubr (&Sclear_this_command_keys
);
11154 defsubr (&Ssuspend_emacs
);
11155 defsubr (&Sabort_recursive_edit
);
11156 defsubr (&Sexit_recursive_edit
);
11157 defsubr (&Srecursion_depth
);
11158 defsubr (&Scommand_error_default_function
);
11159 defsubr (&Stop_level
);
11160 defsubr (&Sdiscard_input
);
11161 defsubr (&Sopen_dribble_file
);
11162 defsubr (&Sset_input_interrupt_mode
);
11163 defsubr (&Sset_output_flow_control
);
11164 defsubr (&Sset_input_meta_mode
);
11165 defsubr (&Sset_quit_char
);
11166 defsubr (&Sset_input_mode
);
11167 defsubr (&Scurrent_input_mode
);
11168 defsubr (&Sposn_at_point
);
11169 defsubr (&Sposn_at_x_y
);
11171 DEFVAR_LISP ("last-command-event", last_command_event
,
11172 doc
: /* Last input event that was part of a command. */);
11174 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11175 doc
: /* Last input event in a command, except for mouse menu events.
11176 Mouse menus give back keys that don't look like mouse events;
11177 this variable holds the actual mouse event that led to the menu,
11178 so that you can determine whether the command was run by mouse or not. */);
11180 DEFVAR_LISP ("last-input-event", last_input_event
,
11181 doc
: /* Last input event. */);
11183 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11184 doc
: /* List of events to be read as the command input.
11185 These events are processed first, before actual keyboard input.
11186 Events read from this list are not normally added to `this-command-keys',
11187 as they will already have been added once as they were read for the first time.
11188 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11189 Vunread_command_events
= Qnil
;
11191 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11192 doc
: /* List of events to be processed as input by input methods.
11193 These events are processed before `unread-command-events'
11194 and actual keyboard input, but are not given to `input-method-function'. */);
11195 Vunread_post_input_method_events
= Qnil
;
11197 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11198 doc
: /* List of events to be processed as input by input methods.
11199 These events are processed after `unread-command-events', but
11200 before actual keyboard input.
11201 If there's an active input method, the events are given to
11202 `input-method-function'. */);
11203 Vunread_input_method_events
= Qnil
;
11205 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11206 doc
: /* Meta-prefix character code.
11207 Meta-foo as command input turns into this character followed by foo. */);
11208 XSETINT (meta_prefix_char
, 033);
11210 DEFVAR_KBOARD ("last-command", Vlast_command
,
11211 doc
: /* The last command executed.
11212 Normally a symbol with a function definition, but can be whatever was found
11213 in the keymap, or whatever the variable `this-command' was set to by that
11216 The value `mode-exit' is special; it means that the previous command
11217 read an event that told it to exit, and it did so and unread that event.
11218 In other words, the present command is the event that made the previous
11221 The value `kill-region' is special; it means that the previous command
11222 was a kill command.
11224 `last-command' has a separate binding for each terminal device.
11225 See Info node `(elisp)Multiple Terminals'. */);
11227 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11228 doc
: /* Same as `last-command', but never altered by Lisp code.
11229 Taken from the previous value of `real-this-command'. */);
11231 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11232 doc
: /* Last command that may be repeated.
11233 The last command executed that was not bound to an input event.
11234 This is the command `repeat' will try to repeat.
11235 Taken from a previous value of `real-this-command'. */);
11237 DEFVAR_LISP ("this-command", Vthis_command
,
11238 doc
: /* The command now being executed.
11239 The command can set this variable; whatever is put here
11240 will be in `last-command' during the following command. */);
11241 Vthis_command
= Qnil
;
11243 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11244 doc
: /* This is like `this-command', except that commands should never modify it. */);
11245 Vreal_this_command
= Qnil
;
11247 DEFVAR_LISP ("this-command-keys-shift-translated",
11248 Vthis_command_keys_shift_translated
,
11249 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11250 Shift-translation occurs when there is no binding for the key sequence
11251 as entered, but a binding was found by changing an upper-case letter
11252 to lower-case, or a shifted function key to an unshifted one. */);
11253 Vthis_command_keys_shift_translated
= Qnil
;
11255 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11256 doc
: /* The command bound to the current key sequence before remapping.
11257 It equals `this-command' if the original command was not remapped through
11258 any of the active keymaps. Otherwise, the value of `this-command' is the
11259 result of looking up the original command in the active keymaps. */);
11260 Vthis_original_command
= Qnil
;
11262 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11263 doc
: /* Number of input events between auto-saves.
11264 Zero means disable autosaving due to number of characters typed. */);
11265 auto_save_interval
= 300;
11267 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11268 doc
: /* Number of seconds idle time before auto-save.
11269 Zero or nil means disable auto-saving due to idleness.
11270 After auto-saving due to this many seconds of idle time,
11271 Emacs also does a garbage collection if that seems to be warranted. */);
11272 XSETFASTINT (Vauto_save_timeout
, 30);
11274 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11275 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11276 The value may be integer or floating point.
11277 If the value is zero, don't echo at all. */);
11278 Vecho_keystrokes
= make_number (1);
11280 DEFVAR_INT ("polling-period", polling_period
,
11281 doc
: /* Interval between polling for input during Lisp execution.
11282 The reason for polling is to make C-g work to stop a running program.
11283 Polling is needed only when using X windows and SIGIO does not work.
11284 Polling is automatically disabled in all other cases. */);
11285 polling_period
= 2;
11287 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11288 doc
: /* Maximum time between mouse clicks to make a double-click.
11289 Measured in milliseconds. The value nil means disable double-click
11290 recognition; t means double-clicks have no time limit and are detected
11291 by position only. */);
11292 Vdouble_click_time
= make_number (500);
11294 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11295 doc
: /* Maximum mouse movement between clicks to make a double-click.
11296 On window-system frames, value is the number of pixels the mouse may have
11297 moved horizontally or vertically between two clicks to make a double-click.
11298 On non window-system frames, value is interpreted in units of 1/8 characters
11301 This variable is also the threshold for motion of the mouse
11302 to count as a drag. */);
11303 double_click_fuzz
= 3;
11305 DEFVAR_INT ("num-input-keys", num_input_keys
,
11306 doc
: /* Number of complete key sequences read as input so far.
11307 This includes key sequences read from keyboard macros.
11308 The number is effectively the number of interactive command invocations. */);
11309 num_input_keys
= 0;
11311 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11312 doc
: /* Number of input events read from the keyboard so far.
11313 This does not include events generated by keyboard macros. */);
11314 num_nonmacro_input_events
= 0;
11316 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11317 doc
: /* The frame in which the most recently read event occurred.
11318 If the last event came from a keyboard macro, this is set to `macro'. */);
11319 Vlast_event_frame
= Qnil
;
11321 /* This variable is set up in sysdep.c. */
11322 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11323 doc
: /* The ERASE character as set by the user with stty. */);
11325 DEFVAR_LISP ("help-char", Vhelp_char
,
11326 doc
: /* Character to recognize as meaning Help.
11327 When it is read, do `(eval help-form)', and display result if it's a string.
11328 If the value of `help-form' is nil, this char can be read normally. */);
11329 XSETINT (Vhelp_char
, Ctl ('H'));
11331 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11332 doc
: /* List of input events to recognize as meaning Help.
11333 These work just like the value of `help-char' (see that). */);
11334 Vhelp_event_list
= Qnil
;
11336 DEFVAR_LISP ("help-form", Vhelp_form
,
11337 doc
: /* Form to execute when character `help-char' is read.
11338 If the form returns a string, that string is displayed.
11339 If `help-form' is nil, the help char is not recognized. */);
11342 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11343 doc
: /* Command to run when `help-char' character follows a prefix key.
11344 This command is used only when there is no actual binding
11345 for that character after that prefix key. */);
11346 Vprefix_help_command
= Qnil
;
11348 DEFVAR_LISP ("top-level", Vtop_level
,
11349 doc
: /* Form to evaluate when Emacs starts up.
11350 Useful to set before you dump a modified Emacs. */);
11353 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11354 doc
: /* Translate table for local keyboard input, or nil.
11355 If non-nil, the value should be a char-table. Each character read
11356 from the keyboard is looked up in this char-table. If the value found
11357 there is non-nil, then it is used instead of the actual input character.
11359 The value can also be a string or vector, but this is considered obsolete.
11360 If it is a string or vector of length N, character codes N and up are left
11361 untranslated. In a vector, an element which is nil means "no translation".
11363 This is applied to the characters supplied to input methods, not their
11364 output. See also `translation-table-for-input'.
11366 This variable has a separate binding for each terminal.
11367 See Info node `(elisp)Multiple Terminals'. */);
11369 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11370 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11371 \(Even if the operating system has support for stopping a process.\) */);
11372 cannot_suspend
= 0;
11374 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11375 doc
: /* Non-nil means prompt with menus when appropriate.
11376 This is done when reading from a keymap that has a prompt string,
11377 for elements that have prompt strings.
11378 The menu is displayed on the screen
11379 if X menus were enabled at configuration
11380 time and the previous event was a mouse click prefix key.
11381 Otherwise, menu prompting uses the echo area. */);
11382 menu_prompting
= 1;
11384 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11385 doc
: /* Character to see next line of menu prompt.
11386 Type this character while in a menu prompt to rotate around the lines of it. */);
11387 XSETINT (menu_prompt_more_char
, ' ');
11389 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11390 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11391 Emacs applies the modifiers of the character stored here to each keyboard
11392 character it reads. For example, after evaluating the expression
11393 (setq extra-keyboard-modifiers ?\\C-x)
11394 all input characters will have the control modifier applied to them.
11396 Note that the character ?\\C-@, equivalent to the integer zero, does
11397 not count as a control character; rather, it counts as a character
11398 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11399 cancels any modification. */);
11400 extra_keyboard_modifiers
= 0;
11402 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11403 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11404 The command loop sets this to nil before each command,
11405 and tests the value when the command returns.
11406 Buffer modification stores t in this variable. */);
11407 Vdeactivate_mark
= Qnil
;
11408 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11409 Fmake_variable_buffer_local (Qdeactivate_mark
);
11411 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11412 doc
: /* Normal hook run before each command is executed.
11413 If an unhandled error happens in running this hook,
11414 the function in which the error occurred is unconditionally removed, since
11415 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11416 Vpre_command_hook
= Qnil
;
11418 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11419 doc
: /* Normal hook run after each command is executed.
11420 If an unhandled error happens in running this hook,
11421 the function in which the error occurred is unconditionally removed, since
11422 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11423 Vpost_command_hook
= Qnil
;
11426 DEFVAR_LISP ("echo-area-clear-hook", ...,
11427 doc
: /* Normal hook run when clearing the echo area. */);
11429 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11430 Fset (Qecho_area_clear_hook
, Qnil
);
11432 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11433 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11434 Vlucid_menu_bar_dirty_flag
= Qnil
;
11436 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11437 doc
: /* List of menu bar items to move to the end of the menu bar.
11438 The elements of the list are event types that may have menu bar bindings. */);
11439 Vmenu_bar_final_items
= Qnil
;
11441 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11442 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11443 This is used internally by graphical displays that do not render
11444 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11445 Vtool_bar_separator_image_expression
= Qnil
;
11447 DEFVAR_KBOARD ("overriding-terminal-local-map",
11448 Voverriding_terminal_local_map
,
11449 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11450 This variable is intended to let commands such as `universal-argument'
11451 set up a different keymap for reading the next command.
11453 `overriding-terminal-local-map' has a separate binding for each
11454 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11456 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11457 doc
: /* Keymap that replaces (overrides) local keymaps.
11458 If this variable is non-nil, Emacs looks up key bindings in this
11459 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11460 buffer's local map. Hence, the only active keymaps would be
11461 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11462 order of precedence. */);
11463 Voverriding_local_map
= Qnil
;
11465 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11466 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11467 Otherwise, the menu bar continues to reflect the buffer's local map
11468 and the minor mode maps regardless of `overriding-local-map'. */);
11469 Voverriding_local_map_menu_flag
= Qnil
;
11471 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11472 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11473 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11475 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11476 doc
: /* Non-nil means generate motion events for mouse motion. */);
11478 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11479 doc
: /* Alist of system-specific X windows key symbols.
11480 Each element should have the form (N . SYMBOL) where N is the
11481 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11482 and SYMBOL is its name.
11484 `system-key-alist' has a separate binding for each terminal device.
11485 See Info node `(elisp)Multiple Terminals'. */);
11487 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11488 doc
: /* Keymap that translates key sequences to key sequences during input.
11489 This is used mainly for mapping key sequences into some preferred
11490 key events (symbols).
11492 The `read-key-sequence' function replaces any subsequence bound by
11493 `local-function-key-map' with its binding. More precisely, when the
11494 active keymaps have no binding for the current key sequence but
11495 `local-function-key-map' binds a suffix of the sequence to a vector or
11496 string, `read-key-sequence' replaces the matching suffix with its
11497 binding, and continues with the new sequence.
11499 If the binding is a function, it is called with one argument (the prompt)
11500 and its return value (a key sequence) is used.
11502 The events that come from bindings in `local-function-key-map' are not
11503 themselves looked up in `local-function-key-map'.
11505 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11506 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11507 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11508 typing `ESC O P x' would return [f1 x].
11510 `local-function-key-map' has a separate binding for each terminal
11511 device. See Info node `(elisp)Multiple Terminals'. If you need to
11512 define a binding on all terminals, change `function-key-map'
11513 instead. Initially, `local-function-key-map' is an empty keymap that
11514 has `function-key-map' as its parent on all terminal devices. */);
11516 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11517 doc
: /* Keymap that decodes input escape sequences.
11518 This is used mainly for mapping ASCII function key sequences into
11519 real Emacs function key events (symbols).
11521 The `read-key-sequence' function replaces any subsequence bound by
11522 `input-decode-map' with its binding. Contrary to `function-key-map',
11523 this map applies its rebinding regardless of the presence of an ordinary
11524 binding. So it is more like `key-translation-map' except that it applies
11525 before `function-key-map' rather than after.
11527 If the binding is a function, it is called with one argument (the prompt)
11528 and its return value (a key sequence) is used.
11530 The events that come from bindings in `input-decode-map' are not
11531 themselves looked up in `input-decode-map'. */);
11533 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11534 doc
: /* The parent keymap of all `local-function-key-map' instances.
11535 Function key definitions that apply to all terminal devices should go
11536 here. If a mapping is defined in both the current
11537 `local-function-key-map' binding and this variable, then the local
11538 definition will take precedence. */);
11539 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11541 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11542 doc
: /* Keymap of key translations that can override keymaps.
11543 This keymap works like `input-decode-map', but comes after `function-key-map'.
11544 Another difference is that it is global rather than terminal-local. */);
11545 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11547 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11548 doc
: /* List of deferred actions to be performed at a later time.
11549 The precise format isn't relevant here; we just check whether it is nil. */);
11550 Vdeferred_action_list
= Qnil
;
11552 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11553 doc
: /* Function to call to handle deferred actions, after each command.
11554 This function is called with no arguments after each command
11555 whenever `deferred-action-list' is non-nil. */);
11556 Vdeferred_action_function
= Qnil
;
11558 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11559 doc
: /* List of warnings to be displayed after this command.
11560 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11561 as per the args of `display-warning' (which see).
11562 If this variable is non-nil, `delayed-warnings-hook' will be run
11563 immediately after running `post-command-hook'. */);
11564 Vdelayed_warnings_list
= Qnil
;
11566 DEFVAR_LISP ("timer-list", Vtimer_list
,
11567 doc
: /* List of active absolute time timers in order of increasing time. */);
11568 Vtimer_list
= Qnil
;
11570 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11571 doc
: /* List of active idle-time timers in order of increasing time. */);
11572 Vtimer_idle_list
= Qnil
;
11574 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11575 doc
: /* If non-nil, the function that implements the current input method.
11576 It's called with one argument, a printing character that was just read.
11577 \(That means a character with code 040...0176.)
11578 Typically this function uses `read-event' to read additional events.
11579 When it does so, it should first bind `input-method-function' to nil
11580 so it will not be called recursively.
11582 The function should return a list of zero or more events
11583 to be used as input. If it wants to put back some events
11584 to be reconsidered, separately, by the input method,
11585 it can add them to the beginning of `unread-command-events'.
11587 The input method function can find in `input-method-previous-message'
11588 the previous echo area message.
11590 The input method function should refer to the variables
11591 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11592 for guidance on what to do. */);
11593 Vinput_method_function
= Qnil
;
11595 DEFVAR_LISP ("input-method-previous-message",
11596 Vinput_method_previous_message
,
11597 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11598 This variable exists because `read-event' clears the echo area
11599 before running the input method. It is nil if there was no message. */);
11600 Vinput_method_previous_message
= Qnil
;
11602 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11603 doc
: /* If non-nil, the function that implements the display of help.
11604 It's called with one argument, the help string to display. */);
11605 Vshow_help_function
= Qnil
;
11607 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11608 doc
: /* If non-nil, suppress point adjustment after executing a command.
11610 After a command is executed, if point is moved into a region that has
11611 special properties (e.g. composition, display), we adjust point to
11612 the boundary of the region. But, when a command sets this variable to
11613 non-nil, we suppress the point adjustment.
11615 This variable is set to nil before reading a command, and is checked
11616 just after executing the command. */);
11617 Vdisable_point_adjustment
= Qnil
;
11619 DEFVAR_LISP ("global-disable-point-adjustment",
11620 Vglobal_disable_point_adjustment
,
11621 doc
: /* If non-nil, always suppress point adjustment.
11623 The default value is nil, in which case, point adjustment are
11624 suppressed only after special commands that set
11625 `disable-point-adjustment' (which see) to non-nil. */);
11626 Vglobal_disable_point_adjustment
= Qnil
;
11628 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11629 doc
: /* How long to display an echo-area message when the minibuffer is active.
11630 If the value is not a number, such messages don't time out. */);
11631 Vminibuffer_message_timeout
= make_number (2);
11633 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11634 doc
: /* If non-nil, any keyboard input throws to this symbol.
11635 The value of that variable is passed to `quit-flag' and later causes a
11636 peculiar kind of quitting. */);
11637 Vthrow_on_input
= Qnil
;
11639 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11640 doc
: /* Function to output error messages.
11641 Called with three arguments:
11642 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11643 such as what `condition-case' would bind its variable to,
11644 - the context (a string which normally goes at the start of the message),
11645 - the Lisp function within which the error was signaled. */);
11646 Vcommand_error_function
= intern ("command-error-default-function");
11648 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11649 Venable_disabled_menus_and_buttons
,
11650 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11652 Help functions bind this to allow help on disabled menu items
11653 and tool-bar buttons. */);
11654 Venable_disabled_menus_and_buttons
= Qnil
;
11656 DEFVAR_LISP ("select-active-regions",
11657 Vselect_active_regions
,
11658 doc
: /* If non-nil, an active region automatically sets the primary selection.
11659 If the value is `only', only temporarily active regions (usually made
11660 by mouse-dragging or shift-selection) set the window selection.
11662 This takes effect only when Transient Mark mode is enabled. */);
11663 Vselect_active_regions
= Qt
;
11665 DEFVAR_LISP ("saved-region-selection",
11666 Vsaved_region_selection
,
11667 doc
: /* Contents of active region prior to buffer modification.
11668 If `select-active-regions' is non-nil, Emacs sets this to the
11669 text in the region before modifying the buffer. The next call to
11670 the function `deactivate-mark' uses this to set the window selection. */);
11671 Vsaved_region_selection
= Qnil
;
11673 DEFVAR_LISP ("selection-inhibit-update-commands",
11674 Vselection_inhibit_update_commands
,
11675 doc
: /* List of commands which should not update the selection.
11676 Normally, if `select-active-regions' is non-nil and the mark remains
11677 active after a command (i.e. the mark was not deactivated), the Emacs
11678 command loop sets the selection to the text in the region. However,
11679 if the command is in this list, the selection is not updated. */);
11680 Vselection_inhibit_update_commands
11681 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11683 DEFVAR_LISP ("debug-on-event",
11685 doc
: /* Enter debugger on this event. When Emacs
11686 receives the special event specified by this variable, it will try to
11687 break into the debugger as soon as possible instead of processing the
11688 event normally through `special-event-map'.
11690 Currently, the only supported values for this
11691 variable are `sigusr1' and `sigusr2'. */);
11692 Vdebug_on_event
= intern_c_string ("sigusr2");
11694 /* Create the initial keyboard. Qt means 'unset'. */
11695 initial_kboard
= allocate_kboard (Qt
);
11699 keys_of_keyboard (void)
11701 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11702 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11703 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11704 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11705 initial_define_key (meta_map
, 'x', "execute-extended-command");
11707 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11708 "handle-delete-frame");
11709 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11710 "ns-put-working-text");
11711 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11712 "ns-unput-working-text");
11713 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11714 current-prefix-arg, as is done in `handle-switch-frame'.
11715 But `handle-switch-frame is not run from the special-map.
11716 Commands from that map are run in a special way that automatically
11717 preserves the prefix-arg. Restoring the prefix arg here is not just
11718 redundant but harmful:
11720 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11721 - after the first prompt, the exit-minibuffer-hook is run which may
11722 iconify a frame and thus push a `iconify-frame' event.
11723 - after running exit-minibuffer-hook, current-prefix-arg is
11724 restored to the non-nil value it had before the prompt.
11725 - we enter the second prompt.
11726 current-prefix-arg is non-nil, prefix-arg is nil.
11727 - before running the first real event, we run the special iconify-frame
11728 event, but we pass the `special' arg to execute-command so
11729 current-prefix-arg and prefix-arg are left untouched.
11730 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11731 - the next key event will have a spuriously non-nil current-prefix-arg. */
11732 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11734 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11736 /* Handling it at such a low-level causes read_key_sequence to get
11737 * confused because it doesn't realize that the current_buffer was
11738 * changed by read_char.
11740 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11741 * "handle-select-window"); */
11742 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11743 "handle-save-session");
11746 /* Define a special event which is raised for dbus callback
11748 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11749 "dbus-handle-event");
11752 #ifdef USE_FILE_NOTIFY
11753 /* Define a special event which is raised for notification callback
11755 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11756 "file-notify-handle-event");
11757 #endif /* USE_FILE_NOTIFY */
11759 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11761 #if defined (WINDOWSNT)
11762 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11765 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11766 "handle-focus-in");
11767 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11768 "handle-focus-out");
11771 /* Mark the pointers in the kboard objects.
11772 Called by Fgarbage_collect. */
11774 mark_kboards (void)
11778 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11780 if (kb
->kbd_macro_buffer
)
11781 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11783 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11784 mark_object (KVAR (kb
, Vlast_command
));
11785 mark_object (KVAR (kb
, Vreal_last_command
));
11786 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11787 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11788 mark_object (KVAR (kb
, Vprefix_arg
));
11789 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11790 mark_object (KVAR (kb
, kbd_queue
));
11791 mark_object (KVAR (kb
, defining_kbd_macro
));
11792 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11793 mark_object (KVAR (kb
, Vsystem_key_alist
));
11794 mark_object (KVAR (kb
, system_key_syms
));
11795 mark_object (KVAR (kb
, Vwindow_system
));
11796 mark_object (KVAR (kb
, Vinput_decode_map
));
11797 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11798 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11799 mark_object (KVAR (kb
, echo_string
));
11802 struct input_event
*event
;
11803 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11805 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11806 event
= kbd_buffer
;
11807 /* These two special event types has no Lisp_Objects to mark. */
11808 if (event
->kind
!= SELECTION_REQUEST_EVENT
11809 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11811 mark_object (event
->x
);
11812 mark_object (event
->y
);
11813 mark_object (event
->frame_or_window
);
11814 mark_object (event
->arg
);