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 bool ignore_mouse_drag_p
;
1291 static struct frame
*
1292 some_mouse_moved (void)
1294 Lisp_Object tail
, frame
;
1296 if (ignore_mouse_drag_p
)
1298 /* ignore_mouse_drag_p = 0; */
1302 FOR_EACH_FRAME (tail
, frame
)
1304 if (XFRAME (frame
)->mouse_moved
)
1305 return XFRAME (frame
);
1312 /* This is the actual command reading loop,
1313 sans error-handling encapsulation. */
1315 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1316 bool, bool, bool, bool);
1317 void safe_run_hooks (Lisp_Object
);
1318 static void adjust_point_for_property (ptrdiff_t, bool);
1320 /* The last boundary auto-added to buffer-undo-list. */
1321 Lisp_Object last_undo_boundary
;
1323 extern Lisp_Object Qregion_extract_function
;
1325 /* FIXME: This is wrong rather than test window-system, we should call
1326 a new set-selection, which will then dispatch to x-set-selection, or
1327 tty-set-selection, or w32-set-selection, ... */
1330 command_loop_1 (void)
1333 Lisp_Object keybuf
[30];
1335 EMACS_INT prev_modiff
= 0;
1336 struct buffer
*prev_buffer
= NULL
;
1337 bool already_adjusted
= 0;
1339 kset_prefix_arg (current_kboard
, Qnil
);
1340 kset_last_prefix_arg (current_kboard
, Qnil
);
1341 Vdeactivate_mark
= Qnil
;
1342 waiting_for_input
= 0;
1345 this_command_key_count
= 0;
1346 this_command_key_count_reset
= 0;
1347 this_single_command_key_start
= 0;
1349 if (NILP (Vmemory_full
))
1351 /* Make sure this hook runs after commands that get errors and
1352 throw to top level. */
1353 /* Note that the value cell will never directly contain nil
1354 if the symbol is a local variable. */
1355 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1356 safe_run_hooks (Qpost_command_hook
);
1358 /* If displaying a message, resize the echo area window to fit
1359 that message's size exactly. */
1360 if (!NILP (echo_area_buffer
[0]))
1361 resize_echo_area_exactly ();
1363 /* If there are warnings waiting, process them. */
1364 if (!NILP (Vdelayed_warnings_list
))
1365 safe_run_hooks (Qdelayed_warnings_hook
);
1367 if (!NILP (Vdeferred_action_list
))
1368 safe_run_hooks (Qdeferred_action_function
);
1371 /* Do this after running Vpost_command_hook, for consistency. */
1372 kset_last_command (current_kboard
, Vthis_command
);
1373 kset_real_last_command (current_kboard
, Vreal_this_command
);
1374 if (!CONSP (last_command_event
))
1375 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1379 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1382 /* Make sure the current window's buffer is selected. */
1383 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1385 /* Display any malloc warning that just came out. Use while because
1386 displaying one warning can cause another. */
1388 while (pending_malloc_warning
)
1389 display_malloc_warning ();
1391 Vdeactivate_mark
= Qnil
;
1393 /* Don't ignore mouse movements for more than a single command
1394 loop. (This flag is set in xdisp.c whenever the tool bar is
1395 resized, because the resize moves text up or down, and would
1396 generate false mouse drag events if we don't ignore them.) */
1397 ignore_mouse_drag_p
= 0;
1399 /* If minibuffer on and echo area in use,
1400 wait a short time and redraw minibuffer. */
1403 && !NILP (echo_area_buffer
[0])
1404 && EQ (minibuf_window
, echo_area_window
)
1405 && NUMBERP (Vminibuffer_message_timeout
))
1407 /* Bind inhibit-quit to t so that C-g gets read in
1408 rather than quitting back to the minibuffer. */
1409 ptrdiff_t count
= SPECPDL_INDEX ();
1410 specbind (Qinhibit_quit
, Qt
);
1412 sit_for (Vminibuffer_message_timeout
, 0, 2);
1414 /* Clear the echo area. */
1416 safe_run_hooks (Qecho_area_clear_hook
);
1418 unbind_to (count
, Qnil
);
1420 /* If a C-g came in before, treat it as input now. */
1421 if (!NILP (Vquit_flag
))
1424 Vunread_command_events
= list1 (make_number (quit_char
));
1428 /* If it has changed current-menubar from previous value,
1429 really recompute the menubar from the value. */
1430 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1431 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1432 call0 (Qrecompute_lucid_menubar
);
1434 before_command_key_count
= this_command_key_count
;
1435 before_command_echo_length
= echo_length ();
1437 Vthis_command
= Qnil
;
1438 Vreal_this_command
= Qnil
;
1439 Vthis_original_command
= Qnil
;
1440 Vthis_command_keys_shift_translated
= Qnil
;
1442 /* Read next key sequence; i gets its length. */
1443 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1446 /* A filter may have run while we were reading the input. */
1447 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1449 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1453 /* Now we have read a key sequence of length I,
1454 or else I is 0 and we found end of file. */
1456 if (i
== 0) /* End of file -- happens only in */
1457 return Qnil
; /* a kbd macro, at the end. */
1458 /* -1 means read_key_sequence got a menu that was rejected.
1459 Just loop around and read another command. */
1463 this_command_key_count
= 0;
1464 this_command_key_count_reset
= 0;
1465 this_single_command_key_start
= 0;
1469 last_command_event
= keybuf
[i
- 1];
1471 /* If the previous command tried to force a specific window-start,
1472 forget about that, in case this command moves point far away
1473 from that position. But also throw away beg_unchanged and
1474 end_unchanged information in that case, so that redisplay will
1475 update the whole window properly. */
1476 if (XWINDOW (selected_window
)->force_start
)
1479 XWINDOW (selected_window
)->force_start
= 0;
1480 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1481 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1484 cmd
= read_key_sequence_cmd
;
1485 if (!NILP (Vexecuting_kbd_macro
))
1487 if (!NILP (Vquit_flag
))
1489 Vexecuting_kbd_macro
= Qt
;
1490 QUIT
; /* Make some noise. */
1491 /* Will return since macro now empty. */
1495 /* Do redisplay processing after this command except in special
1496 cases identified below. */
1497 prev_buffer
= current_buffer
;
1498 prev_modiff
= MODIFF
;
1499 last_point_position
= PT
;
1501 /* By default, we adjust point to a boundary of a region that
1502 has such a property that should be treated intangible
1503 (e.g. composition, display). But, some commands will set
1504 this variable differently. */
1505 Vdisable_point_adjustment
= Qnil
;
1507 /* Process filters and timers may have messed with deactivate-mark.
1508 reset it before we execute the command. */
1509 Vdeactivate_mark
= Qnil
;
1511 /* Remap command through active keymaps. */
1512 Vthis_original_command
= cmd
;
1513 if (!NILP (read_key_sequence_remapped
))
1514 cmd
= read_key_sequence_remapped
;
1516 /* Execute the command. */
1518 Vthis_command
= cmd
;
1519 Vreal_this_command
= cmd
;
1520 safe_run_hooks (Qpre_command_hook
);
1522 already_adjusted
= 0;
1524 if (NILP (Vthis_command
))
1525 /* nil means key is undefined. */
1529 /* Here for a command that isn't executed directly. */
1531 #ifdef HAVE_WINDOW_SYSTEM
1532 ptrdiff_t scount
= SPECPDL_INDEX ();
1534 if (display_hourglass_p
1535 && NILP (Vexecuting_kbd_macro
))
1537 record_unwind_protect_void (cancel_hourglass
);
1542 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1544 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1547 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1548 ? Qnil
: BVAR (current_buffer
, undo_list
));
1550 call1 (Qcommand_execute
, Vthis_command
);
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 /* Do not check display_hourglass_p here, because
1554 `command-execute' could change it, but we should cancel
1555 hourglass cursor anyway.
1556 But don't cancel the hourglass within a macro
1557 just because a command in the macro finishes. */
1558 if (NILP (Vexecuting_kbd_macro
))
1559 unbind_to (scount
, Qnil
);
1562 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1564 safe_run_hooks (Qpost_command_hook
);
1566 /* If displaying a message, resize the echo area window to fit
1567 that message's size exactly. */
1568 if (!NILP (echo_area_buffer
[0]))
1569 resize_echo_area_exactly ();
1571 /* If there are warnings waiting, process them. */
1572 if (!NILP (Vdelayed_warnings_list
))
1573 safe_run_hooks (Qdelayed_warnings_hook
);
1575 safe_run_hooks (Qdeferred_action_function
);
1577 /* If there is a prefix argument,
1578 1) We don't want Vlast_command to be ``universal-argument''
1579 (that would be dumb), so don't set Vlast_command,
1580 2) we want to leave echoing on so that the prefix will be
1581 echoed as part of this key sequence, so don't call
1583 3) we want to leave this_command_key_count non-zero, so that
1584 read_char will realize that it is re-reading a character, and
1585 not echo it a second time.
1587 If the command didn't actually create a prefix arg,
1588 but is merely a frame event that is transparent to prefix args,
1589 then the above doesn't apply. */
1590 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1591 || CONSP (last_command_event
))
1593 kset_last_command (current_kboard
, Vthis_command
);
1594 kset_real_last_command (current_kboard
, Vreal_this_command
);
1595 if (!CONSP (last_command_event
))
1596 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1598 this_command_key_count
= 0;
1599 this_command_key_count_reset
= 0;
1600 this_single_command_key_start
= 0;
1603 if (!NILP (BVAR (current_buffer
, mark_active
))
1604 && !NILP (Vrun_hooks
))
1606 /* In Emacs 22, setting transient-mark-mode to `only' was a
1607 way of turning it on for just one command. This usage is
1608 obsolete, but support it anyway. */
1609 if (EQ (Vtransient_mark_mode
, Qidentity
))
1610 Vtransient_mark_mode
= Qnil
;
1611 else if (EQ (Vtransient_mark_mode
, Qonly
))
1612 Vtransient_mark_mode
= Qidentity
;
1614 if (!NILP (Vdeactivate_mark
))
1615 /* If `select-active-regions' is non-nil, this call to
1616 `deactivate-mark' also sets the PRIMARY selection. */
1617 call0 (Qdeactivate_mark
);
1620 /* Even if not deactivating the mark, set PRIMARY if
1621 `select-active-regions' is non-nil. */
1622 if (!NILP (Fwindow_system (Qnil
))
1623 /* Even if mark_active is non-nil, the actual buffer
1624 marker may not have been set yet (Bug#7044). */
1625 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1626 && (EQ (Vselect_active_regions
, Qonly
)
1627 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1628 : (!NILP (Vselect_active_regions
)
1629 && !NILP (Vtransient_mark_mode
)))
1630 && NILP (Fmemq (Vthis_command
,
1631 Vselection_inhibit_update_commands
)))
1634 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1635 if (XINT (Flength (txt
)) > 0)
1636 /* Don't set empty selections. */
1637 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1640 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1642 Lisp_Object hook
= intern ("activate-mark-hook");
1643 Frun_hooks (1, &hook
);
1647 Vsaved_region_selection
= Qnil
;
1652 if (current_buffer
== prev_buffer
1653 && last_point_position
!= PT
1654 && NILP (Vdisable_point_adjustment
)
1655 && NILP (Vglobal_disable_point_adjustment
))
1657 if (last_point_position
> BEGV
1658 && last_point_position
< ZV
1659 && (composition_adjust_point (last_point_position
,
1660 last_point_position
)
1661 != last_point_position
))
1662 /* The last point was temporarily set within a grapheme
1663 cluster to prevent automatic composition. To recover
1664 the automatic composition, we must update the
1666 windows_or_buffers_changed
= 21;
1667 if (!already_adjusted
)
1668 adjust_point_for_property (last_point_position
,
1669 MODIFF
!= prev_modiff
);
1672 /* Install chars successfully executed in kbd macro. */
1674 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1675 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1676 finalize_kbd_macro_chars ();
1681 read_menu_command (void)
1683 Lisp_Object keybuf
[30];
1684 ptrdiff_t count
= SPECPDL_INDEX ();
1687 /* We don't want to echo the keystrokes while navigating the
1689 specbind (Qecho_keystrokes
, make_number (0));
1691 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1694 unbind_to (count
, Qnil
);
1696 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1698 if (i
== 0 || i
== -1)
1701 return read_key_sequence_cmd
;
1704 /* Adjust point to a boundary of a region that has such a property
1705 that should be treated intangible. For the moment, we check
1706 `composition', `display' and `invisible' properties.
1707 LAST_PT is the last position of point. */
1710 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1713 Lisp_Object val
, overlay
, tmp
;
1714 /* When called after buffer modification, we should temporarily
1715 suppress the point adjustment for automatic composition so that a
1716 user can keep inserting another character at point or keep
1717 deleting characters around point. */
1718 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1719 ptrdiff_t orig_pt
= PT
;
1721 /* FIXME: cycling is probably not necessary because these properties
1722 can't be usefully combined anyway. */
1723 while (check_composition
|| check_display
|| check_invisible
)
1725 /* FIXME: check `intangible'. */
1726 if (check_composition
1727 && PT
> BEGV
&& PT
< ZV
1728 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1731 check_display
= check_invisible
= 1;
1733 check_composition
= 0;
1735 && PT
> BEGV
&& PT
< ZV
1736 && !NILP (val
= get_char_property_and_overlay
1737 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1738 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1739 && (!OVERLAYP (overlay
)
1740 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1741 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1742 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1743 && (beg
< PT
/* && end > PT <- It's always the case. */
1744 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1747 SET_PT (PT
< last_pt
1748 ? (STRINGP (val
) && SCHARS (val
) == 0
1749 ? max (beg
- 1, BEGV
)
1752 check_composition
= check_invisible
= 1;
1755 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1761 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1764 /* FIXME: We should stop if we find a spot between
1765 two runs of `invisible' where inserted text would
1766 be visible. This is important when we have two
1767 invisible boundaries that enclose an area: if the
1768 area is empty, we need this test in order to make
1769 it possible to place point in the middle rather
1770 than skip both boundaries. However, this code
1771 also stops anywhere in a non-sticky text-property,
1772 which breaks (e.g.) Org mode. */
1773 && (val
= Fget_pos_property (make_number (end
),
1775 TEXT_PROP_MEANS_INVISIBLE (val
))
1777 && !NILP (val
= get_char_property_and_overlay
1778 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1779 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1781 ellipsis
= ellipsis
|| inv
> 1
1782 || (OVERLAYP (overlay
)
1783 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1784 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1785 tmp
= Fnext_single_char_property_change
1786 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1787 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1791 && (val
= Fget_pos_property (make_number (beg
),
1793 TEXT_PROP_MEANS_INVISIBLE (val
))
1795 && !NILP (val
= get_char_property_and_overlay
1796 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1797 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1799 ellipsis
= ellipsis
|| inv
> 1
1800 || (OVERLAYP (overlay
)
1801 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1802 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1803 tmp
= Fprevious_single_char_property_change
1804 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1805 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1808 /* Move away from the inside area. */
1809 if (beg
< PT
&& end
> PT
)
1811 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1812 /* We haven't moved yet (so we don't need to fear
1813 infinite-looping) and we were outside the range
1814 before (so either end of the range still corresponds
1815 to a move in the right direction): pretend we moved
1816 less than we actually did, so that we still have
1817 more freedom below in choosing which end of the range
1819 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1820 /* We either have moved already or the last point
1821 was already in the range: we don't get to choose
1822 which end of the range we have to go to. */
1823 : (PT
< last_pt
? beg
: end
));
1824 check_composition
= check_display
= 1;
1826 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1827 the point to something other than its argument, due to
1828 point-motion hooks, intangibility, etc. */
1829 eassert (PT
== beg
|| PT
== end
);
1832 /* Pretend the area doesn't exist if the buffer is not
1834 if (!modified
&& !ellipsis
&& beg
< end
)
1836 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1837 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1838 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1839 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1840 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1841 /* We've already moved as far as we can. Trying to go
1842 to the other end would mean moving backwards and thus
1843 could lead to an infinite loop. */
1845 else if (val
= Fget_pos_property (make_number (PT
),
1847 TEXT_PROP_MEANS_INVISIBLE (val
)
1848 && (val
= (Fget_pos_property
1849 (make_number (PT
== beg
? end
: beg
),
1851 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1852 (check_composition
= check_display
= 1,
1853 SET_PT (PT
== beg
? end
: beg
));
1856 check_invisible
= 0;
1860 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1863 safe_run_hooks_1 (void)
1865 eassert (CONSP (Vinhibit_quit
));
1866 return call0 (XCDR (Vinhibit_quit
));
1869 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1873 safe_run_hooks_error (Lisp_Object error_data
)
1876 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1877 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1878 Lisp_Object args
[4];
1879 args
[0] = build_string ("Error in %s (%S): %S");
1882 args
[3] = error_data
;
1888 Lisp_Object newval
= Qnil
;
1889 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1890 if (EQ (fun
, XCAR (val
)))
1893 newval
= Fcons (XCAR (val
), newval
);
1895 return Fset (hook
, Fnreverse (newval
));
1896 /* Not found in the local part of the hook. Let's look at the global
1899 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1900 : Fdefault_value (hook
));
1901 CONSP (val
); val
= XCDR (val
))
1902 if (EQ (fun
, XCAR (val
)))
1905 newval
= Fcons (XCAR (val
), newval
);
1907 return Fset_default (hook
, Fnreverse (newval
));
1913 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1915 eassert (nargs
== 1);
1916 if (CONSP (Vinhibit_quit
))
1917 XSETCDR (Vinhibit_quit
, args
[0]);
1919 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1921 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1925 /* If we get an error while running the hook, cause the hook variable
1926 to be nil. Also inhibit quits, so that C-g won't cause the hook
1927 to mysteriously evaporate. */
1930 safe_run_hooks (Lisp_Object hook
)
1932 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1933 to its body or to its handlers other than via globals such as
1934 dynamically-bound variables ;-) */
1935 ptrdiff_t count
= SPECPDL_INDEX ();
1936 specbind (Qinhibit_quit
, hook
);
1938 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1940 unbind_to (count
, Qnil
);
1944 /* Nonzero means polling for input is temporarily suppressed. */
1946 int poll_suppress_count
;
1949 #ifdef POLL_FOR_INPUT
1951 /* Asynchronous timer for polling. */
1953 static struct atimer
*poll_timer
;
1955 /* Poll for input, so that we catch a C-g if it comes in. */
1957 poll_for_input_1 (void)
1959 if (! input_blocked_p ()
1960 && !waiting_for_input
)
1964 /* Timer callback function for poll_timer. TIMER is equal to
1968 poll_for_input (struct atimer
*timer
)
1970 if (poll_suppress_count
== 0)
1971 pending_signals
= 1;
1974 #endif /* POLL_FOR_INPUT */
1976 /* Begin signals to poll for input, if they are appropriate.
1977 This function is called unconditionally from various places. */
1980 start_polling (void)
1982 #ifdef POLL_FOR_INPUT
1983 /* XXX This condition was (read_socket_hook && !interrupt_input),
1984 but read_socket_hook is not global anymore. Let's pretend that
1986 if (!interrupt_input
)
1988 /* Turn alarm handling on unconditionally. It might have
1989 been turned off in process.c. */
1990 turn_on_atimers (1);
1992 /* If poll timer doesn't exist, or we need one with
1993 a different interval, start a new one. */
1994 if (poll_timer
== NULL
1995 || poll_timer
->interval
.tv_sec
!= polling_period
)
1997 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1998 struct timespec interval
= make_timespec (period
, 0);
2001 cancel_atimer (poll_timer
);
2003 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2004 poll_for_input
, NULL
);
2007 /* Let the timer's callback function poll for input
2008 if this becomes zero. */
2009 --poll_suppress_count
;
2014 /* True if we are using polling to handle input asynchronously. */
2017 input_polling_used (void)
2019 #ifdef POLL_FOR_INPUT
2020 /* XXX This condition was (read_socket_hook && !interrupt_input),
2021 but read_socket_hook is not global anymore. Let's pretend that
2023 return !interrupt_input
;
2029 /* Turn off polling. */
2034 #ifdef POLL_FOR_INPUT
2035 /* XXX This condition was (read_socket_hook && !interrupt_input),
2036 but read_socket_hook is not global anymore. Let's pretend that
2038 if (!interrupt_input
)
2039 ++poll_suppress_count
;
2043 /* Set the value of poll_suppress_count to COUNT
2044 and start or stop polling accordingly. */
2047 set_poll_suppress_count (int count
)
2049 #ifdef POLL_FOR_INPUT
2050 if (count
== 0 && poll_suppress_count
!= 0)
2052 poll_suppress_count
= 1;
2055 else if (count
!= 0 && poll_suppress_count
== 0)
2059 poll_suppress_count
= count
;
2063 /* Bind polling_period to a value at least N.
2064 But don't decrease it. */
2067 bind_polling_period (int n
)
2069 #ifdef POLL_FOR_INPUT
2070 EMACS_INT
new = polling_period
;
2075 stop_other_atimers (poll_timer
);
2077 specbind (Qpolling_period
, make_number (new));
2078 /* Start a new alarm with the new period. */
2083 /* Apply the control modifier to CHARACTER. */
2086 make_ctrl_char (int c
)
2088 /* Save the upper bits here. */
2089 int upper
= c
& ~0177;
2091 if (! ASCII_BYTE_P (c
))
2092 return c
|= ctrl_modifier
;
2096 /* Everything in the columns containing the upper-case letters
2097 denotes a control character. */
2098 if (c
>= 0100 && c
< 0140)
2102 /* Set the shift modifier for a control char
2103 made from a shifted letter. But only for letters! */
2104 if (oc
>= 'A' && oc
<= 'Z')
2105 c
|= shift_modifier
;
2108 /* The lower-case letters denote control characters too. */
2109 else if (c
>= 'a' && c
<= 'z')
2112 /* Include the bits for control and shift
2113 only if the basic ASCII code can't indicate them. */
2117 /* Replace the high bits. */
2118 c
|= (upper
& ~ctrl_modifier
);
2123 /* Display the help-echo property of the character after the mouse pointer.
2124 Either show it in the echo area, or call show-help-function to display
2125 it by other means (maybe in a tooltip).
2127 If HELP is nil, that means clear the previous help echo.
2129 If HELP is a string, display that string. If HELP is a function,
2130 call it with OBJECT and POS as arguments; the function should
2131 return a help string or nil for none. For all other types of HELP,
2132 evaluate it to obtain a string.
2134 WINDOW is the window in which the help was generated, if any.
2135 It is nil if not in a window.
2137 If OBJECT is a buffer, POS is the position in the buffer where the
2138 `help-echo' text property was found.
2140 If OBJECT is an overlay, that overlay has a `help-echo' property,
2141 and POS is the position in the overlay's buffer under the mouse.
2143 If OBJECT is a string (an overlay string or a string displayed with
2144 the `display' property). POS is the position in that string under
2147 Note: this function may only be called with HELP nil or a string
2148 from X code running asynchronously. */
2151 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2154 if (!NILP (help
) && !STRINGP (help
))
2156 if (FUNCTIONP (help
))
2157 help
= safe_call (4, help
, window
, object
, pos
);
2159 help
= safe_eval (help
);
2161 if (!STRINGP (help
))
2165 if (!noninteractive
&& STRINGP (help
))
2167 /* The mouse-fixup-help-message Lisp function can call
2168 mouse_position_hook, which resets the mouse_moved flags.
2169 This causes trouble if we are trying to read a mouse motion
2170 event (i.e., if we are inside a `track-mouse' form), so we
2171 restore the mouse_moved flag. */
2172 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2173 help
= call1 (Qmouse_fixup_help_message
, help
);
2178 if (STRINGP (help
) || NILP (help
))
2180 if (!NILP (Vshow_help_function
))
2181 call1 (Vshow_help_function
, help
);
2182 help_echo_showing_p
= STRINGP (help
);
2188 /* Input of single characters from keyboard */
2190 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2191 struct timespec
*end_time
);
2192 static void record_char (Lisp_Object c
);
2194 static Lisp_Object help_form_saved_window_configs
;
2196 read_char_help_form_unwind (void)
2198 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2199 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2200 if (!NILP (window_config
))
2201 Fset_window_configuration (window_config
);
2204 #define STOP_POLLING \
2205 do { if (! polling_stopped_here) stop_polling (); \
2206 polling_stopped_here = 1; } while (0)
2208 #define RESUME_POLLING \
2209 do { if (polling_stopped_here) start_polling (); \
2210 polling_stopped_here = 0; } while (0)
2213 read_event_from_main_queue (struct timespec
*end_time
,
2214 sys_jmp_buf local_getcjmp
,
2215 bool *used_mouse_menu
)
2217 Lisp_Object c
= Qnil
;
2218 sys_jmp_buf save_jump
;
2219 KBOARD
*kb
IF_LINT (= NULL
);
2223 /* Read from the main queue, and if that gives us something we can't use yet,
2224 we put it on the appropriate side queue and try again. */
2226 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2229 /* Actually read a character, waiting if necessary. */
2230 save_getcjmp (save_jump
);
2231 restore_getcjmp (local_getcjmp
);
2233 timer_start_idle ();
2234 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2235 restore_getcjmp (save_jump
);
2237 if (! NILP (c
) && (kb
!= current_kboard
))
2239 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2242 while (CONSP (XCDR (last
)))
2244 if (!NILP (XCDR (last
)))
2248 kset_kbd_queue (kb
, list1 (c
));
2250 XSETCDR (last
, list1 (c
));
2251 kb
->kbd_queue_has_data
= 1;
2255 current_kboard
= kb
;
2256 /* This is going to exit from read_char
2257 so we had better get rid of this frame's stuff. */
2258 return make_number (-2);
2261 /* Terminate Emacs in batch mode if at eof. */
2262 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2263 Fkill_emacs (make_number (1));
2267 /* Add in any extra modifiers, where appropriate. */
2268 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2269 || ((extra_keyboard_modifiers
& 0177) < ' '
2270 && (extra_keyboard_modifiers
& 0177) != 0))
2271 XSETINT (c
, make_ctrl_char (XINT (c
)));
2273 /* Transfer any other modifier bits directly from
2274 extra_keyboard_modifiers to c. Ignore the actual character code
2275 in the low 16 bits of extra_keyboard_modifiers. */
2276 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2284 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2287 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2288 sys_jmp_buf local_getcjmp
,
2289 Lisp_Object prev_event
,
2290 bool *used_mouse_menu
)
2292 #define MAX_ENCODED_BYTES 16
2294 Lisp_Object events
[MAX_ENCODED_BYTES
];
2300 = read_event_from_main_queue (end_time
, local_getcjmp
,
2303 /* w32_console already returns decoded events. It either reads
2304 Unicode characters from the Windows keyboard input, or
2305 converts characters encoded in the current codepage into
2306 Unicode. See w32inevt.c:key_event, near its end. */
2309 struct frame
*frame
= XFRAME (selected_frame
);
2310 struct terminal
*terminal
= frame
->terminal
;
2311 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2312 /* Don't apply decoding if we're just reading a raw event
2313 (e.g. reading bytes sent by the xterm to specify the position
2314 of a mouse click). */
2315 && (!EQ (prev_event
, Qt
))
2316 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2317 & CODING_REQUIRE_DECODING_MASK
)))
2318 return nextevt
; /* No decoding needed. */
2321 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2322 eassert (n
< MAX_ENCODED_BYTES
);
2323 events
[n
++] = nextevt
;
2324 if (NATNUMP (nextevt
)
2325 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2326 { /* An encoded byte sequence, let's try to decode it. */
2327 struct coding_system
*coding
2328 = TERMINAL_KEYBOARD_CODING (terminal
);
2329 unsigned char *src
= alloca (n
);
2331 for (i
= 0; i
< n
; i
++)
2332 src
[i
] = XINT (events
[i
]);
2334 for (i
= 0; i
< n
; i
++)
2336 coding
->destination
= alloca (n
* 4);
2337 coding
->dst_bytes
= n
* 4;
2338 decode_coding_c_string (coding
, src
, n
, Qnil
);
2339 eassert (coding
->produced_char
<= n
);
2340 if (coding
->produced_char
== 0)
2341 { /* The encoded sequence is incomplete. */
2342 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2343 continue; /* Read on! */
2347 const unsigned char *p
= coding
->destination
;
2348 eassert (coding
->carryover_bytes
== 0);
2350 while (n
< coding
->produced_char
)
2351 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2354 /* Now `events' should hold decoded events.
2355 Normally, n should be equal to 1, but better not rely on it.
2356 We can only return one event here, so return the first we
2357 had and keep the others (if any) for later. */
2359 Vunread_command_events
2360 = Fcons (events
[--n
], Vunread_command_events
);
2368 echo_keystrokes_p (void)
2370 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2371 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2374 /* Read a character from the keyboard; call the redisplay if needed. */
2375 /* commandflag 0 means do not autosave, but do redisplay.
2376 -1 means do not redisplay, but do autosave.
2377 -2 means do neither.
2380 /* The argument MAP is a keymap for menu prompting.
2382 PREV_EVENT is the previous input event, or nil if we are reading
2383 the first event of a key sequence (or not reading a key sequence).
2384 If PREV_EVENT is t, that is a "magic" value that says
2385 not to run input methods, but in other respects to act as if
2386 not reading a key sequence.
2388 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2389 if we used a mouse menu to read the input, or false otherwise. If
2390 USED_MOUSE_MENU is null, don't dereference it.
2392 Value is -2 when we find input on another keyboard. A second call
2393 to read_char will read it.
2395 If END_TIME is non-null, it is a pointer to a struct timespec
2396 specifying the maximum time to wait until. If no input arrives by
2397 that time, stop waiting and return nil.
2399 Value is t if we showed a menu and the user rejected it. */
2402 read_char (int commandflag
, Lisp_Object map
,
2403 Lisp_Object prev_event
,
2404 bool *used_mouse_menu
, struct timespec
*end_time
)
2408 sys_jmp_buf local_getcjmp
;
2409 sys_jmp_buf save_jump
;
2410 Lisp_Object tem
, save
;
2411 volatile Lisp_Object previous_echo_area_message
;
2412 volatile Lisp_Object also_record
;
2413 volatile bool reread
;
2414 struct gcpro gcpro1
, gcpro2
;
2415 bool volatile polling_stopped_here
= 0;
2416 struct kboard
*orig_kboard
= current_kboard
;
2420 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2421 before_command_key_count
= this_command_key_count
;
2422 before_command_echo_length
= echo_length ();
2425 previous_echo_area_message
= Qnil
;
2427 GCPRO2 (c
, previous_echo_area_message
);
2431 if (CONSP (Vunread_post_input_method_events
))
2433 c
= XCAR (Vunread_post_input_method_events
);
2434 Vunread_post_input_method_events
2435 = XCDR (Vunread_post_input_method_events
);
2437 /* Undo what read_char_x_menu_prompt did when it unread
2438 additional keys returned by Fx_popup_menu. */
2440 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2451 if (CONSP (Vunread_command_events
))
2453 bool was_disabled
= 0;
2455 c
= XCAR (Vunread_command_events
);
2456 Vunread_command_events
= XCDR (Vunread_command_events
);
2458 /* Undo what sit-for did when it unread additional keys
2459 inside universal-argument. */
2461 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2466 /* Undo what read_char_x_menu_prompt did when it unread
2467 additional keys returned by Fx_popup_menu. */
2469 && EQ (XCDR (c
), Qdisabled
)
2470 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2476 /* If the queued event is something that used the mouse,
2477 set used_mouse_menu accordingly. */
2479 /* Also check was_disabled so last-nonmenu-event won't return
2480 a bad value when submenus are involved. (Bug#447) */
2481 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2482 *used_mouse_menu
= 1;
2484 goto reread_for_input_method
;
2487 if (CONSP (Vunread_input_method_events
))
2489 c
= XCAR (Vunread_input_method_events
);
2490 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2492 /* Undo what read_char_x_menu_prompt did when it unread
2493 additional keys returned by Fx_popup_menu. */
2495 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2499 goto reread_for_input_method
;
2502 this_command_key_count_reset
= 0;
2504 if (!NILP (Vexecuting_kbd_macro
))
2506 /* We set this to Qmacro; since that's not a frame, nobody will
2507 try to switch frames on us, and the selected window will
2510 Since this event came from a macro, it would be misleading to
2511 leave internal_last_event_frame set to wherever the last
2512 real event came from. Normally, a switch-frame event selects
2513 internal_last_event_frame after each command is read, but
2514 events read from a macro should never cause a new frame to be
2516 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2518 /* Exit the macro if we are at the end.
2519 Also, some things replace the macro with t
2520 to force an early exit. */
2521 if (EQ (Vexecuting_kbd_macro
, Qt
)
2522 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2528 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2529 if (STRINGP (Vexecuting_kbd_macro
)
2530 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2531 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2533 executing_kbd_macro_index
++;
2538 if (!NILP (unread_switch_frame
))
2540 c
= unread_switch_frame
;
2541 unread_switch_frame
= Qnil
;
2543 /* This event should make it into this_command_keys, and get echoed
2544 again, so we do not set `reread'. */
2548 /* If redisplay was requested. */
2549 if (commandflag
>= 0)
2551 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2553 /* If there is pending input, process any events which are not
2554 user-visible, such as X selection_request events. */
2556 || detect_input_pending_run_timers (0))
2557 swallow_events (0); /* May clear input_pending. */
2559 /* Redisplay if no pending input. */
2560 while (!input_pending
)
2562 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2563 redisplay_preserve_echo_area (5);
2568 /* Normal case: no input arrived during redisplay. */
2571 /* Input arrived and pre-empted redisplay.
2572 Process any events which are not user-visible. */
2574 /* If that cleared input_pending, try again to redisplay. */
2577 /* Prevent the redisplay we just did
2578 from messing up echoing of the input after the prompt. */
2579 if (commandflag
== 0 && echo_current
)
2580 echo_message_buffer
= echo_area_buffer
[0];
2584 /* Message turns off echoing unless more keystrokes turn it on again.
2586 The code in 20.x for the condition was
2588 1. echo_area_glyphs && *echo_area_glyphs
2589 2. && echo_area_glyphs != current_kboard->echobuf
2590 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2592 (1) means there's a current message displayed
2594 (2) means it's not the message from echoing from the current
2597 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2598 is set to a non-null value. This is done in read_char and it is
2599 set to echo_area_glyphs after a call to echo_char. That means
2600 ok_to_echo_at_next_pause is either null or
2601 current_kboard->echobuf with the appropriate current_kboard at
2604 So, condition (3) means in clear text ok_to_echo_at_next_pause
2605 must be either null, or the current message isn't from echoing at
2606 all, or it's from echoing from a different kboard than the
2609 if (/* There currently is something in the echo area. */
2610 !NILP (echo_area_buffer
[0])
2611 && (/* It's an echo from a different kboard. */
2612 echo_kboard
!= current_kboard
2613 /* Or we explicitly allow overwriting whatever there is. */
2614 || ok_to_echo_at_next_pause
== NULL
))
2619 /* Try reading a character via menu prompting in the minibuf.
2620 Try this before the sit-for, because the sit-for
2621 would do the wrong thing if we are supposed to do
2622 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2623 after a mouse event so don't try a minibuf menu. */
2625 if (KEYMAPP (map
) && INTERACTIVE
2626 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2627 /* Don't bring up a menu if we already have another event. */
2628 && NILP (Vunread_command_events
)
2629 && !detect_input_pending_run_timers (0))
2631 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2633 if (INTEGERP (c
) && XINT (c
) == -2)
2634 return c
; /* wrong_kboard_jmpbuf */
2640 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2641 We will do that below, temporarily for short sections of code,
2642 when appropriate. local_getcjmp must be in effect
2643 around any call to sit_for or kbd_buffer_get_event;
2644 it *must not* be in effect when we call redisplay. */
2646 jmpcount
= SPECPDL_INDEX ();
2647 if (sys_setjmp (local_getcjmp
))
2649 /* Handle quits while reading the keyboard. */
2650 /* We must have saved the outer value of getcjmp here,
2651 so restore it now. */
2652 restore_getcjmp (save_jump
);
2653 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2654 unbind_to (jmpcount
, Qnil
);
2655 XSETINT (c
, quit_char
);
2656 internal_last_event_frame
= selected_frame
;
2657 Vlast_event_frame
= internal_last_event_frame
;
2658 /* If we report the quit char as an event,
2659 don't do so more than once. */
2660 if (!NILP (Vinhibit_quit
))
2664 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2665 if (kb
!= current_kboard
)
2667 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2668 /* We shouldn't get here if we were in single-kboard mode! */
2673 while (CONSP (XCDR (last
)))
2675 if (!NILP (XCDR (last
)))
2679 kset_kbd_queue (kb
, list1 (c
));
2681 XSETCDR (last
, list1 (c
));
2682 kb
->kbd_queue_has_data
= 1;
2683 current_kboard
= kb
;
2684 /* This is going to exit from read_char
2685 so we had better get rid of this frame's stuff. */
2687 return make_number (-2); /* wrong_kboard_jmpbuf */
2693 /* Start idle timers if no time limit is supplied. We don't do it
2694 if a time limit is supplied to avoid an infinite recursion in the
2695 situation where an idle timer calls `sit-for'. */
2698 timer_start_idle ();
2700 /* If in middle of key sequence and minibuffer not active,
2701 start echoing if enough time elapses. */
2703 if (minibuf_level
== 0
2705 && !current_kboard
->immediate_echo
2706 && this_command_key_count
> 0
2708 && echo_keystrokes_p ()
2709 && (/* No message. */
2710 NILP (echo_area_buffer
[0])
2711 /* Or empty message. */
2712 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2713 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2714 /* Or already echoing from same kboard. */
2715 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2716 /* Or not echoing before and echoing allowed. */
2717 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2719 /* After a mouse event, start echoing right away.
2720 This is because we are probably about to display a menu,
2721 and we don't want to delay before doing so. */
2722 if (EVENT_HAS_PARAMETERS (prev_event
))
2728 save_getcjmp (save_jump
);
2729 restore_getcjmp (local_getcjmp
);
2730 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2731 restore_getcjmp (save_jump
);
2733 && ! CONSP (Vunread_command_events
))
2738 /* Maybe auto save due to number of keystrokes. */
2740 if (commandflag
!= 0 && commandflag
!= -2
2741 && auto_save_interval
> 0
2742 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2743 && !detect_input_pending_run_timers (0))
2745 Fdo_auto_save (Qnil
, Qnil
);
2746 /* Hooks can actually change some buffers in auto save. */
2750 /* Try reading using an X menu.
2751 This is never confused with reading using the minibuf
2752 because the recursive call of read_char in read_char_minibuf_menu_prompt
2753 does not pass on any keymaps. */
2755 if (KEYMAPP (map
) && INTERACTIVE
2756 && !NILP (prev_event
)
2757 && EVENT_HAS_PARAMETERS (prev_event
)
2758 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2759 && !EQ (XCAR (prev_event
), Qtool_bar
)
2760 /* Don't bring up a menu if we already have another event. */
2761 && NILP (Vunread_command_events
))
2763 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2765 /* Now that we have read an event, Emacs is not idle. */
2772 /* Maybe autosave and/or garbage collect due to idleness. */
2774 if (INTERACTIVE
&& NILP (c
))
2777 ptrdiff_t buffer_size
;
2779 /* Slow down auto saves logarithmically in size of current buffer,
2780 and garbage collect while we're at it. */
2781 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2782 last_non_minibuf_size
= Z
- BEG
;
2783 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2785 while (buffer_size
> 64)
2786 delay_level
++, buffer_size
-= buffer_size
>> 2;
2787 if (delay_level
< 4) delay_level
= 4;
2788 /* delay_level is 4 for files under around 50k, 7 at 100k,
2789 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2791 /* Auto save if enough time goes by without input. */
2792 if (commandflag
!= 0 && commandflag
!= -2
2793 && num_nonmacro_input_events
> last_auto_save
2794 && INTEGERP (Vauto_save_timeout
)
2795 && XINT (Vauto_save_timeout
) > 0)
2798 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2800 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2801 timeout
= delay_level
* timeout
/ 4;
2802 save_getcjmp (save_jump
);
2803 restore_getcjmp (local_getcjmp
);
2804 tem0
= sit_for (make_number (timeout
), 1, 1);
2805 restore_getcjmp (save_jump
);
2808 && ! CONSP (Vunread_command_events
))
2810 Fdo_auto_save (Qnil
, Qnil
);
2815 /* If there is still no input available, ask for GC. */
2816 if (!detect_input_pending_run_timers (0))
2820 /* Notify the caller if an autosave hook, or a timer, sentinel or
2821 filter in the sit_for calls above have changed the current
2822 kboard. This could happen if they use the minibuffer or start a
2823 recursive edit, like the fancy splash screen in server.el's
2824 filter. If this longjmp wasn't here, read_key_sequence would
2825 interpret the next key sequence using the wrong translation
2826 tables and function keymaps. */
2827 if (NILP (c
) && current_kboard
!= orig_kboard
)
2830 return make_number (-2); /* wrong_kboard_jmpbuf */
2833 /* If this has become non-nil here, it has been set by a timer
2834 or sentinel or filter. */
2835 if (CONSP (Vunread_command_events
))
2837 c
= XCAR (Vunread_command_events
);
2838 Vunread_command_events
= XCDR (Vunread_command_events
);
2840 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2846 /* Read something from current KBOARD's side queue, if possible. */
2850 if (current_kboard
->kbd_queue_has_data
)
2852 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2854 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2855 kset_kbd_queue (current_kboard
,
2856 XCDR (KVAR (current_kboard
, kbd_queue
)));
2857 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2858 current_kboard
->kbd_queue_has_data
= 0;
2859 input_pending
= readable_events (0);
2860 if (EVENT_HAS_PARAMETERS (c
)
2861 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2862 internal_last_event_frame
= XCAR (XCDR (c
));
2863 Vlast_event_frame
= internal_last_event_frame
;
2867 /* If current_kboard's side queue is empty check the other kboards.
2868 If one of them has data that we have not yet seen here,
2869 switch to it and process the data waiting for it.
2871 Note: if the events queued up for another kboard
2872 have already been seen here, and therefore are not a complete command,
2873 the kbd_queue_has_data field is 0, so we skip that kboard here.
2874 That's to avoid an infinite loop switching between kboards here. */
2875 if (NILP (c
) && !single_kboard
)
2878 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2879 if (kb
->kbd_queue_has_data
)
2881 current_kboard
= kb
;
2882 /* This is going to exit from read_char
2883 so we had better get rid of this frame's stuff. */
2885 return make_number (-2); /* wrong_kboard_jmpbuf */
2895 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2896 prev_event
, used_mouse_menu
);
2897 if (NILP (c
) && end_time
2898 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2903 if (EQ (c
, make_number (-2)))
2905 /* This is going to exit from read_char
2906 so we had better get rid of this frame's stuff. */
2920 if (commandflag
>= 0
2921 && !input_pending
&& !detect_input_pending_run_timers (0))
2927 /* Buffer switch events are only for internal wakeups
2928 so don't show them to the user.
2929 Also, don't record a key if we already did. */
2933 /* Process special events within read_char
2934 and loop around to read another event. */
2937 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2942 struct buffer
*prev_buffer
= current_buffer
;
2943 last_input_event
= c
;
2944 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2946 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2947 /* We stopped being idle for this event; undo that. This
2948 prevents automatic window selection (under
2949 mouse_autoselect_window from acting as a real input event, for
2950 example banishing the mouse under mouse-avoidance-mode. */
2951 timer_resume_idle ();
2953 if (current_buffer
!= prev_buffer
)
2955 /* The command may have changed the keymaps. Pretend there
2956 is input in another keyboard and return. This will
2957 recalculate keymaps. */
2958 c
= make_number (-2);
2965 /* Handle things that only apply to characters. */
2968 /* If kbd_buffer_get_event gave us an EOF, return that. */
2972 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2973 && UNSIGNED_CMP (XFASTINT (c
), <,
2974 SCHARS (KVAR (current_kboard
,
2975 Vkeyboard_translate_table
))))
2976 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2977 && UNSIGNED_CMP (XFASTINT (c
), <,
2978 ASIZE (KVAR (current_kboard
,
2979 Vkeyboard_translate_table
))))
2980 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2984 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2985 /* nil in keyboard-translate-table means no translation. */
2991 /* If this event is a mouse click in the menu bar,
2992 return just menu-bar for now. Modify the mouse click event
2993 so we won't do this twice, then queue it up. */
2994 if (EVENT_HAS_PARAMETERS (c
)
2996 && CONSP (EVENT_START (c
))
2997 && CONSP (XCDR (EVENT_START (c
))))
3001 posn
= POSN_POSN (EVENT_START (c
));
3002 /* Handle menu-bar events:
3003 insert the dummy prefix event `menu-bar'. */
3004 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3006 /* Change menu-bar to (menu-bar) as the event "position". */
3007 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3010 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3015 /* Store these characters into recent_keys, the dribble file if any,
3016 and the keyboard macro being defined, if any. */
3018 if (! NILP (also_record
))
3019 record_char (also_record
);
3021 /* Wipe the echo area.
3022 But first, if we are about to use an input method,
3023 save the echo area contents for it to refer to. */
3025 && ! NILP (Vinput_method_function
)
3026 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3028 previous_echo_area_message
= Fcurrent_message ();
3029 Vinput_method_previous_message
= previous_echo_area_message
;
3032 /* Now wipe the echo area, except for help events which do their
3033 own stuff with the echo area. */
3035 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3036 && !(EQ (Qswitch_frame
, XCAR (c
)))
3037 /* Don't wipe echo area for select window events: These might
3038 get delayed via `mouse-autoselect-window' (Bug#11304). */
3039 && !(EQ (Qselect_window
, XCAR (c
)))))
3041 if (!NILP (echo_area_buffer
[0]))
3043 safe_run_hooks (Qecho_area_clear_hook
);
3044 clear_message (1, 0);
3048 reread_for_input_method
:
3050 /* Pass this to the input method, if appropriate. */
3052 && ! NILP (Vinput_method_function
)
3053 /* Don't run the input method within a key sequence,
3054 after the first event of the key sequence. */
3055 && NILP (prev_event
)
3056 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3059 ptrdiff_t key_count
;
3060 bool key_count_reset
;
3061 struct gcpro gcpro1
;
3062 ptrdiff_t count
= SPECPDL_INDEX ();
3064 /* Save the echo status. */
3065 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3066 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3067 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3068 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3071 if (before_command_restore_flag
)
3073 this_command_key_count
= before_command_key_count_1
;
3074 if (this_command_key_count
< this_single_command_key_start
)
3075 this_single_command_key_start
= this_command_key_count
;
3076 echo_truncate (before_command_echo_length_1
);
3077 before_command_restore_flag
= 0;
3081 /* Save the this_command_keys status. */
3082 key_count
= this_command_key_count
;
3083 key_count_reset
= this_command_key_count_reset
;
3086 keys
= Fcopy_sequence (this_command_keys
);
3091 /* Clear out this_command_keys. */
3092 this_command_key_count
= 0;
3093 this_command_key_count_reset
= 0;
3095 /* Now wipe the echo area. */
3096 if (!NILP (echo_area_buffer
[0]))
3097 safe_run_hooks (Qecho_area_clear_hook
);
3098 clear_message (1, 0);
3101 /* If we are not reading a key sequence,
3102 never use the echo area. */
3105 specbind (Qinput_method_use_echo_area
, Qt
);
3108 /* Call the input method. */
3109 tem
= call1 (Vinput_method_function
, c
);
3111 tem
= unbind_to (count
, tem
);
3113 /* Restore the saved echoing state
3114 and this_command_keys state. */
3115 this_command_key_count
= key_count
;
3116 this_command_key_count_reset
= key_count_reset
;
3118 this_command_keys
= keys
;
3121 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3122 kset_echo_string (current_kboard
, saved_echo_string
);
3123 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3124 if (saved_immediate_echo
)
3129 /* The input method can return no events. */
3132 /* Bring back the previous message, if any. */
3133 if (! NILP (previous_echo_area_message
))
3134 message_with_string ("%s", previous_echo_area_message
, 0);
3137 /* It returned one event or more. */
3139 Vunread_post_input_method_events
3140 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3145 /* Display help if not echoing. */
3146 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3148 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3149 Lisp_Object help
, object
, position
, window
, htem
;
3151 htem
= Fcdr (XCDR (c
));
3154 window
= Fcar (htem
);
3156 object
= Fcar (htem
);
3158 position
= Fcar (htem
);
3160 show_help_echo (help
, window
, object
, position
);
3162 /* We stopped being idle for this event; undo that. */
3164 timer_resume_idle ();
3168 if ((! reread
|| this_command_key_count
== 0
3169 || this_command_key_count_reset
)
3173 /* Don't echo mouse motion events. */
3174 if (echo_keystrokes_p ()
3175 && ! (EVENT_HAS_PARAMETERS (c
)
3176 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3179 if (! NILP (also_record
))
3180 echo_char (also_record
);
3181 /* Once we reread a character, echoing can happen
3182 the next time we pause to read a new one. */
3183 ok_to_echo_at_next_pause
= current_kboard
;
3186 /* Record this character as part of the current key. */
3187 add_command_key (c
);
3188 if (! NILP (also_record
))
3189 add_command_key (also_record
);
3192 last_input_event
= c
;
3195 /* Process the help character specially if enabled. */
3196 if (!NILP (Vhelp_form
) && help_char_p (c
))
3198 ptrdiff_t count
= SPECPDL_INDEX ();
3200 help_form_saved_window_configs
3201 = Fcons (Fcurrent_window_configuration (Qnil
),
3202 help_form_saved_window_configs
);
3203 record_unwind_protect_void (read_char_help_form_unwind
);
3204 call0 (Qhelp_form_show
);
3209 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3210 if (EVENT_HAS_PARAMETERS (c
)
3211 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3212 XSETCAR (help_form_saved_window_configs
, Qnil
);
3214 while (BUFFERP (c
));
3215 /* Remove the help from the frame. */
3216 unbind_to (count
, Qnil
);
3219 if (EQ (c
, make_number (040)))
3223 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3224 while (BUFFERP (c
));
3233 /* Record a key that came from a mouse menu.
3234 Record it for echoing, for this-command-keys, and so on. */
3237 record_menu_key (Lisp_Object c
)
3239 /* Wipe the echo area. */
3240 clear_message (1, 0);
3245 before_command_key_count
= this_command_key_count
;
3246 before_command_echo_length
= echo_length ();
3249 /* Don't echo mouse motion events. */
3250 if (echo_keystrokes_p ())
3254 /* Once we reread a character, echoing can happen
3255 the next time we pause to read a new one. */
3256 ok_to_echo_at_next_pause
= 0;
3259 /* Record this character as part of the current key. */
3260 add_command_key (c
);
3262 /* Re-reading in the middle of a command. */
3263 last_input_event
= c
;
3267 /* Return true if should recognize C as "the help character". */
3270 help_char_p (Lisp_Object c
)
3274 if (EQ (c
, Vhelp_char
))
3276 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3277 if (EQ (c
, XCAR (tail
)))
3282 /* Record the input event C in various ways. */
3285 record_char (Lisp_Object c
)
3289 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3291 /* To avoid filling recent_keys with help-echo and mouse-movement
3292 events, we filter out repeated help-echo events, only store the
3293 first and last in a series of mouse-movement events, and don't
3294 store repeated help-echo events which are only separated by
3295 mouse-movement events. */
3297 Lisp_Object ev1
, ev2
, ev3
;
3300 if ((ix1
= recent_keys_index
- 1) < 0)
3301 ix1
= NUM_RECENT_KEYS
- 1;
3302 ev1
= AREF (recent_keys
, ix1
);
3304 if ((ix2
= ix1
- 1) < 0)
3305 ix2
= NUM_RECENT_KEYS
- 1;
3306 ev2
= AREF (recent_keys
, ix2
);
3308 if ((ix3
= ix2
- 1) < 0)
3309 ix3
= NUM_RECENT_KEYS
- 1;
3310 ev3
= AREF (recent_keys
, ix3
);
3312 if (EQ (XCAR (c
), Qhelp_echo
))
3314 /* Don't record `help-echo' in recent_keys unless it shows some help
3315 message, and a different help than the previously recorded
3317 Lisp_Object help
, last_help
;
3319 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3320 if (!STRINGP (help
))
3322 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3323 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3325 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3326 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3327 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3329 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3330 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3331 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3332 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3335 else if (EQ (XCAR (c
), Qmouse_movement
))
3337 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3338 So additional mouse movement events replace the last element. */
3339 Lisp_Object last_window
, window
;
3341 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3342 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3343 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3344 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3345 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3347 ASET (recent_keys
, ix1
, c
);
3353 store_kbd_macro_char (c
);
3357 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3358 ASET (recent_keys
, recent_keys_index
, c
);
3359 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3360 recent_keys_index
= 0;
3362 else if (recorded
< 0)
3364 /* We need to remove one or two events from recent_keys.
3365 To do this, we simply put nil at those events and move the
3366 recent_keys_index backwards over those events. Usually,
3367 users will never see those nil events, as they will be
3368 overwritten by the command keys entered to see recent_keys
3371 while (recorded
++ < 0 && total_keys
> 0)
3373 if (total_keys
< NUM_RECENT_KEYS
)
3375 if (--recent_keys_index
< 0)
3376 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3377 ASET (recent_keys
, recent_keys_index
, Qnil
);
3381 num_nonmacro_input_events
++;
3383 /* Write c to the dribble file. If c is a lispy event, write
3384 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3385 If you, dear reader, have a better idea, you've got the source. :-) */
3391 if (XUINT (c
) < 0x100)
3392 putc (XUINT (c
), dribble
);
3394 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3398 Lisp_Object dribblee
;
3400 /* If it's a structured event, take the event header. */
3401 dribblee
= EVENT_HEAD (c
);
3403 if (SYMBOLP (dribblee
))
3405 putc ('<', dribble
);
3406 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3407 SBYTES (SYMBOL_NAME (dribblee
)),
3409 putc ('>', dribble
);
3418 /* Copy out or in the info on where C-g should throw to.
3419 This is used when running Lisp code from within get_char,
3420 in case get_char is called recursively.
3421 See read_process_output. */
3424 save_getcjmp (sys_jmp_buf temp
)
3426 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3430 restore_getcjmp (sys_jmp_buf temp
)
3432 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3435 /* Low level keyboard/mouse input.
3436 kbd_buffer_store_event places events in kbd_buffer, and
3437 kbd_buffer_get_event retrieves them. */
3439 /* Return true if there are any events in the queue that read-char
3440 would return. If this returns false, a read-char would block. */
3442 readable_events (int flags
)
3444 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3447 /* If the buffer contains only FOCUS_IN_EVENT events, and
3448 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3449 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3451 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3452 #ifdef USE_TOOLKIT_SCROLL_BARS
3453 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3457 struct input_event
*event
;
3459 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3466 #ifdef USE_TOOLKIT_SCROLL_BARS
3467 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3469 event
->kind
== FOCUS_IN_EVENT
)
3470 #ifdef USE_TOOLKIT_SCROLL_BARS
3471 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3472 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3473 && event
->part
== scroll_bar_handle
3474 && event
->modifiers
== 0)
3479 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3482 while (event
!= kbd_store_ptr
);
3488 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3489 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3493 if (current_kboard
->kbd_queue_has_data
)
3499 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3500 if (kb
->kbd_queue_has_data
)
3506 /* Set this for debugging, to have a way to get out */
3507 int stop_character EXTERNALLY_VISIBLE
;
3510 event_to_kboard (struct input_event
*event
)
3512 /* Not applicable for these special events. */
3513 if (event
->kind
== SELECTION_REQUEST_EVENT
3514 || event
->kind
== SELECTION_CLEAR_EVENT
)
3518 Lisp_Object obj
= event
->frame_or_window
;
3519 /* There are some events that set this field to nil or string. */
3521 obj
= WINDOW_FRAME (XWINDOW (obj
));
3522 /* Also ignore dead frames here. */
3523 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3524 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3529 /* Return the number of slots occupied in kbd_buffer. */
3532 kbd_buffer_nr_stored (void)
3534 return kbd_fetch_ptr
== kbd_store_ptr
3536 : (kbd_fetch_ptr
< kbd_store_ptr
3537 ? kbd_store_ptr
- kbd_fetch_ptr
3538 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3539 + (kbd_store_ptr
- kbd_buffer
)));
3541 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3544 kbd_buffer_store_event (register struct input_event
*event
)
3546 kbd_buffer_store_event_hold (event
, 0);
3549 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3551 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3552 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3553 Else, if EVENT is a quit event, store the quit event
3554 in HOLD_QUIT, and return (thus ignoring further events).
3556 This is used to postpone the processing of the quit event until all
3557 subsequent input events have been parsed (and discarded). */
3560 kbd_buffer_store_event_hold (register struct input_event
*event
,
3561 struct input_event
*hold_quit
)
3563 if (event
->kind
== NO_EVENT
)
3566 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3569 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3571 register int c
= event
->code
& 0377;
3573 if (event
->modifiers
& ctrl_modifier
)
3574 c
= make_ctrl_char (c
);
3576 c
|= (event
->modifiers
3577 & (meta_modifier
| alt_modifier
3578 | hyper_modifier
| super_modifier
));
3582 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3583 struct input_event
*sp
;
3585 if (single_kboard
&& kb
!= current_kboard
)
3588 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3590 kb
->kbd_queue_has_data
= 1;
3591 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3593 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3596 if (event_to_kboard (sp
) == kb
)
3598 sp
->kind
= NO_EVENT
;
3599 sp
->frame_or_window
= Qnil
;
3608 *hold_quit
= *event
;
3612 /* If this results in a quit_char being returned to Emacs as
3613 input, set Vlast_event_frame properly. If this doesn't
3614 get returned to Emacs as an event, the next event read
3615 will set Vlast_event_frame again, so this is safe to do. */
3619 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3621 focus
= event
->frame_or_window
;
3622 internal_last_event_frame
= focus
;
3623 Vlast_event_frame
= focus
;
3626 handle_interrupt (0);
3630 if (c
&& c
== stop_character
)
3636 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3637 Just ignore the second one. */
3638 else if (event
->kind
== BUFFER_SWITCH_EVENT
3639 && kbd_fetch_ptr
!= kbd_store_ptr
3640 && ((kbd_store_ptr
== kbd_buffer
3641 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3642 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3645 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3646 kbd_store_ptr
= kbd_buffer
;
3648 /* Don't let the very last slot in the buffer become full,
3649 since that would make the two pointers equal,
3650 and that is indistinguishable from an empty buffer.
3651 Discard the event if it would fill the last slot. */
3652 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3654 *kbd_store_ptr
= *event
;
3657 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3658 && ! kbd_on_hold_p ())
3660 /* Don't read keyboard input until we have processed kbd_buffer.
3661 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3662 hold_keyboard_input ();
3663 if (!noninteractive
)
3667 #endif /* subprocesses */
3670 /* If we're inside while-no-input, and this event qualifies
3671 as input, set quit-flag to cause an interrupt. */
3672 if (!NILP (Vthrow_on_input
)
3673 && event
->kind
!= FOCUS_IN_EVENT
3674 && event
->kind
!= HELP_EVENT
3675 && event
->kind
!= DEICONIFY_EVENT
)
3677 Vquit_flag
= Vthrow_on_input
;
3678 /* If we're inside a function that wants immediate quits,
3680 if (immediate_quit
&& NILP (Vinhibit_quit
))
3689 /* Put an input event back in the head of the event queue. */
3692 kbd_buffer_unget_event (register struct input_event
*event
)
3694 if (kbd_fetch_ptr
== kbd_buffer
)
3695 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3697 /* Don't let the very last slot in the buffer become full, */
3698 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3701 *kbd_fetch_ptr
= *event
;
3706 /* Generate a HELP_EVENT input_event and store it in the keyboard
3709 HELP is the help form.
3711 FRAME and WINDOW are the frame and window where the help is
3712 generated. OBJECT is the Lisp object where the help was found (a
3713 buffer, a string, an overlay, or nil if neither from a string nor
3714 from a buffer). POS is the position within OBJECT where the help
3718 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3719 Lisp_Object object
, ptrdiff_t pos
)
3721 struct input_event event
;
3725 event
.kind
= HELP_EVENT
;
3726 event
.frame_or_window
= frame
;
3728 event
.x
= WINDOWP (window
) ? window
: frame
;
3731 kbd_buffer_store_event (&event
);
3735 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3738 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3740 struct input_event event
;
3742 event
.kind
= HELP_EVENT
;
3743 event
.frame_or_window
= frame
;
3748 kbd_buffer_store_event (&event
);
3752 /* Discard any mouse events in the event buffer by setting them to
3755 discard_mouse_events (void)
3757 struct input_event
*sp
;
3758 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3760 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3763 if (sp
->kind
== MOUSE_CLICK_EVENT
3764 || sp
->kind
== WHEEL_EVENT
3765 || sp
->kind
== HORIZ_WHEEL_EVENT
3767 || sp
->kind
== GPM_CLICK_EVENT
3769 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3771 sp
->kind
= NO_EVENT
;
3777 /* Return true if there are any real events waiting in the event
3778 buffer, not counting `NO_EVENT's.
3780 Discard NO_EVENT events at the front of the input queue, possibly
3781 leaving the input queue empty if there are no real input events. */
3784 kbd_buffer_events_waiting (void)
3786 struct input_event
*sp
;
3788 for (sp
= kbd_fetch_ptr
;
3789 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3792 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3797 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3801 /* Clear input event EVENT. */
3804 clear_event (struct input_event
*event
)
3806 event
->kind
= NO_EVENT
;
3810 /* Read one event from the event buffer, waiting if necessary.
3811 The value is a Lisp object representing the event.
3812 The value is nil for an event that should be ignored,
3813 or that was handled here.
3814 We always read and discard one event. */
3817 kbd_buffer_get_event (KBOARD
**kbp
,
3818 bool *used_mouse_menu
,
3819 struct timespec
*end_time
)
3824 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3826 /* Start reading input again because we have processed enough to
3827 be able to accept new events again. */
3828 unhold_keyboard_input ();
3831 #endif /* subprocesses */
3833 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3835 /* In case we are running as a daemon, only do this before
3836 detaching from the terminal. */
3837 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3841 *kbp
= current_kboard
;
3844 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3846 /* Wait until there is input available. */
3849 /* Break loop if there's an unread command event. Needed in
3850 moused window autoselection which uses a timer to insert such
3852 if (CONSP (Vunread_command_events
))
3855 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3857 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3860 /* If the quit flag is set, then read_char will return
3861 quit_char, so that counts as "available input." */
3862 if (!NILP (Vquit_flag
))
3863 quit_throw_to_read_char (0);
3865 /* One way or another, wait until input is available; then, if
3866 interrupt handlers have not read it, read it now. */
3871 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3873 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3877 struct timespec now
= current_timespec ();
3878 if (timespec_cmp (*end_time
, now
) <= 0)
3879 return Qnil
; /* Finished waiting. */
3882 struct timespec duration
= timespec_sub (*end_time
, now
);
3883 wait_reading_process_output (min (duration
.tv_sec
,
3886 -1, 1, Qnil
, NULL
, 0);
3891 bool do_display
= true;
3893 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3895 struct tty_display_info
*tty
= CURTTY ();
3897 /* When this TTY is displaying a menu, we must prevent
3898 any redisplay, because we modify the frame's glyph
3899 matrix behind the back of the display engine. */
3900 if (tty
->showing_menu
)
3904 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3907 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3911 if (CONSP (Vunread_command_events
))
3914 first
= XCAR (Vunread_command_events
);
3915 Vunread_command_events
= XCDR (Vunread_command_events
);
3916 *kbp
= current_kboard
;
3920 /* At this point, we know that there is a readable event available
3921 somewhere. If the event queue is empty, then there must be a
3922 mouse movement enabled and available. */
3923 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3925 struct input_event
*event
;
3927 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3931 *kbp
= event_to_kboard (event
);
3933 *kbp
= current_kboard
; /* Better than returning null ptr? */
3937 /* These two kinds of events get special handling
3938 and don't actually appear to the command loop.
3939 We return nil for them. */
3940 if (event
->kind
== SELECTION_REQUEST_EVENT
3941 || event
->kind
== SELECTION_CLEAR_EVENT
)
3944 struct input_event copy
;
3946 /* Remove it from the buffer before processing it,
3947 since otherwise swallow_events will see it
3948 and process it again. */
3950 kbd_fetch_ptr
= event
+ 1;
3951 input_pending
= readable_events (0);
3952 x_handle_selection_event (©
);
3954 /* We're getting selection request events, but we don't have
3960 #if defined (HAVE_NS)
3961 else if (event
->kind
== NS_TEXT_EVENT
)
3963 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3964 obj
= list1 (intern ("ns-put-working-text"));
3966 obj
= list1 (intern ("ns-unput-working-text"));
3967 kbd_fetch_ptr
= event
+ 1;
3968 if (used_mouse_menu
)
3969 *used_mouse_menu
= 1;
3973 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3974 || defined (HAVE_NS)
3975 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3977 /* Make an event (delete-frame (FRAME)). */
3978 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3979 kbd_fetch_ptr
= event
+ 1;
3982 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3983 || defined (HAVE_NS)
3984 else if (event
->kind
== ICONIFY_EVENT
)
3986 /* Make an event (iconify-frame (FRAME)). */
3987 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3988 kbd_fetch_ptr
= event
+ 1;
3990 else if (event
->kind
== DEICONIFY_EVENT
)
3992 /* Make an event (make-frame-visible (FRAME)). */
3993 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3994 kbd_fetch_ptr
= event
+ 1;
3997 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3999 /* The value doesn't matter here; only the type is tested. */
4000 XSETBUFFER (obj
, current_buffer
);
4001 kbd_fetch_ptr
= event
+ 1;
4003 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4004 || defined (HAVE_NS) || defined (USE_GTK)
4005 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4007 kbd_fetch_ptr
= event
+ 1;
4008 input_pending
= readable_events (0);
4009 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4010 x_activate_menubar (XFRAME (event
->frame_or_window
));
4014 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4016 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4017 obj
= list4 (Qlanguage_change
,
4018 event
->frame_or_window
,
4019 make_number (event
->code
),
4020 make_number (event
->modifiers
));
4021 kbd_fetch_ptr
= event
+ 1;
4024 #ifdef USE_FILE_NOTIFY
4025 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4027 #ifdef HAVE_W32NOTIFY
4028 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4029 obj
= list3 (Qfile_notify
,
4030 list3 (make_number (event
->code
),
4033 event
->frame_or_window
);
4035 obj
= make_lispy_event (event
);
4037 kbd_fetch_ptr
= event
+ 1;
4039 #endif /* USE_FILE_NOTIFY */
4040 else if (event
->kind
== SAVE_SESSION_EVENT
)
4042 obj
= list2 (Qsave_session
, event
->arg
);
4043 kbd_fetch_ptr
= event
+ 1;
4045 /* Just discard these, by returning nil.
4046 With MULTI_KBOARD, these events are used as placeholders
4047 when we need to randomly delete events from the queue.
4048 (They shouldn't otherwise be found in the buffer,
4049 but on some machines it appears they do show up
4050 even without MULTI_KBOARD.) */
4051 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4052 mouse events during a popup-menu call. */
4053 else if (event
->kind
== NO_EVENT
)
4054 kbd_fetch_ptr
= event
+ 1;
4055 else if (event
->kind
== HELP_EVENT
)
4057 Lisp_Object object
, position
, help
, frame
, window
;
4059 frame
= event
->frame_or_window
;
4060 object
= event
->arg
;
4061 position
= make_number (event
->code
);
4064 clear_event (event
);
4066 kbd_fetch_ptr
= event
+ 1;
4067 if (!WINDOWP (window
))
4069 obj
= Fcons (Qhelp_echo
,
4070 list5 (frame
, help
, window
, object
, position
));
4072 else if (event
->kind
== FOCUS_IN_EVENT
)
4074 /* Notification of a FocusIn event. The frame receiving the
4075 focus is in event->frame_or_window. Generate a
4076 switch-frame event if necessary. */
4077 Lisp_Object frame
, focus
;
4079 frame
= event
->frame_or_window
;
4080 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4089 !EQ (frame
, internal_last_event_frame
)
4090 && !EQ (frame
, selected_frame
))
4091 obj
= make_lispy_switch_frame (frame
);
4093 obj
= make_lispy_focus_in (frame
);
4095 internal_last_event_frame
= frame
;
4096 kbd_fetch_ptr
= event
+ 1;
4098 else if (event
->kind
== FOCUS_OUT_EVENT
)
4100 #ifdef HAVE_WINDOW_SYSTEM
4103 Lisp_Object frame
= event
->frame_or_window
;
4104 bool focused
= false;
4106 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4107 focused
= di
->x_highlight_frame
!= 0;
4110 obj
= make_lispy_focus_out (frame
);
4112 #endif /* HAVE_WINDOW_SYSTEM */
4114 kbd_fetch_ptr
= event
+ 1;
4117 else if (event
->kind
== DBUS_EVENT
)
4119 obj
= make_lispy_event (event
);
4120 kbd_fetch_ptr
= event
+ 1;
4123 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4125 obj
= make_lispy_event (event
);
4126 kbd_fetch_ptr
= event
+ 1;
4130 /* If this event is on a different frame, return a switch-frame this
4131 time, and leave the event in the queue for next time. */
4135 frame
= event
->frame_or_window
;
4137 frame
= XCAR (frame
);
4138 else if (WINDOWP (frame
))
4139 frame
= WINDOW_FRAME (XWINDOW (frame
));
4141 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4145 if (! EQ (frame
, internal_last_event_frame
)
4146 && !EQ (frame
, selected_frame
))
4147 obj
= make_lispy_switch_frame (frame
);
4148 internal_last_event_frame
= frame
;
4150 /* If we didn't decide to make a switch-frame event, go ahead
4151 and build a real event from the queue entry. */
4155 obj
= make_lispy_event (event
);
4157 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4158 || defined (HAVE_NS) || defined (USE_GTK)
4159 /* If this was a menu selection, then set the flag to inhibit
4160 writing to last_nonmenu_event. Don't do this if the event
4161 we're returning is (menu-bar), though; that indicates the
4162 beginning of the menu sequence, and we might as well leave
4163 that as the `event with parameters' for this selection. */
4165 && !EQ (event
->frame_or_window
, event
->arg
)
4166 && (event
->kind
== MENU_BAR_EVENT
4167 || event
->kind
== TOOL_BAR_EVENT
))
4168 *used_mouse_menu
= 1;
4171 /* Certain system events are non-key events. */
4173 && event
->kind
== NS_NONKEY_EVENT
)
4174 *used_mouse_menu
= 1;
4177 /* Wipe out this event, to catch bugs. */
4178 clear_event (event
);
4179 kbd_fetch_ptr
= event
+ 1;
4183 /* Try generating a mouse motion event. */
4184 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4186 struct frame
*f
= some_mouse_moved ();
4187 Lisp_Object bar_window
;
4188 enum scroll_bar_part part
;
4192 *kbp
= current_kboard
;
4193 /* Note that this uses F to determine which terminal to look at.
4194 If there is no valid info, it does not store anything
4195 so x remains nil. */
4198 /* XXX Can f or mouse_position_hook be NULL here? */
4199 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4200 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4205 /* Decide if we should generate a switch-frame event. Don't
4206 generate switch-frame events for motion outside of all Emacs
4212 frame
= FRAME_FOCUS_FRAME (f
);
4214 XSETFRAME (frame
, f
);
4216 if (! EQ (frame
, internal_last_event_frame
)
4217 && !EQ (frame
, selected_frame
))
4218 obj
= make_lispy_switch_frame (frame
);
4219 internal_last_event_frame
= frame
;
4222 /* If we didn't decide to make a switch-frame event, go ahead and
4223 return a mouse-motion event. */
4224 if (!NILP (x
) && NILP (obj
))
4225 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4228 /* We were promised by the above while loop that there was
4229 something for us to read! */
4232 input_pending
= readable_events (0);
4234 Vlast_event_frame
= internal_last_event_frame
;
4239 /* Process any non-user-visible events (currently X selection events),
4240 without reading any user-visible events. */
4243 process_special_events (void)
4245 struct input_event
*event
;
4247 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4249 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4252 if (event
== kbd_store_ptr
)
4256 /* If we find a stored X selection request, handle it now. */
4257 if (event
->kind
== SELECTION_REQUEST_EVENT
4258 || event
->kind
== SELECTION_CLEAR_EVENT
)
4262 /* Remove the event from the fifo buffer before processing;
4263 otherwise swallow_events called recursively could see it
4264 and process it again. To do this, we move the events
4265 between kbd_fetch_ptr and EVENT one slot to the right,
4268 struct input_event copy
= *event
;
4269 struct input_event
*beg
4270 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4271 ? kbd_buffer
: kbd_fetch_ptr
;
4274 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4275 else if (event
< beg
)
4277 if (event
> kbd_buffer
)
4278 memmove (kbd_buffer
+ 1, kbd_buffer
,
4279 (event
- kbd_buffer
) * sizeof (struct input_event
));
4280 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4281 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4282 memmove (beg
+ 1, beg
,
4283 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4284 * sizeof (struct input_event
));
4287 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4288 kbd_fetch_ptr
= kbd_buffer
+ 1;
4292 input_pending
= readable_events (0);
4293 x_handle_selection_event (©
);
4295 /* We're getting selection request events, but we don't have
4303 /* Process any events that are not user-visible, run timer events that
4304 are ripe, and return, without reading any user-visible events. */
4307 swallow_events (bool do_display
)
4309 unsigned old_timers_run
;
4311 process_special_events ();
4313 old_timers_run
= timers_run
;
4314 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4316 if (timers_run
!= old_timers_run
&& do_display
)
4317 redisplay_preserve_echo_area (7);
4320 /* Record the start of when Emacs is idle,
4321 for the sake of running idle-time timers. */
4324 timer_start_idle (void)
4326 /* If we are already in the idle state, do nothing. */
4327 if (timespec_valid_p (timer_idleness_start_time
))
4330 timer_idleness_start_time
= current_timespec ();
4331 timer_last_idleness_start_time
= timer_idleness_start_time
;
4333 /* Mark all idle-time timers as once again candidates for running. */
4334 call0 (intern ("internal-timer-start-idle"));
4337 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4340 timer_stop_idle (void)
4342 timer_idleness_start_time
= invalid_timespec ();
4345 /* Resume idle timer from last idle start time. */
4348 timer_resume_idle (void)
4350 if (timespec_valid_p (timer_idleness_start_time
))
4353 timer_idleness_start_time
= timer_last_idleness_start_time
;
4356 /* This is only for debugging. */
4357 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4359 /* List of elisp functions to call, delayed because they were generated in
4360 a context where Elisp could not be safely run (e.g. redisplay, signal,
4361 ...). Each element has the form (FUN . ARGS). */
4362 Lisp_Object pending_funcalls
;
4364 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4366 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4368 Lisp_Object
*vector
;
4370 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4372 vector
= XVECTOR (timer
)->contents
;
4373 if (! NILP (vector
[0]))
4376 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4381 /* Check whether a timer has fired. To prevent larger problems we simply
4382 disregard elements that are not proper timers. Do not make a circular
4383 timer list for the time being.
4385 Returns the time to wait until the next timer fires. If a
4386 timer is triggering now, return zero.
4387 If no timer is active, return -1.
4389 If a timer is ripe, we run it, with quitting turned off.
4390 In that case we return 0 to indicate that a new timer_check_2 call
4393 static struct timespec
4394 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4396 struct timespec nexttime
;
4397 struct timespec now
;
4398 struct timespec idleness_now
;
4399 Lisp_Object chosen_timer
;
4400 struct gcpro gcpro1
;
4402 nexttime
= invalid_timespec ();
4404 chosen_timer
= Qnil
;
4405 GCPRO1 (chosen_timer
);
4407 /* First run the code that was delayed. */
4408 while (CONSP (pending_funcalls
))
4410 Lisp_Object funcall
= XCAR (pending_funcalls
);
4411 pending_funcalls
= XCDR (pending_funcalls
);
4412 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4415 if (CONSP (timers
) || CONSP (idle_timers
))
4417 now
= current_timespec ();
4418 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4419 ? timespec_sub (now
, timer_idleness_start_time
)
4420 : make_timespec (0, 0));
4423 while (CONSP (timers
) || CONSP (idle_timers
))
4425 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4426 struct timespec timer_time
, idle_timer_time
;
4427 struct timespec difference
;
4428 struct timespec timer_difference
= invalid_timespec ();
4429 struct timespec idle_timer_difference
= invalid_timespec ();
4430 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4432 /* Set TIMER and TIMER_DIFFERENCE
4433 based on the next ordinary timer.
4434 TIMER_DIFFERENCE is the distance in time from NOW to when
4435 this timer becomes ripe (negative if it's already ripe).
4436 Skip past invalid timers and timers already handled. */
4439 timer
= XCAR (timers
);
4440 if (! decode_timer (timer
, &timer_time
))
4442 timers
= XCDR (timers
);
4446 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4447 timer_difference
= (timer_ripe
4448 ? timespec_sub (now
, timer_time
)
4449 : timespec_sub (timer_time
, now
));
4452 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4453 based on the next idle timer. */
4454 if (CONSP (idle_timers
))
4456 idle_timer
= XCAR (idle_timers
);
4457 if (! decode_timer (idle_timer
, &idle_timer_time
))
4459 idle_timers
= XCDR (idle_timers
);
4463 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4464 idle_timer_difference
4466 ? timespec_sub (idleness_now
, idle_timer_time
)
4467 : timespec_sub (idle_timer_time
, idleness_now
));
4470 /* Decide which timer is the next timer,
4471 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4472 Also step down the list where we found that timer. */
4474 if (timespec_valid_p (timer_difference
)
4475 && (! timespec_valid_p (idle_timer_difference
)
4476 || idle_timer_ripe
< timer_ripe
4477 || (idle_timer_ripe
== timer_ripe
4479 ? timespec_cmp (idle_timer_difference
,
4481 : timespec_cmp (timer_difference
,
4482 idle_timer_difference
))
4485 chosen_timer
= timer
;
4486 timers
= XCDR (timers
);
4487 difference
= timer_difference
;
4492 chosen_timer
= idle_timer
;
4493 idle_timers
= XCDR (idle_timers
);
4494 difference
= idle_timer_difference
;
4495 ripe
= idle_timer_ripe
;
4498 /* If timer is ripe, run it if it hasn't been run. */
4501 if (NILP (AREF (chosen_timer
, 0)))
4503 ptrdiff_t count
= SPECPDL_INDEX ();
4504 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4506 /* Mark the timer as triggered to prevent problems if the lisp
4507 code fails to reschedule it right. */
4508 ASET (chosen_timer
, 0, Qt
);
4510 specbind (Qinhibit_quit
, Qt
);
4512 call1 (Qtimer_event_handler
, chosen_timer
);
4513 Vdeactivate_mark
= old_deactivate_mark
;
4515 unbind_to (count
, Qnil
);
4517 /* Since we have handled the event,
4518 we don't need to tell the caller to wake up and do it. */
4519 /* But the caller must still wait for the next timer, so
4520 return 0 to indicate that. */
4523 nexttime
= make_timespec (0, 0);
4527 /* When we encounter a timer that is still waiting,
4528 return the amount of time to wait before it is ripe. */
4535 /* No timers are pending in the future. */
4536 /* Return 0 if we generated an event, and -1 if not. */
4542 /* Check whether a timer has fired. To prevent larger problems we simply
4543 disregard elements that are not proper timers. Do not make a circular
4544 timer list for the time being.
4546 Returns the time to wait until the next timer fires.
4547 If no timer is active, return an invalid value.
4549 As long as any timer is ripe, we run it. */
4554 struct timespec nexttime
;
4555 Lisp_Object timers
, idle_timers
;
4556 struct gcpro gcpro1
, gcpro2
;
4558 Lisp_Object tem
= Vinhibit_quit
;
4561 /* We use copies of the timers' lists to allow a timer to add itself
4562 again, without locking up Emacs if the newly added timer is
4563 already ripe when added. */
4565 /* Always consider the ordinary timers. */
4566 timers
= Fcopy_sequence (Vtimer_list
);
4567 /* Consider the idle timers only if Emacs is idle. */
4568 if (timespec_valid_p (timer_idleness_start_time
))
4569 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4573 Vinhibit_quit
= tem
;
4575 GCPRO2 (timers
, idle_timers
);
4579 nexttime
= timer_check_2 (timers
, idle_timers
);
4581 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4587 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4588 doc
: /* Return the current length of Emacs idleness, or nil.
4589 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4590 in the same style as (current-time).
4592 The value when Emacs is not idle is nil.
4594 PSEC is a multiple of the system clock resolution. */)
4597 if (timespec_valid_p (timer_idleness_start_time
))
4598 return make_lisp_time (timespec_sub (current_timespec (),
4599 timer_idleness_start_time
));
4604 /* Caches for modify_event_symbol. */
4605 static Lisp_Object accent_key_syms
;
4606 static Lisp_Object func_key_syms
;
4607 static Lisp_Object mouse_syms
;
4608 static Lisp_Object wheel_syms
;
4609 static Lisp_Object drag_n_drop_syms
;
4611 /* This is a list of keysym codes for special "accent" characters.
4612 It parallels lispy_accent_keys. */
4614 static const int lispy_accent_codes
[] =
4616 #ifdef XK_dead_circumflex
4621 #ifdef XK_dead_grave
4626 #ifdef XK_dead_tilde
4631 #ifdef XK_dead_diaeresis
4636 #ifdef XK_dead_macron
4641 #ifdef XK_dead_degree
4646 #ifdef XK_dead_acute
4651 #ifdef XK_dead_cedilla
4656 #ifdef XK_dead_breve
4661 #ifdef XK_dead_ogonek
4666 #ifdef XK_dead_caron
4671 #ifdef XK_dead_doubleacute
4672 XK_dead_doubleacute
,
4676 #ifdef XK_dead_abovedot
4681 #ifdef XK_dead_abovering
4691 #ifdef XK_dead_belowdot
4696 #ifdef XK_dead_voiced_sound
4697 XK_dead_voiced_sound
,
4701 #ifdef XK_dead_semivoiced_sound
4702 XK_dead_semivoiced_sound
,
4718 /* This is a list of Lisp names for special "accent" characters.
4719 It parallels lispy_accent_codes. */
4721 static const char *const lispy_accent_keys
[] =
4739 "dead-voiced-sound",
4740 "dead-semivoiced-sound",
4746 #define FUNCTION_KEY_OFFSET 0x0
4748 const char *const lispy_function_keys
[] =
4752 0, /* VK_LBUTTON 0x01 */
4753 0, /* VK_RBUTTON 0x02 */
4754 "cancel", /* VK_CANCEL 0x03 */
4755 0, /* VK_MBUTTON 0x04 */
4757 0, 0, 0, /* 0x05 .. 0x07 */
4759 "backspace", /* VK_BACK 0x08 */
4760 "tab", /* VK_TAB 0x09 */
4762 0, 0, /* 0x0A .. 0x0B */
4764 "clear", /* VK_CLEAR 0x0C */
4765 "return", /* VK_RETURN 0x0D */
4767 0, 0, /* 0x0E .. 0x0F */
4769 0, /* VK_SHIFT 0x10 */
4770 0, /* VK_CONTROL 0x11 */
4771 0, /* VK_MENU 0x12 */
4772 "pause", /* VK_PAUSE 0x13 */
4773 "capslock", /* VK_CAPITAL 0x14 */
4774 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4776 "junja", /* VK_JUNJA 0x17 */
4777 "final", /* VK_FINAL 0x18 */
4778 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4780 "escape", /* VK_ESCAPE 0x1B */
4781 "convert", /* VK_CONVERT 0x1C */
4782 "non-convert", /* VK_NONCONVERT 0x1D */
4783 "accept", /* VK_ACCEPT 0x1E */
4784 "mode-change", /* VK_MODECHANGE 0x1F */
4785 0, /* VK_SPACE 0x20 */
4786 "prior", /* VK_PRIOR 0x21 */
4787 "next", /* VK_NEXT 0x22 */
4788 "end", /* VK_END 0x23 */
4789 "home", /* VK_HOME 0x24 */
4790 "left", /* VK_LEFT 0x25 */
4791 "up", /* VK_UP 0x26 */
4792 "right", /* VK_RIGHT 0x27 */
4793 "down", /* VK_DOWN 0x28 */
4794 "select", /* VK_SELECT 0x29 */
4795 "print", /* VK_PRINT 0x2A */
4796 "execute", /* VK_EXECUTE 0x2B */
4797 "snapshot", /* VK_SNAPSHOT 0x2C */
4798 "insert", /* VK_INSERT 0x2D */
4799 "delete", /* VK_DELETE 0x2E */
4800 "help", /* VK_HELP 0x2F */
4802 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4804 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4806 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4808 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4810 0, 0, 0, 0, 0, 0, 0, 0, 0,
4811 0, 0, 0, 0, 0, 0, 0, 0, 0,
4812 0, 0, 0, 0, 0, 0, 0, 0,
4814 "lwindow", /* VK_LWIN 0x5B */
4815 "rwindow", /* VK_RWIN 0x5C */
4816 "apps", /* VK_APPS 0x5D */
4819 "kp-0", /* VK_NUMPAD0 0x60 */
4820 "kp-1", /* VK_NUMPAD1 0x61 */
4821 "kp-2", /* VK_NUMPAD2 0x62 */
4822 "kp-3", /* VK_NUMPAD3 0x63 */
4823 "kp-4", /* VK_NUMPAD4 0x64 */
4824 "kp-5", /* VK_NUMPAD5 0x65 */
4825 "kp-6", /* VK_NUMPAD6 0x66 */
4826 "kp-7", /* VK_NUMPAD7 0x67 */
4827 "kp-8", /* VK_NUMPAD8 0x68 */
4828 "kp-9", /* VK_NUMPAD9 0x69 */
4829 "kp-multiply", /* VK_MULTIPLY 0x6A */
4830 "kp-add", /* VK_ADD 0x6B */
4831 "kp-separator", /* VK_SEPARATOR 0x6C */
4832 "kp-subtract", /* VK_SUBTRACT 0x6D */
4833 "kp-decimal", /* VK_DECIMAL 0x6E */
4834 "kp-divide", /* VK_DIVIDE 0x6F */
4835 "f1", /* VK_F1 0x70 */
4836 "f2", /* VK_F2 0x71 */
4837 "f3", /* VK_F3 0x72 */
4838 "f4", /* VK_F4 0x73 */
4839 "f5", /* VK_F5 0x74 */
4840 "f6", /* VK_F6 0x75 */
4841 "f7", /* VK_F7 0x76 */
4842 "f8", /* VK_F8 0x77 */
4843 "f9", /* VK_F9 0x78 */
4844 "f10", /* VK_F10 0x79 */
4845 "f11", /* VK_F11 0x7A */
4846 "f12", /* VK_F12 0x7B */
4847 "f13", /* VK_F13 0x7C */
4848 "f14", /* VK_F14 0x7D */
4849 "f15", /* VK_F15 0x7E */
4850 "f16", /* VK_F16 0x7F */
4851 "f17", /* VK_F17 0x80 */
4852 "f18", /* VK_F18 0x81 */
4853 "f19", /* VK_F19 0x82 */
4854 "f20", /* VK_F20 0x83 */
4855 "f21", /* VK_F21 0x84 */
4856 "f22", /* VK_F22 0x85 */
4857 "f23", /* VK_F23 0x86 */
4858 "f24", /* VK_F24 0x87 */
4860 0, 0, 0, 0, /* 0x88 .. 0x8B */
4861 0, 0, 0, 0, /* 0x8C .. 0x8F */
4863 "kp-numlock", /* VK_NUMLOCK 0x90 */
4864 "scroll", /* VK_SCROLL 0x91 */
4865 /* Not sure where the following block comes from.
4866 Windows headers have NEC and Fujitsu specific keys in
4867 this block, but nothing generic. */
4868 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4869 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4870 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4871 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4872 "kp-end", /* VK_NUMPAD_END 0x96 */
4873 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4874 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4875 "kp-up", /* VK_NUMPAD_UP 0x99 */
4876 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4877 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4878 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4879 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4881 0, 0, /* 0x9E .. 0x9F */
4884 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4885 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4886 * No other API or message will distinguish left and right keys this way.
4891 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4892 to enable them selectively, and gives access to a few more functions.
4893 See lispy_multimedia_keys below. */
4894 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4895 0, 0, 0, /* 0xAD .. 0xAF Volume */
4896 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4897 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4899 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4900 0, 0, 0, 0, 0, 0, 0, 0, 0,
4902 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4903 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4904 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4907 "ax", /* VK_OEM_AX 0xE1 */
4908 0, /* VK_OEM_102 0xE2 */
4909 "ico-help", /* VK_ICO_HELP 0xE3 */
4910 "ico-00", /* VK_ICO_00 0xE4 */
4911 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4912 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4913 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4915 "reset", /* VK_OEM_RESET 0xE9 */
4916 "jump", /* VK_OEM_JUMP 0xEA */
4917 "oem-pa1", /* VK_OEM_PA1 0xEB */
4918 "oem-pa2", /* VK_OEM_PA2 0xEC */
4919 "oem-pa3", /* VK_OEM_PA3 0xED */
4920 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4921 "cusel", /* VK_OEM_CUSEL 0xEF */
4922 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4923 "finish", /* VK_OEM_FINISH 0xF1 */
4924 "copy", /* VK_OEM_COPY 0xF2 */
4925 "auto", /* VK_OEM_AUTO 0xF3 */
4926 "enlw", /* VK_OEM_ENLW 0xF4 */
4927 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4928 "attn", /* VK_ATTN 0xF6 */
4929 "crsel", /* VK_CRSEL 0xF7 */
4930 "exsel", /* VK_EXSEL 0xF8 */
4931 "ereof", /* VK_EREOF 0xF9 */
4932 "play", /* VK_PLAY 0xFA */
4933 "zoom", /* VK_ZOOM 0xFB */
4934 "noname", /* VK_NONAME 0xFC */
4935 "pa1", /* VK_PA1 0xFD */
4936 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4940 /* Some of these duplicate the "Media keys" on newer keyboards,
4941 but they are delivered to the application in a different way. */
4942 static const char *const lispy_multimedia_keys
[] =
4950 "browser-favorites",
4987 "toggle-dictate-command",
4993 "media-fast-forward",
4996 "media-channel-down"
4999 #else /* not HAVE_NTGUI */
5001 /* This should be dealt with in XTread_socket now, and that doesn't
5002 depend on the client system having the Kana syms defined. See also
5003 the XK_kana_A case below. */
5006 static const char *const lispy_kana_keys
[] =
5008 /* X Keysym value */
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5019 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5020 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5021 "kana-i", "kana-u", "kana-e", "kana-o",
5022 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5023 "prolongedsound", "kana-A", "kana-I", "kana-U",
5024 "kana-E", "kana-O", "kana-KA", "kana-KI",
5025 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5026 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5027 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5028 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5029 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5030 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5031 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5032 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5033 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5034 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5035 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5038 #endif /* XK_kana_A */
5041 #define FUNCTION_KEY_OFFSET 0xff00
5043 /* You'll notice that this table is arranged to be conveniently
5044 indexed by X Windows keysym values. */
5045 static const char *const lispy_function_keys
[] =
5047 /* X Keysym value */
5049 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5050 "backspace", "tab", "linefeed", "clear",
5052 0, 0, 0, "pause", /* 0xff10...1f */
5053 0, 0, 0, 0, 0, 0, 0, "escape",
5055 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5056 "romaji", "hiragana", "katakana", "hiragana-katakana",
5057 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5058 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5059 "eisu-toggle", /* 0xff30...3f */
5060 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5061 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5063 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5064 "down", "prior", "next", "end",
5065 "begin", 0, 0, 0, 0, 0, 0, 0,
5066 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5077 "break", /* 0xff6b */
5080 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5081 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5082 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5083 0, 0, 0, 0, 0, 0, 0, 0,
5084 "kp-tab", /* 0xff89 */
5086 "kp-enter", /* 0xff8d */
5088 "kp-f1", /* 0xff91 */
5092 "kp-home", /* 0xff95 */
5097 "kp-prior", /* kp-page-up */
5098 "kp-next", /* kp-page-down */
5104 0, 0, 0, 0, 0, 0, 0, 0, 0,
5105 "kp-multiply", /* 0xffaa */
5110 "kp-divide", /* 0xffaf */
5111 "kp-0", /* 0xffb0 */
5112 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5115 "kp-equal", /* 0xffbd */
5116 "f1", /* 0xffbe */ /* IsFunctionKey */
5118 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5119 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5120 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5121 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5122 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5123 0, 0, 0, 0, 0, 0, 0, 0,
5124 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5125 0, 0, 0, 0, 0, 0, 0, "delete"
5128 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5129 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5131 static const char *const iso_lispy_function_keys
[] =
5133 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5134 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5135 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5136 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5137 "iso-lefttab", /* 0xfe20 */
5138 "iso-move-line-up", "iso-move-line-down",
5139 "iso-partial-line-up", "iso-partial-line-down",
5140 "iso-partial-space-left", "iso-partial-space-right",
5141 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5142 "iso-release-margin-left", "iso-release-margin-right",
5143 "iso-release-both-margins",
5144 "iso-fast-cursor-left", "iso-fast-cursor-right",
5145 "iso-fast-cursor-up", "iso-fast-cursor-down",
5146 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5147 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5150 #endif /* not HAVE_NTGUI */
5152 static Lisp_Object Vlispy_mouse_stem
;
5154 static const char *const lispy_wheel_names
[] =
5156 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5159 /* drag-n-drop events are generated when a set of selected files are
5160 dragged from another application and dropped onto an Emacs window. */
5161 static const char *const lispy_drag_n_drop_names
[] =
5166 /* Scroll bar parts. */
5167 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5168 Lisp_Object Qup
, Qdown
, Qbottom
;
5169 static Lisp_Object Qend_scroll
;
5171 static Lisp_Object Qratio
;
5173 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5174 static Lisp_Object
*const scroll_bar_parts
[] = {
5175 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5176 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5179 /* A vector, indexed by button number, giving the down-going location
5180 of currently depressed buttons, both scroll bar and non-scroll bar.
5182 The elements have the form
5183 (BUTTON-NUMBER MODIFIER-MASK . REST)
5184 where REST is the cdr of a position as it would be reported in the event.
5186 The make_lispy_event function stores positions here to tell the
5187 difference between click and drag events, and to store the starting
5188 location to be included in drag events. */
5190 static Lisp_Object button_down_location
;
5192 /* Information about the most recent up-going button event: Which
5193 button, what location, and what time. */
5195 static int last_mouse_button
;
5196 static int last_mouse_x
;
5197 static int last_mouse_y
;
5198 static Time button_down_time
;
5200 /* The number of clicks in this multiple-click. */
5202 static int double_click_count
;
5204 /* X and Y are frame-relative coordinates for a click or wheel event.
5205 Return a Lisp-style event list. */
5208 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5211 enum window_part part
;
5212 Lisp_Object posn
= Qnil
;
5213 Lisp_Object extra_info
= Qnil
;
5214 /* Coordinate pixel positions to return. */
5215 int xret
= 0, yret
= 0;
5216 /* The window under frame pixel coordinates (x,y) */
5217 Lisp_Object window
= f
5218 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5221 if (WINDOWP (window
))
5223 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5224 struct window
*w
= XWINDOW (window
);
5225 Lisp_Object string_info
= Qnil
;
5226 ptrdiff_t textpos
= 0;
5227 int col
= -1, row
= -1;
5228 int dx
= -1, dy
= -1;
5229 int width
= -1, height
= -1;
5230 Lisp_Object object
= Qnil
;
5232 /* Pixel coordinates relative to the window corner. */
5233 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5234 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5236 /* For text area clicks, return X, Y relative to the corner of
5237 this text area. Note that dX, dY etc are set below, by
5238 buffer_posn_from_coords. */
5239 if (part
== ON_TEXT
)
5241 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5242 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5244 /* For mode line and header line clicks, return X, Y relative to
5245 the left window edge. Use mode_line_string to look for a
5246 string on the click position. */
5247 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5252 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5253 /* Note that mode_line_string takes COL, ROW as pixels and
5254 converts them to characters. */
5257 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5258 &object
, &dx
, &dy
, &width
, &height
);
5259 if (STRINGP (string
))
5260 string_info
= Fcons (string
, make_number (charpos
));
5266 /* For fringes and margins, Y is relative to the area's (and the
5267 window's) top edge, while X is meaningless. */
5268 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5273 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5276 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5277 &object
, &dx
, &dy
, &width
, &height
);
5278 if (STRINGP (string
))
5279 string_info
= Fcons (string
, make_number (charpos
));
5280 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5282 else if (part
== ON_LEFT_FRINGE
)
5284 posn
= Qleft_fringe
;
5287 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5288 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5289 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5291 else if (part
== ON_RIGHT_FRINGE
)
5293 posn
= Qright_fringe
;
5296 - window_box_width (w
, LEFT_MARGIN_AREA
)
5297 - window_box_width (w
, TEXT_AREA
)
5298 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5299 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5301 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5303 else if (part
== ON_VERTICAL_BORDER
)
5305 posn
= Qvertical_line
;
5310 /* Nothing special for part == ON_SCROLL_BAR. */
5311 else if (part
== ON_RIGHT_DIVIDER
)
5313 posn
= Qright_divider
;
5314 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5318 else if (part
== ON_BOTTOM_DIVIDER
)
5320 posn
= Qbottom_divider
;
5321 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5326 /* For clicks in the text area, fringes, or margins, call
5327 buffer_posn_from_coords to extract TEXTPOS, the buffer
5328 position nearest to the click. */
5331 Lisp_Object string2
, object2
= Qnil
;
5332 struct display_pos p
;
5334 int width2
, height2
;
5335 /* The pixel X coordinate passed to buffer_posn_from_coords
5336 is the X coordinate relative to the text area for
5337 text-area and right-margin clicks, zero otherwise. */
5339 = (part
== ON_TEXT
) ? xret
5340 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5341 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5345 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5346 &object2
, &dx2
, &dy2
,
5348 textpos
= CHARPOS (p
.pos
);
5349 if (col
< 0) col
= x2
;
5350 if (row
< 0) row
= y2
;
5351 if (dx
< 0) dx
= dx2
;
5352 if (dy
< 0) dy
= dy2
;
5353 if (width
< 0) width
= width2
;
5354 if (height
< 0) height
= height2
;
5358 posn
= make_number (textpos
);
5359 if (STRINGP (string2
))
5360 string_info
= Fcons (string2
,
5361 make_number (CHARPOS (p
.string_pos
)));
5367 #ifdef HAVE_WINDOW_SYSTEM
5368 if (IMAGEP (object
))
5370 Lisp_Object image_map
, hotspot
;
5371 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5373 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5375 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5376 posn
= XCAR (hotspot
);
5383 Fcons (make_number (dx
), make_number (dy
)),
5384 Fcons (make_number (width
), make_number (height
)));
5387 extra_info
= Fcons (string_info
,
5388 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5389 Fcons (Fcons (make_number (col
),
5394 XSETFRAME (window
, f
);
5398 return Fcons (window
,
5400 Fcons (Fcons (make_number (xret
),
5401 make_number (yret
)),
5402 Fcons (make_number (t
),
5406 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5407 menu bar. This really means that Emacs draws and manages the menu
5408 bar as part of its normal display, and therefore can compute its
5411 toolkit_menubar_in_use (struct frame
*f
)
5413 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5414 return !(!FRAME_WINDOW_P (f
));
5420 /* Given a struct input_event, build the lisp event which represents
5421 it. If EVENT is 0, build a mouse movement event from the mouse
5422 movement buffer, which should have a movement event in it.
5424 Note that events must be passed to this function in the order they
5425 are received; this function stores the location of button presses
5426 in order to build drag events when the button is released. */
5429 make_lispy_event (struct input_event
*event
)
5433 switch (event
->kind
)
5435 /* A simple keystroke. */
5436 case ASCII_KEYSTROKE_EVENT
:
5437 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5439 Lisp_Object lispy_c
;
5440 EMACS_INT c
= event
->code
;
5441 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5444 eassert (c
== event
->code
);
5445 /* Turn ASCII characters into control characters
5447 if (event
->modifiers
& ctrl_modifier
)
5449 c
= make_ctrl_char (c
);
5450 event
->modifiers
&= ~ctrl_modifier
;
5454 /* Add in the other modifier bits. The shift key was taken care
5455 of by the X code. */
5456 c
|= (event
->modifiers
5457 & (meta_modifier
| alt_modifier
5458 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5459 /* Distinguish Shift-SPC from SPC. */
5460 if ((event
->code
) == 040
5461 && event
->modifiers
& shift_modifier
)
5462 c
|= shift_modifier
;
5463 button_down_time
= 0;
5464 XSETFASTINT (lispy_c
, c
);
5469 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5470 except that they are non-key events (last-nonmenu-event is nil). */
5471 case NS_NONKEY_EVENT
:
5474 /* A function key. The symbol may need to have modifier prefixes
5476 case NON_ASCII_KEYSTROKE_EVENT
:
5477 button_down_time
= 0;
5479 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5480 if (event
->code
== lispy_accent_codes
[i
])
5481 return modify_event_symbol (i
,
5483 Qfunction_key
, Qnil
,
5484 lispy_accent_keys
, &accent_key_syms
,
5485 ARRAYELTS (lispy_accent_keys
));
5489 if (event
->code
>= 0x400 && event
->code
< 0x500)
5490 return modify_event_symbol (event
->code
- 0x400,
5491 event
->modifiers
& ~shift_modifier
,
5492 Qfunction_key
, Qnil
,
5493 lispy_kana_keys
, &func_key_syms
,
5494 ARRAYELTS (lispy_kana_keys
));
5495 #endif /* XK_kana_A */
5498 #ifdef ISO_FUNCTION_KEY_OFFSET
5499 if (event
->code
< FUNCTION_KEY_OFFSET
5500 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5501 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5503 Qfunction_key
, Qnil
,
5504 iso_lispy_function_keys
, &func_key_syms
,
5505 ARRAYELTS (iso_lispy_function_keys
));
5508 /* Handle system-specific or unknown keysyms. */
5509 if (event
->code
& (1 << 28)
5510 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5511 || (event
->code
- FUNCTION_KEY_OFFSET
5512 >= ARRAYELTS (lispy_function_keys
))
5513 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5515 /* We need to use an alist rather than a vector as the cache
5516 since we can't make a vector long enough. */
5517 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5518 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5519 return modify_event_symbol (event
->code
,
5522 KVAR (current_kboard
, Vsystem_key_alist
),
5523 0, &KVAR (current_kboard
, system_key_syms
),
5527 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5529 Qfunction_key
, Qnil
,
5530 lispy_function_keys
, &func_key_syms
,
5531 ARRAYELTS (lispy_function_keys
));
5534 case MULTIMEDIA_KEY_EVENT
:
5535 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5536 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5538 return modify_event_symbol (event
->code
, event
->modifiers
,
5539 Qfunction_key
, Qnil
,
5540 lispy_multimedia_keys
, &func_key_syms
,
5541 ARRAYELTS (lispy_multimedia_keys
));
5546 /* A mouse click. Figure out where it is, decide whether it's
5547 a press, click or drag, and build the appropriate structure. */
5548 case MOUSE_CLICK_EVENT
:
5550 case GPM_CLICK_EVENT
:
5552 #ifndef USE_TOOLKIT_SCROLL_BARS
5553 case SCROLL_BAR_CLICK_EVENT
:
5556 int button
= event
->code
;
5558 Lisp_Object position
;
5559 Lisp_Object
*start_pos_ptr
;
5560 Lisp_Object start_pos
;
5564 /* Build the position as appropriate for this mouse click. */
5565 if (event
->kind
== MOUSE_CLICK_EVENT
5567 || event
->kind
== GPM_CLICK_EVENT
5571 struct frame
*f
= XFRAME (event
->frame_or_window
);
5574 /* Ignore mouse events that were made on frame that
5575 have been deleted. */
5576 if (! FRAME_LIVE_P (f
))
5579 /* EVENT->x and EVENT->y are frame-relative pixel
5580 coordinates at this place. Under old redisplay, COLUMN
5581 and ROW are set to frame relative glyph coordinates
5582 which are then used to determine whether this click is
5583 in a menu (non-toolkit version). */
5584 if (!toolkit_menubar_in_use (f
))
5586 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5587 &column
, &row
, NULL
, 1);
5589 /* In the non-toolkit version, clicks on the menu bar
5590 are ordinary button events in the event buffer.
5591 Distinguish them, and invoke the menu.
5593 (In the toolkit version, the toolkit handles the
5594 menu bar and Emacs doesn't know about it until
5595 after the user makes a selection.) */
5596 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5597 && (event
->modifiers
& down_modifier
))
5599 Lisp_Object items
, item
;
5601 /* Find the menu bar item under `column'. */
5603 items
= FRAME_MENU_BAR_ITEMS (f
);
5604 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5606 Lisp_Object pos
, string
;
5607 string
= AREF (items
, i
+ 1);
5608 pos
= AREF (items
, i
+ 3);
5611 if (column
>= XINT (pos
)
5612 && column
< XINT (pos
) + SCHARS (string
))
5614 item
= AREF (items
, i
);
5619 /* ELisp manual 2.4b says (x y) are window
5620 relative but code says they are
5622 position
= list4 (event
->frame_or_window
,
5624 Fcons (event
->x
, event
->y
),
5625 make_number (event
->timestamp
));
5627 return list2 (item
, position
);
5631 position
= make_lispy_position (f
, event
->x
, event
->y
,
5634 #ifndef USE_TOOLKIT_SCROLL_BARS
5637 /* It's a scrollbar click. */
5639 Lisp_Object portion_whole
;
5642 window
= event
->frame_or_window
;
5643 portion_whole
= Fcons (event
->x
, event
->y
);
5644 part
= *scroll_bar_parts
[(int) event
->part
];
5646 position
= list5 (window
, Qvertical_scroll_bar
,
5647 portion_whole
, make_number (event
->timestamp
),
5650 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5652 if (button
>= ASIZE (button_down_location
))
5654 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5655 button_down_location
= larger_vector (button_down_location
,
5657 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5660 start_pos_ptr
= aref_addr (button_down_location
, button
);
5661 start_pos
= *start_pos_ptr
;
5662 *start_pos_ptr
= Qnil
;
5665 /* On window-system frames, use the value of
5666 double-click-fuzz as is. On other frames, interpret it
5667 as a multiple of 1/8 characters. */
5671 if (WINDOWP (event
->frame_or_window
))
5672 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5673 else if (FRAMEP (event
->frame_or_window
))
5674 f
= XFRAME (event
->frame_or_window
);
5678 if (FRAME_WINDOW_P (f
))
5679 fuzz
= double_click_fuzz
;
5681 fuzz
= double_click_fuzz
/ 8;
5683 is_double
= (button
== last_mouse_button
5684 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5685 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5686 && button_down_time
!= 0
5687 && (EQ (Vdouble_click_time
, Qt
)
5688 || (NATNUMP (Vdouble_click_time
)
5689 && (event
->timestamp
- button_down_time
5690 < XFASTINT (Vdouble_click_time
)))));
5693 last_mouse_button
= button
;
5694 last_mouse_x
= XINT (event
->x
);
5695 last_mouse_y
= XINT (event
->y
);
5697 /* If this is a button press, squirrel away the location, so
5698 we can decide later whether it was a click or a drag. */
5699 if (event
->modifiers
& down_modifier
)
5703 double_click_count
++;
5704 event
->modifiers
|= ((double_click_count
> 2)
5709 double_click_count
= 1;
5710 button_down_time
= event
->timestamp
;
5711 *start_pos_ptr
= Fcopy_alist (position
);
5712 ignore_mouse_drag_p
= 0;
5715 /* Now we're releasing a button - check the co-ordinates to
5716 see if this was a click or a drag. */
5717 else if (event
->modifiers
& up_modifier
)
5719 /* If we did not see a down before this up, ignore the up.
5720 Probably this happened because the down event chose a
5721 menu item. It would be an annoyance to treat the
5722 release of the button that chose the menu item as a
5725 if (!CONSP (start_pos
))
5728 event
->modifiers
&= ~up_modifier
;
5731 Lisp_Object new_down
, down
;
5732 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5734 /* The third element of every position
5735 should be the (x,y) pair. */
5736 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5737 new_down
= Fcar (Fcdr (Fcdr (position
)));
5740 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5742 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5743 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5746 if (ignore_mouse_drag_p
)
5748 event
->modifiers
|= click_modifier
;
5749 ignore_mouse_drag_p
= 0;
5751 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5752 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5753 /* Maybe the mouse has moved a lot, caused scrolling, and
5754 eventually ended up at the same screen position (but
5755 not buffer position) in which case it is a drag, not
5757 /* FIXME: OTOH if the buffer position has changed
5758 because of a timer or process filter rather than
5759 because of mouse movement, it should be considered as
5760 a click. But mouse-drag-region completely ignores
5761 this case and it hasn't caused any real problem, so
5762 it's probably OK to ignore it as well. */
5763 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5764 /* Mouse hasn't moved (much). */
5765 event
->modifiers
|= click_modifier
;
5768 button_down_time
= 0;
5769 event
->modifiers
|= drag_modifier
;
5772 /* Don't check is_double; treat this as multiple
5773 if the down-event was multiple. */
5774 if (double_click_count
> 1)
5775 event
->modifiers
|= ((double_click_count
> 2)
5781 /* Every mouse event should either have the down_modifier or
5782 the up_modifier set. */
5786 /* Get the symbol we should use for the mouse click. */
5789 head
= modify_event_symbol (button
,
5791 Qmouse_click
, Vlispy_mouse_stem
,
5794 ASIZE (mouse_syms
));
5795 if (event
->modifiers
& drag_modifier
)
5796 return list3 (head
, start_pos
, position
);
5797 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5798 return list3 (head
, position
, make_number (double_click_count
));
5800 return list2 (head
, position
);
5805 case HORIZ_WHEEL_EVENT
:
5807 Lisp_Object position
;
5810 /* Build the position as appropriate for this mouse click. */
5811 struct frame
*f
= XFRAME (event
->frame_or_window
);
5813 /* Ignore wheel events that were made on frame that have been
5815 if (! FRAME_LIVE_P (f
))
5818 position
= make_lispy_position (f
, event
->x
, event
->y
,
5821 /* Set double or triple modifiers to indicate the wheel speed. */
5823 /* On window-system frames, use the value of
5824 double-click-fuzz as is. On other frames, interpret it
5825 as a multiple of 1/8 characters. */
5831 if (WINDOWP (event
->frame_or_window
))
5832 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5833 else if (FRAMEP (event
->frame_or_window
))
5834 fr
= XFRAME (event
->frame_or_window
);
5838 fuzz
= FRAME_WINDOW_P (fr
)
5839 ? double_click_fuzz
: double_click_fuzz
/ 8;
5841 if (event
->modifiers
& up_modifier
)
5843 /* Emit a wheel-up event. */
5844 event
->modifiers
&= ~up_modifier
;
5847 else if (event
->modifiers
& down_modifier
)
5849 /* Emit a wheel-down event. */
5850 event
->modifiers
&= ~down_modifier
;
5854 /* Every wheel event should either have the down_modifier or
5855 the up_modifier set. */
5858 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5861 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5862 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5863 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5864 && button_down_time
!= 0
5865 && (EQ (Vdouble_click_time
, Qt
)
5866 || (NATNUMP (Vdouble_click_time
)
5867 && (event
->timestamp
- button_down_time
5868 < XFASTINT (Vdouble_click_time
)))));
5871 double_click_count
++;
5872 event
->modifiers
|= ((double_click_count
> 2)
5878 double_click_count
= 1;
5879 event
->modifiers
|= click_modifier
;
5882 button_down_time
= event
->timestamp
;
5883 /* Use a negative value to distinguish wheel from mouse button. */
5884 last_mouse_button
= - (1 + symbol_num
);
5885 last_mouse_x
= XINT (event
->x
);
5886 last_mouse_y
= XINT (event
->y
);
5888 /* Get the symbol we should use for the wheel event. */
5889 head
= modify_event_symbol (symbol_num
,
5895 ASIZE (wheel_syms
));
5898 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5899 return list3 (head
, position
, make_number (double_click_count
));
5901 return list2 (head
, position
);
5905 #ifdef USE_TOOLKIT_SCROLL_BARS
5907 /* We don't have down and up events if using toolkit scroll bars,
5908 so make this always a click event. Store in the `part' of
5909 the Lisp event a symbol which maps to the following actions:
5911 `above_handle' page up
5912 `below_handle' page down
5916 `bottom' bottom of buffer
5917 `handle' thumb has been dragged.
5918 `end-scroll' end of interaction with scroll bar
5920 The incoming input_event contains in its `part' member an
5921 index of type `enum scroll_bar_part' which we can use as an
5922 index in scroll_bar_parts to get the appropriate symbol. */
5924 case SCROLL_BAR_CLICK_EVENT
:
5926 Lisp_Object position
, head
, window
, portion_whole
, part
;
5928 window
= event
->frame_or_window
;
5929 portion_whole
= Fcons (event
->x
, event
->y
);
5930 part
= *scroll_bar_parts
[(int) event
->part
];
5932 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5933 make_number (event
->timestamp
), part
);
5935 /* Always treat scroll bar events as clicks. */
5936 event
->modifiers
|= click_modifier
;
5937 event
->modifiers
&= ~up_modifier
;
5939 if (event
->code
>= ASIZE (mouse_syms
))
5940 mouse_syms
= larger_vector (mouse_syms
,
5941 event
->code
- ASIZE (mouse_syms
) + 1,
5944 /* Get the symbol we should use for the mouse click. */
5945 head
= modify_event_symbol (event
->code
,
5950 ASIZE (mouse_syms
));
5951 return list2 (head
, position
);
5954 #endif /* USE_TOOLKIT_SCROLL_BARS */
5956 case DRAG_N_DROP_EVENT
:
5959 Lisp_Object head
, position
;
5962 f
= XFRAME (event
->frame_or_window
);
5965 /* Ignore mouse events that were made on frames that
5966 have been deleted. */
5967 if (! FRAME_LIVE_P (f
))
5970 position
= make_lispy_position (f
, event
->x
, event
->y
,
5973 head
= modify_event_symbol (0, event
->modifiers
,
5975 lispy_drag_n_drop_names
,
5976 &drag_n_drop_syms
, 1);
5977 return list3 (head
, position
, files
);
5980 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5981 || defined (HAVE_NS) || defined (USE_GTK)
5982 case MENU_BAR_EVENT
:
5983 if (EQ (event
->arg
, event
->frame_or_window
))
5984 /* This is the prefix key. We translate this to
5985 `(menu_bar)' because the code in keyboard.c for menu
5986 events, which we use, relies on this. */
5987 return list1 (Qmenu_bar
);
5991 case SELECT_WINDOW_EVENT
:
5992 /* Make an event (select-window (WINDOW)). */
5993 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5995 case TOOL_BAR_EVENT
:
5996 if (EQ (event
->arg
, event
->frame_or_window
))
5997 /* This is the prefix key. We translate this to
5998 `(tool_bar)' because the code in keyboard.c for tool bar
5999 events, which we use, relies on this. */
6000 return list1 (Qtool_bar
);
6001 else if (SYMBOLP (event
->arg
))
6002 return apply_modifiers (event
->modifiers
, event
->arg
);
6005 case USER_SIGNAL_EVENT
:
6006 /* A user signal. */
6008 char *name
= find_user_signal_name (event
->code
);
6011 return intern (name
);
6014 case SAVE_SESSION_EVENT
:
6015 return Qsave_session
;
6020 return Fcons (Qdbus_event
, event
->arg
);
6022 #endif /* HAVE_DBUS */
6024 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6025 case FILE_NOTIFY_EVENT
:
6027 return Fcons (Qfile_notify
, event
->arg
);
6029 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6031 case CONFIG_CHANGED_EVENT
:
6032 return list3 (Qconfig_changed_event
,
6033 event
->arg
, event
->frame_or_window
);
6035 /* The 'kind' field of the event is something we don't recognize. */
6042 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6043 Lisp_Object x
, Lisp_Object y
, Time t
)
6045 /* Is it a scroll bar movement? */
6046 if (frame
&& ! NILP (bar_window
))
6048 Lisp_Object part_sym
;
6050 part_sym
= *scroll_bar_parts
[(int) part
];
6051 return list2 (Qscroll_bar_movement
,
6053 Qvertical_scroll_bar
,
6058 /* Or is it an ordinary mouse movement? */
6061 Lisp_Object position
;
6062 position
= make_lispy_position (frame
, x
, y
, t
);
6063 return list2 (Qmouse_movement
, position
);
6067 /* Construct a switch frame event. */
6069 make_lispy_switch_frame (Lisp_Object frame
)
6071 return list2 (Qswitch_frame
, frame
);
6075 make_lispy_focus_in (Lisp_Object frame
)
6077 return list2 (Qfocus_in
, frame
);
6080 #ifdef HAVE_WINDOW_SYSTEM
6083 make_lispy_focus_out (Lisp_Object frame
)
6085 return list2 (Qfocus_out
, frame
);
6088 #endif /* HAVE_WINDOW_SYSTEM */
6090 /* Manipulating modifiers. */
6092 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6094 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6095 SYMBOL's name of the end of the modifiers; the string from this
6096 position is the unmodified symbol name.
6098 This doesn't use any caches. */
6101 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6107 CHECK_SYMBOL (symbol
);
6110 name
= SYMBOL_NAME (symbol
);
6112 for (i
= 0; i
< SBYTES (name
) - 1; )
6114 ptrdiff_t this_mod_end
= 0;
6117 /* See if the name continues with a modifier word.
6118 Check that the word appears, but don't check what follows it.
6119 Set this_mod and this_mod_end to record what we find. */
6121 switch (SREF (name
, i
))
6123 #define SINGLE_LETTER_MOD(BIT) \
6124 (this_mod_end = i + 1, this_mod = BIT)
6127 SINGLE_LETTER_MOD (alt_modifier
);
6131 SINGLE_LETTER_MOD (ctrl_modifier
);
6135 SINGLE_LETTER_MOD (hyper_modifier
);
6139 SINGLE_LETTER_MOD (meta_modifier
);
6143 SINGLE_LETTER_MOD (shift_modifier
);
6147 SINGLE_LETTER_MOD (super_modifier
);
6150 #undef SINGLE_LETTER_MOD
6152 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6153 if (i + LEN + 1 <= SBYTES (name) \
6154 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6156 this_mod_end = i + LEN; \
6161 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6162 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6163 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6167 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6169 #undef MULTI_LETTER_MOD
6173 /* If we found no modifier, stop looking for them. */
6174 if (this_mod_end
== 0)
6177 /* Check there is a dash after the modifier, so that it
6178 really is a modifier. */
6179 if (this_mod_end
>= SBYTES (name
)
6180 || SREF (name
, this_mod_end
) != '-')
6183 /* This modifier is real; look for another. */
6184 modifiers
|= this_mod
;
6185 i
= this_mod_end
+ 1;
6188 /* Should we include the `click' modifier? */
6189 if (! (modifiers
& (down_modifier
| drag_modifier
6190 | double_modifier
| triple_modifier
))
6191 && i
+ 7 == SBYTES (name
)
6192 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6193 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6194 modifiers
|= click_modifier
;
6196 if (! (modifiers
& (double_modifier
| triple_modifier
))
6197 && i
+ 6 < SBYTES (name
)
6198 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6199 modifiers
|= click_modifier
;
6207 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6208 prepended to the string BASE[0..BASE_LEN-1].
6209 This doesn't use any caches. */
6211 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6213 /* Since BASE could contain nulls, we can't use intern here; we have
6214 to use Fintern, which expects a genuine Lisp_String, and keeps a
6216 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6222 /* Only the event queue may use the `up' modifier; it should always
6223 be turned into a click or drag event before presented to lisp code. */
6224 if (modifiers
& up_modifier
)
6227 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6228 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6229 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6230 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6231 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6232 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6233 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6234 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6235 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6236 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6237 /* The click modifier is denoted by the absence of other modifiers. */
6241 mod_len
= p
- new_mods
;
6245 Lisp_Object new_name
;
6247 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6248 mod_len
+ base_len_byte
);
6249 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6250 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6252 return Fintern (new_name
, Qnil
);
6257 static const char *const modifier_names
[] =
6259 "up", "down", "drag", "click", "double", "triple", 0, 0,
6260 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6261 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6263 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6265 static Lisp_Object modifier_symbols
;
6267 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6269 lispy_modifier_list (int modifiers
)
6271 Lisp_Object modifier_list
;
6274 modifier_list
= Qnil
;
6275 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6276 if (modifiers
& (1<<i
))
6277 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6280 return modifier_list
;
6284 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6285 where UNMODIFIED is the unmodified form of SYMBOL,
6286 MASK is the set of modifiers present in SYMBOL's name.
6287 This is similar to parse_modifiers_uncached, but uses the cache in
6288 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6289 Qevent_symbol_elements property. */
6291 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6294 parse_modifiers (Lisp_Object symbol
)
6296 Lisp_Object elements
;
6298 if (INTEGERP (symbol
))
6299 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6300 else if (!SYMBOLP (symbol
))
6303 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6304 if (CONSP (elements
))
6309 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6310 Lisp_Object unmodified
;
6313 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6314 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6317 if (modifiers
& ~INTMASK
)
6319 XSETFASTINT (mask
, modifiers
);
6320 elements
= list2 (unmodified
, mask
);
6322 /* Cache the parsing results on SYMBOL. */
6323 Fput (symbol
, Qevent_symbol_element_mask
,
6325 Fput (symbol
, Qevent_symbol_elements
,
6326 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6328 /* Since we know that SYMBOL is modifiers applied to unmodified,
6329 it would be nice to put that in unmodified's cache.
6330 But we can't, since we're not sure that parse_modifiers is
6337 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6338 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6339 doc
: /* Parse the event symbol. For internal use. */)
6340 (Lisp_Object symbol
)
6342 /* Fill the cache if needed. */
6343 parse_modifiers (symbol
);
6344 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6345 and use the Lispier representation stored on Qevent_symbol_elements
6347 return Fget (symbol
, Qevent_symbol_elements
);
6350 /* Apply the modifiers MODIFIERS to the symbol BASE.
6351 BASE must be unmodified.
6353 This is like apply_modifiers_uncached, but uses BASE's
6354 Qmodifier_cache property, if present. It also builds
6355 Qevent_symbol_elements properties, since it has that info anyway.
6357 apply_modifiers copies the value of BASE's Qevent_kind property to
6358 the modified symbol. */
6360 apply_modifiers (int modifiers
, Lisp_Object base
)
6362 Lisp_Object cache
, idx
, entry
, new_symbol
;
6364 /* Mask out upper bits. We don't know where this value's been. */
6365 modifiers
&= INTMASK
;
6367 if (INTEGERP (base
))
6368 return make_number (XINT (base
) | modifiers
);
6370 /* The click modifier never figures into cache indices. */
6371 cache
= Fget (base
, Qmodifier_cache
);
6372 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6373 entry
= assq_no_quit (idx
, cache
);
6376 new_symbol
= XCDR (entry
);
6379 /* We have to create the symbol ourselves. */
6380 new_symbol
= apply_modifiers_uncached (modifiers
,
6381 SSDATA (SYMBOL_NAME (base
)),
6382 SCHARS (SYMBOL_NAME (base
)),
6383 SBYTES (SYMBOL_NAME (base
)));
6385 /* Add the new symbol to the base's cache. */
6386 entry
= Fcons (idx
, new_symbol
);
6387 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6389 /* We have the parsing info now for free, so we could add it to
6391 XSETFASTINT (idx, modifiers);
6392 Fput (new_symbol, Qevent_symbol_element_mask,
6394 Fput (new_symbol, Qevent_symbol_elements,
6395 Fcons (base, lispy_modifier_list (modifiers)));
6396 Sadly, this is only correct if `base' is indeed a base event,
6397 which is not necessarily the case. -stef */
6400 /* Make sure this symbol is of the same kind as BASE.
6402 You'd think we could just set this once and for all when we
6403 intern the symbol above, but reorder_modifiers may call us when
6404 BASE's property isn't set right; we can't assume that just
6405 because it has a Qmodifier_cache property it must have its
6406 Qevent_kind set right as well. */
6407 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6411 kind
= Fget (base
, Qevent_kind
);
6413 Fput (new_symbol
, Qevent_kind
, kind
);
6420 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6421 return a symbol with the modifiers placed in the canonical order.
6422 Canonical order is alphabetical, except for down and drag, which
6423 always come last. The 'click' modifier is never written out.
6425 Fdefine_key calls this to make sure that (for example) C-M-foo
6426 and M-C-foo end up being equivalent in the keymap. */
6429 reorder_modifiers (Lisp_Object symbol
)
6431 /* It's hopefully okay to write the code this way, since everything
6432 will soon be in caches, and no consing will be done at all. */
6435 parsed
= parse_modifiers (symbol
);
6436 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6441 /* For handling events, we often want to produce a symbol whose name
6442 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6443 to some base, like the name of a function key or mouse button.
6444 modify_event_symbol produces symbols of this sort.
6446 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6447 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6450 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6451 into symbol names, or a string specifying a name stem used to
6452 construct a symbol name or the form `STEM-N', where N is the decimal
6453 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6454 non-nil; otherwise NAME_TABLE is used.
6456 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6457 persist between calls to modify_event_symbol that it can use to
6458 store a cache of the symbols it's generated for this NAME_TABLE
6459 before. The object stored there may be a vector or an alist.
6461 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6463 MODIFIERS is a set of modifier bits (as given in struct input_events)
6464 whose prefixes should be applied to the symbol name.
6466 SYMBOL_KIND is the value to be placed in the event_kind property of
6467 the returned symbol.
6469 The symbols we create are supposed to have an
6470 `event-symbol-elements' property, which lists the modifiers present
6471 in the symbol's name. */
6474 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6475 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6476 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6479 Lisp_Object symbol_int
;
6481 /* Get rid of the "vendor-specific" bit here. */
6482 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6484 /* Is this a request for a valid symbol? */
6485 if (symbol_num
< 0 || symbol_num
>= table_size
)
6488 if (CONSP (*symbol_table
))
6489 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6491 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6492 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6493 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6494 we've never used that symbol before. */
6497 if (! VECTORP (*symbol_table
)
6498 || ASIZE (*symbol_table
) != table_size
)
6502 XSETFASTINT (size
, table_size
);
6503 *symbol_table
= Fmake_vector (size
, Qnil
);
6506 value
= AREF (*symbol_table
, symbol_num
);
6509 /* Have we already used this symbol before? */
6512 /* No; let's create it. */
6513 if (CONSP (name_alist_or_stem
))
6514 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6515 else if (STRINGP (name_alist_or_stem
))
6518 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6519 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6521 buf
= SAFE_ALLOCA (len
);
6522 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6523 XINT (symbol_int
) + 1);
6524 value
= intern (buf
);
6527 else if (name_table
!= 0 && name_table
[symbol_num
])
6528 value
= intern (name_table
[symbol_num
]);
6530 #ifdef HAVE_WINDOW_SYSTEM
6533 char *name
= x_get_keysym_name (symbol_num
);
6535 value
= intern (name
);
6541 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6542 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6543 value
= intern (buf
);
6546 if (CONSP (*symbol_table
))
6547 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6549 ASET (*symbol_table
, symbol_num
, value
);
6551 /* Fill in the cache entries for this symbol; this also
6552 builds the Qevent_symbol_elements property, which the user
6554 apply_modifiers (modifiers
& click_modifier
, value
);
6555 Fput (value
, Qevent_kind
, symbol_kind
);
6558 /* Apply modifiers to that symbol. */
6559 return apply_modifiers (modifiers
, value
);
6562 /* Convert a list that represents an event type,
6563 such as (ctrl meta backspace), into the usual representation of that
6564 event type as a number or a symbol. */
6566 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6567 doc
: /* Convert the event description list EVENT-DESC to an event type.
6568 EVENT-DESC should contain one base event type (a character or symbol)
6569 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6570 drag, down, double or triple). The base must be last.
6571 The return value is an event type (a character or symbol) which
6572 has the same base event type and all the specified modifiers. */)
6573 (Lisp_Object event_desc
)
6581 while (CONSP (rest
))
6589 /* Given a symbol, see if it is a modifier name. */
6590 if (SYMBOLP (elt
) && CONSP (rest
))
6591 this = parse_solitary_modifier (elt
);
6595 else if (!NILP (base
))
6596 error ("Two bases given in one event");
6602 /* Let the symbol A refer to the character A. */
6603 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6604 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6606 if (INTEGERP (base
))
6608 /* Turn (shift a) into A. */
6609 if ((modifiers
& shift_modifier
) != 0
6610 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6612 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6613 modifiers
&= ~shift_modifier
;
6616 /* Turn (control a) into C-a. */
6617 if (modifiers
& ctrl_modifier
)
6618 return make_number ((modifiers
& ~ctrl_modifier
)
6619 | make_ctrl_char (XINT (base
)));
6621 return make_number (modifiers
| XINT (base
));
6623 else if (SYMBOLP (base
))
6624 return apply_modifiers (modifiers
, base
);
6626 error ("Invalid base event");
6629 /* Try to recognize SYMBOL as a modifier name.
6630 Return the modifier flag bit, or 0 if not recognized. */
6633 parse_solitary_modifier (Lisp_Object symbol
)
6635 Lisp_Object name
= SYMBOL_NAME (symbol
);
6637 switch (SREF (name
, 0))
6639 #define SINGLE_LETTER_MOD(BIT) \
6640 if (SBYTES (name) == 1) \
6643 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6644 if (LEN == SBYTES (name) \
6645 && ! memcmp (SDATA (name), NAME, LEN)) \
6649 SINGLE_LETTER_MOD (alt_modifier
);
6653 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6657 SINGLE_LETTER_MOD (ctrl_modifier
);
6661 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6662 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6666 SINGLE_LETTER_MOD (hyper_modifier
);
6670 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6674 SINGLE_LETTER_MOD (meta_modifier
);
6678 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6682 SINGLE_LETTER_MOD (shift_modifier
);
6686 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6687 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6688 SINGLE_LETTER_MOD (super_modifier
);
6692 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6693 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6694 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6698 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6701 #undef SINGLE_LETTER_MOD
6702 #undef MULTI_LETTER_MOD
6708 /* Return true if EVENT is a list whose elements are all integers or symbols.
6709 Such a list is not valid as an event,
6710 but it can be a Lucid-style event type list. */
6713 lucid_event_type_list_p (Lisp_Object object
)
6717 if (! CONSP (object
))
6720 if (EQ (XCAR (object
), Qhelp_echo
)
6721 || EQ (XCAR (object
), Qvertical_line
)
6722 || EQ (XCAR (object
), Qmode_line
)
6723 || EQ (XCAR (object
), Qheader_line
))
6726 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6730 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6737 /* Return true if terminal input chars are available.
6738 Also, store the return value into INPUT_PENDING.
6740 Serves the purpose of ioctl (0, FIONREAD, ...)
6741 but works even if FIONREAD does not exist.
6742 (In fact, this may actually read some input.)
6744 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6745 timer events that are ripe.
6746 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6747 events (FOCUS_IN_EVENT).
6748 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6749 movements and toolkit scroll bar thumb drags. */
6752 get_input_pending (int flags
)
6754 /* First of all, have we already counted some input? */
6755 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6757 /* If input is being read as it arrives, and we have none, there is none. */
6758 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6760 /* Try to read some input and see how much we get. */
6762 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6765 return input_pending
;
6768 /* Put a BUFFER_SWITCH_EVENT in the buffer
6769 so that read_key_sequence will notice the new current buffer. */
6772 record_asynch_buffer_change (void)
6774 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6775 The purpose of the event is to make read_key_sequence look up the
6776 keymaps again. If we aren't in read_key_sequence, we don't need one,
6777 and the event could cause trouble by messing up (input-pending-p).
6778 Note: Fwaiting_for_user_input_p always returns nil when async
6779 subprocesses aren't supported. */
6780 if (!NILP (Fwaiting_for_user_input_p ()))
6782 struct input_event event
;
6785 event
.kind
= BUFFER_SWITCH_EVENT
;
6786 event
.frame_or_window
= Qnil
;
6789 /* Make sure no interrupt happens while storing the event. */
6791 if (interrupt_input
)
6792 kbd_buffer_store_event (&event
);
6797 kbd_buffer_store_event (&event
);
6803 /* Read any terminal input already buffered up by the system
6804 into the kbd_buffer, but do not wait.
6806 Return the number of keyboard chars read, or -1 meaning
6807 this is a bad time to try to read input. */
6816 /* Store pending user signal events, if any. */
6817 store_user_signal_events ();
6819 /* Loop through the available terminals, and call their input hooks. */
6823 struct terminal
*next
= t
->next_terminal
;
6825 if (t
->read_socket_hook
)
6828 struct input_event hold_quit
;
6830 if (input_blocked_p ())
6832 pending_signals
= 1;
6836 EVENT_INIT (hold_quit
);
6837 hold_quit
.kind
= NO_EVENT
;
6839 /* No need for FIONREAD or fcntl; just say don't wait. */
6840 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6843 if (nr
== -1) /* Not OK to read input now. */
6847 else if (nr
== -2) /* Non-transient error. */
6849 /* The terminal device terminated; it should be closed. */
6851 /* Kill Emacs if this was our last terminal. */
6852 if (!terminal_list
->next_terminal
)
6853 /* Formerly simply reported no input, but that
6854 sometimes led to a failure of Emacs to terminate.
6855 SIGHUP seems appropriate if we can't reach the
6857 /* ??? Is it really right to send the signal just to
6858 this process rather than to the whole process
6859 group? Perhaps on systems with FIONREAD Emacs is
6860 alone in its group. */
6861 terminate_due_to_signal (SIGHUP
, 10);
6863 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6866 XSETTERMINAL (tmp
, t
);
6867 Fdelete_terminal (tmp
, Qnoelisp
);
6871 /* If there was no error, make sure the pointer
6872 is visible for all frames on this terminal. */
6875 Lisp_Object tail
, frame
;
6877 FOR_EACH_FRAME (tail
, frame
)
6879 struct frame
*f
= XFRAME (frame
);
6880 if (FRAME_TERMINAL (f
) == t
)
6881 frame_make_pointer_visible (f
);
6885 if (hold_quit
.kind
!= NO_EVENT
)
6886 kbd_buffer_store_event (&hold_quit
);
6898 /* This is the tty way of reading available input.
6900 Note that each terminal device has its own `struct terminal' object,
6901 and so this function is called once for each individual termcap
6902 terminal. The first parameter indicates which terminal to read from. */
6905 tty_read_avail_input (struct terminal
*terminal
,
6906 struct input_event
*hold_quit
)
6908 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6909 the kbd_buffer can really hold. That may prevent loss
6910 of characters on some systems when input is stuffed at us. */
6911 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6913 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6916 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6918 if (kbd_on_hold_p () || buffer_free
<= 0)
6920 #endif /* subprocesses */
6922 if (!terminal
->name
) /* Don't read from a dead terminal. */
6925 if (terminal
->type
!= output_termcap
6926 && terminal
->type
!= output_msdos_raw
)
6929 /* XXX I think the following code should be moved to separate hook
6930 functions in system-dependent files. */
6932 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6933 code sets read_socket_hook to w32_console_read_socket instead! */
6935 #else /* not WINDOWSNT */
6936 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6940 return 0; /* The terminal is suspended. */
6943 n_to_read
= dos_keysns ();
6947 cbuf
[0] = dos_keyread ();
6950 #else /* not MSDOS */
6955 struct input_event gpm_hold_quit
;
6956 int gpm
, fd
= gpm_fd
;
6958 EVENT_INIT (gpm_hold_quit
);
6959 gpm_hold_quit
.kind
= NO_EVENT
;
6961 /* gpm==1 if event received.
6962 gpm==0 if the GPM daemon has closed the connection, in which case
6963 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6964 we save it in `fd' so close_gpm can remove it from the
6966 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6967 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6968 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6971 /* Presumably the GPM daemon has closed the connection. */
6973 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6974 kbd_buffer_store_event (&gpm_hold_quit
);
6978 #endif /* HAVE_GPM */
6980 /* Determine how many characters we should *try* to read. */
6981 #ifdef USABLE_FIONREAD
6982 /* Find out how much input is available. */
6983 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6985 if (! noninteractive
)
6986 return -2; /* Close this terminal. */
6992 if (n_to_read
> sizeof cbuf
)
6993 n_to_read
= sizeof cbuf
;
6994 #elif defined USG || defined CYGWIN
6995 /* Read some input if available, but don't wait. */
6996 n_to_read
= sizeof cbuf
;
6997 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6999 # error "Cannot read without possibly delaying"
7003 /* Don't read more than we can store. */
7004 if (n_to_read
> buffer_free
)
7005 n_to_read
= buffer_free
;
7006 #endif /* subprocesses */
7008 /* Now read; for one reason or another, this will not block.
7009 NREAD is set to the number of chars read. */
7012 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7013 /* POSIX infers that processes which are not in the session leader's
7014 process group won't get SIGHUPs at logout time. BSDI adheres to
7015 this part standard and returns -1 from read (0) with errno==EIO
7016 when the control tty is taken away.
7017 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7018 if (nread
== -1 && errno
== EIO
)
7019 return -2; /* Close this terminal. */
7020 #if defined (AIX) && defined (_BSD)
7021 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7022 This looks incorrect, but it isn't, because _BSD causes
7023 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7024 and that causes a value other than 0 when there is no input. */
7026 return -2; /* Close this terminal. */
7030 /* We used to retry the read if it was interrupted.
7031 But this does the wrong thing when O_NONBLOCK causes
7032 an EAGAIN error. Does anybody know of a situation
7033 where a retry is actually needed? */
7035 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7045 #ifndef USABLE_FIONREAD
7046 #if defined (USG) || defined (CYGWIN)
7047 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7048 #endif /* USG or CYGWIN */
7049 #endif /* no FIONREAD */
7054 #endif /* not MSDOS */
7055 #endif /* not WINDOWSNT */
7057 for (i
= 0; i
< nread
; i
++)
7059 struct input_event buf
;
7061 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7063 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7064 buf
.modifiers
= meta_modifier
;
7065 if (tty
->meta_key
!= 2)
7069 /* Set the frame corresponding to the active tty. Note that the
7070 value of selected_frame is not reliable here, redisplay tends
7071 to temporarily change it. */
7072 buf
.frame_or_window
= tty
->top_frame
;
7075 kbd_buffer_store_event (&buf
);
7076 /* Don't look at input that follows a C-g too closely.
7077 This reduces lossage due to autorepeat on C-g. */
7078 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7079 && buf
.code
== quit_char
)
7087 handle_async_input (void)
7092 int nread
= gobble_input ();
7093 /* -1 means it's not ok to read the input now.
7094 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7095 0 means there was no keyboard input available. */
7103 process_pending_signals (void)
7105 pending_signals
= 0;
7106 handle_async_input ();
7107 do_pending_atimers ();
7110 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7111 and reinvoke any pending signal if the level is now 0 and
7112 a fatal error is not already in progress. */
7115 unblock_input_to (int level
)
7117 interrupt_input_blocked
= level
;
7120 if (pending_signals
&& !fatal_error_in_progress
)
7121 process_pending_signals ();
7127 /* End critical section.
7129 If doing signal-driven input, and a signal came in when input was
7130 blocked, reinvoke the signal handler now to deal with it.
7132 It will also process queued input, if it was not read before.
7133 When a longer code sequence does not use block/unblock input
7134 at all, the whole input gathered up to the next call to
7135 unblock_input will be processed inside that call. */
7138 unblock_input (void)
7140 unblock_input_to (interrupt_input_blocked
- 1);
7143 /* Undo any number of BLOCK_INPUT calls,
7144 and also reinvoke any pending signal. */
7147 totally_unblock_input (void)
7149 unblock_input_to (0);
7155 handle_input_available_signal (int sig
)
7157 pending_signals
= 1;
7159 if (input_available_clear_time
)
7160 *input_available_clear_time
= make_timespec (0, 0);
7164 deliver_input_available_signal (int sig
)
7166 deliver_process_signal (sig
, handle_input_available_signal
);
7168 #endif /* USABLE_SIGIO */
7171 /* User signal events. */
7173 struct user_signal_info
7175 /* Signal number. */
7178 /* Name of the signal. */
7181 /* Number of pending signals. */
7184 struct user_signal_info
*next
;
7187 /* List of user signals. */
7188 static struct user_signal_info
*user_signals
= NULL
;
7191 add_user_signal (int sig
, const char *name
)
7193 struct sigaction action
;
7194 struct user_signal_info
*p
;
7196 for (p
= user_signals
; p
; p
= p
->next
)
7198 /* Already added. */
7201 p
= xmalloc (sizeof *p
);
7203 p
->name
= xstrdup (name
);
7205 p
->next
= user_signals
;
7208 emacs_sigaction_init (&action
, deliver_user_signal
);
7209 sigaction (sig
, &action
, 0);
7213 handle_user_signal (int sig
)
7215 struct user_signal_info
*p
;
7216 const char *special_event_name
= NULL
;
7218 if (SYMBOLP (Vdebug_on_event
))
7219 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7221 for (p
= user_signals
; p
; p
= p
->next
)
7224 if (special_event_name
7225 && strcmp (special_event_name
, p
->name
) == 0)
7227 /* Enter the debugger in many ways. */
7228 debug_on_next_call
= 1;
7231 Vinhibit_quit
= Qnil
;
7233 /* Eat the event. */
7239 if (interrupt_input
)
7240 handle_input_available_signal (sig
);
7244 /* Tell wait_reading_process_output that it needs to wake
7245 up and look around. */
7246 if (input_available_clear_time
)
7247 *input_available_clear_time
= make_timespec (0, 0);
7254 deliver_user_signal (int sig
)
7256 deliver_process_signal (sig
, handle_user_signal
);
7260 find_user_signal_name (int sig
)
7262 struct user_signal_info
*p
;
7264 for (p
= user_signals
; p
; p
= p
->next
)
7272 store_user_signal_events (void)
7274 struct user_signal_info
*p
;
7275 struct input_event buf
;
7276 bool buf_initialized
= 0;
7278 for (p
= user_signals
; p
; p
= p
->next
)
7279 if (p
->npending
> 0)
7281 if (! buf_initialized
)
7283 memset (&buf
, 0, sizeof buf
);
7284 buf
.kind
= USER_SIGNAL_EVENT
;
7285 buf
.frame_or_window
= selected_frame
;
7286 buf_initialized
= 1;
7292 kbd_buffer_store_event (&buf
);
7295 while (p
->npending
> 0);
7300 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7301 static Lisp_Object menu_bar_one_keymap_changed_items
;
7303 /* These variables hold the vector under construction within
7304 menu_bar_items and its subroutines, and the current index
7305 for storing into that vector. */
7306 static Lisp_Object menu_bar_items_vector
;
7307 static int menu_bar_items_index
;
7310 static const char *separator_names
[] = {
7315 "single-dashed-line",
7316 "double-dashed-line",
7318 "shadow-etched-out",
7319 "shadow-etched-in-dash",
7320 "shadow-etched-out-dash",
7321 "shadow-double-etched-in",
7322 "shadow-double-etched-out",
7323 "shadow-double-etched-in-dash",
7324 "shadow-double-etched-out-dash",
7328 /* Return true if LABEL specifies a separator. */
7331 menu_separator_name_p (const char *label
)
7335 else if (strlen (label
) > 3
7336 && memcmp (label
, "--", 2) == 0
7341 for (i
= 0; separator_names
[i
]; ++i
)
7342 if (strcmp (label
, separator_names
[i
]) == 0)
7347 /* It's a separator if it contains only dashes. */
7348 while (*label
== '-')
7350 return (*label
== 0);
7357 /* Return a vector of menu items for a menu bar, appropriate
7358 to the current buffer. Each item has three elements in the vector:
7361 OLD is an old vector we can optionally reuse, or nil. */
7364 menu_bar_items (Lisp_Object old
)
7366 /* The number of keymaps we're scanning right now, and the number of
7367 keymaps we have allocated space for. */
7370 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7371 in the current keymaps, or nil where it is not a prefix. */
7374 Lisp_Object def
, tail
;
7379 /* In order to build the menus, we need to call the keymap
7380 accessors. They all call QUIT. But this function is called
7381 during redisplay, during which a quit is fatal. So inhibit
7382 quitting while building the menus.
7383 We do this instead of specbind because (1) errors will clear it anyway
7384 and (2) this avoids risk of specpdl overflow. */
7385 oquit
= Vinhibit_quit
;
7389 menu_bar_items_vector
= old
;
7391 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7392 menu_bar_items_index
= 0;
7394 /* Build our list of keymaps.
7395 If we recognize a function key and replace its escape sequence in
7396 keybuf with its symbol, or if the sequence starts with a mouse
7397 click and we need to switch buffers, we jump back here to rebuild
7398 the initial keymaps from the current buffer. */
7402 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7403 if (!NILP (Voverriding_local_map_menu_flag
)
7404 && !NILP (Voverriding_local_map
))
7406 /* Yes, use them (if non-nil) as well as the global map. */
7407 maps
= alloca (3 * sizeof (maps
[0]));
7409 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7410 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7411 if (!NILP (Voverriding_local_map
))
7412 maps
[nmaps
++] = Voverriding_local_map
;
7416 /* No, so use major and minor mode keymaps and keymap property.
7417 Note that menu-bar bindings in the local-map and keymap
7418 properties may not work reliable, as they are only
7419 recognized when the menu-bar (or mode-line) is updated,
7420 which does not normally happen after every command. */
7423 nminor
= current_minor_maps (NULL
, &tmaps
);
7424 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7426 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7427 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7428 maps
[nmaps
++] = tem
;
7429 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7430 maps
[nmaps
++] = tem
;
7431 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7433 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7435 maps
[nmaps
++] = current_global_map
;
7438 /* Look up in each map the dummy prefix key `menu-bar'. */
7440 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7441 if (!NILP (maps
[mapno
]))
7443 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7447 menu_bar_one_keymap_changed_items
= Qnil
;
7448 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7452 /* Move to the end those items that should be at the end. */
7454 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7457 int end
= menu_bar_items_index
;
7459 for (i
= 0; i
< end
; i
+= 4)
7460 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7462 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7463 /* Move the item at index I to the end,
7464 shifting all the others forward. */
7465 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7466 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7467 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7468 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7470 memmove (aref_addr (menu_bar_items_vector
, i
),
7471 aref_addr (menu_bar_items_vector
, i
+ 4),
7472 (end
- i
- 4) * word_size
);
7473 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7474 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7475 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7476 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7481 /* Add nil, nil, nil, nil at the end. */
7483 int i
= menu_bar_items_index
;
7484 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7485 menu_bar_items_vector
7486 = larger_vector (menu_bar_items_vector
, 4, -1);
7487 /* Add this item. */
7488 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7489 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7490 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7491 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7492 menu_bar_items_index
= i
;
7495 Vinhibit_quit
= oquit
;
7496 return menu_bar_items_vector
;
7499 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7500 If there's already an item for KEY, add this DEF to it. */
7502 Lisp_Object item_properties
;
7505 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7507 struct gcpro gcpro1
;
7512 if (EQ (item
, Qundefined
))
7514 /* If a map has an explicit `undefined' as definition,
7515 discard any previously made menu bar item. */
7517 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7518 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7520 if (menu_bar_items_index
> i
+ 4)
7521 memmove (aref_addr (menu_bar_items_vector
, i
),
7522 aref_addr (menu_bar_items_vector
, i
+ 4),
7523 (menu_bar_items_index
- i
- 4) * word_size
);
7524 menu_bar_items_index
-= 4;
7528 /* If this keymap has already contributed to this KEY,
7529 don't contribute to it a second time. */
7530 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7531 if (!NILP (tem
) || NILP (item
))
7534 menu_bar_one_keymap_changed_items
7535 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7537 /* We add to menu_bar_one_keymap_changed_items before doing the
7538 parse_menu_item, so that if it turns out it wasn't a menu item,
7539 it still correctly hides any further menu item. */
7541 parsed
= parse_menu_item (item
, 1);
7546 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7548 /* Find any existing item for this KEY. */
7549 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7550 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7553 /* If we did not find this KEY, add it at the end. */
7554 if (i
== menu_bar_items_index
)
7556 /* If vector is too small, get a bigger one. */
7557 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7558 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7559 /* Add this item. */
7560 ASET (menu_bar_items_vector
, i
, key
); i
++;
7561 ASET (menu_bar_items_vector
, i
,
7562 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7563 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7564 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7565 menu_bar_items_index
= i
;
7567 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7571 old
= AREF (menu_bar_items_vector
, i
+ 2);
7572 /* If the new and the old items are not both keymaps,
7573 the lookup will only find `item'. */
7574 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7575 ASET (menu_bar_items_vector
, i
+ 2, item
);
7579 /* This is used as the handler when calling menu_item_eval_property. */
7581 menu_item_eval_property_1 (Lisp_Object arg
)
7583 /* If we got a quit from within the menu computation,
7584 quit all the way out of it. This takes care of C-] in the debugger. */
7585 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7586 Fsignal (Qquit
, Qnil
);
7592 eval_dyn (Lisp_Object form
)
7594 return Feval (form
, Qnil
);
7597 /* Evaluate an expression and return the result (or nil if something
7598 went wrong). Used to evaluate dynamic parts of menu items. */
7600 menu_item_eval_property (Lisp_Object sexpr
)
7602 ptrdiff_t count
= SPECPDL_INDEX ();
7604 specbind (Qinhibit_redisplay
, Qt
);
7605 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7606 menu_item_eval_property_1
);
7607 return unbind_to (count
, val
);
7610 /* This function parses a menu item and leaves the result in the
7611 vector item_properties.
7612 ITEM is a key binding, a possible menu item.
7613 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7615 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7616 parse_menu_item returns true if the item is a menu item and false
7620 parse_menu_item (Lisp_Object item
, int inmenubar
)
7622 Lisp_Object def
, tem
, item_string
, start
;
7624 Lisp_Object keyhint
;
7633 /* Create item_properties vector if necessary. */
7634 if (NILP (item_properties
))
7636 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7638 /* Initialize optional entries. */
7639 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7640 ASET (item_properties
, i
, Qnil
);
7641 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7643 /* Save the item here to protect it from GC. */
7644 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7646 item_string
= XCAR (item
);
7650 if (STRINGP (item_string
))
7652 /* Old format menu item. */
7653 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7655 /* Maybe help string. */
7656 if (CONSP (item
) && STRINGP (XCAR (item
)))
7658 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7663 /* Maybe an obsolete key binding cache. */
7664 if (CONSP (item
) && CONSP (XCAR (item
))
7665 && (NILP (XCAR (XCAR (item
)))
7666 || VECTORP (XCAR (XCAR (item
)))))
7669 /* This is the real definition--the function to run. */
7670 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7672 /* Get enable property, if any. */
7675 tem
= Fget (item
, Qmenu_enable
);
7676 if (!NILP (Venable_disabled_menus_and_buttons
))
7677 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7678 else if (!NILP (tem
))
7679 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7682 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7684 /* New format menu item. */
7685 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7686 start
= XCDR (item
);
7689 /* We have a real binding. */
7690 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7692 item
= XCDR (start
);
7693 /* Is there an obsolete cache list with key equivalences. */
7694 if (CONSP (item
) && CONSP (XCAR (item
)))
7697 /* Parse properties. */
7698 while (CONSP (item
) && CONSP (XCDR (item
)))
7703 if (EQ (tem
, QCenable
))
7705 if (!NILP (Venable_disabled_menus_and_buttons
))
7706 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7708 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7710 else if (EQ (tem
, QCvisible
))
7712 /* If got a visible property and that evaluates to nil
7713 then ignore this item. */
7714 tem
= menu_item_eval_property (XCAR (item
));
7718 else if (EQ (tem
, QChelp
))
7719 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7720 else if (EQ (tem
, QCfilter
))
7722 else if (EQ (tem
, QCkey_sequence
))
7725 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7726 /* Be GC protected. Set keyhint to item instead of tem. */
7729 else if (EQ (tem
, QCkeys
))
7732 if (CONSP (tem
) || STRINGP (tem
))
7733 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7735 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7740 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7742 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7744 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7750 else if (inmenubar
|| !NILP (start
))
7754 return 0; /* not a menu item */
7756 /* If item string is not a string, evaluate it to get string.
7757 If we don't get a string, skip this item. */
7758 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7759 if (!(STRINGP (item_string
)))
7761 item_string
= menu_item_eval_property (item_string
);
7762 if (!STRINGP (item_string
))
7764 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7767 /* If got a filter apply it on definition. */
7768 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7771 def
= menu_item_eval_property (list2 (XCAR (filter
),
7772 list2 (Qquote
, def
)));
7774 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7777 /* Enable or disable selection of item. */
7778 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7781 tem
= menu_item_eval_property (tem
);
7782 if (inmenubar
&& NILP (tem
))
7783 return 0; /* Ignore disabled items in menu bar. */
7784 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7787 /* If we got no definition, this item is just unselectable text which
7788 is OK in a submenu but not in the menubar. */
7790 return (!inmenubar
);
7792 /* See if this is a separate pane or a submenu. */
7793 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7794 tem
= get_keymap (def
, 0, 1);
7795 /* For a subkeymap, just record its details and exit. */
7798 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7799 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7803 /* At the top level in the menu bar, do likewise for commands also.
7804 The menu bar does not display equivalent key bindings anyway.
7805 ITEM_PROPERTY_DEF is already set up properly. */
7809 { /* This is a command. See if there is an equivalent key binding. */
7810 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7812 /* The previous code preferred :key-sequence to :keys, so we
7813 preserve this behavior. */
7814 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7815 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7818 Lisp_Object prefix
= keyeq
;
7819 Lisp_Object keys
= Qnil
;
7823 def
= XCAR (prefix
);
7824 prefix
= XCDR (prefix
);
7827 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7829 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7831 keys
= XCAR (keyhint
);
7832 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7834 /* We have a suggested key. Is it bound to the command? */
7837 /* If the command is an alias for another
7838 (such as lmenu.el set it up), check if the
7839 original command matches the cached command. */
7841 && EQ (tem
, XSYMBOL (def
)->function
))))
7846 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7850 tem
= Fkey_description (keys
, Qnil
);
7853 if (STRINGP (XCAR (prefix
)))
7854 tem
= concat2 (XCAR (prefix
), tem
);
7855 if (STRINGP (XCDR (prefix
)))
7856 tem
= concat2 (tem
, XCDR (prefix
));
7858 keyeq
= concat2 (build_string (" "), tem
);
7859 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7865 /* If we have an equivalent key binding, use that. */
7866 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7869 /* Include this when menu help is implemented.
7870 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7871 if (!(NILP (tem) || STRINGP (tem)))
7873 tem = menu_item_eval_property (tem);
7876 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7880 /* Handle radio buttons or toggle boxes. */
7881 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7883 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7884 menu_item_eval_property (tem
));
7891 /***********************************************************************
7893 ***********************************************************************/
7895 /* A vector holding tool bar items while they are parsed in function
7896 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7899 static Lisp_Object tool_bar_items_vector
;
7901 /* A vector holding the result of parse_tool_bar_item. Layout is like
7902 the one for a single item in tool_bar_items_vector. */
7904 static Lisp_Object tool_bar_item_properties
;
7906 /* Next free index in tool_bar_items_vector. */
7908 static int ntool_bar_items
;
7910 /* The symbols `:image' and `:rtl'. */
7912 static Lisp_Object QCimage
;
7913 static Lisp_Object QCrtl
;
7915 /* Function prototypes. */
7917 static void init_tool_bar_items (Lisp_Object
);
7918 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7920 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7921 static void append_tool_bar_item (void);
7924 /* Return a vector of tool bar items for keymaps currently in effect.
7925 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7926 tool bar items found. */
7929 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7938 /* In order to build the menus, we need to call the keymap
7939 accessors. They all call QUIT. But this function is called
7940 during redisplay, during which a quit is fatal. So inhibit
7941 quitting while building the menus. We do this instead of
7942 specbind because (1) errors will clear it anyway and (2) this
7943 avoids risk of specpdl overflow. */
7944 oquit
= Vinhibit_quit
;
7947 /* Initialize tool_bar_items_vector and protect it from GC. */
7948 init_tool_bar_items (reuse
);
7950 /* Build list of keymaps in maps. Set nmaps to the number of maps
7953 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7954 if (!NILP (Voverriding_local_map_menu_flag
)
7955 && !NILP (Voverriding_local_map
))
7957 /* Yes, use them (if non-nil) as well as the global map. */
7958 maps
= alloca (3 * sizeof *maps
);
7960 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7961 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7962 if (!NILP (Voverriding_local_map
))
7963 maps
[nmaps
++] = Voverriding_local_map
;
7967 /* No, so use major and minor mode keymaps and keymap property.
7968 Note that tool-bar bindings in the local-map and keymap
7969 properties may not work reliable, as they are only
7970 recognized when the tool-bar (or mode-line) is updated,
7971 which does not normally happen after every command. */
7974 nminor
= current_minor_maps (NULL
, &tmaps
);
7975 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7977 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7978 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7979 maps
[nmaps
++] = tem
;
7980 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7981 maps
[nmaps
++] = tem
;
7982 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7984 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7987 /* Add global keymap at the end. */
7988 maps
[nmaps
++] = current_global_map
;
7990 /* Process maps in reverse order and look up in each map the prefix
7992 for (i
= nmaps
- 1; i
>= 0; --i
)
7993 if (!NILP (maps
[i
]))
7997 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7999 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8002 Vinhibit_quit
= oquit
;
8003 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8004 return tool_bar_items_vector
;
8008 /* Process the definition of KEY which is DEF. */
8011 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8014 struct gcpro gcpro1
, gcpro2
;
8016 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8020 if (EQ (def
, Qundefined
))
8022 /* If a map has an explicit `undefined' as definition,
8023 discard any previously made item. */
8024 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8026 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8028 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8030 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8031 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8032 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8034 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8039 else if (parse_tool_bar_item (key
, def
))
8040 /* Append a new tool bar item to tool_bar_items_vector. Accept
8041 more than one definition for the same key. */
8042 append_tool_bar_item ();
8047 /* Access slot with index IDX of vector tool_bar_item_properties. */
8048 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8050 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8052 ASET (tool_bar_item_properties
, idx
, val
);
8056 /* Parse a tool bar item specification ITEM for key KEY and return the
8057 result in tool_bar_item_properties. Value is false if ITEM is
8060 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8062 CAPTION is the caption of the item, If it's not a string, it is
8063 evaluated to get a string.
8065 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8066 as binding are currently ignored.
8068 The following properties are recognized:
8072 FORM is evaluated and specifies whether the tool bar item is
8073 enabled or disabled.
8077 FORM is evaluated and specifies whether the tool bar item is visible.
8079 - `:filter FUNCTION'
8081 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8082 result is stored as the new binding.
8084 - `:button (TYPE SELECTED)'
8086 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8087 and specifies whether the button is selected (pressed) or not.
8091 IMAGES is either a single image specification or a vector of four
8092 image specifications. See enum tool_bar_item_images.
8094 - `:help HELP-STRING'.
8096 Gives a help string to display for the tool bar item.
8098 - `:label LABEL-STRING'.
8100 A text label to show with the tool bar button if labels are enabled. */
8103 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8105 Lisp_Object filter
= Qnil
;
8106 Lisp_Object caption
;
8108 bool have_label
= 0;
8110 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8111 Rule out items that aren't lists, don't start with
8112 `menu-item' or whose rest following `tool-bar-item' is not a
8117 /* As an exception, allow old-style menu separators. */
8118 if (STRINGP (XCAR (item
)))
8119 item
= list1 (XCAR (item
));
8120 else if (!EQ (XCAR (item
), Qmenu_item
)
8121 || (item
= XCDR (item
), !CONSP (item
)))
8124 /* Create tool_bar_item_properties vector if necessary. Reset it to
8126 if (VECTORP (tool_bar_item_properties
))
8128 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8132 tool_bar_item_properties
8133 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8136 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8137 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8139 /* Get the caption of the item. If the caption is not a string,
8140 evaluate it to get a string. If we don't get a string, skip this
8142 caption
= XCAR (item
);
8143 if (!STRINGP (caption
))
8145 caption
= menu_item_eval_property (caption
);
8146 if (!STRINGP (caption
))
8149 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8151 /* If the rest following the caption is not a list, the menu item is
8152 either a separator, or invalid. */
8156 if (menu_separator_name_p (SSDATA (caption
)))
8158 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8159 #if !defined (USE_GTK) && !defined (HAVE_NS)
8160 /* If we use build_desired_tool_bar_string to render the
8161 tool bar, the separator is rendered as an image. */
8162 set_prop (TOOL_BAR_ITEM_IMAGES
,
8163 (menu_item_eval_property
8164 (Vtool_bar_separator_image_expression
)));
8165 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8166 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8167 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8174 /* Store the binding. */
8175 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8178 /* Ignore cached key binding, if any. */
8179 if (CONSP (item
) && CONSP (XCAR (item
)))
8182 /* Process the rest of the properties. */
8183 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8185 Lisp_Object ikey
, value
;
8188 value
= XCAR (XCDR (item
));
8190 if (EQ (ikey
, QCenable
))
8192 /* `:enable FORM'. */
8193 if (!NILP (Venable_disabled_menus_and_buttons
))
8194 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8196 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8198 else if (EQ (ikey
, QCvisible
))
8200 /* `:visible FORM'. If got a visible property and that
8201 evaluates to nil then ignore this item. */
8202 if (NILP (menu_item_eval_property (value
)))
8205 else if (EQ (ikey
, QChelp
))
8206 /* `:help HELP-STRING'. */
8207 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8208 else if (EQ (ikey
, QCvert_only
))
8209 /* `:vert-only t/nil'. */
8210 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8211 else if (EQ (ikey
, QClabel
))
8213 const char *bad_label
= "!!?GARBLED ITEM?!!";
8214 /* `:label LABEL-STRING'. */
8215 set_prop (TOOL_BAR_ITEM_LABEL
,
8216 STRINGP (value
) ? value
: build_string (bad_label
));
8219 else if (EQ (ikey
, QCfilter
))
8220 /* ':filter FORM'. */
8222 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8224 /* `:button (TYPE . SELECTED)'. */
8225 Lisp_Object type
, selected
;
8227 type
= XCAR (value
);
8228 selected
= XCDR (value
);
8229 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8231 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8232 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8235 else if (EQ (ikey
, QCimage
)
8237 || (VECTORP (value
) && ASIZE (value
) == 4)))
8238 /* Value is either a single image specification or a vector
8239 of 4 such specifications for the different button states. */
8240 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8241 else if (EQ (ikey
, QCrtl
))
8243 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8249 /* Try to make one from caption and key. */
8250 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8251 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8252 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8253 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8255 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8256 char *buf
= xmalloc (max_lbl
+ 1);
8257 Lisp_Object new_lbl
;
8258 ptrdiff_t caption_len
= strlen (capt
);
8260 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8263 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8265 buf
[caption_len
] = '\0';
8269 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8273 strcpy (buf
, label
);
8275 for (j
= 0; buf
[j
] != '\0'; ++j
)
8283 new_lbl
= Fupcase_initials (build_string (label
));
8284 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8285 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8287 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8291 /* If got a filter apply it on binding. */
8293 set_prop (TOOL_BAR_ITEM_BINDING
,
8294 (menu_item_eval_property
8297 PROP (TOOL_BAR_ITEM_BINDING
))))));
8299 /* See if the binding is a keymap. Give up if it is. */
8300 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8303 /* Enable or disable selection of item. */
8304 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8305 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8306 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8308 /* Handle radio buttons or toggle boxes. */
8309 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8310 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8311 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8319 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8320 that can be reused. */
8323 init_tool_bar_items (Lisp_Object reuse
)
8325 if (VECTORP (reuse
))
8326 tool_bar_items_vector
= reuse
;
8328 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8329 ntool_bar_items
= 0;
8333 /* Append parsed tool bar item properties from
8334 tool_bar_item_properties */
8337 append_tool_bar_item (void)
8341 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8343 /* Enlarge tool_bar_items_vector if necessary. */
8345 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8347 /* Append entries from tool_bar_item_properties to the end of
8348 tool_bar_items_vector. */
8349 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8350 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8351 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8358 /* Read a character using menus based on the keymap MAP.
8359 Return nil if there are no menus in the maps.
8360 Return t if we displayed a menu but the user rejected it.
8362 PREV_EVENT is the previous input event, or nil if we are reading
8363 the first event of a key sequence.
8365 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8366 if we used a mouse menu to read the input, or false otherwise. If
8367 USED_MOUSE_MENU is null, don't dereference it.
8369 The prompting is done based on the prompt-string of the map
8370 and the strings associated with various map elements.
8372 This can be done with X menus or with menus put in the minibuf.
8373 These are done in different ways, depending on how the input will be read.
8374 Menus using X are done after auto-saving in read-char, getting the input
8375 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8376 and do auto-saving in the inner call of read_char. */
8379 read_char_x_menu_prompt (Lisp_Object map
,
8380 Lisp_Object prev_event
, bool *used_mouse_menu
)
8382 if (used_mouse_menu
)
8383 *used_mouse_menu
= 0;
8385 /* Use local over global Menu maps. */
8387 if (! menu_prompting
)
8390 /* If we got to this point via a mouse click,
8391 use a real menu for mouse selection. */
8392 if (EVENT_HAS_PARAMETERS (prev_event
)
8393 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8394 && !EQ (XCAR (prev_event
), Qtool_bar
))
8396 /* Display the menu and get the selection. */
8399 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8404 record_menu_key (XCAR (value
));
8406 /* If we got multiple events, unread all but
8408 There is no way to prevent those unread events
8409 from showing up later in last_nonmenu_event.
8410 So turn symbol and integer events into lists,
8411 to indicate that they came from a mouse menu,
8412 so that when present in last_nonmenu_event
8413 they won't confuse things. */
8414 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8416 record_menu_key (XCAR (tem
));
8417 if (SYMBOLP (XCAR (tem
))
8418 || INTEGERP (XCAR (tem
)))
8419 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8422 /* If we got more than one event, put all but the first
8423 onto this list to be read later.
8424 Return just the first event now. */
8425 Vunread_command_events
8426 = nconc2 (XCDR (value
), Vunread_command_events
);
8427 value
= XCAR (value
);
8429 else if (NILP (value
))
8431 if (used_mouse_menu
)
8432 *used_mouse_menu
= 1;
8439 read_char_minibuf_menu_prompt (int commandflag
,
8442 register Lisp_Object name
;
8444 /* FIXME: Use the minibuffer's frame width. */
8445 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8447 bool nobindings
= 1;
8448 Lisp_Object rest
, vector
;
8449 Lisp_Object prompt_strings
= Qnil
;
8453 if (! menu_prompting
)
8456 map
= get_keymap (map
, 0, 1);
8457 name
= Fkeymap_prompt (map
);
8459 /* If we don't have any menus, just read a character normally. */
8460 if (!STRINGP (name
))
8463 #define PUSH_C_STR(str, listvar) \
8464 listvar = Fcons (build_unibyte_string (str), listvar)
8466 /* Prompt string always starts with map's prompt, and a space. */
8467 prompt_strings
= Fcons (name
, prompt_strings
);
8468 PUSH_C_STR (": ", prompt_strings
);
8469 nlength
= SCHARS (name
) + 2;
8473 /* Present the documented bindings, a line at a time. */
8477 Lisp_Object menu_strings
= prompt_strings
;
8478 ptrdiff_t i
= nlength
;
8480 Lisp_Object orig_defn_macro
;
8482 /* Loop over elements of map. */
8487 /* FIXME: Use map_keymap to handle new keymap formats. */
8489 /* At end of map, wrap around if just starting,
8490 or end this line if already have something on it. */
8493 if (notfirst
|| nobindings
)
8499 /* Look at the next element of the map. */
8501 elt
= AREF (vector
, idx
);
8503 elt
= Fcar_safe (rest
);
8505 if (idx
< 0 && VECTORP (elt
))
8507 /* If we found a dense table in the keymap,
8508 advanced past it, but start scanning its contents. */
8509 rest
= Fcdr_safe (rest
);
8515 /* An ordinary element. */
8516 Lisp_Object event
, tem
;
8520 event
= Fcar_safe (elt
); /* alist */
8521 elt
= Fcdr_safe (elt
);
8525 XSETINT (event
, idx
); /* vector */
8528 /* Ignore the element if it has no prompt string. */
8529 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8531 /* True if the char to type matches the string. */
8533 Lisp_Object upcased_event
, downcased_event
;
8534 Lisp_Object desc
= Qnil
;
8536 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8538 upcased_event
= Fupcase (event
);
8539 downcased_event
= Fdowncase (event
);
8540 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8541 || XINT (downcased_event
) == SREF (s
, 0));
8543 desc
= Fsingle_key_description (event
, Qnil
);
8545 #if 0 /* It is redundant to list the equivalent key bindings because
8546 the prefix is what the user has already typed. */
8548 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8550 /* Insert equivalent keybinding. */
8551 s
= concat2 (s
, tem
);
8554 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8555 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8557 /* Insert button prefix. */
8558 Lisp_Object selected
8559 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8560 if (EQ (tem
, QCradio
))
8561 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8563 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8564 s
= concat2 (tem
, s
);
8568 /* If we have room for the prompt string, add it to this line.
8569 If this is the first on the line, always add it. */
8570 if ((SCHARS (s
) + i
+ 2
8571 + (char_matches
? 0 : SCHARS (desc
) + 3))
8575 ptrdiff_t thiswidth
;
8577 /* Punctuate between strings. */
8580 PUSH_C_STR (", ", menu_strings
);
8586 /* If the char to type doesn't match the string's
8587 first char, explicitly show what char to type. */
8590 /* Add as much of string as fits. */
8591 thiswidth
= min (SCHARS (desc
), width
- i
);
8593 = Fcons (Fsubstring (desc
, make_number (0),
8594 make_number (thiswidth
)),
8597 PUSH_C_STR (" = ", menu_strings
);
8601 /* Add as much of string as fits. */
8602 thiswidth
= min (SCHARS (s
), width
- i
);
8604 = Fcons (Fsubstring (s
, make_number (0),
8605 make_number (thiswidth
)),
8611 /* If this element does not fit, end the line now,
8612 and save the element for the next line. */
8613 PUSH_C_STR ("...", menu_strings
);
8618 /* Move past this element. */
8619 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8620 /* Handle reaching end of dense table. */
8625 rest
= Fcdr_safe (rest
);
8629 /* Prompt with that and read response. */
8630 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8632 /* Make believe it's not a keyboard macro in case the help char
8633 is pressed. Help characters are not recorded because menu prompting
8634 is not used on replay. */
8635 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8636 kset_defining_kbd_macro (current_kboard
, Qnil
);
8638 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8639 while (BUFFERP (obj
));
8640 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8642 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8645 if (! EQ (obj
, menu_prompt_more_char
)
8646 && (!INTEGERP (menu_prompt_more_char
)
8647 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8649 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8650 store_kbd_macro_char (obj
);
8653 /* Help char - go round again. */
8657 /* Reading key sequences. */
8660 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8662 return access_keymap (get_keymap (keymap
, 0, 1),
8667 active_maps (Lisp_Object first_event
)
8669 Lisp_Object position
8670 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8671 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8674 /* Structure used to keep track of partial application of key remapping
8675 such as Vfunction_key_map and Vkey_translation_map. */
8676 typedef struct keyremap
8678 /* This is the map originally specified for this use. */
8680 /* This is a submap reached by looking up, in PARENT,
8681 the events from START to END. */
8683 /* Positions [START, END) in the key sequence buffer
8684 are the key that we have scanned so far.
8685 Those events are the ones that we will replace
8686 if PARENT maps them into a key sequence. */
8690 /* Lookup KEY in MAP.
8691 MAP is a keymap mapping keys to key vectors or functions.
8692 If the mapping is a function and DO_FUNCALL is true,
8693 the function is called with PROMPT as parameter and its return
8694 value is used as the return value of this function (after checking
8695 that it is indeed a vector). */
8698 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8703 next
= access_keymap (map
, key
, 1, 0, 1);
8705 /* Handle a symbol whose function definition is a keymap
8707 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8708 && (ARRAYP (XSYMBOL (next
)->function
)
8709 || KEYMAPP (XSYMBOL (next
)->function
)))
8710 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8712 /* If the keymap gives a function, not an
8713 array, then call the function with one arg and use
8714 its value instead. */
8715 if (do_funcall
&& FUNCTIONP (next
))
8720 next
= call1 (next
, prompt
);
8721 /* If the function returned something invalid,
8722 barf--don't ignore it.
8723 (To ignore it safely, we would need to gcpro a bunch of
8724 other variables.) */
8725 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8726 error ("Function %s returns invalid key sequence",
8727 SSDATA (SYMBOL_NAME (tem
)));
8732 /* Do one step of the key remapping used for function-key-map and
8733 key-translation-map:
8734 KEYBUF is the buffer holding the input events.
8735 BUFSIZE is its maximum size.
8736 FKEY is a pointer to the keyremap structure to use.
8737 INPUT is the index of the last element in KEYBUF.
8738 DOIT if true says that the remapping can actually take place.
8739 DIFF is used to return the number of keys added/removed by the remapping.
8740 PARENT is the root of the keymap.
8741 PROMPT is the prompt to use if the remapping happens through a function.
8742 Return true if the remapping actually took place. */
8745 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8746 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8748 Lisp_Object next
, key
;
8750 key
= keybuf
[fkey
->end
++];
8752 if (KEYMAPP (fkey
->parent
))
8753 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8757 /* If keybuf[fkey->start..fkey->end] is bound in the
8758 map and we're in a position to do the key remapping, replace it with
8759 the binding and restart with fkey->start at the end. */
8760 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8762 int len
= XFASTINT (Flength (next
));
8765 *diff
= len
- (fkey
->end
- fkey
->start
);
8767 if (bufsize
- input
<= *diff
)
8768 error ("Key sequence too long");
8770 /* Shift the keys that follow fkey->end. */
8772 for (i
= fkey
->end
; i
< input
; i
++)
8773 keybuf
[i
+ *diff
] = keybuf
[i
];
8775 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8776 keybuf
[i
+ *diff
] = keybuf
[i
];
8777 /* Overwrite the old keys with the new ones. */
8778 for (i
= 0; i
< len
; i
++)
8779 keybuf
[fkey
->start
+ i
]
8780 = Faref (next
, make_number (i
));
8782 fkey
->start
= fkey
->end
+= *diff
;
8783 fkey
->map
= fkey
->parent
;
8788 fkey
->map
= get_keymap (next
, 0, 1);
8790 /* If we no longer have a bound suffix, try a new position for
8792 if (!CONSP (fkey
->map
))
8794 fkey
->end
= ++fkey
->start
;
8795 fkey
->map
= fkey
->parent
;
8801 test_undefined (Lisp_Object binding
)
8803 return (NILP (binding
)
8804 || EQ (binding
, Qundefined
)
8805 || (SYMBOLP (binding
)
8806 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8809 /* Read a sequence of keys that ends with a non prefix character,
8810 storing it in KEYBUF, a buffer of size BUFSIZE.
8812 Return the length of the key sequence stored.
8813 Return -1 if the user rejected a command menu.
8815 Echo starting immediately unless `prompt' is 0.
8817 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8818 read_char with a suitable COMMANDFLAG argument.
8820 Where a key sequence ends depends on the currently active keymaps.
8821 These include any minor mode keymaps active in the current buffer,
8822 the current buffer's local map, and the global map.
8824 If a key sequence has no other bindings, we check Vfunction_key_map
8825 to see if some trailing subsequence might be the beginning of a
8826 function key's sequence. If so, we try to read the whole function
8827 key, and substitute its symbolic name into the key sequence.
8829 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8830 `double-' events into similar click events, if that would make them
8831 bound. We try to turn `triple-' events first into `double-' events,
8834 If we get a mouse click in a mode line, vertical divider, or other
8835 non-text area, we treat the click as if it were prefixed by the
8836 symbol denoting that area - `mode-line', `vertical-line', or
8839 If the sequence starts with a mouse click, we read the key sequence
8840 with respect to the buffer clicked on, not the current buffer.
8842 If the user switches frames in the midst of a key sequence, we put
8843 off the switch-frame event until later; the next call to
8844 read_char will return it.
8846 If FIX_CURRENT_BUFFER, we restore current_buffer
8847 from the selected window's buffer. */
8850 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8851 bool dont_downcase_last
, bool can_return_switch_frame
,
8852 bool fix_current_buffer
, bool prevent_redisplay
)
8854 ptrdiff_t count
= SPECPDL_INDEX ();
8856 /* How many keys there are in the current key sequence. */
8859 /* The length of the echo buffer when we started reading, and
8860 the length of this_command_keys when we started reading. */
8861 ptrdiff_t echo_start
IF_LINT (= 0);
8862 ptrdiff_t keys_start
;
8864 Lisp_Object current_binding
= Qnil
;
8865 Lisp_Object first_event
= Qnil
;
8867 /* Index of the first key that has no binding.
8868 It is useless to try fkey.start larger than that. */
8871 /* If t < mock_input, then KEYBUF[t] should be read as the next
8874 We use this to recover after recognizing a function key. Once we
8875 realize that a suffix of the current key sequence is actually a
8876 function key's escape sequence, we replace the suffix with the
8877 function key's binding from Vfunction_key_map. Now keybuf
8878 contains a new and different key sequence, so the echo area,
8879 this_command_keys, and the submaps and defs arrays are wrong. In
8880 this situation, we set mock_input to t, set t to 0, and jump to
8881 restart_sequence; the loop will read keys from keybuf up until
8882 mock_input, thus rebuilding the state; and then it will resume
8883 reading characters from the keyboard. */
8886 /* If the sequence is unbound in submaps[], then
8887 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8888 and fkey.map is its binding.
8890 These might be > t, indicating that all function key scanning
8891 should hold off until t reaches them. We do this when we've just
8892 recognized a function key, to avoid searching for the function
8893 key's again in Vfunction_key_map. */
8896 /* Likewise, for key_translation_map and input-decode-map. */
8897 keyremap keytran
, indec
;
8899 /* True if we are trying to map a key by changing an upper-case
8900 letter to lower case, or a shifted function key to an unshifted
8902 bool shift_translated
= 0;
8904 /* If we receive a `switch-frame' or `select-window' event in the middle of
8905 a key sequence, we put it off for later.
8906 While we're reading, we keep the event here. */
8907 Lisp_Object delayed_switch_frame
;
8909 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8910 int original_uppercase_position
= -1;
8912 /* Gets around Microsoft compiler limitations. */
8915 struct buffer
*starting_buffer
;
8917 /* List of events for which a fake prefix key has been generated. */
8918 Lisp_Object fake_prefixed_keys
= Qnil
;
8920 struct gcpro gcpro1
;
8922 GCPRO1 (fake_prefixed_keys
);
8923 raw_keybuf_count
= 0;
8925 last_nonmenu_event
= Qnil
;
8927 delayed_switch_frame
= Qnil
;
8933 /* Install the string PROMPT as the beginning of the string
8934 of echoing, so that it serves as a prompt for the next
8936 kset_echo_string (current_kboard
, prompt
);
8937 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8940 else if (cursor_in_echo_area
8941 && echo_keystrokes_p ())
8942 /* This doesn't put in a dash if the echo buffer is empty, so
8943 you don't always see a dash hanging out in the minibuffer. */
8947 /* Record the initial state of the echo area and this_command_keys;
8948 we will need to restore them if we replay a key sequence. */
8950 echo_start
= echo_length ();
8951 keys_start
= this_command_key_count
;
8952 this_single_command_key_start
= keys_start
;
8954 /* We jump here when we need to reinitialize fkey and keytran; this
8955 happens if we switch keyboards between rescans. */
8956 replay_entire_sequence
:
8958 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8959 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8960 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8961 indec
.start
= indec
.end
= 0;
8962 fkey
.start
= fkey
.end
= 0;
8963 keytran
.start
= keytran
.end
= 0;
8965 /* We jump here when the key sequence has been thoroughly changed, and
8966 we need to rescan it starting from the beginning. When we jump here,
8967 keybuf[0..mock_input] holds the sequence we should reread. */
8970 starting_buffer
= current_buffer
;
8971 first_unbound
= bufsize
+ 1;
8973 /* Build our list of keymaps.
8974 If we recognize a function key and replace its escape sequence in
8975 keybuf with its symbol, or if the sequence starts with a mouse
8976 click and we need to switch buffers, we jump back here to rebuild
8977 the initial keymaps from the current buffer. */
8978 current_binding
= active_maps (first_event
);
8980 /* Start from the beginning in keybuf. */
8983 /* These are no-ops the first time through, but if we restart, they
8984 revert the echo area and this_command_keys to their original state. */
8985 this_command_key_count
= keys_start
;
8986 if (INTERACTIVE
&& t
< mock_input
)
8987 echo_truncate (echo_start
);
8989 /* If the best binding for the current key sequence is a keymap, or
8990 we may be looking at a function key's escape sequence, keep on
8992 while (!NILP (current_binding
)
8993 /* Keep reading as long as there's a prefix binding. */
8994 ? KEYMAPP (current_binding
)
8995 /* Don't return in the middle of a possible function key sequence,
8996 if the only bindings we found were via case conversion.
8997 Thus, if ESC O a has a function-key-map translation
8998 and ESC o has a binding, don't return after ESC O,
8999 so that we can translate ESC O plus the next character. */
9000 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9003 bool used_mouse_menu
= 0;
9005 /* Where the last real key started. If we need to throw away a
9006 key that has expanded into more than one element of keybuf
9007 (say, a mouse click on the mode line which is being treated
9008 as [mode-line (mouse-...)], then we backtrack to this point
9010 int last_real_key_start
;
9012 /* These variables are analogous to echo_start and keys_start;
9013 while those allow us to restart the entire key sequence,
9014 echo_local_start and keys_local_start allow us to throw away
9016 ptrdiff_t echo_local_start
IF_LINT (= 0);
9017 int keys_local_start
;
9018 Lisp_Object new_binding
;
9020 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9021 eassert (indec
.start
<= indec
.end
);
9022 eassert (fkey
.start
<= fkey
.end
);
9023 eassert (keytran
.start
<= keytran
.end
);
9024 /* key-translation-map is applied *after* function-key-map
9025 which is itself applied *after* input-decode-map. */
9026 eassert (fkey
.end
<= indec
.start
);
9027 eassert (keytran
.end
<= fkey
.start
);
9029 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9030 first_unbound
< keytran
.start
)
9031 { /* The prefix upto first_unbound has no binding and has
9032 no translation left to do either, so we know it's unbound.
9033 If we don't stop now, we risk staying here indefinitely
9034 (if the user keeps entering fkey or keytran prefixes
9035 like C-c ESC ESC ESC ESC ...) */
9037 for (i
= first_unbound
+ 1; i
< t
; i
++)
9038 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9039 mock_input
= t
- first_unbound
- 1;
9040 indec
.end
= indec
.start
-= first_unbound
+ 1;
9041 indec
.map
= indec
.parent
;
9042 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9043 fkey
.map
= fkey
.parent
;
9044 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9045 keytran
.map
= keytran
.parent
;
9046 goto replay_sequence
;
9050 error ("Key sequence too long");
9053 echo_local_start
= echo_length ();
9054 keys_local_start
= this_command_key_count
;
9057 /* These are no-ops, unless we throw away a keystroke below and
9058 jumped back up to replay_key; in that case, these restore the
9059 variables to their original state, allowing us to replay the
9061 if (INTERACTIVE
&& t
< mock_input
)
9062 echo_truncate (echo_local_start
);
9063 this_command_key_count
= keys_local_start
;
9065 /* By default, assume each event is "real". */
9066 last_real_key_start
= t
;
9068 /* Does mock_input indicate that we are re-reading a key sequence? */
9072 add_command_key (key
);
9073 if (echo_keystrokes_p ()
9074 && current_kboard
->immediate_echo
)
9081 /* If not, we should actually read a character. */
9085 KBOARD
*interrupted_kboard
= current_kboard
;
9086 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9087 /* Calling read_char with COMMANDFLAG = -2 avoids
9088 redisplay in read_char and its subroutines. */
9089 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9090 current_binding
, last_nonmenu_event
,
9091 &used_mouse_menu
, NULL
);
9092 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9093 /* When switching to a new tty (with a new keyboard),
9094 read_char returns the new buffer, rather than -2
9095 (Bug#5095). This is because `terminal-init-xterm'
9096 calls read-char, which eats the wrong_kboard_jmpbuf
9097 return. Any better way to fix this? -- cyd */
9098 || (interrupted_kboard
!= current_kboard
))
9103 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9104 if (k
== interrupted_kboard
)
9109 /* Don't touch interrupted_kboard when it's been
9111 delayed_switch_frame
= Qnil
;
9112 goto replay_entire_sequence
;
9115 if (!NILP (delayed_switch_frame
))
9118 (interrupted_kboard
,
9119 Fcons (delayed_switch_frame
,
9120 KVAR (interrupted_kboard
, kbd_queue
)));
9121 delayed_switch_frame
= Qnil
;
9126 (interrupted_kboard
,
9127 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9129 /* If the side queue is non-empty, ensure it begins with a
9130 switch-frame, so we'll replay it in the right context. */
9131 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9132 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9133 !(EVENT_HAS_PARAMETERS (key
)
9134 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9138 XSETFRAME (frame
, interrupted_frame
);
9140 (interrupted_kboard
,
9141 Fcons (make_lispy_switch_frame (frame
),
9142 KVAR (interrupted_kboard
, kbd_queue
)));
9145 goto replay_entire_sequence
;
9149 /* read_char returns t when it shows a menu and the user rejects it.
9153 unbind_to (count
, Qnil
);
9158 /* read_char returns -1 at the end of a macro.
9159 Emacs 18 handles this by returning immediately with a
9160 zero, so that's what we'll do. */
9161 if (INTEGERP (key
) && XINT (key
) == -1)
9164 /* The Microsoft C compiler can't handle the goto that
9170 /* If the current buffer has been changed from under us, the
9171 keymap may have changed, so replay the sequence. */
9174 timer_resume_idle ();
9177 /* Reset the current buffer from the selected window
9178 in case something changed the former and not the latter.
9179 This is to be more consistent with the behavior
9180 of the command_loop_1. */
9181 if (fix_current_buffer
)
9183 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9185 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9187 Fset_buffer (XWINDOW (selected_window
)->contents
);
9190 goto replay_sequence
;
9193 /* If we have a quit that was typed in another frame, and
9194 quit_throw_to_read_char switched buffers,
9195 replay to get the right keymap. */
9197 && XINT (key
) == quit_char
9198 && current_buffer
!= starting_buffer
)
9201 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9206 goto replay_sequence
;
9211 if (EVENT_HAS_PARAMETERS (key
)
9212 /* Either a `switch-frame' or a `select-window' event. */
9213 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9215 /* If we're at the beginning of a key sequence, and the caller
9216 says it's okay, go ahead and return this event. If we're
9217 in the midst of a key sequence, delay it until the end. */
9218 if (t
> 0 || !can_return_switch_frame
)
9220 delayed_switch_frame
= key
;
9225 if (NILP (first_event
))
9228 /* Even if first_event does not specify a particular
9229 window/position, it's important to recompute the maps here
9230 since a long time might have passed since we entered
9231 read_key_sequence, and a timer (or process-filter or
9232 special-event-map, ...) might have switched the current buffer
9233 or the selected window from under us in the mean time. */
9234 if (fix_current_buffer
9235 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9237 Fset_buffer (XWINDOW (selected_window
)->contents
);
9238 current_binding
= active_maps (first_event
);
9242 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9246 /* Clicks in non-text areas get prefixed by the symbol
9247 in their CHAR-ADDRESS field. For example, a click on
9248 the mode line is prefixed by the symbol `mode-line'.
9250 Furthermore, key sequences beginning with mouse clicks
9251 are read using the keymaps of the buffer clicked on, not
9252 the current buffer. So we may have to switch the buffer
9255 When we turn one event into two events, we must make sure
9256 that neither of the two looks like the original--so that,
9257 if we replay the events, they won't be expanded again.
9258 If not for this, such reexpansion could happen either here
9259 or when user programs play with this-command-keys. */
9260 if (EVENT_HAS_PARAMETERS (key
))
9262 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9263 if (EQ (kind
, Qmouse_click
))
9265 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9266 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9269 || (!NILP (fake_prefixed_keys
)
9270 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9272 /* We're looking a second time at an event for which
9273 we generated a fake prefix key. Set
9274 last_real_key_start appropriately. */
9276 last_real_key_start
= t
- 1;
9279 if (last_real_key_start
== 0)
9281 /* Key sequences beginning with mouse clicks are
9282 read using the keymaps in the buffer clicked on,
9283 not the current buffer. If we're at the
9284 beginning of a key sequence, switch buffers. */
9285 if (WINDOWP (window
)
9286 && BUFFERP (XWINDOW (window
)->contents
)
9287 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9289 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9294 /* Arrange to go back to the original buffer once we're
9295 done reading the key sequence. Note that we can't
9296 use save_excursion_{save,restore} here, because they
9297 save point as well as the current buffer; we don't
9298 want to save point, because redisplay may change it,
9299 to accommodate a Fset_window_start or something. We
9300 don't want to do this at the top of the function,
9301 because we may get input from a subprocess which
9302 wants to change the selected window and stuff (say,
9304 record_unwind_current_buffer ();
9306 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9308 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9309 goto replay_sequence
;
9313 /* Expand mode-line and scroll-bar events into two events:
9314 use posn as a fake prefix key. */
9316 && (NILP (fake_prefixed_keys
)
9317 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9319 if (bufsize
- t
<= 1)
9320 error ("Key sequence too long");
9323 keybuf
[t
+ 1] = key
;
9326 /* Record that a fake prefix key has been generated
9327 for KEY. Don't modify the event; this would
9328 prevent proper action when the event is pushed
9329 back into unread-command-events. */
9330 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9334 else if (CONSP (XCDR (key
))
9335 && CONSP (EVENT_START (key
))
9336 && CONSP (XCDR (EVENT_START (key
))))
9340 posn
= POSN_POSN (EVENT_START (key
));
9341 /* Handle menu-bar events:
9342 insert the dummy prefix event `menu-bar'. */
9343 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9345 if (bufsize
- t
<= 1)
9346 error ("Key sequence too long");
9348 keybuf
[t
+ 1] = key
;
9350 /* Zap the position in key, so we know that we've
9351 expanded it, and don't try to do so again. */
9352 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9355 goto replay_sequence
;
9357 else if (CONSP (posn
))
9359 /* We're looking at the second event of a
9360 sequence which we expanded before. Set
9361 last_real_key_start appropriately. */
9362 if (last_real_key_start
== t
&& t
> 0)
9363 last_real_key_start
= t
- 1;
9368 /* We have finally decided that KEY is something we might want
9370 new_binding
= follow_key (current_binding
, key
);
9372 /* If KEY wasn't bound, we'll try some fallbacks. */
9373 if (!NILP (new_binding
))
9374 /* This is needed for the following scenario:
9375 event 0: a down-event that gets dropped by calling replay_key.
9376 event 1: some normal prefix like C-h.
9377 After event 0, first_unbound is 0, after event 1 indec.start,
9378 fkey.start, and keytran.start are all 1, so when we see that
9379 C-h is bound, we need to update first_unbound. */
9380 first_unbound
= max (t
+ 1, first_unbound
);
9385 /* Remember the position to put an upper bound on indec.start. */
9386 first_unbound
= min (t
, first_unbound
);
9388 head
= EVENT_HEAD (key
);
9389 if (help_char_p (head
) && t
> 0)
9391 read_key_sequence_cmd
= Vprefix_help_command
;
9393 last_nonmenu_event
= key
;
9394 /* The Microsoft C compiler can't handle the goto that
9402 Lisp_Object breakdown
;
9405 breakdown
= parse_modifiers (head
);
9406 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9407 /* Attempt to reduce an unbound mouse event to a simpler
9408 event that is bound:
9409 Drags reduce to clicks.
9410 Double-clicks reduce to clicks.
9411 Triple-clicks reduce to double-clicks, then to clicks.
9412 Down-clicks are eliminated.
9413 Double-downs reduce to downs, then are eliminated.
9414 Triple-downs reduce to double-downs, then to downs,
9415 then are eliminated. */
9416 if (modifiers
& (down_modifier
| drag_modifier
9417 | double_modifier
| triple_modifier
))
9419 while (modifiers
& (down_modifier
| drag_modifier
9420 | double_modifier
| triple_modifier
))
9422 Lisp_Object new_head
, new_click
;
9423 if (modifiers
& triple_modifier
)
9424 modifiers
^= (double_modifier
| triple_modifier
);
9425 else if (modifiers
& double_modifier
)
9426 modifiers
&= ~double_modifier
;
9427 else if (modifiers
& drag_modifier
)
9428 modifiers
&= ~drag_modifier
;
9431 /* Dispose of this `down' event by simply jumping
9432 back to replay_key, to get another event.
9434 Note that if this event came from mock input,
9435 then just jumping back to replay_key will just
9436 hand it to us again. So we have to wipe out any
9439 We could delete keybuf[t] and shift everything
9440 after that to the left by one spot, but we'd also
9441 have to fix up any variable that points into
9442 keybuf, and shifting isn't really necessary
9445 Adding prefixes for non-textual mouse clicks
9446 creates two characters of mock input, and both
9447 must be thrown away. If we're only looking at
9448 the prefix now, we can just jump back to
9449 replay_key. On the other hand, if we've already
9450 processed the prefix, and now the actual click
9451 itself is giving us trouble, then we've lost the
9452 state of the keymaps we want to backtrack to, and
9453 we need to replay the whole sequence to rebuild
9456 Beyond that, only function key expansion could
9457 create more than two keys, but that should never
9458 generate mouse events, so it's okay to zero
9459 mock_input in that case too.
9461 FIXME: The above paragraph seems just plain
9462 wrong, if you consider things like
9463 xterm-mouse-mode. -stef
9465 Isn't this just the most wonderful code ever? */
9467 /* If mock_input > t + 1, the above simplification
9468 will actually end up dropping keys on the floor.
9469 This is probably OK for now, but even
9470 if mock_input <= t + 1, we need to adjust indec,
9472 Typical case [header-line down-mouse-N]:
9473 mock_input = 2, t = 1, fkey.end = 1,
9474 last_real_key_start = 0. */
9475 if (indec
.end
> last_real_key_start
)
9477 indec
.end
= indec
.start
9478 = min (last_real_key_start
, indec
.start
);
9479 indec
.map
= indec
.parent
;
9480 if (fkey
.end
> last_real_key_start
)
9482 fkey
.end
= fkey
.start
9483 = min (last_real_key_start
, fkey
.start
);
9484 fkey
.map
= fkey
.parent
;
9485 if (keytran
.end
> last_real_key_start
)
9487 keytran
.end
= keytran
.start
9488 = min (last_real_key_start
, keytran
.start
);
9489 keytran
.map
= keytran
.parent
;
9493 if (t
== last_real_key_start
)
9500 mock_input
= last_real_key_start
;
9501 goto replay_sequence
;
9506 = apply_modifiers (modifiers
, XCAR (breakdown
));
9507 new_click
= list2 (new_head
, EVENT_START (key
));
9509 /* Look for a binding for this new key. */
9510 new_binding
= follow_key (current_binding
, new_click
);
9512 /* If that click is bound, go for it. */
9513 if (!NILP (new_binding
))
9515 current_binding
= new_binding
;
9519 /* Otherwise, we'll leave key set to the drag event. */
9524 current_binding
= new_binding
;
9527 /* Normally, last_nonmenu_event gets the previous key we read.
9528 But when a mouse popup menu is being used,
9529 we don't update last_nonmenu_event; it continues to hold the mouse
9530 event that preceded the first level of menu. */
9531 if (!used_mouse_menu
)
9532 last_nonmenu_event
= key
;
9534 /* Record what part of this_command_keys is the current key sequence. */
9535 this_single_command_key_start
= this_command_key_count
- t
;
9537 /* Look for this sequence in input-decode-map.
9538 Scan from indec.end until we find a bound suffix. */
9539 while (indec
.end
< t
)
9541 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9545 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9546 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9551 mock_input
= diff
+ max (t
, mock_input
);
9552 goto replay_sequence
;
9556 if (!KEYMAPP (current_binding
)
9557 && !test_undefined (current_binding
)
9558 && indec
.start
>= t
)
9559 /* There is a binding and it's not a prefix.
9560 (and it doesn't have any input-decode-map translation pending).
9561 There is thus no function-key in this sequence.
9562 Moving fkey.start is important in this case to allow keytran.start
9563 to go over the sequence before we return (since we keep the
9564 invariant that keytran.end <= fkey.start). */
9567 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9570 /* If the sequence is unbound, see if we can hang a function key
9571 off the end of it. */
9572 /* Continue scan from fkey.end until we find a bound suffix. */
9573 while (fkey
.end
< indec
.start
)
9575 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9579 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9580 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9581 max (t
, mock_input
),
9582 /* If there's a binding (i.e.
9583 first_binding >= nmaps) we don't want
9584 to apply this function-key-mapping. */
9586 && (test_undefined (current_binding
)),
9591 mock_input
= diff
+ max (t
, mock_input
);
9592 /* Adjust the input-decode-map counters. */
9594 indec
.start
+= diff
;
9596 goto replay_sequence
;
9600 /* Look for this sequence in key-translation-map.
9601 Scan from keytran.end until we find a bound suffix. */
9602 while (keytran
.end
< fkey
.start
)
9604 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9608 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9609 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9614 mock_input
= diff
+ max (t
, mock_input
);
9615 /* Adjust the function-key-map and input-decode-map counters. */
9617 indec
.start
+= diff
;
9621 goto replay_sequence
;
9625 /* If KEY is not defined in any of the keymaps,
9626 and cannot be part of a function key or translation,
9627 and is an upper case letter
9628 use the corresponding lower-case letter instead. */
9629 if (NILP (current_binding
)
9630 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9632 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9633 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9634 || (XINT (key
) & shift_modifier
)))
9636 Lisp_Object new_key
;
9638 original_uppercase
= key
;
9639 original_uppercase_position
= t
- 1;
9641 if (XINT (key
) & shift_modifier
)
9642 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9644 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9645 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9647 /* We have to do this unconditionally, regardless of whether
9648 the lower-case char is defined in the keymaps, because they
9649 might get translated through function-key-map. */
9650 keybuf
[t
- 1] = new_key
;
9651 mock_input
= max (t
, mock_input
);
9652 shift_translated
= 1;
9654 goto replay_sequence
;
9656 /* If KEY is not defined in any of the keymaps,
9657 and cannot be part of a function key or translation,
9658 and is a shifted function key,
9659 use the corresponding unshifted function key instead. */
9660 if (NILP (current_binding
)
9661 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9663 Lisp_Object breakdown
= parse_modifiers (key
);
9665 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9667 if (modifiers
& shift_modifier
9668 /* Treat uppercase keys as shifted. */
9670 && (KEY_TO_CHAR (key
)
9671 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9672 && uppercasep (KEY_TO_CHAR (key
))))
9675 = (modifiers
& shift_modifier
9676 ? apply_modifiers (modifiers
& ~shift_modifier
,
9678 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9680 original_uppercase
= key
;
9681 original_uppercase_position
= t
- 1;
9683 /* We have to do this unconditionally, regardless of whether
9684 the lower-case char is defined in the keymaps, because they
9685 might get translated through function-key-map. */
9686 keybuf
[t
- 1] = new_key
;
9687 mock_input
= max (t
, mock_input
);
9688 /* Reset fkey (and consequently keytran) to apply
9689 function-key-map on the result, so that S-backspace is
9690 correctly mapped to DEL (via backspace). OTOH,
9691 input-decode-map doesn't need to go through it again. */
9692 fkey
.start
= fkey
.end
= 0;
9693 keytran
.start
= keytran
.end
= 0;
9694 shift_translated
= 1;
9696 goto replay_sequence
;
9701 read_key_sequence_cmd
= current_binding
;
9702 read_key_sequence_remapped
9703 /* Remap command through active keymaps.
9704 Do the remapping here, before the unbind_to so it uses the keymaps
9705 of the appropriate buffer. */
9706 = SYMBOLP (read_key_sequence_cmd
)
9707 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9710 unread_switch_frame
= delayed_switch_frame
;
9711 unbind_to (count
, Qnil
);
9713 /* Don't downcase the last character if the caller says don't.
9714 Don't downcase it if the result is undefined, either. */
9715 if ((dont_downcase_last
|| NILP (current_binding
))
9717 && t
- 1 == original_uppercase_position
)
9719 keybuf
[t
- 1] = original_uppercase
;
9720 shift_translated
= 0;
9723 if (shift_translated
)
9724 Vthis_command_keys_shift_translated
= Qt
;
9726 /* Occasionally we fabricate events, perhaps by expanding something
9727 according to function-key-map, or by adding a prefix symbol to a
9728 mouse click in the scroll bar or modeline. In this cases, return
9729 the entire generated key sequence, even if we hit an unbound
9730 prefix or a definition before the end. This means that you will
9731 be able to push back the event properly, and also means that
9732 read-key-sequence will always return a logical unit.
9735 for (; t
< mock_input
; t
++)
9737 if (echo_keystrokes_p ())
9738 echo_char (keybuf
[t
]);
9739 add_command_key (keybuf
[t
]);
9747 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9748 Lisp_Object dont_downcase_last
,
9749 Lisp_Object can_return_switch_frame
,
9750 Lisp_Object cmd_loop
, bool allow_string
)
9752 Lisp_Object keybuf
[30];
9754 struct gcpro gcpro1
;
9755 ptrdiff_t count
= SPECPDL_INDEX ();
9758 CHECK_STRING (prompt
);
9761 specbind (Qinput_method_exit_on_first_char
,
9762 (NILP (cmd_loop
) ? Qt
: Qnil
));
9763 specbind (Qinput_method_use_echo_area
,
9764 (NILP (cmd_loop
) ? Qt
: Qnil
));
9766 memset (keybuf
, 0, sizeof keybuf
);
9768 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9770 if (NILP (continue_echo
))
9772 this_command_key_count
= 0;
9773 this_command_key_count_reset
= 0;
9774 this_single_command_key_start
= 0;
9777 #ifdef HAVE_WINDOW_SYSTEM
9778 if (display_hourglass_p
)
9779 cancel_hourglass ();
9782 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9783 prompt
, ! NILP (dont_downcase_last
),
9784 ! NILP (can_return_switch_frame
), 0, 0);
9786 #if 0 /* The following is fine for code reading a key sequence and
9787 then proceeding with a lengthy computation, but it's not good
9788 for code reading keys in a loop, like an input method. */
9789 #ifdef HAVE_WINDOW_SYSTEM
9790 if (display_hourglass_p
)
9801 return unbind_to (count
,
9802 ((allow_string
? make_event_array
: Fvector
)
9806 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9807 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9808 The sequence is sufficient to specify a non-prefix command in the
9809 current local and global maps.
9811 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9812 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9813 as a continuation of the previous key.
9815 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9816 convert the last event to lower case. (Normally any upper case event
9817 is converted to lower case if the original event is undefined and the lower
9818 case equivalent is defined.) A non-nil value is appropriate for reading
9819 a key sequence to be defined.
9821 A C-g typed while in this function is treated like any other character,
9822 and `quit-flag' is not set.
9824 If the key sequence starts with a mouse click, then the sequence is read
9825 using the keymaps of the buffer of the window clicked in, not the buffer
9826 of the selected window as normal.
9828 `read-key-sequence' drops unbound button-down events, since you normally
9829 only care about the click or drag events which follow them. If a drag
9830 or multi-click event is unbound, but the corresponding click event would
9831 be bound, `read-key-sequence' turns the event into a click event at the
9832 drag's starting position. This means that you don't have to distinguish
9833 between click and drag, double, or triple events unless you want to.
9835 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9836 lines separating windows, and scroll bars with imaginary keys
9837 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9839 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9840 function will process a switch-frame event if the user switches frames
9841 before typing anything. If the user switches frames in the middle of a
9842 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9843 is nil, then the event will be put off until after the current key sequence.
9845 `read-key-sequence' checks `function-key-map' for function key
9846 sequences, where they wouldn't conflict with ordinary bindings. See
9847 `function-key-map' for more details.
9849 The optional fifth argument CMD-LOOP, if non-nil, means
9850 that this key sequence is being read by something that will
9851 read commands one after another. It should be nil if the caller
9852 will read just one key sequence. */)
9853 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9855 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9856 can_return_switch_frame
, cmd_loop
, true);
9859 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9860 Sread_key_sequence_vector
, 1, 5, 0,
9861 doc
: /* Like `read-key-sequence' but always return a vector. */)
9862 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9864 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9865 can_return_switch_frame
, cmd_loop
, false);
9868 /* Return true if input events are pending. */
9871 detect_input_pending (void)
9873 return input_pending
|| get_input_pending (0);
9876 /* Return true if input events other than mouse movements are
9880 detect_input_pending_ignore_squeezables (void)
9882 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9885 /* Return true if input events are pending, and run any pending timers. */
9888 detect_input_pending_run_timers (bool do_display
)
9890 unsigned old_timers_run
= timers_run
;
9893 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9895 if (old_timers_run
!= timers_run
&& do_display
)
9896 redisplay_preserve_echo_area (8);
9898 return input_pending
;
9901 /* This is called in some cases before a possible quit.
9902 It cases the next call to detect_input_pending to recompute input_pending.
9903 So calling this function unnecessarily can't do any harm. */
9906 clear_input_pending (void)
9911 /* Return true if there are pending requeued events.
9912 This isn't used yet. The hope is to make wait_reading_process_output
9913 call it, and return if it runs Lisp code that unreads something.
9914 The problem is, kbd_buffer_get_event needs to be fixed to know what
9915 to do in that case. It isn't trivial. */
9918 requeued_events_pending_p (void)
9920 return (!NILP (Vunread_command_events
));
9923 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9924 doc
: /* Return t if command input is currently available with no wait.
9925 Actually, the value is nil only if we can be sure that no input is available;
9926 if there is a doubt, the value is t.
9928 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9929 (Lisp_Object check_timers
)
9931 if (!NILP (Vunread_command_events
)
9932 || !NILP (Vunread_post_input_method_events
)
9933 || !NILP (Vunread_input_method_events
))
9936 /* Process non-user-visible events (Bug#10195). */
9937 process_special_events ();
9939 return (get_input_pending ((NILP (check_timers
)
9940 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9941 | READABLE_EVENTS_FILTER_EVENTS
)
9945 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9946 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9949 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9952 if (total_keys
< NUM_RECENT_KEYS
)
9953 return Fvector (total_keys
, keys
);
9956 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9957 vcopy (val
, 0, keys
+ recent_keys_index
,
9958 NUM_RECENT_KEYS
- recent_keys_index
);
9959 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9960 keys
, recent_keys_index
);
9965 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9966 doc
: /* Return the key sequence that invoked this command.
9967 However, if the command has called `read-key-sequence', it returns
9968 the last key sequence that has been read.
9969 The value is a string or a vector.
9971 See also `this-command-keys-vector'. */)
9974 return make_event_array (this_command_key_count
,
9975 XVECTOR (this_command_keys
)->contents
);
9978 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9979 doc
: /* Return the key sequence that invoked this command, as a vector.
9980 However, if the command has called `read-key-sequence', it returns
9981 the last key sequence that has been read.
9983 See also `this-command-keys'. */)
9986 return Fvector (this_command_key_count
,
9987 XVECTOR (this_command_keys
)->contents
);
9990 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9991 Sthis_single_command_keys
, 0, 0, 0,
9992 doc
: /* Return the key sequence that invoked this command.
9993 More generally, it returns the last key sequence read, either by
9994 the command loop or by `read-key-sequence'.
9995 Unlike `this-command-keys', this function's value
9996 does not include prefix arguments.
9997 The value is always a vector. */)
10000 return Fvector (this_command_key_count
10001 - this_single_command_key_start
,
10002 (XVECTOR (this_command_keys
)->contents
10003 + this_single_command_key_start
));
10006 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10007 Sthis_single_command_raw_keys
, 0, 0, 0,
10008 doc
: /* Return the raw events that were read for this command.
10009 More generally, it returns the last key sequence read, either by
10010 the command loop or by `read-key-sequence'.
10011 Unlike `this-single-command-keys', this function's value
10012 shows the events before all translations (except for input methods).
10013 The value is always a vector. */)
10016 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10019 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10020 Sreset_this_command_lengths
, 0, 0, 0,
10021 doc
: /* Make the unread events replace the last command and echo.
10022 Used in `universal-argument-other-key'.
10024 `universal-argument-other-key' rereads the event just typed.
10025 It then gets translated through `function-key-map'.
10026 The translated event has to replace the real events,
10027 both in the value of (this-command-keys) and in echoing.
10028 To achieve this, `universal-argument-other-key' calls
10029 `reset-this-command-lengths', which discards the record of reading
10030 these events the first time. */)
10033 this_command_key_count
= before_command_key_count
;
10034 if (this_command_key_count
< this_single_command_key_start
)
10035 this_single_command_key_start
= this_command_key_count
;
10037 echo_truncate (before_command_echo_length
);
10039 /* Cause whatever we put into unread-command-events
10040 to echo as if it were being freshly read from the keyboard. */
10041 this_command_key_count_reset
= 1;
10046 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10047 Sclear_this_command_keys
, 0, 1, 0,
10048 doc
: /* Clear out the vector that `this-command-keys' returns.
10049 Also clear the record of the last 100 events, unless optional arg
10050 KEEP-RECORD is non-nil. */)
10051 (Lisp_Object keep_record
)
10055 this_command_key_count
= 0;
10056 this_command_key_count_reset
= 0;
10058 if (NILP (keep_record
))
10060 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10061 ASET (recent_keys
, i
, Qnil
);
10063 recent_keys_index
= 0;
10068 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10069 doc
: /* Return the current depth in recursive edits. */)
10073 /* Wrap around reliably on integer overflow. */
10074 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10075 XSETINT (temp
, sum
);
10079 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10080 "FOpen dribble file: ",
10081 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10082 If FILE is nil, close any open dribble file.
10083 The file will be closed when Emacs exits.
10085 Be aware that this records ALL characters you type!
10086 This may include sensitive information such as passwords. */)
10099 Lisp_Object encfile
;
10101 file
= Fexpand_file_name (file
, Qnil
);
10102 encfile
= ENCODE_FILE (file
);
10103 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10104 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10105 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10106 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10108 report_file_error ("Opening dribble", file
);
10113 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10114 doc
: /* Discard the contents of the terminal input buffer.
10115 Also end any kbd macro being defined. */)
10118 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10120 /* Discard the last command from the macro. */
10121 Fcancel_kbd_macro_events ();
10125 Vunread_command_events
= Qnil
;
10127 discard_tty_input ();
10129 kbd_fetch_ptr
= kbd_store_ptr
;
10135 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10136 doc
: /* Stop Emacs and return to superior process. You can resume later.
10137 If `cannot-suspend' is non-nil, or if the system doesn't support job
10138 control, run a subshell instead.
10140 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10141 to be read as terminal input by Emacs's parent, after suspension.
10143 Before suspending, run the normal hook `suspend-hook'.
10144 After resumption run the normal hook `suspend-resume-hook'.
10146 Some operating systems cannot stop the Emacs process and resume it later.
10147 On such systems, Emacs starts a subshell instead of suspending. */)
10148 (Lisp_Object stuffstring
)
10150 ptrdiff_t count
= SPECPDL_INDEX ();
10151 int old_height
, old_width
;
10153 struct gcpro gcpro1
;
10156 if (tty_list
&& tty_list
->next
)
10157 error ("There are other tty frames open; close them before suspending Emacs");
10159 if (!NILP (stuffstring
))
10160 CHECK_STRING (stuffstring
);
10162 /* Run the functions in suspend-hook. */
10163 hook
= intern ("suspend-hook");
10164 Frun_hooks (1, &hook
);
10166 GCPRO1 (stuffstring
);
10167 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10168 reset_all_sys_modes ();
10169 /* sys_suspend can get an error if it tries to fork a subshell
10170 and the system resources aren't available for that. */
10171 record_unwind_protect_void (init_all_sys_modes
);
10172 stuff_buffered_input (stuffstring
);
10173 if (cannot_suspend
)
10177 unbind_to (count
, Qnil
);
10179 /* Check if terminal/window size has changed.
10180 Note that this is not useful when we are running directly
10181 with a window system; but suspend should be disabled in that case. */
10182 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10183 if (width
!= old_width
|| height
!= old_height
)
10184 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10186 /* Run suspend-resume-hook. */
10187 hook
= intern ("suspend-resume-hook");
10188 Frun_hooks (1, &hook
);
10194 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10195 Then in any case stuff anything Emacs has read ahead and not used. */
10198 stuff_buffered_input (Lisp_Object stuffstring
)
10200 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10201 register unsigned char *p
;
10203 if (STRINGP (stuffstring
))
10205 register ptrdiff_t count
;
10207 p
= SDATA (stuffstring
);
10208 count
= SBYTES (stuffstring
);
10209 while (count
-- > 0)
10214 /* Anything we have read ahead, put back for the shell to read. */
10215 /* ?? What should this do when we have multiple keyboards??
10216 Should we ignore anything that was typed in at the "wrong" kboard?
10218 rms: we should stuff everything back into the kboard
10220 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10223 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10224 kbd_fetch_ptr
= kbd_buffer
;
10225 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10226 stuff_char (kbd_fetch_ptr
->code
);
10228 clear_event (kbd_fetch_ptr
);
10232 #endif /* SIGTSTP */
10236 set_waiting_for_input (struct timespec
*time_to_clear
)
10238 input_available_clear_time
= time_to_clear
;
10240 /* Tell handle_interrupt to throw back to read_char, */
10241 waiting_for_input
= 1;
10243 /* If handle_interrupt was called before and buffered a C-g,
10244 make it run again now, to avoid timing error. */
10245 if (!NILP (Vquit_flag
))
10246 quit_throw_to_read_char (0);
10250 clear_waiting_for_input (void)
10252 /* Tell handle_interrupt not to throw back to read_char, */
10253 waiting_for_input
= 0;
10254 input_available_clear_time
= 0;
10257 /* The SIGINT handler.
10259 If we have a frame on the controlling tty, we assume that the
10260 SIGINT was generated by C-g, so we call handle_interrupt.
10261 Otherwise, tell QUIT to kill Emacs. */
10264 handle_interrupt_signal (int sig
)
10266 /* See if we have an active terminal on our controlling tty. */
10267 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10270 /* If there are no frames there, let's pretend that we are a
10271 well-behaving UN*X program and quit. We must not call Lisp
10272 in a signal handler, so tell QUIT to exit when it is
10274 Vquit_flag
= Qkill_emacs
;
10278 /* Otherwise, the SIGINT was probably generated by C-g. */
10280 /* Set internal_last_event_frame to the top frame of the
10281 controlling tty, if we have a frame there. We disable the
10282 interrupt key on secondary ttys, so the SIGINT must have come
10283 from the controlling tty. */
10284 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10286 handle_interrupt (1);
10291 deliver_interrupt_signal (int sig
)
10293 deliver_process_signal (sig
, handle_interrupt_signal
);
10297 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10298 of the number of times C-g has been requested. If C-g is pressed
10299 enough times, then quit anyway. See bug#6585. */
10300 static int volatile force_quit_count
;
10302 /* This routine is called at interrupt level in response to C-g.
10304 It is called from the SIGINT handler or kbd_buffer_store_event.
10306 If `waiting_for_input' is non zero, then unless `echoing' is
10307 nonzero, immediately throw back to read_char.
10309 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10310 eval to throw, when it gets a chance. If quit-flag is already
10311 non-nil, it stops the job right away. */
10314 handle_interrupt (bool in_signal_handler
)
10320 /* XXX This code needs to be revised for multi-tty support. */
10321 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10323 if (! in_signal_handler
)
10325 /* If SIGINT isn't blocked, don't let us be interrupted by
10326 a SIGINT. It might be harmful due to non-reentrancy
10327 in I/O functions. */
10329 sigemptyset (&blocked
);
10330 sigaddset (&blocked
, SIGINT
);
10331 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10335 reset_all_sys_modes ();
10339 * On systems which can suspend the current process and return to the original
10340 * shell, this command causes the user to end up back at the shell.
10341 * The "Auto-save" and "Abort" questions are not asked until
10342 * the user elects to return to emacs, at which point he can save the current
10343 * job and either dump core or continue.
10347 /* Perhaps should really fork an inferior shell?
10348 But that would not provide any way to get back
10349 to the original shell, ever. */
10350 printf ("No support for stopping a process on this operating system;\n");
10351 printf ("you can continue or abort.\n");
10352 #endif /* not SIGTSTP */
10354 /* We must remain inside the screen area when the internal terminal
10355 is used. Note that [Enter] is not echoed by dos. */
10356 cursor_to (SELECTED_FRAME (), 0, 0);
10358 /* It doesn't work to autosave while GC is in progress;
10359 the code used for auto-saving doesn't cope with the mark bit. */
10360 if (!gc_in_progress
)
10362 printf ("Auto-save? (y or n) ");
10364 if (((c
= getchar ()) & ~040) == 'Y')
10366 Fdo_auto_save (Qt
, Qnil
);
10368 printf ("\r\nAuto-save done");
10369 #else /* not MSDOS */
10370 printf ("Auto-save done\n");
10371 #endif /* not MSDOS */
10373 while (c
!= '\n') c
= getchar ();
10377 /* During GC, it must be safe to reenable quitting again. */
10378 Vinhibit_quit
= Qnil
;
10381 #endif /* not MSDOS */
10382 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10383 printf ("but will instead do a real quit after garbage collection ends\r\n");
10388 printf ("\r\nAbort? (y or n) ");
10389 #else /* not MSDOS */
10390 printf ("Abort (and dump core)? (y or n) ");
10391 #endif /* not MSDOS */
10393 if (((c
= getchar ()) & ~040) == 'Y')
10395 while (c
!= '\n') c
= getchar ();
10397 printf ("\r\nContinuing...\r\n");
10398 #else /* not MSDOS */
10399 printf ("Continuing...\n");
10400 #endif /* not MSDOS */
10402 init_all_sys_modes ();
10406 /* If executing a function that wants to be interrupted out of
10407 and the user has not deferred quitting by binding `inhibit-quit'
10408 then quit right away. */
10409 if (immediate_quit
&& NILP (Vinhibit_quit
))
10411 struct gl_state_s saved
;
10412 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10414 immediate_quit
= 0;
10415 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10417 GCPRO4 (saved
.object
, saved
.global_code
,
10418 saved
.current_syntax_table
, saved
.old_prop
);
10419 Fsignal (Qquit
, Qnil
);
10424 { /* Else request quit when it's safe. */
10425 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10426 force_quit_count
= count
;
10429 immediate_quit
= 1;
10430 Vinhibit_quit
= Qnil
;
10436 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10438 /* TODO: The longjmp in this call throws the NS event loop integration off,
10439 and it seems to do fine without this. Probably some attention
10440 needs to be paid to the setting of waiting_for_input in
10441 wait_reading_process_output() under HAVE_NS because of the call
10442 to ns_select there (needed because otherwise events aren't picked up
10443 outside of polling since we don't get SIGIO like X and we don't have a
10444 separate event loop thread like W32. */
10446 if (waiting_for_input
&& !echoing
)
10447 quit_throw_to_read_char (in_signal_handler
);
10451 /* Handle a C-g by making read_char return C-g. */
10454 quit_throw_to_read_char (bool from_signal
)
10456 /* When not called from a signal handler it is safe to call
10458 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10459 Fkill_emacs (Qnil
);
10461 /* Prevent another signal from doing this before we finish. */
10462 clear_waiting_for_input ();
10465 Vunread_command_events
= Qnil
;
10467 if (FRAMEP (internal_last_event_frame
)
10468 && !EQ (internal_last_event_frame
, selected_frame
))
10469 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10472 sys_longjmp (getcjmp
, 1);
10475 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10476 Sset_input_interrupt_mode
, 1, 1, 0,
10477 doc
: /* Set interrupt mode of reading keyboard input.
10478 If INTERRUPT is non-nil, Emacs will use input interrupts;
10479 otherwise Emacs uses CBREAK mode.
10481 See also `current-input-mode'. */)
10482 (Lisp_Object interrupt
)
10484 bool new_interrupt_input
;
10485 #ifdef USABLE_SIGIO
10486 #ifdef HAVE_X_WINDOWS
10487 if (x_display_list
!= NULL
)
10489 /* When using X, don't give the user a real choice,
10490 because we haven't implemented the mechanisms to support it. */
10491 new_interrupt_input
= 1;
10494 #endif /* HAVE_X_WINDOWS */
10495 new_interrupt_input
= !NILP (interrupt
);
10496 #else /* not USABLE_SIGIO */
10497 new_interrupt_input
= 0;
10498 #endif /* not USABLE_SIGIO */
10500 if (new_interrupt_input
!= interrupt_input
)
10502 #ifdef POLL_FOR_INPUT
10506 /* this causes startup screen to be restored and messes with the mouse */
10507 reset_all_sys_modes ();
10508 interrupt_input
= new_interrupt_input
;
10509 init_all_sys_modes ();
10511 interrupt_input
= new_interrupt_input
;
10514 #ifdef POLL_FOR_INPUT
10515 poll_suppress_count
= 1;
10522 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10523 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10524 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10525 C-q in key sequences.
10527 This setting only has an effect on tty terminals and only when
10528 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10530 See also `current-input-mode'. */)
10531 (Lisp_Object flow
, Lisp_Object terminal
)
10533 struct terminal
*t
= get_terminal (terminal
, 1);
10534 struct tty_display_info
*tty
;
10535 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10537 tty
= t
->display_info
.tty
;
10539 if (tty
->flow_control
!= !NILP (flow
))
10542 /* This causes startup screen to be restored and messes with the mouse. */
10543 reset_sys_modes (tty
);
10546 tty
->flow_control
= !NILP (flow
);
10549 init_sys_modes (tty
);
10555 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10556 doc
: /* Enable or disable 8-bit input on TERMINAL.
10557 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10558 bit as the Meta modifier.
10560 If META is nil, Emacs will ignore the top bit, on the assumption it is
10563 Otherwise, Emacs will accept and pass through 8-bit input without
10564 specially interpreting the top bit.
10566 This setting only has an effect on tty terminal devices.
10568 Optional parameter TERMINAL specifies the tty terminal device to use.
10569 It may be a terminal object, a frame, or nil for the terminal used by
10570 the currently selected frame.
10572 See also `current-input-mode'. */)
10573 (Lisp_Object meta
, Lisp_Object terminal
)
10575 struct terminal
*t
= get_terminal (terminal
, 1);
10576 struct tty_display_info
*tty
;
10579 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10581 tty
= t
->display_info
.tty
;
10585 else if (EQ (meta
, Qt
))
10590 if (tty
->meta_key
!= new_meta
)
10593 /* this causes startup screen to be restored and messes with the mouse */
10594 reset_sys_modes (tty
);
10597 tty
->meta_key
= new_meta
;
10600 init_sys_modes (tty
);
10606 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10607 doc
: /* Specify character used for quitting.
10608 QUIT must be an ASCII character.
10610 This function only has an effect on the controlling tty of the Emacs
10613 See also `current-input-mode'. */)
10616 struct terminal
*t
= get_named_tty ("/dev/tty");
10617 struct tty_display_info
*tty
;
10618 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10620 tty
= t
->display_info
.tty
;
10622 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10623 error ("QUIT must be an ASCII character");
10626 /* this causes startup screen to be restored and messes with the mouse */
10627 reset_sys_modes (tty
);
10630 /* Don't let this value be out of range. */
10631 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10634 init_sys_modes (tty
);
10640 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10641 doc
: /* Set mode of reading keyboard input.
10642 First arg INTERRUPT non-nil means use input interrupts;
10643 nil means use CBREAK mode.
10644 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10645 (no effect except in CBREAK mode).
10646 Third arg META t means accept 8-bit input (for a Meta key).
10647 META nil means ignore the top bit, on the assumption it is parity.
10648 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10649 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10650 See also `current-input-mode'. */)
10651 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10653 Fset_input_interrupt_mode (interrupt
);
10654 Fset_output_flow_control (flow
, Qnil
);
10655 Fset_input_meta_mode (meta
, Qnil
);
10657 Fset_quit_char (quit
);
10661 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10662 doc
: /* Return information about the way Emacs currently reads keyboard input.
10663 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10664 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10665 nil, Emacs is using CBREAK mode.
10666 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10667 terminal; this does not apply if Emacs uses interrupt-driven input.
10668 META is t if accepting 8-bit input with 8th bit as Meta flag.
10669 META nil means ignoring the top bit, on the assumption it is parity.
10670 META is neither t nor nil if accepting 8-bit input and using
10671 all 8 bits as the character code.
10672 QUIT is the character Emacs currently uses to quit.
10673 The elements of this list correspond to the arguments of
10674 `set-input-mode'. */)
10677 Lisp_Object val
[4];
10678 struct frame
*sf
= XFRAME (selected_frame
);
10680 val
[0] = interrupt_input
? Qt
: Qnil
;
10681 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10683 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10684 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10686 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10693 XSETFASTINT (val
[3], quit_char
);
10695 return Flist (ARRAYELTS (val
), val
);
10698 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10699 doc
: /* Return position information for pixel coordinates X and Y.
10700 By default, X and Y are relative to text area of the selected window.
10701 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10702 If optional fourth arg WHOLE is non-nil, X is relative to the left
10703 edge of the window.
10705 The return value is similar to a mouse click position:
10706 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10707 IMAGE (DX . DY) (WIDTH . HEIGHT))
10708 The `posn-' functions access elements of such lists. */)
10709 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10714 if (NILP (frame_or_window
))
10715 frame_or_window
= selected_window
;
10717 if (WINDOWP (frame_or_window
))
10719 struct window
*w
= decode_live_window (frame_or_window
);
10721 XSETINT (x
, (XINT (x
)
10722 + WINDOW_LEFT_EDGE_X (w
)
10724 ? window_box_left_offset (w
, TEXT_AREA
)
10726 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10727 frame_or_window
= w
->frame
;
10730 CHECK_LIVE_FRAME (frame_or_window
);
10732 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10735 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10736 doc
: /* Return position information for buffer POS in WINDOW.
10737 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10739 Return nil if position is not visible in window. Otherwise,
10740 the return value is similar to that returned by `event-start' for
10741 a mouse click at the upper left corner of the glyph corresponding
10742 to the given buffer position:
10743 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10744 IMAGE (DX . DY) (WIDTH . HEIGHT))
10745 The `posn-' functions access elements of such lists. */)
10746 (Lisp_Object pos
, Lisp_Object window
)
10751 window
= selected_window
;
10753 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10756 Lisp_Object x
= XCAR (tem
);
10757 Lisp_Object y
= XCAR (XCDR (tem
));
10759 /* Point invisible due to hscrolling? */
10762 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10768 /* Set up a new kboard object with reasonable initial values.
10769 TYPE is a window system for which this keyboard is used. */
10772 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10774 kset_overriding_terminal_local_map (kb
, Qnil
);
10775 kset_last_command (kb
, Qnil
);
10776 kset_real_last_command (kb
, Qnil
);
10777 kset_keyboard_translate_table (kb
, Qnil
);
10778 kset_last_repeatable_command (kb
, Qnil
);
10779 kset_prefix_arg (kb
, Qnil
);
10780 kset_last_prefix_arg (kb
, Qnil
);
10781 kset_kbd_queue (kb
, Qnil
);
10782 kb
->kbd_queue_has_data
= 0;
10783 kb
->immediate_echo
= 0;
10784 kset_echo_string (kb
, Qnil
);
10785 kb
->echo_after_prompt
= -1;
10786 kb
->kbd_macro_buffer
= 0;
10787 kb
->kbd_macro_bufsize
= 0;
10788 kset_defining_kbd_macro (kb
, Qnil
);
10789 kset_last_kbd_macro (kb
, Qnil
);
10790 kb
->reference_count
= 0;
10791 kset_system_key_alist (kb
, Qnil
);
10792 kset_system_key_syms (kb
, Qnil
);
10793 kset_window_system (kb
, type
);
10794 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10795 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10796 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10797 kset_default_minibuffer_frame (kb
, Qnil
);
10800 /* Allocate and basically initialize keyboard
10801 object to use with window system TYPE. */
10804 allocate_kboard (Lisp_Object type
)
10806 KBOARD
*kb
= xmalloc (sizeof *kb
);
10808 init_kboard (kb
, type
);
10809 kb
->next_kboard
= all_kboards
;
10815 * Destroy the contents of a kboard object, but not the object itself.
10816 * We use this just before deleting it, or if we're going to initialize
10817 * it a second time.
10820 wipe_kboard (KBOARD
*kb
)
10822 xfree (kb
->kbd_macro_buffer
);
10825 /* Free KB and memory referenced from it. */
10828 delete_kboard (KBOARD
*kb
)
10832 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10835 *kbp
= kb
->next_kboard
;
10837 /* Prevent a dangling reference to KB. */
10838 if (kb
== current_kboard
10839 && FRAMEP (selected_frame
)
10840 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10842 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10844 if (current_kboard
== kb
)
10853 init_keyboard (void)
10855 /* This is correct before outermost invocation of the editor loop. */
10856 command_loop_level
= -1;
10857 immediate_quit
= 0;
10858 quit_char
= Ctl ('g');
10859 Vunread_command_events
= Qnil
;
10860 timer_idleness_start_time
= invalid_timespec ();
10862 recent_keys_index
= 0;
10863 kbd_fetch_ptr
= kbd_buffer
;
10864 kbd_store_ptr
= kbd_buffer
;
10865 do_mouse_tracking
= Qnil
;
10867 interrupt_input_blocked
= 0;
10868 pending_signals
= 0;
10870 /* This means that command_loop_1 won't try to select anything the first
10872 internal_last_event_frame
= Qnil
;
10873 Vlast_event_frame
= internal_last_event_frame
;
10875 current_kboard
= initial_kboard
;
10876 /* Re-initialize the keyboard again. */
10877 wipe_kboard (current_kboard
);
10878 /* A value of nil for Vwindow_system normally means a tty, but we also use
10879 it for the initial terminal since there is no window system there. */
10880 init_kboard (current_kboard
, Qnil
);
10882 if (!noninteractive
)
10884 /* Before multi-tty support, these handlers used to be installed
10885 only if the current session was a tty session. Now an Emacs
10886 session may have multiple display types, so we always handle
10887 SIGINT. There is special code in handle_interrupt_signal to exit
10888 Emacs on SIGINT when there are no termcap frames on the
10889 controlling terminal. */
10890 struct sigaction action
;
10891 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10892 sigaction (SIGINT
, &action
, 0);
10894 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10895 SIGQUIT and we can't tell which one it will give us. */
10896 sigaction (SIGQUIT
, &action
, 0);
10897 #endif /* not DOS_NT */
10899 #ifdef USABLE_SIGIO
10900 if (!noninteractive
)
10902 struct sigaction action
;
10903 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10904 sigaction (SIGIO
, &action
, 0);
10908 /* Use interrupt input by default, if it works and noninterrupt input
10909 has deficiencies. */
10911 #ifdef INTERRUPT_INPUT
10912 interrupt_input
= 1;
10914 interrupt_input
= 0;
10917 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10920 if (keyboard_init_hook
)
10921 (*keyboard_init_hook
) ();
10923 #ifdef POLL_FOR_INPUT
10925 poll_suppress_count
= 1;
10930 /* This type's only use is in syms_of_keyboard, to initialize the
10931 event header symbols and put properties on them. */
10932 struct event_head
{
10938 static const struct event_head head_table
[] = {
10939 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10940 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10941 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10942 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10943 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10944 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10945 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10946 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10947 /* `select-window' should be handled just like `switch-frame'
10948 in read_key_sequence. */
10949 {&Qselect_window
, "select-window", &Qswitch_frame
}
10953 syms_of_keyboard (void)
10955 pending_funcalls
= Qnil
;
10956 staticpro (&pending_funcalls
);
10958 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10959 staticpro (&Vlispy_mouse_stem
);
10962 DEFSYM (QCimage
, ":image");
10963 DEFSYM (Qhelp_echo
, "help-echo");
10964 DEFSYM (QCrtl
, ":rtl");
10966 staticpro (&item_properties
);
10967 item_properties
= Qnil
;
10969 staticpro (&tool_bar_item_properties
);
10970 tool_bar_item_properties
= Qnil
;
10971 staticpro (&tool_bar_items_vector
);
10972 tool_bar_items_vector
= Qnil
;
10974 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10975 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10976 DEFSYM (Qself_insert_command
, "self-insert-command");
10977 DEFSYM (Qforward_char
, "forward-char");
10978 DEFSYM (Qbackward_char
, "backward-char");
10979 DEFSYM (Qdisabled
, "disabled");
10980 DEFSYM (Qundefined
, "undefined");
10981 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10982 DEFSYM (Qpost_command_hook
, "post-command-hook");
10983 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10984 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10985 DEFSYM (Qfunction_key
, "function-key");
10986 DEFSYM (Qmouse_click
, "mouse-click");
10987 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10988 DEFSYM (Qsave_session
, "save-session");
10989 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10990 DEFSYM (Qmenu_enable
, "menu-enable");
10993 DEFSYM (Qlanguage_change
, "language-change");
10997 DEFSYM (Qdbus_event
, "dbus-event");
11000 #ifdef USE_FILE_NOTIFY
11001 DEFSYM (Qfile_notify
, "file-notify");
11002 #endif /* USE_FILE_NOTIFY */
11004 DEFSYM (QCenable
, ":enable");
11005 DEFSYM (QCvisible
, ":visible");
11006 DEFSYM (QChelp
, ":help");
11007 DEFSYM (QCfilter
, ":filter");
11008 DEFSYM (QCbutton
, ":button");
11009 DEFSYM (QCkeys
, ":keys");
11010 DEFSYM (QCkey_sequence
, ":key-sequence");
11011 DEFSYM (QCtoggle
, ":toggle");
11012 DEFSYM (QCradio
, ":radio");
11013 DEFSYM (QClabel
, ":label");
11014 DEFSYM (QCvert_only
, ":vert-only");
11016 DEFSYM (Qmode_line
, "mode-line");
11017 DEFSYM (Qvertical_line
, "vertical-line");
11018 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11019 DEFSYM (Qmenu_bar
, "menu-bar");
11020 DEFSYM (Qright_divider
, "right-divider");
11021 DEFSYM (Qbottom_divider
, "bottom-divider");
11023 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11025 DEFSYM (Qabove_handle
, "above-handle");
11026 DEFSYM (Qhandle
, "handle");
11027 DEFSYM (Qbelow_handle
, "below-handle");
11028 DEFSYM (Qup
, "up");
11029 DEFSYM (Qdown
, "down");
11030 DEFSYM (Qtop
, "top");
11031 DEFSYM (Qbottom
, "bottom");
11032 DEFSYM (Qend_scroll
, "end-scroll");
11033 DEFSYM (Qratio
, "ratio");
11035 DEFSYM (Qevent_kind
, "event-kind");
11036 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11037 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11038 DEFSYM (Qmodifier_cache
, "modifier-cache");
11040 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11041 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11043 DEFSYM (Qpolling_period
, "polling-period");
11045 DEFSYM (Qx_set_selection
, "x-set-selection");
11046 DEFSYM (QPRIMARY
, "PRIMARY");
11047 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11048 DEFSYM (Qhandle_select_window
, "handle-select-window");
11050 DEFSYM (Qinput_method_function
, "input-method-function");
11051 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11052 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11054 DEFSYM (Qhelp_form_show
, "help-form-show");
11056 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11058 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11059 Fset (Qinput_method_use_echo_area
, Qnil
);
11063 int len
= ARRAYELTS (head_table
);
11065 for (i
= 0; i
< len
; i
++)
11067 const struct event_head
*p
= &head_table
[i
];
11068 *p
->var
= intern_c_string (p
->name
);
11069 staticpro (p
->var
);
11070 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11071 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11075 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11076 staticpro (&button_down_location
);
11077 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11078 staticpro (&mouse_syms
);
11079 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11081 staticpro (&wheel_syms
);
11085 int len
= ARRAYELTS (modifier_names
);
11087 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11088 for (i
= 0; i
< len
; i
++)
11089 if (modifier_names
[i
])
11090 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11091 staticpro (&modifier_symbols
);
11094 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11095 staticpro (&recent_keys
);
11097 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11098 staticpro (&this_command_keys
);
11100 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11101 staticpro (&raw_keybuf
);
11103 DEFSYM (Qcommand_execute
, "command-execute");
11105 accent_key_syms
= Qnil
;
11106 staticpro (&accent_key_syms
);
11108 func_key_syms
= Qnil
;
11109 staticpro (&func_key_syms
);
11111 drag_n_drop_syms
= Qnil
;
11112 staticpro (&drag_n_drop_syms
);
11114 unread_switch_frame
= Qnil
;
11115 staticpro (&unread_switch_frame
);
11117 internal_last_event_frame
= Qnil
;
11118 staticpro (&internal_last_event_frame
);
11120 read_key_sequence_cmd
= Qnil
;
11121 staticpro (&read_key_sequence_cmd
);
11122 read_key_sequence_remapped
= Qnil
;
11123 staticpro (&read_key_sequence_remapped
);
11125 menu_bar_one_keymap_changed_items
= Qnil
;
11126 staticpro (&menu_bar_one_keymap_changed_items
);
11128 menu_bar_items_vector
= Qnil
;
11129 staticpro (&menu_bar_items_vector
);
11131 help_form_saved_window_configs
= Qnil
;
11132 staticpro (&help_form_saved_window_configs
);
11134 defsubr (&Scurrent_idle_time
);
11135 defsubr (&Sevent_symbol_parse_modifiers
);
11136 defsubr (&Sevent_convert_list
);
11137 defsubr (&Sread_key_sequence
);
11138 defsubr (&Sread_key_sequence_vector
);
11139 defsubr (&Srecursive_edit
);
11140 defsubr (&Strack_mouse
);
11141 defsubr (&Sinput_pending_p
);
11142 defsubr (&Srecent_keys
);
11143 defsubr (&Sthis_command_keys
);
11144 defsubr (&Sthis_command_keys_vector
);
11145 defsubr (&Sthis_single_command_keys
);
11146 defsubr (&Sthis_single_command_raw_keys
);
11147 defsubr (&Sreset_this_command_lengths
);
11148 defsubr (&Sclear_this_command_keys
);
11149 defsubr (&Ssuspend_emacs
);
11150 defsubr (&Sabort_recursive_edit
);
11151 defsubr (&Sexit_recursive_edit
);
11152 defsubr (&Srecursion_depth
);
11153 defsubr (&Scommand_error_default_function
);
11154 defsubr (&Stop_level
);
11155 defsubr (&Sdiscard_input
);
11156 defsubr (&Sopen_dribble_file
);
11157 defsubr (&Sset_input_interrupt_mode
);
11158 defsubr (&Sset_output_flow_control
);
11159 defsubr (&Sset_input_meta_mode
);
11160 defsubr (&Sset_quit_char
);
11161 defsubr (&Sset_input_mode
);
11162 defsubr (&Scurrent_input_mode
);
11163 defsubr (&Sposn_at_point
);
11164 defsubr (&Sposn_at_x_y
);
11166 DEFVAR_LISP ("last-command-event", last_command_event
,
11167 doc
: /* Last input event that was part of a command. */);
11169 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11170 doc
: /* Last input event in a command, except for mouse menu events.
11171 Mouse menus give back keys that don't look like mouse events;
11172 this variable holds the actual mouse event that led to the menu,
11173 so that you can determine whether the command was run by mouse or not. */);
11175 DEFVAR_LISP ("last-input-event", last_input_event
,
11176 doc
: /* Last input event. */);
11178 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11179 doc
: /* List of events to be read as the command input.
11180 These events are processed first, before actual keyboard input.
11181 Events read from this list are not normally added to `this-command-keys',
11182 as they will already have been added once as they were read for the first time.
11183 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11184 Vunread_command_events
= Qnil
;
11186 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11187 doc
: /* List of events to be processed as input by input methods.
11188 These events are processed before `unread-command-events'
11189 and actual keyboard input, but are not given to `input-method-function'. */);
11190 Vunread_post_input_method_events
= Qnil
;
11192 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11193 doc
: /* List of events to be processed as input by input methods.
11194 These events are processed after `unread-command-events', but
11195 before actual keyboard input.
11196 If there's an active input method, the events are given to
11197 `input-method-function'. */);
11198 Vunread_input_method_events
= Qnil
;
11200 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11201 doc
: /* Meta-prefix character code.
11202 Meta-foo as command input turns into this character followed by foo. */);
11203 XSETINT (meta_prefix_char
, 033);
11205 DEFVAR_KBOARD ("last-command", Vlast_command
,
11206 doc
: /* The last command executed.
11207 Normally a symbol with a function definition, but can be whatever was found
11208 in the keymap, or whatever the variable `this-command' was set to by that
11211 The value `mode-exit' is special; it means that the previous command
11212 read an event that told it to exit, and it did so and unread that event.
11213 In other words, the present command is the event that made the previous
11216 The value `kill-region' is special; it means that the previous command
11217 was a kill command.
11219 `last-command' has a separate binding for each terminal device.
11220 See Info node `(elisp)Multiple Terminals'. */);
11222 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11223 doc
: /* Same as `last-command', but never altered by Lisp code.
11224 Taken from the previous value of `real-this-command'. */);
11226 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11227 doc
: /* Last command that may be repeated.
11228 The last command executed that was not bound to an input event.
11229 This is the command `repeat' will try to repeat.
11230 Taken from a previous value of `real-this-command'. */);
11232 DEFVAR_LISP ("this-command", Vthis_command
,
11233 doc
: /* The command now being executed.
11234 The command can set this variable; whatever is put here
11235 will be in `last-command' during the following command. */);
11236 Vthis_command
= Qnil
;
11238 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11239 doc
: /* This is like `this-command', except that commands should never modify it. */);
11240 Vreal_this_command
= Qnil
;
11242 DEFVAR_LISP ("this-command-keys-shift-translated",
11243 Vthis_command_keys_shift_translated
,
11244 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11245 Shift-translation occurs when there is no binding for the key sequence
11246 as entered, but a binding was found by changing an upper-case letter
11247 to lower-case, or a shifted function key to an unshifted one. */);
11248 Vthis_command_keys_shift_translated
= Qnil
;
11250 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11251 doc
: /* The command bound to the current key sequence before remapping.
11252 It equals `this-command' if the original command was not remapped through
11253 any of the active keymaps. Otherwise, the value of `this-command' is the
11254 result of looking up the original command in the active keymaps. */);
11255 Vthis_original_command
= Qnil
;
11257 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11258 doc
: /* Number of input events between auto-saves.
11259 Zero means disable autosaving due to number of characters typed. */);
11260 auto_save_interval
= 300;
11262 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11263 doc
: /* Number of seconds idle time before auto-save.
11264 Zero or nil means disable auto-saving due to idleness.
11265 After auto-saving due to this many seconds of idle time,
11266 Emacs also does a garbage collection if that seems to be warranted. */);
11267 XSETFASTINT (Vauto_save_timeout
, 30);
11269 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11270 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11271 The value may be integer or floating point.
11272 If the value is zero, don't echo at all. */);
11273 Vecho_keystrokes
= make_number (1);
11275 DEFVAR_INT ("polling-period", polling_period
,
11276 doc
: /* Interval between polling for input during Lisp execution.
11277 The reason for polling is to make C-g work to stop a running program.
11278 Polling is needed only when using X windows and SIGIO does not work.
11279 Polling is automatically disabled in all other cases. */);
11280 polling_period
= 2;
11282 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11283 doc
: /* Maximum time between mouse clicks to make a double-click.
11284 Measured in milliseconds. The value nil means disable double-click
11285 recognition; t means double-clicks have no time limit and are detected
11286 by position only. */);
11287 Vdouble_click_time
= make_number (500);
11289 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11290 doc
: /* Maximum mouse movement between clicks to make a double-click.
11291 On window-system frames, value is the number of pixels the mouse may have
11292 moved horizontally or vertically between two clicks to make a double-click.
11293 On non window-system frames, value is interpreted in units of 1/8 characters
11296 This variable is also the threshold for motion of the mouse
11297 to count as a drag. */);
11298 double_click_fuzz
= 3;
11300 DEFVAR_INT ("num-input-keys", num_input_keys
,
11301 doc
: /* Number of complete key sequences read as input so far.
11302 This includes key sequences read from keyboard macros.
11303 The number is effectively the number of interactive command invocations. */);
11304 num_input_keys
= 0;
11306 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11307 doc
: /* Number of input events read from the keyboard so far.
11308 This does not include events generated by keyboard macros. */);
11309 num_nonmacro_input_events
= 0;
11311 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11312 doc
: /* The frame in which the most recently read event occurred.
11313 If the last event came from a keyboard macro, this is set to `macro'. */);
11314 Vlast_event_frame
= Qnil
;
11316 /* This variable is set up in sysdep.c. */
11317 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11318 doc
: /* The ERASE character as set by the user with stty. */);
11320 DEFVAR_LISP ("help-char", Vhelp_char
,
11321 doc
: /* Character to recognize as meaning Help.
11322 When it is read, do `(eval help-form)', and display result if it's a string.
11323 If the value of `help-form' is nil, this char can be read normally. */);
11324 XSETINT (Vhelp_char
, Ctl ('H'));
11326 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11327 doc
: /* List of input events to recognize as meaning Help.
11328 These work just like the value of `help-char' (see that). */);
11329 Vhelp_event_list
= Qnil
;
11331 DEFVAR_LISP ("help-form", Vhelp_form
,
11332 doc
: /* Form to execute when character `help-char' is read.
11333 If the form returns a string, that string is displayed.
11334 If `help-form' is nil, the help char is not recognized. */);
11337 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11338 doc
: /* Command to run when `help-char' character follows a prefix key.
11339 This command is used only when there is no actual binding
11340 for that character after that prefix key. */);
11341 Vprefix_help_command
= Qnil
;
11343 DEFVAR_LISP ("top-level", Vtop_level
,
11344 doc
: /* Form to evaluate when Emacs starts up.
11345 Useful to set before you dump a modified Emacs. */);
11348 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11349 doc
: /* Translate table for local keyboard input, or nil.
11350 If non-nil, the value should be a char-table. Each character read
11351 from the keyboard is looked up in this char-table. If the value found
11352 there is non-nil, then it is used instead of the actual input character.
11354 The value can also be a string or vector, but this is considered obsolete.
11355 If it is a string or vector of length N, character codes N and up are left
11356 untranslated. In a vector, an element which is nil means "no translation".
11358 This is applied to the characters supplied to input methods, not their
11359 output. See also `translation-table-for-input'.
11361 This variable has a separate binding for each terminal.
11362 See Info node `(elisp)Multiple Terminals'. */);
11364 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11365 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11366 \(Even if the operating system has support for stopping a process.\) */);
11367 cannot_suspend
= 0;
11369 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11370 doc
: /* Non-nil means prompt with menus when appropriate.
11371 This is done when reading from a keymap that has a prompt string,
11372 for elements that have prompt strings.
11373 The menu is displayed on the screen
11374 if X menus were enabled at configuration
11375 time and the previous event was a mouse click prefix key.
11376 Otherwise, menu prompting uses the echo area. */);
11377 menu_prompting
= 1;
11379 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11380 doc
: /* Character to see next line of menu prompt.
11381 Type this character while in a menu prompt to rotate around the lines of it. */);
11382 XSETINT (menu_prompt_more_char
, ' ');
11384 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11385 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11386 Emacs applies the modifiers of the character stored here to each keyboard
11387 character it reads. For example, after evaluating the expression
11388 (setq extra-keyboard-modifiers ?\\C-x)
11389 all input characters will have the control modifier applied to them.
11391 Note that the character ?\\C-@, equivalent to the integer zero, does
11392 not count as a control character; rather, it counts as a character
11393 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11394 cancels any modification. */);
11395 extra_keyboard_modifiers
= 0;
11397 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11398 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11399 The command loop sets this to nil before each command,
11400 and tests the value when the command returns.
11401 Buffer modification stores t in this variable. */);
11402 Vdeactivate_mark
= Qnil
;
11403 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11404 Fmake_variable_buffer_local (Qdeactivate_mark
);
11406 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11407 doc
: /* Normal hook run before each command is executed.
11408 If an unhandled error happens in running this hook,
11409 the function in which the error occurred is unconditionally removed, since
11410 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11411 Vpre_command_hook
= Qnil
;
11413 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11414 doc
: /* Normal hook run after each command is executed.
11415 If an unhandled error happens in running this hook,
11416 the function in which the error occurred is unconditionally removed, since
11417 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11418 Vpost_command_hook
= Qnil
;
11421 DEFVAR_LISP ("echo-area-clear-hook", ...,
11422 doc
: /* Normal hook run when clearing the echo area. */);
11424 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11425 Fset (Qecho_area_clear_hook
, Qnil
);
11427 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11428 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11429 Vlucid_menu_bar_dirty_flag
= Qnil
;
11431 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11432 doc
: /* List of menu bar items to move to the end of the menu bar.
11433 The elements of the list are event types that may have menu bar bindings. */);
11434 Vmenu_bar_final_items
= Qnil
;
11436 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11437 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11438 This is used internally by graphical displays that do not render
11439 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11440 Vtool_bar_separator_image_expression
= Qnil
;
11442 DEFVAR_KBOARD ("overriding-terminal-local-map",
11443 Voverriding_terminal_local_map
,
11444 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11445 This variable is intended to let commands such as `universal-argument'
11446 set up a different keymap for reading the next command.
11448 `overriding-terminal-local-map' has a separate binding for each
11449 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11451 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11452 doc
: /* Keymap that replaces (overrides) local keymaps.
11453 If this variable is non-nil, Emacs looks up key bindings in this
11454 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11455 buffer's local map. Hence, the only active keymaps would be
11456 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11457 order of precedence. */);
11458 Voverriding_local_map
= Qnil
;
11460 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11461 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11462 Otherwise, the menu bar continues to reflect the buffer's local map
11463 and the minor mode maps regardless of `overriding-local-map'. */);
11464 Voverriding_local_map_menu_flag
= Qnil
;
11466 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11467 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11468 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11470 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11471 doc
: /* Non-nil means generate motion events for mouse motion. */);
11473 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11474 doc
: /* Alist of system-specific X windows key symbols.
11475 Each element should have the form (N . SYMBOL) where N is the
11476 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11477 and SYMBOL is its name.
11479 `system-key-alist' has a separate binding for each terminal device.
11480 See Info node `(elisp)Multiple Terminals'. */);
11482 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11483 doc
: /* Keymap that translates key sequences to key sequences during input.
11484 This is used mainly for mapping key sequences into some preferred
11485 key events (symbols).
11487 The `read-key-sequence' function replaces any subsequence bound by
11488 `local-function-key-map' with its binding. More precisely, when the
11489 active keymaps have no binding for the current key sequence but
11490 `local-function-key-map' binds a suffix of the sequence to a vector or
11491 string, `read-key-sequence' replaces the matching suffix with its
11492 binding, and continues with the new sequence.
11494 If the binding is a function, it is called with one argument (the prompt)
11495 and its return value (a key sequence) is used.
11497 The events that come from bindings in `local-function-key-map' are not
11498 themselves looked up in `local-function-key-map'.
11500 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11501 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11502 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11503 typing `ESC O P x' would return [f1 x].
11505 `local-function-key-map' has a separate binding for each terminal
11506 device. See Info node `(elisp)Multiple Terminals'. If you need to
11507 define a binding on all terminals, change `function-key-map'
11508 instead. Initially, `local-function-key-map' is an empty keymap that
11509 has `function-key-map' as its parent on all terminal devices. */);
11511 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11512 doc
: /* Keymap that decodes input escape sequences.
11513 This is used mainly for mapping ASCII function key sequences into
11514 real Emacs function key events (symbols).
11516 The `read-key-sequence' function replaces any subsequence bound by
11517 `input-decode-map' with its binding. Contrary to `function-key-map',
11518 this map applies its rebinding regardless of the presence of an ordinary
11519 binding. So it is more like `key-translation-map' except that it applies
11520 before `function-key-map' rather than after.
11522 If the binding is a function, it is called with one argument (the prompt)
11523 and its return value (a key sequence) is used.
11525 The events that come from bindings in `input-decode-map' are not
11526 themselves looked up in `input-decode-map'. */);
11528 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11529 doc
: /* The parent keymap of all `local-function-key-map' instances.
11530 Function key definitions that apply to all terminal devices should go
11531 here. If a mapping is defined in both the current
11532 `local-function-key-map' binding and this variable, then the local
11533 definition will take precedence. */);
11534 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11536 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11537 doc
: /* Keymap of key translations that can override keymaps.
11538 This keymap works like `input-decode-map', but comes after `function-key-map'.
11539 Another difference is that it is global rather than terminal-local. */);
11540 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11542 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11543 doc
: /* List of deferred actions to be performed at a later time.
11544 The precise format isn't relevant here; we just check whether it is nil. */);
11545 Vdeferred_action_list
= Qnil
;
11547 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11548 doc
: /* Function to call to handle deferred actions, after each command.
11549 This function is called with no arguments after each command
11550 whenever `deferred-action-list' is non-nil. */);
11551 Vdeferred_action_function
= Qnil
;
11553 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11554 doc
: /* List of warnings to be displayed after this command.
11555 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11556 as per the args of `display-warning' (which see).
11557 If this variable is non-nil, `delayed-warnings-hook' will be run
11558 immediately after running `post-command-hook'. */);
11559 Vdelayed_warnings_list
= Qnil
;
11561 DEFVAR_LISP ("timer-list", Vtimer_list
,
11562 doc
: /* List of active absolute time timers in order of increasing time. */);
11563 Vtimer_list
= Qnil
;
11565 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11566 doc
: /* List of active idle-time timers in order of increasing time. */);
11567 Vtimer_idle_list
= Qnil
;
11569 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11570 doc
: /* If non-nil, the function that implements the current input method.
11571 It's called with one argument, a printing character that was just read.
11572 \(That means a character with code 040...0176.)
11573 Typically this function uses `read-event' to read additional events.
11574 When it does so, it should first bind `input-method-function' to nil
11575 so it will not be called recursively.
11577 The function should return a list of zero or more events
11578 to be used as input. If it wants to put back some events
11579 to be reconsidered, separately, by the input method,
11580 it can add them to the beginning of `unread-command-events'.
11582 The input method function can find in `input-method-previous-message'
11583 the previous echo area message.
11585 The input method function should refer to the variables
11586 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11587 for guidance on what to do. */);
11588 Vinput_method_function
= Qnil
;
11590 DEFVAR_LISP ("input-method-previous-message",
11591 Vinput_method_previous_message
,
11592 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11593 This variable exists because `read-event' clears the echo area
11594 before running the input method. It is nil if there was no message. */);
11595 Vinput_method_previous_message
= Qnil
;
11597 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11598 doc
: /* If non-nil, the function that implements the display of help.
11599 It's called with one argument, the help string to display. */);
11600 Vshow_help_function
= Qnil
;
11602 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11603 doc
: /* If non-nil, suppress point adjustment after executing a command.
11605 After a command is executed, if point is moved into a region that has
11606 special properties (e.g. composition, display), we adjust point to
11607 the boundary of the region. But, when a command sets this variable to
11608 non-nil, we suppress the point adjustment.
11610 This variable is set to nil before reading a command, and is checked
11611 just after executing the command. */);
11612 Vdisable_point_adjustment
= Qnil
;
11614 DEFVAR_LISP ("global-disable-point-adjustment",
11615 Vglobal_disable_point_adjustment
,
11616 doc
: /* If non-nil, always suppress point adjustment.
11618 The default value is nil, in which case, point adjustment are
11619 suppressed only after special commands that set
11620 `disable-point-adjustment' (which see) to non-nil. */);
11621 Vglobal_disable_point_adjustment
= Qnil
;
11623 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11624 doc
: /* How long to display an echo-area message when the minibuffer is active.
11625 If the value is not a number, such messages don't time out. */);
11626 Vminibuffer_message_timeout
= make_number (2);
11628 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11629 doc
: /* If non-nil, any keyboard input throws to this symbol.
11630 The value of that variable is passed to `quit-flag' and later causes a
11631 peculiar kind of quitting. */);
11632 Vthrow_on_input
= Qnil
;
11634 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11635 doc
: /* Function to output error messages.
11636 Called with three arguments:
11637 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11638 such as what `condition-case' would bind its variable to,
11639 - the context (a string which normally goes at the start of the message),
11640 - the Lisp function within which the error was signaled. */);
11641 Vcommand_error_function
= intern ("command-error-default-function");
11643 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11644 Venable_disabled_menus_and_buttons
,
11645 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11647 Help functions bind this to allow help on disabled menu items
11648 and tool-bar buttons. */);
11649 Venable_disabled_menus_and_buttons
= Qnil
;
11651 DEFVAR_LISP ("select-active-regions",
11652 Vselect_active_regions
,
11653 doc
: /* If non-nil, an active region automatically sets the primary selection.
11654 If the value is `only', only temporarily active regions (usually made
11655 by mouse-dragging or shift-selection) set the window selection.
11657 This takes effect only when Transient Mark mode is enabled. */);
11658 Vselect_active_regions
= Qt
;
11660 DEFVAR_LISP ("saved-region-selection",
11661 Vsaved_region_selection
,
11662 doc
: /* Contents of active region prior to buffer modification.
11663 If `select-active-regions' is non-nil, Emacs sets this to the
11664 text in the region before modifying the buffer. The next call to
11665 the function `deactivate-mark' uses this to set the window selection. */);
11666 Vsaved_region_selection
= Qnil
;
11668 DEFVAR_LISP ("selection-inhibit-update-commands",
11669 Vselection_inhibit_update_commands
,
11670 doc
: /* List of commands which should not update the selection.
11671 Normally, if `select-active-regions' is non-nil and the mark remains
11672 active after a command (i.e. the mark was not deactivated), the Emacs
11673 command loop sets the selection to the text in the region. However,
11674 if the command is in this list, the selection is not updated. */);
11675 Vselection_inhibit_update_commands
11676 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11678 DEFVAR_LISP ("debug-on-event",
11680 doc
: /* Enter debugger on this event. When Emacs
11681 receives the special event specified by this variable, it will try to
11682 break into the debugger as soon as possible instead of processing the
11683 event normally through `special-event-map'.
11685 Currently, the only supported values for this
11686 variable are `sigusr1' and `sigusr2'. */);
11687 Vdebug_on_event
= intern_c_string ("sigusr2");
11689 /* Create the initial keyboard. Qt means 'unset'. */
11690 initial_kboard
= allocate_kboard (Qt
);
11694 keys_of_keyboard (void)
11696 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11697 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11698 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11699 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11700 initial_define_key (meta_map
, 'x', "execute-extended-command");
11702 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11703 "handle-delete-frame");
11704 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11705 "ns-put-working-text");
11706 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11707 "ns-unput-working-text");
11708 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11709 current-prefix-arg, as is done in `handle-switch-frame'.
11710 But `handle-switch-frame is not run from the special-map.
11711 Commands from that map are run in a special way that automatically
11712 preserves the prefix-arg. Restoring the prefix arg here is not just
11713 redundant but harmful:
11715 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11716 - after the first prompt, the exit-minibuffer-hook is run which may
11717 iconify a frame and thus push a `iconify-frame' event.
11718 - after running exit-minibuffer-hook, current-prefix-arg is
11719 restored to the non-nil value it had before the prompt.
11720 - we enter the second prompt.
11721 current-prefix-arg is non-nil, prefix-arg is nil.
11722 - before running the first real event, we run the special iconify-frame
11723 event, but we pass the `special' arg to execute-command so
11724 current-prefix-arg and prefix-arg are left untouched.
11725 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11726 - the next key event will have a spuriously non-nil current-prefix-arg. */
11727 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11729 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11731 /* Handling it at such a low-level causes read_key_sequence to get
11732 * confused because it doesn't realize that the current_buffer was
11733 * changed by read_char.
11735 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11736 * "handle-select-window"); */
11737 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11738 "handle-save-session");
11741 /* Define a special event which is raised for dbus callback
11743 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11744 "dbus-handle-event");
11747 #ifdef USE_FILE_NOTIFY
11748 /* Define a special event which is raised for notification callback
11750 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11751 "file-notify-handle-event");
11752 #endif /* USE_FILE_NOTIFY */
11754 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11756 #if defined (WINDOWSNT)
11757 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11760 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11761 "handle-focus-in");
11762 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11763 "handle-focus-out");
11766 /* Mark the pointers in the kboard objects.
11767 Called by Fgarbage_collect. */
11769 mark_kboards (void)
11773 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11775 if (kb
->kbd_macro_buffer
)
11776 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11778 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11779 mark_object (KVAR (kb
, Vlast_command
));
11780 mark_object (KVAR (kb
, Vreal_last_command
));
11781 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11782 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11783 mark_object (KVAR (kb
, Vprefix_arg
));
11784 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11785 mark_object (KVAR (kb
, kbd_queue
));
11786 mark_object (KVAR (kb
, defining_kbd_macro
));
11787 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11788 mark_object (KVAR (kb
, Vsystem_key_alist
));
11789 mark_object (KVAR (kb
, system_key_syms
));
11790 mark_object (KVAR (kb
, Vwindow_system
));
11791 mark_object (KVAR (kb
, Vinput_decode_map
));
11792 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11793 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11794 mark_object (KVAR (kb
, echo_string
));
11797 struct input_event
*event
;
11798 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11800 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11801 event
= kbd_buffer
;
11802 /* These two special event types has no Lisp_Objects to mark. */
11803 if (event
->kind
!= SELECTION_REQUEST_EVENT
11804 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11806 mark_object (event
->x
);
11807 mark_object (event
->y
);
11808 mark_object (event
->frame_or_window
);
11809 mark_object (event
->arg
);