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"
56 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #if defined USABLE_FIONREAD && defined USG5_4
60 # include <sys/filio.h>
63 #include "syssignal.h"
65 #include <sys/types.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 #include <gc.h> /* for GC_collect_a_little */
75 /* Variables for blockinput.h: */
77 /* Positive if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* True means an input interrupt or alarm signal has arrived.
81 The QUIT macro checks this. */
82 volatile bool pending_signals
;
84 #define KBD_BUFFER_SIZE 4096
86 KBOARD
*initial_kboard
;
87 KBOARD
*current_kboard
;
88 static KBOARD
*all_kboards
;
90 /* True in the single-kboard state, false in the any-kboard state. */
91 static bool single_kboard
;
93 /* Non-nil disable property on a command means
94 do not execute it; call disabled-command-function's value instead. */
95 Lisp_Object Qdisabled
;
96 static Lisp_Object Qdisabled_command_function
;
98 #define NUM_RECENT_KEYS (300)
100 /* Index for storing next element into recent_keys. */
101 static int recent_keys_index
;
103 /* Total number of elements stored into recent_keys. */
104 static int total_keys
;
106 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
107 static Lisp_Object recent_keys
;
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 ptrdiff_t this_command_key_count
;
117 /* True after calling Freset_this_command_lengths.
118 Usually it is false. */
119 static bool this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static ptrdiff_t before_command_key_count
;
137 static ptrdiff_t before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static Lisp_Object getctag
;
143 /* True while doing kbd input. */
144 bool waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* True means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 EMACS_INT command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static ptrdiff_t last_non_minibuf_size
;
203 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
204 uintmax_t num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
225 static Lisp_Object Qhandle_select_window
;
226 Lisp_Object QPRIMARY
;
228 static Lisp_Object Qself_insert_command
;
229 static Lisp_Object Qforward_char
;
230 static Lisp_Object Qbackward_char
;
231 Lisp_Object Qundefined
;
232 static Lisp_Object Qtimer_event_handler
;
234 /* `read_key_sequence' stores here the command definition of the
235 key sequence that it reads. */
236 static Lisp_Object read_key_sequence_cmd
;
237 static Lisp_Object read_key_sequence_remapped
;
239 static Lisp_Object Qinput_method_function
;
241 static Lisp_Object Qdeactivate_mark
;
243 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
245 static Lisp_Object Qecho_area_clear_hook
;
247 /* Hooks to run before and after each command. */
248 static Lisp_Object Qpre_command_hook
;
249 static Lisp_Object Qpost_command_hook
;
251 static Lisp_Object Qdeferred_action_function
;
253 static Lisp_Object Qdelayed_warnings_hook
;
255 static Lisp_Object Qinput_method_exit_on_first_char
;
256 static Lisp_Object Qinput_method_use_echo_area
;
258 static Lisp_Object Qhelp_form_show
;
260 /* File in which we write all commands we read. */
261 static FILE *dribble
;
263 /* Nonzero if input is available. */
266 /* Circular buffer for pre-read keyboard input. */
268 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
270 /* Pointer to next available character in kbd_buffer.
271 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
272 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
273 next available char is in kbd_buffer[0]. */
274 static struct input_event
*kbd_fetch_ptr
;
276 /* Pointer to next place to store character in kbd_buffer. This
277 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
278 character should go in kbd_buffer[0]. */
279 static struct input_event
* volatile kbd_store_ptr
;
281 /* The above pair of variables forms a "queue empty" flag. When we
282 enqueue a non-hook event, we increment kbd_store_ptr. When we
283 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
284 there is input available if the two pointers are not equal.
286 Why not just have a flag set and cleared by the enqueuing and
287 dequeuing functions? Such a flag could be screwed up by interrupts
288 at inopportune times. */
290 /* Symbols to head events. */
291 static Lisp_Object Qmouse_movement
;
292 static Lisp_Object Qscroll_bar_movement
;
293 Lisp_Object Qswitch_frame
;
294 static Lisp_Object Qfocus_in
, Qfocus_out
;
295 static Lisp_Object Qdelete_frame
;
296 static Lisp_Object Qiconify_frame
;
297 static Lisp_Object Qmake_frame_visible
;
298 static Lisp_Object Qselect_window
;
299 Lisp_Object Qhelp_echo
;
301 static Lisp_Object Qmouse_fixup_help_message
;
303 /* Symbols to denote kinds of events. */
304 static Lisp_Object Qfunction_key
;
305 Lisp_Object Qmouse_click
;
307 Lisp_Object Qlanguage_change
;
309 static Lisp_Object Qdrag_n_drop
;
310 static Lisp_Object Qsave_session
;
312 static Lisp_Object Qdbus_event
;
314 #ifdef USE_FILE_NOTIFY
315 static Lisp_Object Qfile_notify
;
316 #endif /* USE_FILE_NOTIFY */
317 static Lisp_Object Qconfig_changed_event
;
319 /* Lisp_Object Qmouse_movement; - also an event header */
321 /* Properties of event headers. */
322 Lisp_Object Qevent_kind
;
323 static Lisp_Object Qevent_symbol_elements
;
325 /* Menu and tool bar item parts. */
326 static Lisp_Object Qmenu_enable
;
327 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
328 Lisp_Object QCfilter
;
330 /* Non-nil disable property on a command means
331 do not execute it; call disabled-command-function's value instead. */
332 Lisp_Object QCtoggle
, QCradio
;
333 static Lisp_Object QCbutton
, QClabel
;
335 static Lisp_Object QCvert_only
;
337 /* An event header symbol HEAD may have a property named
338 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
339 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
340 mask of modifiers applied to it. If present, this is used to help
341 speed up parse_modifiers. */
342 Lisp_Object Qevent_symbol_element_mask
;
344 /* An unmodified event header BASE may have a property named
345 Qmodifier_cache, which is an alist mapping modifier masks onto
346 modified versions of BASE. If present, this helps speed up
348 static Lisp_Object Qmodifier_cache
;
350 /* Symbols to use for parts of windows. */
351 Lisp_Object Qmode_line
;
352 Lisp_Object Qvertical_line
;
353 Lisp_Object Qright_divider
, Qbottom_divider
;
354 static Lisp_Object Qvertical_scroll_bar
;
355 Lisp_Object Qmenu_bar
;
357 static Lisp_Object Qecho_keystrokes
;
359 static void recursive_edit_unwind (Lisp_Object buffer
);
360 static Lisp_Object
command_loop (void);
361 static Lisp_Object Qcommand_execute
;
363 static void echo_now (void);
364 static ptrdiff_t echo_length (void);
366 static Lisp_Object Qpolling_period
;
368 /* Incremented whenever a timer is run. */
371 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
373 struct timespec
*input_available_clear_time
;
375 /* True means use SIGIO interrupts; false means use CBREAK mode.
376 Default is true if INTERRUPT_INPUT is defined. */
377 bool interrupt_input
;
379 /* Nonzero while interrupts are temporarily deferred during redisplay. */
380 bool interrupts_deferred
;
382 /* The time when Emacs started being idle. */
384 static struct timespec timer_idleness_start_time
;
386 /* After Emacs stops being idle, this saves the last value
387 of timer_idleness_start_time from when it was idle. */
389 static struct timespec timer_last_idleness_start_time
;
392 /* Global variable declarations. */
394 /* Flags for readable_events. */
395 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
396 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
397 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
399 /* Function for init_keyboard to call with no args (if nonzero). */
400 static void (*keyboard_init_hook
) (void);
402 static bool get_input_pending (int);
403 static bool readable_events (int);
404 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
405 Lisp_Object
, bool *);
406 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
407 static Lisp_Object
make_lispy_event (struct input_event
*);
408 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
409 enum scroll_bar_part
,
410 Lisp_Object
, Lisp_Object
,
412 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
413 Lisp_Object
, const char *const *,
414 Lisp_Object
*, ptrdiff_t);
415 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
416 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
417 #ifdef HAVE_WINDOW_SYSTEM
418 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
419 #endif /* HAVE_WINDOW_SYSTEM */
420 static bool help_char_p (Lisp_Object
);
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)
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
);
783 /* When an auto-save happens, record the "time", and don't do again soon. */
786 record_auto_save (void)
788 last_auto_save
= num_nonmacro_input_events
;
791 /* Make an auto save happen as soon as possible at command level. */
795 force_auto_save_soon (void)
797 last_auto_save
= - auto_save_interval
- 1;
799 record_asynch_buffer_change ();
803 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
804 doc
: /* Invoke the editor command loop recursively.
805 To get out of the recursive edit, a command can throw to `exit' -- for
806 instance `(throw 'exit nil)'.
807 If you throw a value other than t, `recursive-edit' returns normally
808 to the function that called it. Throwing a t value causes
809 `recursive-edit' to quit, so that control returns to the command loop
812 This function is called by the editor initialization to begin editing. */)
818 /* If we enter while input is blocked, don't lock up here.
819 This may happen through the debugger during redisplay. */
820 if (input_blocked_p ()) {
825 if (command_loop_level
>= 0
826 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
827 buffer
= Fcurrent_buffer ();
831 /* Don't do anything interesting between the increment and the
832 record_unwind_protect! Otherwise, we could get distracted and
833 never decrement the counter again. */
834 command_loop_level
++;
835 update_mode_lines
= 17;
836 record_unwind_protect (recursive_edit_unwind
, buffer
);
838 /* If we leave recursive_edit_1 below with a `throw' for instance,
839 like it is done in the splash screen display, we have to
840 make sure that we restore single_kboard as command_loop_1
841 would have done if it were left normally. */
842 if (command_loop_level
> 0)
843 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
851 recursive_edit_unwind (Lisp_Object buffer
)
853 if (BUFFERP (buffer
))
854 Fset_buffer (buffer
);
856 command_loop_level
--;
857 update_mode_lines
= 18;
861 #if 0 /* These two functions are now replaced with
862 temporarily_switch_to_single_kboard. */
866 #if 0 /* Theory: if there's anything in Vunread_command_events,
867 it will right away be read by read_key_sequence,
868 and then if we do switch KBOARDS, it will go into the side
869 queue then. So we don't need to do anything special here -- rms. */
870 if (CONSP (Vunread_command_events
))
872 current_kboard
->kbd_queue
873 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
874 current_kboard
->kbd_queue_has_data
= 1;
876 Vunread_command_events
= Qnil
;
881 /* Switch to the single-kboard state, making current_kboard
882 the only KBOARD from which further input is accepted. */
885 single_kboard_state ()
891 /* If we're in single_kboard state for kboard KBOARD,
895 not_single_kboard_state (KBOARD
*kboard
)
897 if (kboard
== current_kboard
)
901 /* Maintain a stack of kboards, so other parts of Emacs
902 can switch temporarily to the kboard of a given frame
903 and then revert to the previous status. */
908 struct kboard_stack
*next
;
911 static struct kboard_stack
*kboard_stack
;
914 push_kboard (struct kboard
*k
)
916 struct kboard_stack
*p
= xmalloc (sizeof *p
);
918 p
->next
= kboard_stack
;
919 p
->kboard
= current_kboard
;
929 struct kboard_stack
*p
= kboard_stack
;
931 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
933 if (t
->kboard
== p
->kboard
)
935 current_kboard
= p
->kboard
;
942 /* The terminal we remembered has been deleted. */
943 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
946 kboard_stack
= p
->next
;
950 /* Switch to single_kboard mode, making current_kboard the only KBOARD
951 from which further input is accepted. If F is non-nil, set its
952 KBOARD as the current keyboard.
954 This function uses record_unwind_protect_int to return to the previous
957 If Emacs is already in single_kboard mode, and F's keyboard is
958 locked, then this function will throw an error. */
961 temporarily_switch_to_single_kboard (struct frame
*f
)
963 bool was_locked
= single_kboard
;
966 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
967 /* We can not switch keyboards while in single_kboard mode.
968 In rare cases, Lisp code may call `recursive-edit' (or
969 `read-minibuffer' or `y-or-n-p') after it switched to a
970 locked frame. For example, this is likely to happen
971 when server.el connects to a new terminal while Emacs is in
972 single_kboard mode. It is best to throw an error instead
973 of presenting the user with a frozen screen. */
974 error ("Terminal %d is locked, cannot read from it",
975 FRAME_TERMINAL (f
)->id
);
977 /* This call is unnecessary, but helps
978 `restore_kboard_configuration' discover if somebody changed
979 `current_kboard' behind our back. */
980 push_kboard (current_kboard
);
983 current_kboard
= FRAME_KBOARD (f
);
985 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
988 #if 0 /* This function is not needed anymore. */
990 record_single_kboard_state ()
993 push_kboard (current_kboard
);
994 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
999 restore_kboard_configuration (int was_locked
)
1001 single_kboard
= was_locked
;
1004 struct kboard
*prev
= current_kboard
;
1006 /* The pop should not change the kboard. */
1007 if (single_kboard
&& current_kboard
!= prev
)
1013 /* Handle errors that are not handled at inner levels
1014 by printing an error message and returning to the editor command loop. */
1017 cmd_error (Lisp_Object data
)
1019 Lisp_Object old_level
, old_length
;
1020 char macroerror
[sizeof "After..kbd macro iterations: "
1021 + INT_STRLEN_BOUND (EMACS_INT
)];
1023 #ifdef HAVE_WINDOW_SYSTEM
1024 if (display_hourglass_p
)
1025 cancel_hourglass ();
1028 if (!NILP (executing_kbd_macro
))
1030 if (executing_kbd_macro_iterations
== 1)
1031 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1033 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1034 executing_kbd_macro_iterations
);
1039 Vstandard_output
= Qt
;
1040 Vstandard_input
= Qt
;
1041 Vexecuting_kbd_macro
= Qnil
;
1042 executing_kbd_macro
= Qnil
;
1043 kset_prefix_arg (current_kboard
, Qnil
);
1044 kset_last_prefix_arg (current_kboard
, Qnil
);
1047 /* Avoid unquittable loop if data contains a circular list. */
1048 old_level
= Vprint_level
;
1049 old_length
= Vprint_length
;
1050 XSETFASTINT (Vprint_level
, 10);
1051 XSETFASTINT (Vprint_length
, 10);
1052 cmd_error_internal (data
, macroerror
);
1053 Vprint_level
= old_level
;
1054 Vprint_length
= old_length
;
1057 Vinhibit_quit
= Qnil
;
1059 return make_number (0);
1062 /* Take actions on handling an error. DATA is the data that describes
1065 CONTEXT is a C-string containing ASCII characters only which
1066 describes the context in which the error happened. If we need to
1067 generalize CONTEXT to allow multibyte characters, make it a Lisp
1071 cmd_error_internal (Lisp_Object data
, const char *context
)
1073 /* The immediate context is not interesting for Quits,
1074 since they are asynchronous. */
1075 if (EQ (XCAR (data
), Qquit
))
1076 Vsignaling_function
= Qnil
;
1081 /* Use user's specified output function if any. */
1082 if (!NILP (Vcommand_error_function
))
1083 call3 (Vcommand_error_function
, data
,
1084 context
? build_string (context
) : empty_unibyte_string
,
1085 Vsignaling_function
);
1087 Vsignaling_function
= Qnil
;
1090 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1091 Scommand_error_default_function
, 3, 3, 0,
1092 doc
: /* Produce default output for unhandled error message.
1093 Default value of `command-error-function'. */)
1094 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1096 struct frame
*sf
= SELECTED_FRAME ();
1098 CHECK_STRING (context
);
1100 /* If the window system or terminal frame hasn't been initialized
1101 yet, or we're not interactive, write the message to stderr and exit. */
1102 if (!sf
->glyphs_initialized_p
1103 /* The initial frame is a special non-displaying frame. It
1104 will be current in daemon mode when there are no frames
1105 to display, and in non-daemon mode before the real frame
1106 has finished initializing. If an error is thrown in the
1107 latter case while creating the frame, then the frame
1108 will never be displayed, so the safest thing to do is
1109 write to stderr and quit. In daemon mode, there are
1110 many other potential errors that do not prevent frames
1111 from being created, so continuing as normal is better in
1113 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1116 print_error_message (data
, Qexternal_debugging_output
,
1117 SSDATA (context
), signal
);
1118 Fterpri (Qexternal_debugging_output
);
1119 Fkill_emacs (make_number (-1));
1123 clear_message (1, 0);
1125 message_log_maybe_newline ();
1128 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1133 static Lisp_Object
command_loop_2 (Lisp_Object
);
1134 static Lisp_Object
top_level_1 (Lisp_Object
);
1136 /* Entry to editor-command-loop.
1137 This level has the catches for exiting/returning to editor command loop.
1138 It returns nil to exit recursive edit, t to abort it. */
1143 if (command_loop_level
> 0 || minibuf_level
> 0)
1146 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1147 executing_kbd_macro
= Qnil
;
1153 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1154 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1155 executing_kbd_macro
= Qnil
;
1157 /* End of file in -batch run causes exit here. */
1163 /* Here we catch errors in execution of commands within the
1164 editing loop, and reenter the editing loop.
1165 When there is an error, cmd_error runs and returns a non-nil
1166 value to us. A value of nil means that command_loop_1 itself
1167 returned due to end of file (or end of kbd macro). */
1170 command_loop_2_body (void *ignore
)
1172 return command_loop_1 ();
1176 command_loop_2_handler (void *ignore
, SCM key
, SCM args
)
1178 return Fsignal (Qerror
,
1179 list3 (build_string ("Scheme error"), key
, args
));
1183 command_loop_2_inner (void)
1185 return scm_c_with_throw_handler (SCM_BOOL_T
,
1186 command_loop_2_body
, NULL
,
1187 command_loop_2_handler
, NULL
,
1192 command_loop_2 (Lisp_Object ignore
)
1194 register Lisp_Object val
;
1197 val
= internal_condition_case (command_loop_2_inner
, Qerror
, cmd_error
);
1198 while (!NILP (val
));
1206 return Feval (Vtop_level
, Qnil
);
1210 top_level_1 (Lisp_Object ignore
)
1212 /* On entry to the outer level, run the startup file. */
1213 if (!NILP (Vtop_level
))
1214 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1215 else if (!NILP (Vpurify_flag
))
1216 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1218 message1 ("Bare Emacs (standard Lisp code not loaded)");
1222 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1223 doc
: /* Exit all recursive editing levels.
1224 This also exits all active minibuffers. */)
1227 #ifdef HAVE_WINDOW_SYSTEM
1228 if (display_hourglass_p
)
1229 cancel_hourglass ();
1232 /* Unblock input if we enter with input blocked. This may happen if
1233 redisplay traps e.g. during tool-bar update with input blocked. */
1234 totally_unblock_input ();
1236 Fthrow (Qtop_level
, Qnil
);
1239 static _Noreturn
void
1240 user_error (const char *msg
)
1242 xsignal1 (Quser_error
, build_string (msg
));
1245 /* _Noreturn will be added to prototype by make-docfile. */
1246 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1247 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1250 if (command_loop_level
> 0 || minibuf_level
> 0)
1251 Fthrow (Qexit
, Qnil
);
1253 user_error ("No recursive edit is in progress");
1256 /* _Noreturn will be added to prototype by make-docfile. */
1257 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1258 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1261 if (command_loop_level
> 0 || minibuf_level
> 0)
1264 user_error ("No recursive edit is in progress");
1267 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1268 of this function. */
1271 tracking_off (Lisp_Object old_value
)
1273 do_mouse_tracking
= old_value
;
1274 if (NILP (old_value
))
1276 /* Redisplay may have been preempted because there was input
1277 available, and it assumes it will be called again after the
1278 input has been processed. If the only input available was
1279 the sort that we have just disabled, then we need to call
1281 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1283 redisplay_preserve_echo_area (6);
1284 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1289 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1290 doc
: /* Evaluate BODY with mouse movement events enabled.
1291 Within a `track-mouse' form, mouse motion generates input events that
1292 you can read with `read-event'.
1293 Normally, mouse motion is ignored.
1294 usage: (track-mouse BODY...) */)
1300 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1302 do_mouse_tracking
= Qt
;
1304 val
= Fprogn (args
);
1309 /* If mouse has moved on some frame, return one of those frames.
1313 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1314 after resizing the tool-bar window. */
1316 bool ignore_mouse_drag_p
;
1318 static struct frame
*
1319 some_mouse_moved (void)
1321 Lisp_Object tail
, frame
;
1323 if (ignore_mouse_drag_p
)
1325 /* ignore_mouse_drag_p = 0; */
1329 FOR_EACH_FRAME (tail
, frame
)
1331 if (XFRAME (frame
)->mouse_moved
)
1332 return XFRAME (frame
);
1339 /* This is the actual command reading loop,
1340 sans error-handling encapsulation. */
1342 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1343 bool, bool, bool, bool);
1344 static void adjust_point_for_property (ptrdiff_t, bool);
1346 /* The last boundary auto-added to buffer-undo-list. */
1347 Lisp_Object last_undo_boundary
;
1349 /* FIXME: This is wrong rather than test window-system, we should call
1350 a new set-selection, which will then dispatch to x-set-selection, or
1351 tty-set-selection, or w32-set-selection, ... */
1354 command_loop_1 (void)
1357 Lisp_Object keybuf
[30];
1359 EMACS_INT prev_modiff
= 0;
1360 struct buffer
*prev_buffer
= NULL
;
1361 bool already_adjusted
= 0;
1363 kset_prefix_arg (current_kboard
, Qnil
);
1364 kset_last_prefix_arg (current_kboard
, Qnil
);
1365 Vdeactivate_mark
= Qnil
;
1366 waiting_for_input
= 0;
1369 this_command_key_count
= 0;
1370 this_command_key_count_reset
= 0;
1371 this_single_command_key_start
= 0;
1373 if (NILP (Vmemory_full
))
1375 /* Make sure this hook runs after commands that get errors and
1376 throw to top level. */
1377 /* Note that the value cell will never directly contain nil
1378 if the symbol is a local variable. */
1379 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1380 safe_run_hooks (Qpost_command_hook
);
1382 /* If displaying a message, resize the echo area window to fit
1383 that message's size exactly. */
1384 if (!NILP (echo_area_buffer
[0]))
1385 resize_echo_area_exactly ();
1387 /* If there are warnings waiting, process them. */
1388 if (!NILP (Vdelayed_warnings_list
))
1389 safe_run_hooks (Qdelayed_warnings_hook
);
1391 if (!NILP (Vdeferred_action_list
))
1392 safe_run_hooks (Qdeferred_action_function
);
1395 /* Do this after running Vpost_command_hook, for consistency. */
1396 kset_last_command (current_kboard
, Vthis_command
);
1397 kset_real_last_command (current_kboard
, Vreal_this_command
);
1398 if (!CONSP (last_command_event
))
1399 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1403 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1406 /* Make sure the current window's buffer is selected. */
1407 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1409 /* Display any malloc warning that just came out. Use while because
1410 displaying one warning can cause another. */
1412 while (pending_malloc_warning
)
1413 display_malloc_warning ();
1415 Vdeactivate_mark
= Qnil
;
1417 /* Don't ignore mouse movements for more than a single command
1418 loop. (This flag is set in xdisp.c whenever the tool bar is
1419 resized, because the resize moves text up or down, and would
1420 generate false mouse drag events if we don't ignore them.) */
1421 ignore_mouse_drag_p
= 0;
1423 /* If minibuffer on and echo area in use,
1424 wait a short time and redraw minibuffer. */
1427 && !NILP (echo_area_buffer
[0])
1428 && EQ (minibuf_window
, echo_area_window
)
1429 && NUMBERP (Vminibuffer_message_timeout
))
1431 /* Bind inhibit-quit to t so that C-g gets read in
1432 rather than quitting back to the minibuffer. */
1434 specbind (Qinhibit_quit
, Qt
);
1436 sit_for (Vminibuffer_message_timeout
, 0, 2);
1438 /* Clear the echo area. */
1440 safe_run_hooks (Qecho_area_clear_hook
);
1444 /* If a C-g came in before, treat it as input now. */
1445 if (!NILP (Vquit_flag
))
1448 Vunread_command_events
= list1 (make_number (quit_char
));
1452 /* If it has changed current-menubar from previous value,
1453 really recompute the menubar from the value. */
1454 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1455 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1456 call0 (Qrecompute_lucid_menubar
);
1458 before_command_key_count
= this_command_key_count
;
1459 before_command_echo_length
= echo_length ();
1461 Vthis_command
= Qnil
;
1462 Vreal_this_command
= Qnil
;
1463 Vthis_original_command
= Qnil
;
1464 Vthis_command_keys_shift_translated
= Qnil
;
1466 /* Read next key sequence; i gets its length. */
1467 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1470 /* A filter may have run while we were reading the input. */
1471 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1473 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1477 /* Now we have read a key sequence of length I,
1478 or else I is 0 and we found end of file. */
1480 if (i
== 0) /* End of file -- happens only in */
1481 return Qnil
; /* a kbd macro, at the end. */
1482 /* -1 means read_key_sequence got a menu that was rejected.
1483 Just loop around and read another command. */
1487 this_command_key_count
= 0;
1488 this_command_key_count_reset
= 0;
1489 this_single_command_key_start
= 0;
1493 last_command_event
= keybuf
[i
- 1];
1495 /* If the previous command tried to force a specific window-start,
1496 forget about that, in case this command moves point far away
1497 from that position. But also throw away beg_unchanged and
1498 end_unchanged information in that case, so that redisplay will
1499 update the whole window properly. */
1500 if (XWINDOW (selected_window
)->force_start
)
1503 XWINDOW (selected_window
)->force_start
= 0;
1504 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1505 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1508 cmd
= read_key_sequence_cmd
;
1509 if (!NILP (Vexecuting_kbd_macro
))
1511 if (!NILP (Vquit_flag
))
1513 Vexecuting_kbd_macro
= Qt
;
1514 QUIT
; /* Make some noise. */
1515 /* Will return since macro now empty. */
1519 /* Do redisplay processing after this command except in special
1520 cases identified below. */
1521 prev_buffer
= current_buffer
;
1522 prev_modiff
= MODIFF
;
1523 last_point_position
= PT
;
1525 /* By default, we adjust point to a boundary of a region that
1526 has such a property that should be treated intangible
1527 (e.g. composition, display). But, some commands will set
1528 this variable differently. */
1529 Vdisable_point_adjustment
= Qnil
;
1531 /* Process filters and timers may have messed with deactivate-mark.
1532 reset it before we execute the command. */
1533 Vdeactivate_mark
= Qnil
;
1535 /* Remap command through active keymaps. */
1536 Vthis_original_command
= cmd
;
1537 if (!NILP (read_key_sequence_remapped
))
1538 cmd
= read_key_sequence_remapped
;
1540 /* Execute the command. */
1542 Vthis_command
= cmd
;
1543 Vreal_this_command
= cmd
;
1544 safe_run_hooks (Qpre_command_hook
);
1546 already_adjusted
= 0;
1548 if (NILP (Vthis_command
))
1549 /* nil means key is undefined. */
1553 /* Here for a command that isn't executed directly. */
1555 #ifdef HAVE_WINDOW_SYSTEM
1558 if (display_hourglass_p
1559 && NILP (Vexecuting_kbd_macro
))
1561 record_unwind_protect_void (cancel_hourglass
);
1566 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1568 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1571 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1572 ? Qnil
: BVAR (current_buffer
, undo_list
));
1574 call1 (Qcommand_execute
, Vthis_command
);
1576 #ifdef HAVE_WINDOW_SYSTEM
1577 /* Do not check display_hourglass_p here, because
1578 `command-execute' could change it, but we should cancel
1579 hourglass cursor anyway.
1580 But don't cancel the hourglass within a macro
1581 just because a command in the macro finishes. */
1585 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1587 safe_run_hooks (Qpost_command_hook
);
1589 /* If displaying a message, resize the echo area window to fit
1590 that message's size exactly. */
1591 if (!NILP (echo_area_buffer
[0]))
1592 resize_echo_area_exactly ();
1594 /* If there are warnings waiting, process them. */
1595 if (!NILP (Vdelayed_warnings_list
))
1596 safe_run_hooks (Qdelayed_warnings_hook
);
1598 safe_run_hooks (Qdeferred_action_function
);
1600 /* If there is a prefix argument,
1601 1) We don't want Vlast_command to be ``universal-argument''
1602 (that would be dumb), so don't set Vlast_command,
1603 2) we want to leave echoing on so that the prefix will be
1604 echoed as part of this key sequence, so don't call
1606 3) we want to leave this_command_key_count non-zero, so that
1607 read_char will realize that it is re-reading a character, and
1608 not echo it a second time.
1610 If the command didn't actually create a prefix arg,
1611 but is merely a frame event that is transparent to prefix args,
1612 then the above doesn't apply. */
1613 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1614 || CONSP (last_command_event
))
1616 kset_last_command (current_kboard
, Vthis_command
);
1617 kset_real_last_command (current_kboard
, Vreal_this_command
);
1618 if (!CONSP (last_command_event
))
1619 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1621 this_command_key_count
= 0;
1622 this_command_key_count_reset
= 0;
1623 this_single_command_key_start
= 0;
1626 if (!NILP (BVAR (current_buffer
, mark_active
))
1627 && !NILP (Vrun_hooks
))
1629 /* In Emacs 22, setting transient-mark-mode to `only' was a
1630 way of turning it on for just one command. This usage is
1631 obsolete, but support it anyway. */
1632 if (EQ (Vtransient_mark_mode
, Qidentity
))
1633 Vtransient_mark_mode
= Qnil
;
1634 else if (EQ (Vtransient_mark_mode
, Qonly
))
1635 Vtransient_mark_mode
= Qidentity
;
1637 if (!NILP (Vdeactivate_mark
))
1638 /* If `select-active-regions' is non-nil, this call to
1639 `deactivate-mark' also sets the PRIMARY selection. */
1640 call0 (Qdeactivate_mark
);
1643 /* Even if not deactivating the mark, set PRIMARY if
1644 `select-active-regions' is non-nil. */
1645 if (!NILP (Fwindow_system (Qnil
))
1646 /* Even if mark_active is non-nil, the actual buffer
1647 marker may not have been set yet (Bug#7044). */
1648 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1649 && (EQ (Vselect_active_regions
, Qonly
)
1650 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1651 : (!NILP (Vselect_active_regions
)
1652 && !NILP (Vtransient_mark_mode
)))
1653 && NILP (Fmemq (Vthis_command
,
1654 Vselection_inhibit_update_commands
)))
1657 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1658 if (XINT (Flength (txt
)) > 0)
1659 /* Don't set empty selections. */
1660 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1663 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1665 Lisp_Object hook
= intern ("activate-mark-hook");
1666 Frun_hooks (1, &hook
);
1670 Vsaved_region_selection
= Qnil
;
1675 if (current_buffer
== prev_buffer
1676 && last_point_position
!= PT
1677 && NILP (Vdisable_point_adjustment
)
1678 && NILP (Vglobal_disable_point_adjustment
))
1680 if (last_point_position
> BEGV
1681 && last_point_position
< ZV
1682 && (composition_adjust_point (last_point_position
,
1683 last_point_position
)
1684 != last_point_position
))
1685 /* The last point was temporarily set within a grapheme
1686 cluster to prevent automatic composition. To recover
1687 the automatic composition, we must update the
1689 windows_or_buffers_changed
= 21;
1690 if (!already_adjusted
)
1691 adjust_point_for_property (last_point_position
,
1692 MODIFF
!= prev_modiff
);
1695 /* Install chars successfully executed in kbd macro. */
1697 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1698 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1699 finalize_kbd_macro_chars ();
1704 read_menu_command (void)
1706 Lisp_Object keybuf
[30];
1707 scm_dynwind_begin (0);
1710 /* We don't want to echo the keystrokes while navigating the
1712 specbind (Qecho_keystrokes
, make_number (0));
1714 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1719 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1721 if (i
== 0 || i
== -1)
1724 return read_key_sequence_cmd
;
1727 /* Adjust point to a boundary of a region that has such a property
1728 that should be treated intangible. For the moment, we check
1729 `composition', `display' and `invisible' properties.
1730 LAST_PT is the last position of point. */
1733 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1736 Lisp_Object val
, overlay
, tmp
;
1737 /* When called after buffer modification, we should temporarily
1738 suppress the point adjustment for automatic composition so that a
1739 user can keep inserting another character at point or keep
1740 deleting characters around point. */
1741 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1742 ptrdiff_t orig_pt
= PT
;
1744 /* FIXME: cycling is probably not necessary because these properties
1745 can't be usefully combined anyway. */
1746 while (check_composition
|| check_display
|| check_invisible
)
1748 /* FIXME: check `intangible'. */
1749 if (check_composition
1750 && PT
> BEGV
&& PT
< ZV
1751 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1754 check_display
= check_invisible
= 1;
1756 check_composition
= 0;
1758 && PT
> BEGV
&& PT
< ZV
1759 && !NILP (val
= get_char_property_and_overlay
1760 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1761 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1762 && (!OVERLAYP (overlay
)
1763 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1764 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1765 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1766 && (beg
< PT
/* && end > PT <- It's always the case. */
1767 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1770 SET_PT (PT
< last_pt
1771 ? (STRINGP (val
) && SCHARS (val
) == 0
1772 ? max (beg
- 1, BEGV
)
1775 check_composition
= check_invisible
= 1;
1778 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1784 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1787 /* FIXME: We should stop if we find a spot between
1788 two runs of `invisible' where inserted text would
1789 be visible. This is important when we have two
1790 invisible boundaries that enclose an area: if the
1791 area is empty, we need this test in order to make
1792 it possible to place point in the middle rather
1793 than skip both boundaries. However, this code
1794 also stops anywhere in a non-sticky text-property,
1795 which breaks (e.g.) Org mode. */
1796 && (val
= Fget_pos_property (make_number (end
),
1798 TEXT_PROP_MEANS_INVISIBLE (val
))
1800 && !NILP (val
= get_char_property_and_overlay
1801 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1802 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1804 ellipsis
= ellipsis
|| inv
> 1
1805 || (OVERLAYP (overlay
)
1806 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1807 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1808 tmp
= Fnext_single_char_property_change
1809 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1810 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1814 && (val
= Fget_pos_property (make_number (beg
),
1816 TEXT_PROP_MEANS_INVISIBLE (val
))
1818 && !NILP (val
= get_char_property_and_overlay
1819 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1820 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1822 ellipsis
= ellipsis
|| inv
> 1
1823 || (OVERLAYP (overlay
)
1824 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1825 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1826 tmp
= Fprevious_single_char_property_change
1827 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1828 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1831 /* Move away from the inside area. */
1832 if (beg
< PT
&& end
> PT
)
1834 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1835 /* We haven't moved yet (so we don't need to fear
1836 infinite-looping) and we were outside the range
1837 before (so either end of the range still corresponds
1838 to a move in the right direction): pretend we moved
1839 less than we actually did, so that we still have
1840 more freedom below in choosing which end of the range
1842 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1843 /* We either have moved already or the last point
1844 was already in the range: we don't get to choose
1845 which end of the range we have to go to. */
1846 : (PT
< last_pt
? beg
: end
));
1847 check_composition
= check_display
= 1;
1849 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1850 the point to something other than its argument, due to
1851 point-motion hooks, intangibility, etc. */
1852 eassert (PT
== beg
|| PT
== end
);
1855 /* Pretend the area doesn't exist if the buffer is not
1857 if (!modified
&& !ellipsis
&& beg
< end
)
1859 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1860 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1861 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1862 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1863 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1864 /* We've already moved as far as we can. Trying to go
1865 to the other end would mean moving backwards and thus
1866 could lead to an infinite loop. */
1868 else if (val
= Fget_pos_property (make_number (PT
),
1870 TEXT_PROP_MEANS_INVISIBLE (val
)
1871 && (val
= (Fget_pos_property
1872 (make_number (PT
== beg
? end
: beg
),
1874 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1875 (check_composition
= check_display
= 1,
1876 SET_PT (PT
== beg
? end
: beg
));
1879 check_invisible
= 0;
1883 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1886 safe_run_hooks_1 (void)
1888 eassert (CONSP (Vinhibit_quit
));
1889 return call0 (XCDR (Vinhibit_quit
));
1892 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1896 safe_run_hooks_error (Lisp_Object error_data
)
1899 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1900 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1901 Lisp_Object args
[4];
1902 args
[0] = build_string ("Error in %s (%S): %S");
1905 args
[3] = error_data
;
1911 Lisp_Object newval
= Qnil
;
1912 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1913 if (EQ (fun
, XCAR (val
)))
1916 newval
= Fcons (XCAR (val
), newval
);
1918 return Fset (hook
, Fnreverse (newval
));
1919 /* Not found in the local part of the hook. Let's look at the global
1922 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1923 : Fdefault_value (hook
));
1924 CONSP (val
); val
= XCDR (val
))
1925 if (EQ (fun
, XCAR (val
)))
1928 newval
= Fcons (XCAR (val
), newval
);
1930 return Fset_default (hook
, Fnreverse (newval
));
1936 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1938 eassert (nargs
== 1);
1939 if (CONSP (Vinhibit_quit
))
1940 XSETCDR (Vinhibit_quit
, args
[0]);
1942 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1944 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1948 /* If we get an error while running the hook, cause the hook variable
1949 to be nil. Also inhibit quits, so that C-g won't cause the hook
1950 to mysteriously evaporate. */
1953 safe_run_hooks (Lisp_Object hook
)
1955 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1956 to its body or to its handlers other than via globals such as
1957 dynamically-bound variables ;-) */
1959 specbind (Qinhibit_quit
, hook
);
1961 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1967 /* Nonzero means polling for input is temporarily suppressed. */
1969 int poll_suppress_count
;
1972 #ifdef POLL_FOR_INPUT
1974 /* Asynchronous timer for polling. */
1976 static struct atimer
*poll_timer
;
1978 /* Poll for input, so that we catch a C-g if it comes in. */
1980 poll_for_input_1 (void)
1982 if (! input_blocked_p ()
1983 && !waiting_for_input
)
1987 /* Timer callback function for poll_timer. TIMER is equal to
1991 poll_for_input (struct atimer
*timer
)
1993 if (poll_suppress_count
== 0)
1994 pending_signals
= 1;
1997 #endif /* POLL_FOR_INPUT */
1999 /* Begin signals to poll for input, if they are appropriate.
2000 This function is called unconditionally from various places. */
2003 start_polling (void)
2005 #ifdef POLL_FOR_INPUT
2006 /* XXX This condition was (read_socket_hook && !interrupt_input),
2007 but read_socket_hook is not global anymore. Let's pretend that
2009 if (!interrupt_input
)
2011 /* Turn alarm handling on unconditionally. It might have
2012 been turned off in process.c. */
2013 turn_on_atimers (1);
2015 /* If poll timer doesn't exist, or we need one with
2016 a different interval, start a new one. */
2017 if (poll_timer
== NULL
2018 || poll_timer
->interval
.tv_sec
!= polling_period
)
2020 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2021 struct timespec interval
= make_timespec (period
, 0);
2024 cancel_atimer (poll_timer
);
2026 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2027 poll_for_input
, NULL
);
2030 /* Let the timer's callback function poll for input
2031 if this becomes zero. */
2032 --poll_suppress_count
;
2037 /* True if we are using polling to handle input asynchronously. */
2040 input_polling_used (void)
2042 #ifdef POLL_FOR_INPUT
2043 /* XXX This condition was (read_socket_hook && !interrupt_input),
2044 but read_socket_hook is not global anymore. Let's pretend that
2046 return !interrupt_input
;
2052 /* Turn off polling. */
2057 #ifdef POLL_FOR_INPUT
2058 /* XXX This condition was (read_socket_hook && !interrupt_input),
2059 but read_socket_hook is not global anymore. Let's pretend that
2061 if (!interrupt_input
)
2062 ++poll_suppress_count
;
2066 /* Set the value of poll_suppress_count to COUNT
2067 and start or stop polling accordingly. */
2070 set_poll_suppress_count (int count
)
2072 #ifdef POLL_FOR_INPUT
2073 if (count
== 0 && poll_suppress_count
!= 0)
2075 poll_suppress_count
= 1;
2078 else if (count
!= 0 && poll_suppress_count
== 0)
2082 poll_suppress_count
= count
;
2086 /* Bind polling_period to a value at least N.
2087 But don't decrease it. */
2090 bind_polling_period (int n
)
2092 #ifdef POLL_FOR_INPUT
2093 EMACS_INT
new = polling_period
;
2098 stop_other_atimers (poll_timer
);
2100 specbind (Qpolling_period
, make_number (new));
2101 /* Start a new alarm with the new period. */
2106 /* Apply the control modifier to CHARACTER. */
2109 make_ctrl_char (int c
)
2111 /* Save the upper bits here. */
2112 int upper
= c
& ~0177;
2114 if (! ASCII_CHAR_P (c
))
2115 return c
|= ctrl_modifier
;
2119 /* Everything in the columns containing the upper-case letters
2120 denotes a control character. */
2121 if (c
>= 0100 && c
< 0140)
2125 /* Set the shift modifier for a control char
2126 made from a shifted letter. But only for letters! */
2127 if (oc
>= 'A' && oc
<= 'Z')
2128 c
|= shift_modifier
;
2131 /* The lower-case letters denote control characters too. */
2132 else if (c
>= 'a' && c
<= 'z')
2135 /* Include the bits for control and shift
2136 only if the basic ASCII code can't indicate them. */
2140 /* Replace the high bits. */
2141 c
|= (upper
& ~ctrl_modifier
);
2146 /* Display the help-echo property of the character after the mouse pointer.
2147 Either show it in the echo area, or call show-help-function to display
2148 it by other means (maybe in a tooltip).
2150 If HELP is nil, that means clear the previous help echo.
2152 If HELP is a string, display that string. If HELP is a function,
2153 call it with OBJECT and POS as arguments; the function should
2154 return a help string or nil for none. For all other types of HELP,
2155 evaluate it to obtain a string.
2157 WINDOW is the window in which the help was generated, if any.
2158 It is nil if not in a window.
2160 If OBJECT is a buffer, POS is the position in the buffer where the
2161 `help-echo' text property was found.
2163 If OBJECT is an overlay, that overlay has a `help-echo' property,
2164 and POS is the position in the overlay's buffer under the mouse.
2166 If OBJECT is a string (an overlay string or a string displayed with
2167 the `display' property). POS is the position in that string under
2170 Note: this function may only be called with HELP nil or a string
2171 from X code running asynchronously. */
2174 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2177 if (!NILP (help
) && !STRINGP (help
))
2179 if (FUNCTIONP (help
))
2180 help
= safe_call (4, help
, window
, object
, pos
);
2182 help
= safe_eval (help
);
2184 if (!STRINGP (help
))
2188 if (!noninteractive
&& STRINGP (help
))
2190 /* The mouse-fixup-help-message Lisp function can call
2191 mouse_position_hook, which resets the mouse_moved flags.
2192 This causes trouble if we are trying to read a mouse motion
2193 event (i.e., if we are inside a `track-mouse' form), so we
2194 restore the mouse_moved flag. */
2195 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2196 help
= call1 (Qmouse_fixup_help_message
, help
);
2201 if (STRINGP (help
) || NILP (help
))
2203 if (!NILP (Vshow_help_function
))
2204 call1 (Vshow_help_function
, help
);
2205 help_echo_showing_p
= STRINGP (help
);
2211 /* Input of single characters from keyboard. */
2213 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2214 struct timespec
*end_time
);
2215 static void record_char (Lisp_Object c
);
2217 static Lisp_Object help_form_saved_window_configs
;
2219 read_char_help_form_unwind (void)
2221 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2222 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2223 if (!NILP (window_config
))
2224 Fset_window_configuration (window_config
);
2227 #define STOP_POLLING \
2228 do { if (! polling_stopped_here) stop_polling (); \
2229 polling_stopped_here = 1; } while (0)
2231 #define RESUME_POLLING \
2232 do { if (polling_stopped_here) start_polling (); \
2233 polling_stopped_here = 0; } while (0)
2236 read_event_from_main_queue (struct timespec
*end_time
,
2237 Lisp_Object local_tag
,
2238 bool *used_mouse_menu
)
2240 Lisp_Object c
= Qnil
;
2241 Lisp_Object save_tag
= Qnil
;
2242 sys_jmp_buf
*save_jump
= xmalloc (sizeof *save_jump
);
2243 KBOARD
*kb
IF_LINT (= NULL
);
2247 /* Read from the main queue, and if that gives us something we can't use yet,
2248 we put it on the appropriate side queue and try again. */
2250 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2253 /* Actually read a character, waiting if necessary. */
2255 getctag
= local_tag
;
2257 timer_start_idle ();
2258 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2261 if (! NILP (c
) && (kb
!= current_kboard
))
2263 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2266 while (CONSP (XCDR (last
)))
2268 if (!NILP (XCDR (last
)))
2272 kset_kbd_queue (kb
, list1 (c
));
2274 XSETCDR (last
, list1 (c
));
2275 kb
->kbd_queue_has_data
= 1;
2279 current_kboard
= kb
;
2280 /* This is going to exit from read_char
2281 so we had better get rid of this frame's stuff. */
2282 return make_number (-2);
2285 /* Terminate Emacs in batch mode if at eof. */
2286 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2287 Fkill_emacs (make_number (1));
2291 /* Add in any extra modifiers, where appropriate. */
2292 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2293 || ((extra_keyboard_modifiers
& 0177) < ' '
2294 && (extra_keyboard_modifiers
& 0177) != 0))
2295 XSETINT (c
, make_ctrl_char (XINT (c
)));
2297 /* Transfer any other modifier bits directly from
2298 extra_keyboard_modifiers to c. Ignore the actual character code
2299 in the low 16 bits of extra_keyboard_modifiers. */
2300 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2308 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2311 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2312 Lisp_Object local_getcjmp
,
2313 Lisp_Object prev_event
,
2314 bool *used_mouse_menu
)
2316 #define MAX_ENCODED_BYTES 16
2318 Lisp_Object events
[MAX_ENCODED_BYTES
];
2324 = read_event_from_main_queue (end_time
, local_getcjmp
,
2327 /* w32_console already returns decoded events. It either reads
2328 Unicode characters from the Windows keyboard input, or
2329 converts characters encoded in the current codepage into
2330 Unicode. See w32inevt.c:key_event, near its end. */
2333 struct frame
*frame
= XFRAME (selected_frame
);
2334 struct terminal
*terminal
= frame
->terminal
;
2335 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2336 /* Don't apply decoding if we're just reading a raw event
2337 (e.g. reading bytes sent by the xterm to specify the position
2338 of a mouse click). */
2339 && (!EQ (prev_event
, Qt
))
2340 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2341 & CODING_REQUIRE_DECODING_MASK
)))
2342 return nextevt
; /* No decoding needed. */
2345 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2346 eassert (n
< MAX_ENCODED_BYTES
);
2347 events
[n
++] = nextevt
;
2348 if (NATNUMP (nextevt
)
2349 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2350 { /* An encoded byte sequence, let's try to decode it. */
2351 struct coding_system
*coding
2352 = TERMINAL_KEYBOARD_CODING (terminal
);
2353 unsigned char *src
= alloca (n
);
2355 for (i
= 0; i
< n
; i
++)
2356 src
[i
] = XINT (events
[i
]);
2358 for (i
= 0; i
< n
; i
++)
2360 coding
->destination
= alloca (n
* 4);
2361 coding
->dst_bytes
= n
* 4;
2362 decode_coding_c_string (coding
, src
, n
, Qnil
);
2363 eassert (coding
->produced_char
<= n
);
2364 if (coding
->produced_char
== 0)
2365 { /* The encoded sequence is incomplete. */
2366 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2367 continue; /* Read on! */
2371 const unsigned char *p
= coding
->destination
;
2372 eassert (coding
->carryover_bytes
== 0);
2374 while (n
< coding
->produced_char
)
2375 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2378 /* Now `events' should hold decoded events.
2379 Normally, n should be equal to 1, but better not rely on it.
2380 We can only return one event here, so return the first we
2381 had and keep the others (if any) for later. */
2383 Vunread_command_events
2384 = Fcons (events
[--n
], Vunread_command_events
);
2392 echo_keystrokes_p (void)
2394 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2395 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2398 /* Read a character from the keyboard; call the redisplay if needed. */
2399 /* commandflag 0 means do not autosave, but do redisplay.
2400 -1 means do not redisplay, but do autosave.
2401 -2 means do neither.
2404 /* The argument MAP is a keymap for menu prompting.
2406 PREV_EVENT is the previous input event, or nil if we are reading
2407 the first event of a key sequence (or not reading a key sequence).
2408 If PREV_EVENT is t, that is a "magic" value that says
2409 not to run input methods, but in other respects to act as if
2410 not reading a key sequence.
2412 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2413 if we used a mouse menu to read the input, or false otherwise. If
2414 USED_MOUSE_MENU is null, don't dereference it.
2416 Value is -2 when we find input on another keyboard. A second call
2417 to read_char will read it.
2419 If END_TIME is non-null, it is a pointer to a struct timespec
2420 specifying the maximum time to wait until. If no input arrives by
2421 that time, stop waiting and return nil.
2423 Value is t if we showed a menu and the user rejected it. */
2425 struct read_char_state
2429 Lisp_Object prev_event
;
2430 bool *used_mouse_menu
;
2431 struct timespec
*end_time
;
2434 Lisp_Object local_tag
;
2435 Lisp_Object save_tag
;
2436 Lisp_Object previous_echo_area_message
;
2437 Lisp_Object also_record
;
2439 bool polling_stopped_here
;
2440 struct kboard
*orig_kboard
;
2443 static Lisp_Object
read_char_1 (bool, volatile struct read_char_state
*);
2446 read_char_thunk (void *data
)
2448 return read_char_1 (false, data
);
2452 read_char_handle_quit (void *data
, Lisp_Object k
)
2454 struct read_char_state
*state
= data
;
2455 /* Handle quits while reading the keyboard. */
2456 /* We must have saved the outer value of getcjmp here,
2457 so restore it now. */
2458 getctag
= state
->save_tag
;
2459 XSETINT (state
->c
, quit_char
);
2460 internal_last_event_frame
= selected_frame
;
2461 Vlast_event_frame
= internal_last_event_frame
;
2462 /* If we report the quit char as an event,
2463 don't do so more than once. */
2464 if (!NILP (Vinhibit_quit
))
2468 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2469 if (kb
!= current_kboard
)
2471 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2472 /* We shouldn't get here if we were in single-kboard mode! */
2477 while (CONSP (XCDR (last
)))
2479 if (!NILP (XCDR (last
)))
2483 kset_kbd_queue (kb
, list1 (state
->c
));
2485 XSETCDR (last
, list1 (state
->c
));
2486 kb
->kbd_queue_has_data
= 1;
2487 current_kboard
= kb
;
2488 /* This is going to exit from read_char
2489 so we had better get rid of this frame's stuff. */
2491 return make_number (-2); /* wrong_kboard_jmpbuf */
2494 return read_char_1 (true, state
);
2497 /* {{coccinelle:skip_start}} */
2499 read_char (int commandflag
, Lisp_Object map
,
2500 Lisp_Object prev_event
,
2501 bool *used_mouse_menu
, struct timespec
*end_time
)
2503 struct read_char_state
*state
= xmalloc (sizeof *state
);
2505 state
->commandflag
= commandflag
;
2507 state
->prev_event
= prev_event
;
2508 state
->used_mouse_menu
= used_mouse_menu
;
2509 state
->end_time
= end_time
;
2511 state
->local_tag
= Qnil
;
2512 state
->save_tag
= Qnil
;
2513 state
->previous_echo_area_message
= Qnil
;
2514 state
->also_record
= Qnil
;
2515 state
->reread
= false;
2516 state
->polling_stopped_here
= false;
2517 state
->orig_kboard
= current_kboard
;
2519 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2520 We will do that below, temporarily for short sections of code,
2521 when appropriate. local_getcjmp must be in effect
2522 around any call to sit_for or kbd_buffer_get_event;
2523 it *must not* be in effect when we call redisplay. */
2525 state
->tag
= state
->local_tag
= make_prompt_tag ();
2527 return call_with_prompt (state
->tag
,
2528 make_c_closure (read_char_thunk
, state
, 0, 0),
2529 make_c_closure (read_char_handle_quit
, state
, 1, 0));
2533 read_char_1 (bool jump
, volatile struct read_char_state
*state
)
2535 #define commandflag state->commandflag
2536 #define map state->map
2537 #define prev_event state->prev_event
2538 #define used_mouse_menu state->used_mouse_menu
2539 #define end_time state->end_time
2541 #define jmpcount state->jmpcount
2542 #define local_getcjmp state->local_tag
2543 #define save_jump state->save_tag
2544 #define previous_echo_area_message state->previous_echo_area_message
2545 #define also_record state->also_record
2546 #define reread state->reread
2547 #define polling_stopped_here state->polling_stopped_here
2548 #define orig_kboard state->orig_kboard
2549 #define save_getcjmp(x) (x = getctag)
2550 #define restore_getcjmp(x) (getctag = x)
2551 Lisp_Object tem
, save
;
2558 if (CONSP (Vunread_post_input_method_events
))
2560 c
= XCAR (Vunread_post_input_method_events
);
2561 Vunread_post_input_method_events
2562 = XCDR (Vunread_post_input_method_events
);
2564 /* Undo what read_char_x_menu_prompt did when it unread
2565 additional keys returned by Fx_popup_menu. */
2567 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2578 if (CONSP (Vunread_command_events
))
2580 bool was_disabled
= 0;
2582 c
= XCAR (Vunread_command_events
);
2583 Vunread_command_events
= XCDR (Vunread_command_events
);
2585 /* Undo what sit-for did when it unread additional keys
2586 inside universal-argument. */
2588 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2593 /* Undo what read_char_x_menu_prompt did when it unread
2594 additional keys returned by Fx_popup_menu. */
2596 && EQ (XCDR (c
), Qdisabled
)
2597 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2603 /* If the queued event is something that used the mouse,
2604 set used_mouse_menu accordingly. */
2606 /* Also check was_disabled so last-nonmenu-event won't return
2607 a bad value when submenus are involved. (Bug#447) */
2608 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2609 *used_mouse_menu
= 1;
2611 goto reread_for_input_method
;
2614 if (CONSP (Vunread_input_method_events
))
2616 c
= XCAR (Vunread_input_method_events
);
2617 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2619 /* Undo what read_char_x_menu_prompt did when it unread
2620 additional keys returned by Fx_popup_menu. */
2622 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2626 goto reread_for_input_method
;
2629 this_command_key_count_reset
= 0;
2631 if (!NILP (Vexecuting_kbd_macro
))
2633 /* We set this to Qmacro; since that's not a frame, nobody will
2634 try to switch frames on us, and the selected window will
2637 Since this event came from a macro, it would be misleading to
2638 leave internal_last_event_frame set to wherever the last
2639 real event came from. Normally, a switch-frame event selects
2640 internal_last_event_frame after each command is read, but
2641 events read from a macro should never cause a new frame to be
2643 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2645 /* Exit the macro if we are at the end.
2646 Also, some things replace the macro with t
2647 to force an early exit. */
2648 if (EQ (Vexecuting_kbd_macro
, Qt
)
2649 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2655 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2656 if (STRINGP (Vexecuting_kbd_macro
)
2657 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2658 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2660 executing_kbd_macro_index
++;
2665 if (!NILP (unread_switch_frame
))
2667 c
= unread_switch_frame
;
2668 unread_switch_frame
= Qnil
;
2670 /* This event should make it into this_command_keys, and get echoed
2671 again, so we do not set `reread'. */
2675 /* If redisplay was requested. */
2676 if (commandflag
>= 0)
2678 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2680 /* If there is pending input, process any events which are not
2681 user-visible, such as X selection_request events. */
2683 || detect_input_pending_run_timers (0))
2684 swallow_events (0); /* May clear input_pending. */
2686 /* Redisplay if no pending input. */
2687 while (!input_pending
)
2689 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2690 redisplay_preserve_echo_area (5);
2695 /* Normal case: no input arrived during redisplay. */
2698 /* Input arrived and pre-empted redisplay.
2699 Process any events which are not user-visible. */
2701 /* If that cleared input_pending, try again to redisplay. */
2704 /* Prevent the redisplay we just did
2705 from messing up echoing of the input after the prompt. */
2706 if (commandflag
== 0 && echo_current
)
2707 echo_message_buffer
= echo_area_buffer
[0];
2711 /* Message turns off echoing unless more keystrokes turn it on again.
2713 The code in 20.x for the condition was
2715 1. echo_area_glyphs && *echo_area_glyphs
2716 2. && echo_area_glyphs != current_kboard->echobuf
2717 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2719 (1) means there's a current message displayed
2721 (2) means it's not the message from echoing from the current
2724 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2725 is set to a non-null value. This is done in read_char and it is
2726 set to echo_area_glyphs after a call to echo_char. That means
2727 ok_to_echo_at_next_pause is either null or
2728 current_kboard->echobuf with the appropriate current_kboard at
2731 So, condition (3) means in clear text ok_to_echo_at_next_pause
2732 must be either null, or the current message isn't from echoing at
2733 all, or it's from echoing from a different kboard than the
2736 if (/* There currently is something in the echo area. */
2737 !NILP (echo_area_buffer
[0])
2738 && (/* It's an echo from a different kboard. */
2739 echo_kboard
!= current_kboard
2740 /* Or we explicitly allow overwriting whatever there is. */
2741 || ok_to_echo_at_next_pause
== NULL
))
2746 /* Try reading a character via menu prompting in the minibuf.
2747 Try this before the sit-for, because the sit-for
2748 would do the wrong thing if we are supposed to do
2749 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2750 after a mouse event so don't try a minibuf menu. */
2752 if (KEYMAPP (map
) && INTERACTIVE
2753 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2754 /* Don't bring up a menu if we already have another event. */
2755 && NILP (Vunread_command_events
)
2756 && !detect_input_pending_run_timers (0))
2758 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2760 if (INTEGERP (c
) && XINT (c
) == -2)
2761 return c
; /* wrong_kboard_jmpbuf */
2767 /* Start idle timers if no time limit is supplied. We don't do it
2768 if a time limit is supplied to avoid an infinite recursion in the
2769 situation where an idle timer calls `sit-for'. */
2772 timer_start_idle ();
2774 /* If in middle of key sequence and minibuffer not active,
2775 start echoing if enough time elapses. */
2777 if (minibuf_level
== 0
2779 && !current_kboard
->immediate_echo
2780 && this_command_key_count
> 0
2782 && echo_keystrokes_p ()
2783 && (/* No message. */
2784 NILP (echo_area_buffer
[0])
2785 /* Or empty message. */
2786 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2787 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2788 /* Or already echoing from same kboard. */
2789 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2790 /* Or not echoing before and echoing allowed. */
2791 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2793 /* After a mouse event, start echoing right away.
2794 This is because we are probably about to display a menu,
2795 and we don't want to delay before doing so. */
2796 if (EVENT_HAS_PARAMETERS (prev_event
))
2802 save_getcjmp (save_jump
);
2803 restore_getcjmp (local_getcjmp
);
2804 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2805 restore_getcjmp (save_jump
);
2807 && ! CONSP (Vunread_command_events
))
2812 /* Maybe auto save due to number of keystrokes. */
2814 if (commandflag
!= 0 && commandflag
!= -2
2815 && auto_save_interval
> 0
2816 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2817 && !detect_input_pending_run_timers (0))
2819 Fdo_auto_save (Qnil
, Qnil
);
2820 /* Hooks can actually change some buffers in auto save. */
2824 /* Try reading using an X menu.
2825 This is never confused with reading using the minibuf
2826 because the recursive call of read_char in read_char_minibuf_menu_prompt
2827 does not pass on any keymaps. */
2829 if (KEYMAPP (map
) && INTERACTIVE
2830 && !NILP (prev_event
)
2831 && EVENT_HAS_PARAMETERS (prev_event
)
2832 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2833 && !EQ (XCAR (prev_event
), Qtool_bar
)
2834 /* Don't bring up a menu if we already have another event. */
2835 && NILP (Vunread_command_events
))
2837 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2839 /* Now that we have read an event, Emacs is not idle. */
2846 /* Maybe autosave and/or garbage collect due to idleness. */
2848 if (INTERACTIVE
&& NILP (c
))
2851 ptrdiff_t buffer_size
;
2853 /* Slow down auto saves logarithmically in size of current buffer,
2854 and garbage collect while we're at it. */
2855 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2856 last_non_minibuf_size
= Z
- BEG
;
2857 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2859 while (buffer_size
> 64)
2860 delay_level
++, buffer_size
-= buffer_size
>> 2;
2861 if (delay_level
< 4) delay_level
= 4;
2862 /* delay_level is 4 for files under around 50k, 7 at 100k,
2863 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2865 /* Auto save if enough time goes by without input. */
2866 if (commandflag
!= 0 && commandflag
!= -2
2867 && num_nonmacro_input_events
> last_auto_save
2868 && INTEGERP (Vauto_save_timeout
)
2869 && XINT (Vauto_save_timeout
) > 0)
2872 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2874 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2875 timeout
= delay_level
* timeout
/ 4;
2876 save_getcjmp (save_jump
);
2877 restore_getcjmp (local_getcjmp
);
2878 tem0
= sit_for (make_number (timeout
), 1, 1);
2879 restore_getcjmp (save_jump
);
2882 && ! CONSP (Vunread_command_events
))
2884 Fdo_auto_save (Qnil
, Qnil
);
2889 /* If there is still no input available, ask for GC. */
2890 if (!detect_input_pending_run_timers (0))
2891 GC_collect_a_little ();
2894 /* Notify the caller if an autosave hook, or a timer, sentinel or
2895 filter in the sit_for calls above have changed the current
2896 kboard. This could happen if they use the minibuffer or start a
2897 recursive edit, like the fancy splash screen in server.el's
2898 filter. If this longjmp wasn't here, read_key_sequence would
2899 interpret the next key sequence using the wrong translation
2900 tables and function keymaps. */
2901 if (NILP (c
) && current_kboard
!= orig_kboard
)
2904 return make_number (-2); /* wrong_kboard_jmpbuf */
2907 /* If this has become non-nil here, it has been set by a timer
2908 or sentinel or filter. */
2909 if (CONSP (Vunread_command_events
))
2911 c
= XCAR (Vunread_command_events
);
2912 Vunread_command_events
= XCDR (Vunread_command_events
);
2914 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2920 /* Read something from current KBOARD's side queue, if possible. */
2924 if (current_kboard
->kbd_queue_has_data
)
2926 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2928 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2929 kset_kbd_queue (current_kboard
,
2930 XCDR (KVAR (current_kboard
, kbd_queue
)));
2931 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2932 current_kboard
->kbd_queue_has_data
= 0;
2933 input_pending
= readable_events (0);
2934 if (EVENT_HAS_PARAMETERS (c
)
2935 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2936 internal_last_event_frame
= XCAR (XCDR (c
));
2937 Vlast_event_frame
= internal_last_event_frame
;
2941 /* If current_kboard's side queue is empty check the other kboards.
2942 If one of them has data that we have not yet seen here,
2943 switch to it and process the data waiting for it.
2945 Note: if the events queued up for another kboard
2946 have already been seen here, and therefore are not a complete command,
2947 the kbd_queue_has_data field is 0, so we skip that kboard here.
2948 That's to avoid an infinite loop switching between kboards here. */
2949 if (NILP (c
) && !single_kboard
)
2952 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2953 if (kb
->kbd_queue_has_data
)
2955 current_kboard
= kb
;
2956 /* This is going to exit from read_char
2957 so we had better get rid of this frame's stuff. */
2959 return make_number (-2); /* wrong_kboard_jmpbuf */
2969 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2970 prev_event
, used_mouse_menu
);
2971 if (NILP (c
) && end_time
2972 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2977 if (EQ (c
, make_number (-2)))
2979 /* This is going to exit from read_char
2980 so we had better get rid of this frame's stuff. */
2994 if (commandflag
>= 0
2995 && !input_pending
&& !detect_input_pending_run_timers (0))
3001 /* Buffer switch events are only for internal wakeups
3002 so don't show them to the user.
3003 Also, don't record a key if we already did. */
3007 /* Process special events within read_char
3008 and loop around to read another event. */
3011 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3016 struct buffer
*prev_buffer
= current_buffer
;
3017 last_input_event
= c
;
3018 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3020 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3021 /* We stopped being idle for this event; undo that. This
3022 prevents automatic window selection (under
3023 mouse_autoselect_window from acting as a real input event, for
3024 example banishing the mouse under mouse-avoidance-mode. */
3025 timer_resume_idle ();
3027 if (current_buffer
!= prev_buffer
)
3029 /* The command may have changed the keymaps. Pretend there
3030 is input in another keyboard and return. This will
3031 recalculate keymaps. */
3032 c
= make_number (-2);
3039 /* Handle things that only apply to characters. */
3042 /* If kbd_buffer_get_event gave us an EOF, return that. */
3046 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3047 && UNSIGNED_CMP (XFASTINT (c
), <,
3048 SCHARS (KVAR (current_kboard
,
3049 Vkeyboard_translate_table
))))
3050 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3051 && UNSIGNED_CMP (XFASTINT (c
), <,
3052 ASIZE (KVAR (current_kboard
,
3053 Vkeyboard_translate_table
))))
3054 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3058 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3059 /* nil in keyboard-translate-table means no translation. */
3065 /* If this event is a mouse click in the menu bar,
3066 return just menu-bar for now. Modify the mouse click event
3067 so we won't do this twice, then queue it up. */
3068 if (EVENT_HAS_PARAMETERS (c
)
3070 && CONSP (EVENT_START (c
))
3071 && CONSP (XCDR (EVENT_START (c
))))
3075 posn
= POSN_POSN (EVENT_START (c
));
3076 /* Handle menu-bar events:
3077 insert the dummy prefix event `menu-bar'. */
3078 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3080 /* Change menu-bar to (menu-bar) as the event "position". */
3081 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3084 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3089 /* Store these characters into recent_keys, the dribble file if any,
3090 and the keyboard macro being defined, if any. */
3092 if (! NILP (also_record
))
3093 record_char (also_record
);
3095 /* Wipe the echo area.
3096 But first, if we are about to use an input method,
3097 save the echo area contents for it to refer to. */
3099 && ! NILP (Vinput_method_function
)
3100 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3102 previous_echo_area_message
= Fcurrent_message ();
3103 Vinput_method_previous_message
= previous_echo_area_message
;
3106 /* Now wipe the echo area, except for help events which do their
3107 own stuff with the echo area. */
3109 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3110 && !(EQ (Qswitch_frame
, XCAR (c
)))
3111 /* Don't wipe echo area for select window events: These might
3112 get delayed via `mouse-autoselect-window' (Bug#11304). */
3113 && !(EQ (Qselect_window
, XCAR (c
)))))
3115 if (!NILP (echo_area_buffer
[0]))
3117 safe_run_hooks (Qecho_area_clear_hook
);
3118 clear_message (1, 0);
3122 reread_for_input_method
:
3124 /* Pass this to the input method, if appropriate. */
3126 && ! NILP (Vinput_method_function
)
3127 /* Don't run the input method within a key sequence,
3128 after the first event of the key sequence. */
3129 && NILP (prev_event
)
3130 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3133 ptrdiff_t key_count
;
3134 bool key_count_reset
;
3135 struct gcpro gcpro1
;
3137 /* Save the echo status. */
3138 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3139 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3140 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3141 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3146 if (before_command_restore_flag
)
3148 this_command_key_count
= before_command_key_count_1
;
3149 if (this_command_key_count
< this_single_command_key_start
)
3150 this_single_command_key_start
= this_command_key_count
;
3151 echo_truncate (before_command_echo_length_1
);
3152 before_command_restore_flag
= 0;
3156 /* Save the this_command_keys status. */
3157 key_count
= this_command_key_count
;
3158 key_count_reset
= this_command_key_count_reset
;
3161 keys
= Fcopy_sequence (this_command_keys
);
3166 /* Clear out this_command_keys. */
3167 this_command_key_count
= 0;
3168 this_command_key_count_reset
= 0;
3170 /* Now wipe the echo area. */
3171 if (!NILP (echo_area_buffer
[0]))
3172 safe_run_hooks (Qecho_area_clear_hook
);
3173 clear_message (1, 0);
3176 /* If we are not reading a key sequence,
3177 never use the echo area. */
3180 specbind (Qinput_method_use_echo_area
, Qt
);
3183 /* Call the input method. */
3184 tem
= call1 (Vinput_method_function
, c
);
3188 /* Restore the saved echoing state
3189 and this_command_keys state. */
3190 this_command_key_count
= key_count
;
3191 this_command_key_count_reset
= key_count_reset
;
3193 this_command_keys
= keys
;
3196 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3197 kset_echo_string (current_kboard
, saved_echo_string
);
3198 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3199 if (saved_immediate_echo
)
3204 /* The input method can return no events. */
3207 /* Bring back the previous message, if any. */
3208 if (! NILP (previous_echo_area_message
))
3209 message_with_string ("%s", previous_echo_area_message
, 0);
3212 /* It returned one event or more. */
3214 Vunread_post_input_method_events
3215 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3220 /* Display help if not echoing. */
3221 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3223 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3224 Lisp_Object help
, object
, position
, window
, htem
;
3226 htem
= Fcdr (XCDR (c
));
3229 window
= Fcar (htem
);
3231 object
= Fcar (htem
);
3233 position
= Fcar (htem
);
3235 show_help_echo (help
, window
, object
, position
);
3237 /* We stopped being idle for this event; undo that. */
3239 timer_resume_idle ();
3243 if ((! reread
|| this_command_key_count
== 0
3244 || this_command_key_count_reset
)
3248 /* Don't echo mouse motion events. */
3249 if (echo_keystrokes_p ()
3250 && ! (EVENT_HAS_PARAMETERS (c
)
3251 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3254 if (! NILP (also_record
))
3255 echo_char (also_record
);
3256 /* Once we reread a character, echoing can happen
3257 the next time we pause to read a new one. */
3258 ok_to_echo_at_next_pause
= current_kboard
;
3261 /* Record this character as part of the current key. */
3262 add_command_key (c
);
3263 if (! NILP (also_record
))
3264 add_command_key (also_record
);
3267 last_input_event
= c
;
3270 /* Process the help character specially if enabled. */
3271 if (!NILP (Vhelp_form
) && help_char_p (c
))
3275 help_form_saved_window_configs
3276 = Fcons (Fcurrent_window_configuration (Qnil
),
3277 help_form_saved_window_configs
);
3278 record_unwind_protect_void (read_char_help_form_unwind
);
3279 call0 (Qhelp_form_show
);
3284 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3285 if (EVENT_HAS_PARAMETERS (c
)
3286 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3287 XSETCAR (help_form_saved_window_configs
, Qnil
);
3289 while (BUFFERP (c
));
3290 /* Remove the help from the frame. */
3294 if (EQ (c
, make_number (040)))
3298 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3299 while (BUFFERP (c
));
3309 #undef used_mouse_menu
3313 #undef local_getcjmp
3315 #undef previous_echo_area_message
3318 #undef polling_stopped_here
3321 #undef restore_getcjmp
3323 /* {{coccinelle:skip_end}} */
3325 /* Record a key that came from a mouse menu.
3326 Record it for echoing, for this-command-keys, and so on. */
3329 record_menu_key (Lisp_Object c
)
3331 /* Wipe the echo area. */
3332 clear_message (1, 0);
3337 before_command_key_count
= this_command_key_count
;
3338 before_command_echo_length
= echo_length ();
3341 /* Don't echo mouse motion events. */
3342 if (echo_keystrokes_p ())
3346 /* Once we reread a character, echoing can happen
3347 the next time we pause to read a new one. */
3348 ok_to_echo_at_next_pause
= 0;
3351 /* Record this character as part of the current key. */
3352 add_command_key (c
);
3354 /* Re-reading in the middle of a command. */
3355 last_input_event
= c
;
3359 /* Return true if should recognize C as "the help character". */
3362 help_char_p (Lisp_Object c
)
3366 if (EQ (c
, Vhelp_char
))
3368 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3369 if (EQ (c
, XCAR (tail
)))
3374 /* Record the input event C in various ways. */
3377 record_char (Lisp_Object c
)
3381 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3383 /* To avoid filling recent_keys with help-echo and mouse-movement
3384 events, we filter out repeated help-echo events, only store the
3385 first and last in a series of mouse-movement events, and don't
3386 store repeated help-echo events which are only separated by
3387 mouse-movement events. */
3389 Lisp_Object ev1
, ev2
, ev3
;
3392 if ((ix1
= recent_keys_index
- 1) < 0)
3393 ix1
= NUM_RECENT_KEYS
- 1;
3394 ev1
= AREF (recent_keys
, ix1
);
3396 if ((ix2
= ix1
- 1) < 0)
3397 ix2
= NUM_RECENT_KEYS
- 1;
3398 ev2
= AREF (recent_keys
, ix2
);
3400 if ((ix3
= ix2
- 1) < 0)
3401 ix3
= NUM_RECENT_KEYS
- 1;
3402 ev3
= AREF (recent_keys
, ix3
);
3404 if (EQ (XCAR (c
), Qhelp_echo
))
3406 /* Don't record `help-echo' in recent_keys unless it shows some help
3407 message, and a different help than the previously recorded
3409 Lisp_Object help
, last_help
;
3411 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3412 if (!STRINGP (help
))
3414 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3415 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3417 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3418 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3419 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3421 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3422 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3423 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3424 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3427 else if (EQ (XCAR (c
), Qmouse_movement
))
3429 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3430 So additional mouse movement events replace the last element. */
3431 Lisp_Object last_window
, window
;
3433 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3434 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3435 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3436 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3437 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3439 ASET (recent_keys
, ix1
, c
);
3445 store_kbd_macro_char (c
);
3449 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3450 ASET (recent_keys
, recent_keys_index
, c
);
3451 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3452 recent_keys_index
= 0;
3454 else if (recorded
< 0)
3456 /* We need to remove one or two events from recent_keys.
3457 To do this, we simply put nil at those events and move the
3458 recent_keys_index backwards over those events. Usually,
3459 users will never see those nil events, as they will be
3460 overwritten by the command keys entered to see recent_keys
3463 while (recorded
++ < 0 && total_keys
> 0)
3465 if (total_keys
< NUM_RECENT_KEYS
)
3467 if (--recent_keys_index
< 0)
3468 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3469 ASET (recent_keys
, recent_keys_index
, Qnil
);
3473 num_nonmacro_input_events
++;
3475 /* Write c to the dribble file. If c is a lispy event, write
3476 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3477 If you, dear reader, have a better idea, you've got the source. :-) */
3483 if (XUINT (c
) < 0x100)
3484 putc (XUINT (c
), dribble
);
3486 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3490 Lisp_Object dribblee
;
3492 /* If it's a structured event, take the event header. */
3493 dribblee
= EVENT_HEAD (c
);
3495 if (SYMBOLP (dribblee
))
3497 putc ('<', dribble
);
3498 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3499 SBYTES (SYMBOL_NAME (dribblee
)),
3501 putc ('>', dribble
);
3510 /* Low level keyboard/mouse input.
3511 kbd_buffer_store_event places events in kbd_buffer, and
3512 kbd_buffer_get_event retrieves them. */
3514 /* Return true if there are any events in the queue that read-char
3515 would return. If this returns false, a read-char would block. */
3517 readable_events (int flags
)
3519 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3522 /* If the buffer contains only FOCUS_IN_EVENT events, and
3523 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3524 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3526 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3527 #ifdef USE_TOOLKIT_SCROLL_BARS
3528 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3532 struct input_event
*event
;
3534 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3541 #ifdef USE_TOOLKIT_SCROLL_BARS
3542 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3544 event
->kind
== FOCUS_IN_EVENT
)
3545 #ifdef USE_TOOLKIT_SCROLL_BARS
3546 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3547 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3548 && event
->part
== scroll_bar_handle
3549 && event
->modifiers
== 0)
3554 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3557 while (event
!= kbd_store_ptr
);
3563 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3564 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3568 if (current_kboard
->kbd_queue_has_data
)
3574 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3575 if (kb
->kbd_queue_has_data
)
3581 /* Set this for debugging, to have a way to get out */
3582 int stop_character EXTERNALLY_VISIBLE
;
3585 event_to_kboard (struct input_event
*event
)
3587 /* Not applicable for these special events. */
3588 if (event
->kind
== SELECTION_REQUEST_EVENT
3589 || event
->kind
== SELECTION_CLEAR_EVENT
)
3593 Lisp_Object obj
= event
->frame_or_window
;
3594 /* There are some events that set this field to nil or string. */
3596 obj
= WINDOW_FRAME (XWINDOW (obj
));
3597 /* Also ignore dead frames here. */
3598 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3599 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3604 /* Return the number of slots occupied in kbd_buffer. */
3607 kbd_buffer_nr_stored (void)
3609 return kbd_fetch_ptr
== kbd_store_ptr
3611 : (kbd_fetch_ptr
< kbd_store_ptr
3612 ? kbd_store_ptr
- kbd_fetch_ptr
3613 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3614 + (kbd_store_ptr
- kbd_buffer
)));
3616 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3619 kbd_buffer_store_event (register struct input_event
*event
)
3621 kbd_buffer_store_event_hold (event
, 0);
3624 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3626 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3627 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3628 Else, if EVENT is a quit event, store the quit event
3629 in HOLD_QUIT, and return (thus ignoring further events).
3631 This is used to postpone the processing of the quit event until all
3632 subsequent input events have been parsed (and discarded). */
3635 kbd_buffer_store_event_hold (register struct input_event
*event
,
3636 struct input_event
*hold_quit
)
3638 if (event
->kind
== NO_EVENT
)
3641 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3644 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3646 register int c
= event
->code
& 0377;
3648 if (event
->modifiers
& ctrl_modifier
)
3649 c
= make_ctrl_char (c
);
3651 c
|= (event
->modifiers
3652 & (meta_modifier
| alt_modifier
3653 | hyper_modifier
| super_modifier
));
3657 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3658 struct input_event
*sp
;
3660 if (single_kboard
&& kb
!= current_kboard
)
3663 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3665 kb
->kbd_queue_has_data
= 1;
3666 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3668 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3671 if (event_to_kboard (sp
) == kb
)
3673 sp
->kind
= NO_EVENT
;
3674 sp
->frame_or_window
= Qnil
;
3683 *hold_quit
= *event
;
3687 /* If this results in a quit_char being returned to Emacs as
3688 input, set Vlast_event_frame properly. If this doesn't
3689 get returned to Emacs as an event, the next event read
3690 will set Vlast_event_frame again, so this is safe to do. */
3694 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3696 focus
= event
->frame_or_window
;
3697 internal_last_event_frame
= focus
;
3698 Vlast_event_frame
= focus
;
3701 handle_interrupt (0);
3705 if (c
&& c
== stop_character
)
3711 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3712 Just ignore the second one. */
3713 else if (event
->kind
== BUFFER_SWITCH_EVENT
3714 && kbd_fetch_ptr
!= kbd_store_ptr
3715 && ((kbd_store_ptr
== kbd_buffer
3716 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3717 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3720 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3721 kbd_store_ptr
= kbd_buffer
;
3723 /* Don't let the very last slot in the buffer become full,
3724 since that would make the two pointers equal,
3725 and that is indistinguishable from an empty buffer.
3726 Discard the event if it would fill the last slot. */
3727 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3729 *kbd_store_ptr
= *event
;
3732 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3733 && ! kbd_on_hold_p ())
3735 /* Don't read keyboard input until we have processed kbd_buffer.
3736 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3737 hold_keyboard_input ();
3738 if (!noninteractive
)
3742 #endif /* subprocesses */
3745 /* If we're inside while-no-input, and this event qualifies
3746 as input, set quit-flag to cause an interrupt. */
3747 if (!NILP (Vthrow_on_input
)
3748 && event
->kind
!= FOCUS_IN_EVENT
3749 && event
->kind
!= HELP_EVENT
3750 && event
->kind
!= DEICONIFY_EVENT
)
3752 Vquit_flag
= Vthrow_on_input
;
3753 /* If we're inside a function that wants immediate quits,
3755 if (immediate_quit
&& NILP (Vinhibit_quit
))
3764 /* Put an input event back in the head of the event queue. */
3767 kbd_buffer_unget_event (register struct input_event
*event
)
3769 if (kbd_fetch_ptr
== kbd_buffer
)
3770 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3772 /* Don't let the very last slot in the buffer become full, */
3773 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3776 *kbd_fetch_ptr
= *event
;
3781 /* Generate a HELP_EVENT input_event and store it in the keyboard
3784 HELP is the help form.
3786 FRAME and WINDOW are the frame and window where the help is
3787 generated. OBJECT is the Lisp object where the help was found (a
3788 buffer, a string, an overlay, or nil if neither from a string nor
3789 from a buffer). POS is the position within OBJECT where the help
3793 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3794 Lisp_Object object
, ptrdiff_t pos
)
3796 struct input_event event
;
3800 event
.kind
= HELP_EVENT
;
3801 event
.frame_or_window
= frame
;
3803 event
.x
= WINDOWP (window
) ? window
: frame
;
3806 kbd_buffer_store_event (&event
);
3810 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3813 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3815 struct input_event event
;
3817 event
.kind
= HELP_EVENT
;
3818 event
.frame_or_window
= frame
;
3823 kbd_buffer_store_event (&event
);
3827 /* Discard any mouse events in the event buffer by setting them to
3830 discard_mouse_events (void)
3832 struct input_event
*sp
;
3833 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3835 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3838 if (sp
->kind
== MOUSE_CLICK_EVENT
3839 || sp
->kind
== WHEEL_EVENT
3840 || sp
->kind
== HORIZ_WHEEL_EVENT
3842 || sp
->kind
== GPM_CLICK_EVENT
3844 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3846 sp
->kind
= NO_EVENT
;
3852 /* Return true if there are any real events waiting in the event
3853 buffer, not counting `NO_EVENT's.
3855 Discard NO_EVENT events at the front of the input queue, possibly
3856 leaving the input queue empty if there are no real input events. */
3859 kbd_buffer_events_waiting (void)
3861 struct input_event
*sp
;
3863 for (sp
= kbd_fetch_ptr
;
3864 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3867 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3872 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3876 /* Clear input event EVENT. */
3879 clear_event (struct input_event
*event
)
3881 event
->kind
= NO_EVENT
;
3885 /* Read one event from the event buffer, waiting if necessary.
3886 The value is a Lisp object representing the event.
3887 The value is nil for an event that should be ignored,
3888 or that was handled here.
3889 We always read and discard one event. */
3892 kbd_buffer_get_event (KBOARD
**kbp
,
3893 bool *used_mouse_menu
,
3894 struct timespec
*end_time
)
3899 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3901 /* Start reading input again because we have processed enough to
3902 be able to accept new events again. */
3903 unhold_keyboard_input ();
3906 #endif /* subprocesses */
3908 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3910 /* In case we are running as a daemon, only do this before
3911 detaching from the terminal. */
3912 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3916 *kbp
= current_kboard
;
3919 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3921 /* Wait until there is input available. */
3924 /* Break loop if there's an unread command event. Needed in
3925 moused window autoselection which uses a timer to insert such
3927 if (CONSP (Vunread_command_events
))
3930 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3932 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3935 /* If the quit flag is set, then read_char will return
3936 quit_char, so that counts as "available input." */
3937 if (!NILP (Vquit_flag
))
3938 quit_throw_to_read_char (0);
3940 /* One way or another, wait until input is available; then, if
3941 interrupt handlers have not read it, read it now. */
3946 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3948 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3952 struct timespec now
= current_timespec ();
3953 if (timespec_cmp (*end_time
, now
) <= 0)
3954 return Qnil
; /* Finished waiting. */
3957 struct timespec duration
= timespec_sub (*end_time
, now
);
3958 wait_reading_process_output (min (duration
.tv_sec
,
3961 -1, 1, Qnil
, NULL
, 0);
3966 bool do_display
= true;
3968 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3970 struct tty_display_info
*tty
= CURTTY ();
3972 /* When this TTY is displaying a menu, we must prevent
3973 any redisplay, because we modify the frame's glyph
3974 matrix behind the back of the display engine. */
3975 if (tty
->showing_menu
)
3979 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3982 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3986 if (CONSP (Vunread_command_events
))
3989 first
= XCAR (Vunread_command_events
);
3990 Vunread_command_events
= XCDR (Vunread_command_events
);
3991 *kbp
= current_kboard
;
3995 /* At this point, we know that there is a readable event available
3996 somewhere. If the event queue is empty, then there must be a
3997 mouse movement enabled and available. */
3998 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4000 struct input_event
*event
;
4002 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4006 *kbp
= event_to_kboard (event
);
4008 *kbp
= current_kboard
; /* Better than returning null ptr? */
4012 /* These two kinds of events get special handling
4013 and don't actually appear to the command loop.
4014 We return nil for them. */
4015 if (event
->kind
== SELECTION_REQUEST_EVENT
4016 || event
->kind
== SELECTION_CLEAR_EVENT
)
4019 struct input_event copy
;
4021 /* Remove it from the buffer before processing it,
4022 since otherwise swallow_events will see it
4023 and process it again. */
4025 kbd_fetch_ptr
= event
+ 1;
4026 input_pending
= readable_events (0);
4027 x_handle_selection_event (©
);
4029 /* We're getting selection request events, but we don't have
4035 #if defined (HAVE_NS)
4036 else if (event
->kind
== NS_TEXT_EVENT
)
4038 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4039 obj
= list1 (intern ("ns-put-working-text"));
4041 obj
= list1 (intern ("ns-unput-working-text"));
4042 kbd_fetch_ptr
= event
+ 1;
4043 if (used_mouse_menu
)
4044 *used_mouse_menu
= 1;
4048 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4049 || defined (HAVE_NS)
4050 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4052 /* Make an event (delete-frame (FRAME)). */
4053 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4054 kbd_fetch_ptr
= event
+ 1;
4057 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4058 || defined (HAVE_NS)
4059 else if (event
->kind
== ICONIFY_EVENT
)
4061 /* Make an event (iconify-frame (FRAME)). */
4062 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4063 kbd_fetch_ptr
= event
+ 1;
4065 else if (event
->kind
== DEICONIFY_EVENT
)
4067 /* Make an event (make-frame-visible (FRAME)). */
4068 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4069 kbd_fetch_ptr
= event
+ 1;
4072 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4074 /* The value doesn't matter here; only the type is tested. */
4075 XSETBUFFER (obj
, current_buffer
);
4076 kbd_fetch_ptr
= event
+ 1;
4078 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4079 || defined (HAVE_NS) || defined (USE_GTK)
4080 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4082 kbd_fetch_ptr
= event
+ 1;
4083 input_pending
= readable_events (0);
4084 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4085 x_activate_menubar (XFRAME (event
->frame_or_window
));
4089 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4091 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4092 obj
= list4 (Qlanguage_change
,
4093 event
->frame_or_window
,
4094 make_number (event
->code
),
4095 make_number (event
->modifiers
));
4096 kbd_fetch_ptr
= event
+ 1;
4099 #ifdef USE_FILE_NOTIFY
4100 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4102 #ifdef HAVE_W32NOTIFY
4103 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4104 obj
= list3 (Qfile_notify
,
4105 list3 (make_number (event
->code
),
4108 event
->frame_or_window
);
4110 obj
= make_lispy_event (event
);
4112 kbd_fetch_ptr
= event
+ 1;
4114 #endif /* USE_FILE_NOTIFY */
4115 else if (event
->kind
== SAVE_SESSION_EVENT
)
4117 obj
= list2 (Qsave_session
, event
->arg
);
4118 kbd_fetch_ptr
= event
+ 1;
4120 /* Just discard these, by returning nil.
4121 With MULTI_KBOARD, these events are used as placeholders
4122 when we need to randomly delete events from the queue.
4123 (They shouldn't otherwise be found in the buffer,
4124 but on some machines it appears they do show up
4125 even without MULTI_KBOARD.) */
4126 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4127 mouse events during a popup-menu call. */
4128 else if (event
->kind
== NO_EVENT
)
4129 kbd_fetch_ptr
= event
+ 1;
4130 else if (event
->kind
== HELP_EVENT
)
4132 Lisp_Object object
, position
, help
, frame
, window
;
4134 frame
= event
->frame_or_window
;
4135 object
= event
->arg
;
4136 position
= make_number (event
->code
);
4139 clear_event (event
);
4141 kbd_fetch_ptr
= event
+ 1;
4142 if (!WINDOWP (window
))
4144 obj
= Fcons (Qhelp_echo
,
4145 list5 (frame
, help
, window
, object
, position
));
4147 else if (event
->kind
== FOCUS_IN_EVENT
)
4149 /* Notification of a FocusIn event. The frame receiving the
4150 focus is in event->frame_or_window. Generate a
4151 switch-frame event if necessary. */
4152 Lisp_Object frame
, focus
;
4154 frame
= event
->frame_or_window
;
4155 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4164 !EQ (frame
, internal_last_event_frame
)
4165 && !EQ (frame
, selected_frame
))
4166 obj
= make_lispy_switch_frame (frame
);
4168 obj
= make_lispy_focus_in (frame
);
4170 internal_last_event_frame
= frame
;
4171 kbd_fetch_ptr
= event
+ 1;
4173 else if (event
->kind
== FOCUS_OUT_EVENT
)
4175 #ifdef HAVE_WINDOW_SYSTEM
4178 Lisp_Object frame
= event
->frame_or_window
;
4179 bool focused
= false;
4181 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4182 focused
= di
->x_highlight_frame
!= 0;
4185 obj
= make_lispy_focus_out (frame
);
4187 #endif /* HAVE_WINDOW_SYSTEM */
4189 kbd_fetch_ptr
= event
+ 1;
4192 else if (event
->kind
== DBUS_EVENT
)
4194 obj
= make_lispy_event (event
);
4195 kbd_fetch_ptr
= event
+ 1;
4198 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4200 obj
= make_lispy_event (event
);
4201 kbd_fetch_ptr
= event
+ 1;
4205 /* If this event is on a different frame, return a switch-frame this
4206 time, and leave the event in the queue for next time. */
4210 frame
= event
->frame_or_window
;
4212 frame
= XCAR (frame
);
4213 else if (WINDOWP (frame
))
4214 frame
= WINDOW_FRAME (XWINDOW (frame
));
4216 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4220 if (! EQ (frame
, internal_last_event_frame
)
4221 && !EQ (frame
, selected_frame
))
4222 obj
= make_lispy_switch_frame (frame
);
4223 internal_last_event_frame
= frame
;
4225 /* If we didn't decide to make a switch-frame event, go ahead
4226 and build a real event from the queue entry. */
4230 obj
= make_lispy_event (event
);
4232 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4233 || defined (HAVE_NS) || defined (USE_GTK)
4234 /* If this was a menu selection, then set the flag to inhibit
4235 writing to last_nonmenu_event. Don't do this if the event
4236 we're returning is (menu-bar), though; that indicates the
4237 beginning of the menu sequence, and we might as well leave
4238 that as the `event with parameters' for this selection. */
4240 && !EQ (event
->frame_or_window
, event
->arg
)
4241 && (event
->kind
== MENU_BAR_EVENT
4242 || event
->kind
== TOOL_BAR_EVENT
))
4243 *used_mouse_menu
= 1;
4246 /* Certain system events are non-key events. */
4248 && event
->kind
== NS_NONKEY_EVENT
)
4249 *used_mouse_menu
= 1;
4252 /* Wipe out this event, to catch bugs. */
4253 clear_event (event
);
4254 kbd_fetch_ptr
= event
+ 1;
4258 /* Try generating a mouse motion event. */
4259 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4261 struct frame
*f
= some_mouse_moved ();
4262 Lisp_Object bar_window
;
4263 enum scroll_bar_part part
;
4267 *kbp
= current_kboard
;
4268 /* Note that this uses F to determine which terminal to look at.
4269 If there is no valid info, it does not store anything
4270 so x remains nil. */
4273 /* XXX Can f or mouse_position_hook be NULL here? */
4274 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4275 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4280 /* Decide if we should generate a switch-frame event. Don't
4281 generate switch-frame events for motion outside of all Emacs
4287 frame
= FRAME_FOCUS_FRAME (f
);
4289 XSETFRAME (frame
, f
);
4291 if (! EQ (frame
, internal_last_event_frame
)
4292 && !EQ (frame
, selected_frame
))
4293 obj
= make_lispy_switch_frame (frame
);
4294 internal_last_event_frame
= frame
;
4297 /* If we didn't decide to make a switch-frame event, go ahead and
4298 return a mouse-motion event. */
4299 if (!NILP (x
) && NILP (obj
))
4300 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4303 /* We were promised by the above while loop that there was
4304 something for us to read! */
4307 input_pending
= readable_events (0);
4309 Vlast_event_frame
= internal_last_event_frame
;
4314 /* Process any non-user-visible events (currently X selection events),
4315 without reading any user-visible events. */
4318 process_special_events (void)
4320 struct input_event
*event
;
4322 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4324 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4327 if (event
== kbd_store_ptr
)
4331 /* If we find a stored X selection request, handle it now. */
4332 if (event
->kind
== SELECTION_REQUEST_EVENT
4333 || event
->kind
== SELECTION_CLEAR_EVENT
)
4337 /* Remove the event from the fifo buffer before processing;
4338 otherwise swallow_events called recursively could see it
4339 and process it again. To do this, we move the events
4340 between kbd_fetch_ptr and EVENT one slot to the right,
4343 struct input_event copy
= *event
;
4344 struct input_event
*beg
4345 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4346 ? kbd_buffer
: kbd_fetch_ptr
;
4349 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4350 else if (event
< beg
)
4352 if (event
> kbd_buffer
)
4353 memmove (kbd_buffer
+ 1, kbd_buffer
,
4354 (event
- kbd_buffer
) * sizeof (struct input_event
));
4355 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4356 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4357 memmove (beg
+ 1, beg
,
4358 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4359 * sizeof (struct input_event
));
4362 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4363 kbd_fetch_ptr
= kbd_buffer
+ 1;
4367 input_pending
= readable_events (0);
4368 x_handle_selection_event (©
);
4370 /* We're getting selection request events, but we don't have
4378 /* Process any events that are not user-visible, run timer events that
4379 are ripe, and return, without reading any user-visible events. */
4382 swallow_events (bool do_display
)
4384 unsigned old_timers_run
;
4386 process_special_events ();
4388 old_timers_run
= timers_run
;
4389 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4391 if (timers_run
!= old_timers_run
&& do_display
)
4392 redisplay_preserve_echo_area (7);
4395 /* Record the start of when Emacs is idle,
4396 for the sake of running idle-time timers. */
4399 timer_start_idle (void)
4401 /* If we are already in the idle state, do nothing. */
4402 if (timespec_valid_p (timer_idleness_start_time
))
4405 timer_idleness_start_time
= current_timespec ();
4406 timer_last_idleness_start_time
= timer_idleness_start_time
;
4408 /* Mark all idle-time timers as once again candidates for running. */
4409 call0 (intern ("internal-timer-start-idle"));
4412 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4415 timer_stop_idle (void)
4417 timer_idleness_start_time
= invalid_timespec ();
4420 /* Resume idle timer from last idle start time. */
4423 timer_resume_idle (void)
4425 if (timespec_valid_p (timer_idleness_start_time
))
4428 timer_idleness_start_time
= timer_last_idleness_start_time
;
4431 /* This is only for debugging. */
4432 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4434 /* List of elisp functions to call, delayed because they were generated in
4435 a context where Elisp could not be safely run (e.g. redisplay, signal,
4436 ...). Each element has the form (FUN . ARGS). */
4437 Lisp_Object pending_funcalls
;
4439 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4441 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4443 Lisp_Object
*vector
;
4445 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4447 vector
= XVECTOR (timer
)->contents
;
4448 if (! NILP (vector
[0]))
4451 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4456 /* Check whether a timer has fired. To prevent larger problems we simply
4457 disregard elements that are not proper timers. Do not make a circular
4458 timer list for the time being.
4460 Returns the time to wait until the next timer fires. If a
4461 timer is triggering now, return zero.
4462 If no timer is active, return -1.
4464 If a timer is ripe, we run it, with quitting turned off.
4465 In that case we return 0 to indicate that a new timer_check_2 call
4468 static struct timespec
4469 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4471 struct timespec nexttime
;
4472 struct timespec now
;
4473 struct timespec idleness_now
;
4474 Lisp_Object chosen_timer
;
4475 struct gcpro gcpro1
;
4477 nexttime
= invalid_timespec ();
4479 chosen_timer
= Qnil
;
4480 GCPRO1 (chosen_timer
);
4482 /* First run the code that was delayed. */
4483 while (CONSP (pending_funcalls
))
4485 Lisp_Object funcall
= XCAR (pending_funcalls
);
4486 pending_funcalls
= XCDR (pending_funcalls
);
4487 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4490 if (CONSP (timers
) || CONSP (idle_timers
))
4492 now
= current_timespec ();
4493 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4494 ? timespec_sub (now
, timer_idleness_start_time
)
4495 : make_timespec (0, 0));
4498 while (CONSP (timers
) || CONSP (idle_timers
))
4500 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4501 struct timespec timer_time
, idle_timer_time
;
4502 struct timespec difference
;
4503 struct timespec timer_difference
= invalid_timespec ();
4504 struct timespec idle_timer_difference
= invalid_timespec ();
4505 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4507 /* Set TIMER and TIMER_DIFFERENCE
4508 based on the next ordinary timer.
4509 TIMER_DIFFERENCE is the distance in time from NOW to when
4510 this timer becomes ripe (negative if it's already ripe).
4511 Skip past invalid timers and timers already handled. */
4514 timer
= XCAR (timers
);
4515 if (! decode_timer (timer
, &timer_time
))
4517 timers
= XCDR (timers
);
4521 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4522 timer_difference
= (timer_ripe
4523 ? timespec_sub (now
, timer_time
)
4524 : timespec_sub (timer_time
, now
));
4527 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4528 based on the next idle timer. */
4529 if (CONSP (idle_timers
))
4531 idle_timer
= XCAR (idle_timers
);
4532 if (! decode_timer (idle_timer
, &idle_timer_time
))
4534 idle_timers
= XCDR (idle_timers
);
4538 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4539 idle_timer_difference
4541 ? timespec_sub (idleness_now
, idle_timer_time
)
4542 : timespec_sub (idle_timer_time
, idleness_now
));
4545 /* Decide which timer is the next timer,
4546 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4547 Also step down the list where we found that timer. */
4549 if (timespec_valid_p (timer_difference
)
4550 && (! timespec_valid_p (idle_timer_difference
)
4551 || idle_timer_ripe
< timer_ripe
4552 || (idle_timer_ripe
== timer_ripe
4554 ? timespec_cmp (idle_timer_difference
,
4556 : timespec_cmp (timer_difference
,
4557 idle_timer_difference
))
4560 chosen_timer
= timer
;
4561 timers
= XCDR (timers
);
4562 difference
= timer_difference
;
4567 chosen_timer
= idle_timer
;
4568 idle_timers
= XCDR (idle_timers
);
4569 difference
= idle_timer_difference
;
4570 ripe
= idle_timer_ripe
;
4573 /* If timer is ripe, run it if it hasn't been run. */
4576 if (NILP (AREF (chosen_timer
, 0)))
4579 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4581 /* Mark the timer as triggered to prevent problems if the lisp
4582 code fails to reschedule it right. */
4583 ASET (chosen_timer
, 0, Qt
);
4585 specbind (Qinhibit_quit
, Qt
);
4587 call1 (Qtimer_event_handler
, chosen_timer
);
4588 Vdeactivate_mark
= old_deactivate_mark
;
4592 /* Since we have handled the event,
4593 we don't need to tell the caller to wake up and do it. */
4594 /* But the caller must still wait for the next timer, so
4595 return 0 to indicate that. */
4598 nexttime
= make_timespec (0, 0);
4602 /* When we encounter a timer that is still waiting,
4603 return the amount of time to wait before it is ripe. */
4610 /* No timers are pending in the future. */
4611 /* Return 0 if we generated an event, and -1 if not. */
4617 /* Check whether a timer has fired. To prevent larger problems we simply
4618 disregard elements that are not proper timers. Do not make a circular
4619 timer list for the time being.
4621 Returns the time to wait until the next timer fires.
4622 If no timer is active, return an invalid value.
4624 As long as any timer is ripe, we run it. */
4629 struct timespec nexttime
;
4630 Lisp_Object timers
, idle_timers
;
4631 struct gcpro gcpro1
, gcpro2
;
4633 Lisp_Object tem
= Vinhibit_quit
;
4636 /* We use copies of the timers' lists to allow a timer to add itself
4637 again, without locking up Emacs if the newly added timer is
4638 already ripe when added. */
4640 /* Always consider the ordinary timers. */
4641 timers
= Fcopy_sequence (Vtimer_list
);
4642 /* Consider the idle timers only if Emacs is idle. */
4643 if (timespec_valid_p (timer_idleness_start_time
))
4644 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4648 Vinhibit_quit
= tem
;
4650 GCPRO2 (timers
, idle_timers
);
4654 nexttime
= timer_check_2 (timers
, idle_timers
);
4656 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4662 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4663 doc
: /* Return the current length of Emacs idleness, or nil.
4664 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4665 in the same style as (current-time).
4667 The value when Emacs is not idle is nil.
4669 PSEC is a multiple of the system clock resolution. */)
4672 if (timespec_valid_p (timer_idleness_start_time
))
4673 return make_lisp_time (timespec_sub (current_timespec (),
4674 timer_idleness_start_time
));
4679 /* Caches for modify_event_symbol. */
4680 static Lisp_Object accent_key_syms
;
4681 static Lisp_Object func_key_syms
;
4682 static Lisp_Object mouse_syms
;
4683 static Lisp_Object wheel_syms
;
4684 static Lisp_Object drag_n_drop_syms
;
4686 /* This is a list of keysym codes for special "accent" characters.
4687 It parallels lispy_accent_keys. */
4689 static const int lispy_accent_codes
[] =
4691 #ifdef XK_dead_circumflex
4696 #ifdef XK_dead_grave
4701 #ifdef XK_dead_tilde
4706 #ifdef XK_dead_diaeresis
4711 #ifdef XK_dead_macron
4716 #ifdef XK_dead_degree
4721 #ifdef XK_dead_acute
4726 #ifdef XK_dead_cedilla
4731 #ifdef XK_dead_breve
4736 #ifdef XK_dead_ogonek
4741 #ifdef XK_dead_caron
4746 #ifdef XK_dead_doubleacute
4747 XK_dead_doubleacute
,
4751 #ifdef XK_dead_abovedot
4756 #ifdef XK_dead_abovering
4766 #ifdef XK_dead_belowdot
4771 #ifdef XK_dead_voiced_sound
4772 XK_dead_voiced_sound
,
4776 #ifdef XK_dead_semivoiced_sound
4777 XK_dead_semivoiced_sound
,
4793 /* This is a list of Lisp names for special "accent" characters.
4794 It parallels lispy_accent_codes. */
4796 static const char *const lispy_accent_keys
[] =
4814 "dead-voiced-sound",
4815 "dead-semivoiced-sound",
4821 #define FUNCTION_KEY_OFFSET 0x0
4823 const char *const lispy_function_keys
[] =
4827 0, /* VK_LBUTTON 0x01 */
4828 0, /* VK_RBUTTON 0x02 */
4829 "cancel", /* VK_CANCEL 0x03 */
4830 0, /* VK_MBUTTON 0x04 */
4832 0, 0, 0, /* 0x05 .. 0x07 */
4834 "backspace", /* VK_BACK 0x08 */
4835 "tab", /* VK_TAB 0x09 */
4837 0, 0, /* 0x0A .. 0x0B */
4839 "clear", /* VK_CLEAR 0x0C */
4840 "return", /* VK_RETURN 0x0D */
4842 0, 0, /* 0x0E .. 0x0F */
4844 0, /* VK_SHIFT 0x10 */
4845 0, /* VK_CONTROL 0x11 */
4846 0, /* VK_MENU 0x12 */
4847 "pause", /* VK_PAUSE 0x13 */
4848 "capslock", /* VK_CAPITAL 0x14 */
4849 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4851 "junja", /* VK_JUNJA 0x17 */
4852 "final", /* VK_FINAL 0x18 */
4853 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4855 "escape", /* VK_ESCAPE 0x1B */
4856 "convert", /* VK_CONVERT 0x1C */
4857 "non-convert", /* VK_NONCONVERT 0x1D */
4858 "accept", /* VK_ACCEPT 0x1E */
4859 "mode-change", /* VK_MODECHANGE 0x1F */
4860 0, /* VK_SPACE 0x20 */
4861 "prior", /* VK_PRIOR 0x21 */
4862 "next", /* VK_NEXT 0x22 */
4863 "end", /* VK_END 0x23 */
4864 "home", /* VK_HOME 0x24 */
4865 "left", /* VK_LEFT 0x25 */
4866 "up", /* VK_UP 0x26 */
4867 "right", /* VK_RIGHT 0x27 */
4868 "down", /* VK_DOWN 0x28 */
4869 "select", /* VK_SELECT 0x29 */
4870 "print", /* VK_PRINT 0x2A */
4871 "execute", /* VK_EXECUTE 0x2B */
4872 "snapshot", /* VK_SNAPSHOT 0x2C */
4873 "insert", /* VK_INSERT 0x2D */
4874 "delete", /* VK_DELETE 0x2E */
4875 "help", /* VK_HELP 0x2F */
4877 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4879 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4881 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4883 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4885 0, 0, 0, 0, 0, 0, 0, 0, 0,
4886 0, 0, 0, 0, 0, 0, 0, 0, 0,
4887 0, 0, 0, 0, 0, 0, 0, 0,
4889 "lwindow", /* VK_LWIN 0x5B */
4890 "rwindow", /* VK_RWIN 0x5C */
4891 "apps", /* VK_APPS 0x5D */
4894 "kp-0", /* VK_NUMPAD0 0x60 */
4895 "kp-1", /* VK_NUMPAD1 0x61 */
4896 "kp-2", /* VK_NUMPAD2 0x62 */
4897 "kp-3", /* VK_NUMPAD3 0x63 */
4898 "kp-4", /* VK_NUMPAD4 0x64 */
4899 "kp-5", /* VK_NUMPAD5 0x65 */
4900 "kp-6", /* VK_NUMPAD6 0x66 */
4901 "kp-7", /* VK_NUMPAD7 0x67 */
4902 "kp-8", /* VK_NUMPAD8 0x68 */
4903 "kp-9", /* VK_NUMPAD9 0x69 */
4904 "kp-multiply", /* VK_MULTIPLY 0x6A */
4905 "kp-add", /* VK_ADD 0x6B */
4906 "kp-separator", /* VK_SEPARATOR 0x6C */
4907 "kp-subtract", /* VK_SUBTRACT 0x6D */
4908 "kp-decimal", /* VK_DECIMAL 0x6E */
4909 "kp-divide", /* VK_DIVIDE 0x6F */
4910 "f1", /* VK_F1 0x70 */
4911 "f2", /* VK_F2 0x71 */
4912 "f3", /* VK_F3 0x72 */
4913 "f4", /* VK_F4 0x73 */
4914 "f5", /* VK_F5 0x74 */
4915 "f6", /* VK_F6 0x75 */
4916 "f7", /* VK_F7 0x76 */
4917 "f8", /* VK_F8 0x77 */
4918 "f9", /* VK_F9 0x78 */
4919 "f10", /* VK_F10 0x79 */
4920 "f11", /* VK_F11 0x7A */
4921 "f12", /* VK_F12 0x7B */
4922 "f13", /* VK_F13 0x7C */
4923 "f14", /* VK_F14 0x7D */
4924 "f15", /* VK_F15 0x7E */
4925 "f16", /* VK_F16 0x7F */
4926 "f17", /* VK_F17 0x80 */
4927 "f18", /* VK_F18 0x81 */
4928 "f19", /* VK_F19 0x82 */
4929 "f20", /* VK_F20 0x83 */
4930 "f21", /* VK_F21 0x84 */
4931 "f22", /* VK_F22 0x85 */
4932 "f23", /* VK_F23 0x86 */
4933 "f24", /* VK_F24 0x87 */
4935 0, 0, 0, 0, /* 0x88 .. 0x8B */
4936 0, 0, 0, 0, /* 0x8C .. 0x8F */
4938 "kp-numlock", /* VK_NUMLOCK 0x90 */
4939 "scroll", /* VK_SCROLL 0x91 */
4940 /* Not sure where the following block comes from.
4941 Windows headers have NEC and Fujitsu specific keys in
4942 this block, but nothing generic. */
4943 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4944 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4945 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4946 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4947 "kp-end", /* VK_NUMPAD_END 0x96 */
4948 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4949 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4950 "kp-up", /* VK_NUMPAD_UP 0x99 */
4951 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4952 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4953 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4954 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4956 0, 0, /* 0x9E .. 0x9F */
4959 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4960 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4961 * No other API or message will distinguish left and right keys this way.
4966 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4967 to enable them selectively, and gives access to a few more functions.
4968 See lispy_multimedia_keys below. */
4969 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4970 0, 0, 0, /* 0xAD .. 0xAF Volume */
4971 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4972 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4974 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4975 0, 0, 0, 0, 0, 0, 0, 0, 0,
4977 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4978 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4979 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4982 "ax", /* VK_OEM_AX 0xE1 */
4983 0, /* VK_OEM_102 0xE2 */
4984 "ico-help", /* VK_ICO_HELP 0xE3 */
4985 "ico-00", /* VK_ICO_00 0xE4 */
4986 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4987 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4988 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4990 "reset", /* VK_OEM_RESET 0xE9 */
4991 "jump", /* VK_OEM_JUMP 0xEA */
4992 "oem-pa1", /* VK_OEM_PA1 0xEB */
4993 "oem-pa2", /* VK_OEM_PA2 0xEC */
4994 "oem-pa3", /* VK_OEM_PA3 0xED */
4995 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4996 "cusel", /* VK_OEM_CUSEL 0xEF */
4997 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4998 "finish", /* VK_OEM_FINISH 0xF1 */
4999 "copy", /* VK_OEM_COPY 0xF2 */
5000 "auto", /* VK_OEM_AUTO 0xF3 */
5001 "enlw", /* VK_OEM_ENLW 0xF4 */
5002 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5003 "attn", /* VK_ATTN 0xF6 */
5004 "crsel", /* VK_CRSEL 0xF7 */
5005 "exsel", /* VK_EXSEL 0xF8 */
5006 "ereof", /* VK_EREOF 0xF9 */
5007 "play", /* VK_PLAY 0xFA */
5008 "zoom", /* VK_ZOOM 0xFB */
5009 "noname", /* VK_NONAME 0xFC */
5010 "pa1", /* VK_PA1 0xFD */
5011 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5015 /* Some of these duplicate the "Media keys" on newer keyboards,
5016 but they are delivered to the application in a different way. */
5017 static const char *const lispy_multimedia_keys
[] =
5025 "browser-favorites",
5062 "toggle-dictate-command",
5068 "media-fast-forward",
5071 "media-channel-down"
5074 #else /* not HAVE_NTGUI */
5076 /* This should be dealt with in XTread_socket now, and that doesn't
5077 depend on the client system having the Kana syms defined. See also
5078 the XK_kana_A case below. */
5081 static const char *const lispy_kana_keys
[] =
5083 /* X Keysym value */
5084 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5085 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5086 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5087 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5088 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5089 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5090 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5091 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5092 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5093 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5094 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5095 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5096 "kana-i", "kana-u", "kana-e", "kana-o",
5097 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5098 "prolongedsound", "kana-A", "kana-I", "kana-U",
5099 "kana-E", "kana-O", "kana-KA", "kana-KI",
5100 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5101 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5102 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5103 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5104 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5105 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5106 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5107 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5108 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5109 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5110 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5111 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5113 #endif /* XK_kana_A */
5116 #define FUNCTION_KEY_OFFSET 0xff00
5118 /* You'll notice that this table is arranged to be conveniently
5119 indexed by X Windows keysym values. */
5120 static const char *const lispy_function_keys
[] =
5122 /* X Keysym value */
5124 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5125 "backspace", "tab", "linefeed", "clear",
5127 0, 0, 0, "pause", /* 0xff10...1f */
5128 0, 0, 0, 0, 0, 0, 0, "escape",
5130 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5131 "romaji", "hiragana", "katakana", "hiragana-katakana",
5132 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5133 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5134 "eisu-toggle", /* 0xff30...3f */
5135 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5136 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5138 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5139 "down", "prior", "next", "end",
5140 "begin", 0, 0, 0, 0, 0, 0, 0,
5141 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5152 "break", /* 0xff6b */
5155 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5156 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5157 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5158 0, 0, 0, 0, 0, 0, 0, 0,
5159 "kp-tab", /* 0xff89 */
5161 "kp-enter", /* 0xff8d */
5163 "kp-f1", /* 0xff91 */
5167 "kp-home", /* 0xff95 */
5172 "kp-prior", /* kp-page-up */
5173 "kp-next", /* kp-page-down */
5179 0, 0, 0, 0, 0, 0, 0, 0, 0,
5180 "kp-multiply", /* 0xffaa */
5185 "kp-divide", /* 0xffaf */
5186 "kp-0", /* 0xffb0 */
5187 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5190 "kp-equal", /* 0xffbd */
5191 "f1", /* 0xffbe */ /* IsFunctionKey */
5193 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5194 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5195 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5196 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5197 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5198 0, 0, 0, 0, 0, 0, 0, 0,
5199 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5200 0, 0, 0, 0, 0, 0, 0, "delete"
5203 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5204 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5206 static const char *const iso_lispy_function_keys
[] =
5208 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5209 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5210 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5211 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5212 "iso-lefttab", /* 0xfe20 */
5213 "iso-move-line-up", "iso-move-line-down",
5214 "iso-partial-line-up", "iso-partial-line-down",
5215 "iso-partial-space-left", "iso-partial-space-right",
5216 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5217 "iso-release-margin-left", "iso-release-margin-right",
5218 "iso-release-both-margins",
5219 "iso-fast-cursor-left", "iso-fast-cursor-right",
5220 "iso-fast-cursor-up", "iso-fast-cursor-down",
5221 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5222 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5225 #endif /* not HAVE_NTGUI */
5227 static Lisp_Object Vlispy_mouse_stem
;
5229 static const char *const lispy_wheel_names
[] =
5231 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5234 /* drag-n-drop events are generated when a set of selected files are
5235 dragged from another application and dropped onto an Emacs window. */
5236 static const char *const lispy_drag_n_drop_names
[] =
5241 /* Scroll bar parts. */
5242 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5243 Lisp_Object Qup
, Qdown
, Qbottom
;
5244 static Lisp_Object Qend_scroll
;
5246 static Lisp_Object Qratio
;
5248 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5249 static Lisp_Object
*const scroll_bar_parts
[] = {
5250 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5251 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5254 /* A vector, indexed by button number, giving the down-going location
5255 of currently depressed buttons, both scroll bar and non-scroll bar.
5257 The elements have the form
5258 (BUTTON-NUMBER MODIFIER-MASK . REST)
5259 where REST is the cdr of a position as it would be reported in the event.
5261 The make_lispy_event function stores positions here to tell the
5262 difference between click and drag events, and to store the starting
5263 location to be included in drag events. */
5265 static Lisp_Object button_down_location
;
5267 /* Information about the most recent up-going button event: Which
5268 button, what location, and what time. */
5270 static int last_mouse_button
;
5271 static int last_mouse_x
;
5272 static int last_mouse_y
;
5273 static Time button_down_time
;
5275 /* The number of clicks in this multiple-click. */
5277 static int double_click_count
;
5279 /* X and Y are frame-relative coordinates for a click or wheel event.
5280 Return a Lisp-style event list. */
5283 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5286 enum window_part part
;
5287 Lisp_Object posn
= Qnil
;
5288 Lisp_Object extra_info
= Qnil
;
5289 /* Coordinate pixel positions to return. */
5290 int xret
= 0, yret
= 0;
5291 /* The window under frame pixel coordinates (x,y) */
5292 Lisp_Object window
= f
5293 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5296 if (WINDOWP (window
))
5298 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5299 struct window
*w
= XWINDOW (window
);
5300 Lisp_Object string_info
= Qnil
;
5301 ptrdiff_t textpos
= 0;
5302 int col
= -1, row
= -1;
5303 int dx
= -1, dy
= -1;
5304 int width
= -1, height
= -1;
5305 Lisp_Object object
= Qnil
;
5307 /* Pixel coordinates relative to the window corner. */
5308 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5309 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5311 /* For text area clicks, return X, Y relative to the corner of
5312 this text area. Note that dX, dY etc are set below, by
5313 buffer_posn_from_coords. */
5314 if (part
== ON_TEXT
)
5316 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5317 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5319 /* For mode line and header line clicks, return X, Y relative to
5320 the left window edge. Use mode_line_string to look for a
5321 string on the click position. */
5322 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5327 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5328 /* Note that mode_line_string takes COL, ROW as pixels and
5329 converts them to characters. */
5332 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5333 &object
, &dx
, &dy
, &width
, &height
);
5334 if (STRINGP (string
))
5335 string_info
= Fcons (string
, make_number (charpos
));
5341 /* For fringes and margins, Y is relative to the area's (and the
5342 window's) top edge, while X is meaningless. */
5343 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5348 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5351 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5352 &object
, &dx
, &dy
, &width
, &height
);
5353 if (STRINGP (string
))
5354 string_info
= Fcons (string
, make_number (charpos
));
5355 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5357 else if (part
== ON_LEFT_FRINGE
)
5359 posn
= Qleft_fringe
;
5362 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5363 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5364 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5366 else if (part
== ON_RIGHT_FRINGE
)
5368 posn
= Qright_fringe
;
5371 - window_box_width (w
, LEFT_MARGIN_AREA
)
5372 - window_box_width (w
, TEXT_AREA
)
5373 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5374 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5376 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5378 else if (part
== ON_VERTICAL_BORDER
)
5380 posn
= Qvertical_line
;
5385 /* Nothing special for part == ON_SCROLL_BAR. */
5386 else if (part
== ON_RIGHT_DIVIDER
)
5388 posn
= Qright_divider
;
5389 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5393 else if (part
== ON_BOTTOM_DIVIDER
)
5395 posn
= Qbottom_divider
;
5396 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5401 /* For clicks in the text area, fringes, or margins, call
5402 buffer_posn_from_coords to extract TEXTPOS, the buffer
5403 position nearest to the click. */
5406 Lisp_Object string2
, object2
= Qnil
;
5407 struct display_pos p
;
5409 int width2
, height2
;
5410 /* The pixel X coordinate passed to buffer_posn_from_coords
5411 is the X coordinate relative to the text area for
5412 text-area and right-margin clicks, zero otherwise. */
5414 = (part
== ON_TEXT
) ? xret
5415 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5416 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5420 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5421 &object2
, &dx2
, &dy2
,
5423 textpos
= CHARPOS (p
.pos
);
5424 if (col
< 0) col
= x2
;
5425 if (row
< 0) row
= y2
;
5426 if (dx
< 0) dx
= dx2
;
5427 if (dy
< 0) dy
= dy2
;
5428 if (width
< 0) width
= width2
;
5429 if (height
< 0) height
= height2
;
5433 posn
= make_number (textpos
);
5434 if (STRINGP (string2
))
5435 string_info
= Fcons (string2
,
5436 make_number (CHARPOS (p
.string_pos
)));
5442 #ifdef HAVE_WINDOW_SYSTEM
5443 if (IMAGEP (object
))
5445 Lisp_Object image_map
, hotspot
;
5446 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5448 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5450 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5451 posn
= XCAR (hotspot
);
5458 Fcons (make_number (dx
), make_number (dy
)),
5459 Fcons (make_number (width
), make_number (height
)));
5462 extra_info
= Fcons (string_info
,
5463 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5464 Fcons (Fcons (make_number (col
),
5469 XSETFRAME (window
, f
);
5473 return Fcons (window
,
5475 Fcons (Fcons (make_number (xret
),
5476 make_number (yret
)),
5477 Fcons (make_number (t
),
5481 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5482 menu bar. This really means that Emacs draws and manages the menu
5483 bar as part of its normal display, and therefore can compute its
5486 toolkit_menubar_in_use (struct frame
*f
)
5488 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5489 return !(!FRAME_WINDOW_P (f
));
5495 /* Given a struct input_event, build the lisp event which represents
5496 it. If EVENT is 0, build a mouse movement event from the mouse
5497 movement buffer, which should have a movement event in it.
5499 Note that events must be passed to this function in the order they
5500 are received; this function stores the location of button presses
5501 in order to build drag events when the button is released. */
5504 make_lispy_event (struct input_event
*event
)
5508 switch (event
->kind
)
5510 /* A simple keystroke. */
5511 case ASCII_KEYSTROKE_EVENT
:
5512 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5514 Lisp_Object lispy_c
;
5515 EMACS_INT c
= event
->code
;
5516 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5519 eassert (c
== event
->code
);
5520 /* Turn ASCII characters into control characters
5522 if (event
->modifiers
& ctrl_modifier
)
5524 c
= make_ctrl_char (c
);
5525 event
->modifiers
&= ~ctrl_modifier
;
5529 /* Add in the other modifier bits. The shift key was taken care
5530 of by the X code. */
5531 c
|= (event
->modifiers
5532 & (meta_modifier
| alt_modifier
5533 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5534 /* Distinguish Shift-SPC from SPC. */
5535 if ((event
->code
) == 040
5536 && event
->modifiers
& shift_modifier
)
5537 c
|= shift_modifier
;
5538 button_down_time
= 0;
5539 XSETFASTINT (lispy_c
, c
);
5544 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5545 except that they are non-key events (last-nonmenu-event is nil). */
5546 case NS_NONKEY_EVENT
:
5549 /* A function key. The symbol may need to have modifier prefixes
5551 case NON_ASCII_KEYSTROKE_EVENT
:
5552 button_down_time
= 0;
5554 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5555 if (event
->code
== lispy_accent_codes
[i
])
5556 return modify_event_symbol (i
,
5558 Qfunction_key
, Qnil
,
5559 lispy_accent_keys
, &accent_key_syms
,
5560 ARRAYELTS (lispy_accent_keys
));
5564 if (event
->code
>= 0x400 && event
->code
< 0x500)
5565 return modify_event_symbol (event
->code
- 0x400,
5566 event
->modifiers
& ~shift_modifier
,
5567 Qfunction_key
, Qnil
,
5568 lispy_kana_keys
, &func_key_syms
,
5569 ARRAYELTS (lispy_kana_keys
));
5570 #endif /* XK_kana_A */
5573 #ifdef ISO_FUNCTION_KEY_OFFSET
5574 if (event
->code
< FUNCTION_KEY_OFFSET
5575 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5576 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5578 Qfunction_key
, Qnil
,
5579 iso_lispy_function_keys
, &func_key_syms
,
5580 ARRAYELTS (iso_lispy_function_keys
));
5583 /* Handle system-specific or unknown keysyms. */
5584 if (event
->code
& (1 << 28)
5585 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5586 || (event
->code
- FUNCTION_KEY_OFFSET
5587 >= ARRAYELTS (lispy_function_keys
))
5588 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5590 /* We need to use an alist rather than a vector as the cache
5591 since we can't make a vector long enough. */
5592 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5593 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5594 return modify_event_symbol (event
->code
,
5597 KVAR (current_kboard
, Vsystem_key_alist
),
5598 0, &KVAR (current_kboard
, system_key_syms
),
5602 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5604 Qfunction_key
, Qnil
,
5605 lispy_function_keys
, &func_key_syms
,
5606 ARRAYELTS (lispy_function_keys
));
5609 case MULTIMEDIA_KEY_EVENT
:
5610 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5611 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5613 return modify_event_symbol (event
->code
, event
->modifiers
,
5614 Qfunction_key
, Qnil
,
5615 lispy_multimedia_keys
, &func_key_syms
,
5616 ARRAYELTS (lispy_multimedia_keys
));
5621 /* A mouse click. Figure out where it is, decide whether it's
5622 a press, click or drag, and build the appropriate structure. */
5623 case MOUSE_CLICK_EVENT
:
5625 case GPM_CLICK_EVENT
:
5627 #ifndef USE_TOOLKIT_SCROLL_BARS
5628 case SCROLL_BAR_CLICK_EVENT
:
5631 int button
= event
->code
;
5633 Lisp_Object position
;
5634 Lisp_Object
*start_pos_ptr
;
5635 Lisp_Object start_pos
;
5639 /* Build the position as appropriate for this mouse click. */
5640 if (event
->kind
== MOUSE_CLICK_EVENT
5642 || event
->kind
== GPM_CLICK_EVENT
5646 struct frame
*f
= XFRAME (event
->frame_or_window
);
5649 /* Ignore mouse events that were made on frame that
5650 have been deleted. */
5651 if (! FRAME_LIVE_P (f
))
5654 /* EVENT->x and EVENT->y are frame-relative pixel
5655 coordinates at this place. Under old redisplay, COLUMN
5656 and ROW are set to frame relative glyph coordinates
5657 which are then used to determine whether this click is
5658 in a menu (non-toolkit version). */
5659 if (!toolkit_menubar_in_use (f
))
5661 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5662 &column
, &row
, NULL
, 1);
5664 /* In the non-toolkit version, clicks on the menu bar
5665 are ordinary button events in the event buffer.
5666 Distinguish them, and invoke the menu.
5668 (In the toolkit version, the toolkit handles the
5669 menu bar and Emacs doesn't know about it until
5670 after the user makes a selection.) */
5671 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5672 && (event
->modifiers
& down_modifier
))
5674 Lisp_Object items
, item
;
5676 /* Find the menu bar item under `column'. */
5678 items
= FRAME_MENU_BAR_ITEMS (f
);
5679 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5681 Lisp_Object pos
, string
;
5682 string
= AREF (items
, i
+ 1);
5683 pos
= AREF (items
, i
+ 3);
5686 if (column
>= XINT (pos
)
5687 && column
< XINT (pos
) + SCHARS (string
))
5689 item
= AREF (items
, i
);
5694 /* ELisp manual 2.4b says (x y) are window
5695 relative but code says they are
5697 position
= list4 (event
->frame_or_window
,
5699 Fcons (event
->x
, event
->y
),
5700 make_number (event
->timestamp
));
5702 return list2 (item
, position
);
5706 position
= make_lispy_position (f
, event
->x
, event
->y
,
5709 #ifndef USE_TOOLKIT_SCROLL_BARS
5712 /* It's a scrollbar click. */
5714 Lisp_Object portion_whole
;
5717 window
= event
->frame_or_window
;
5718 portion_whole
= Fcons (event
->x
, event
->y
);
5719 part
= *scroll_bar_parts
[(int) event
->part
];
5721 position
= list5 (window
, Qvertical_scroll_bar
,
5722 portion_whole
, make_number (event
->timestamp
),
5725 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5727 if (button
>= ASIZE (button_down_location
))
5729 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5730 button_down_location
= larger_vector (button_down_location
,
5732 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5735 start_pos_ptr
= aref_addr (button_down_location
, button
);
5736 start_pos
= *start_pos_ptr
;
5737 *start_pos_ptr
= Qnil
;
5740 /* On window-system frames, use the value of
5741 double-click-fuzz as is. On other frames, interpret it
5742 as a multiple of 1/8 characters. */
5746 if (WINDOWP (event
->frame_or_window
))
5747 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5748 else if (FRAMEP (event
->frame_or_window
))
5749 f
= XFRAME (event
->frame_or_window
);
5753 if (FRAME_WINDOW_P (f
))
5754 fuzz
= double_click_fuzz
;
5756 fuzz
= double_click_fuzz
/ 8;
5758 is_double
= (button
== last_mouse_button
5759 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5760 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5761 && button_down_time
!= 0
5762 && (EQ (Vdouble_click_time
, Qt
)
5763 || (NATNUMP (Vdouble_click_time
)
5764 && (event
->timestamp
- button_down_time
5765 < XFASTINT (Vdouble_click_time
)))));
5768 last_mouse_button
= button
;
5769 last_mouse_x
= XINT (event
->x
);
5770 last_mouse_y
= XINT (event
->y
);
5772 /* If this is a button press, squirrel away the location, so
5773 we can decide later whether it was a click or a drag. */
5774 if (event
->modifiers
& down_modifier
)
5778 double_click_count
++;
5779 event
->modifiers
|= ((double_click_count
> 2)
5784 double_click_count
= 1;
5785 button_down_time
= event
->timestamp
;
5786 *start_pos_ptr
= Fcopy_alist (position
);
5787 ignore_mouse_drag_p
= 0;
5790 /* Now we're releasing a button - check the co-ordinates to
5791 see if this was a click or a drag. */
5792 else if (event
->modifiers
& up_modifier
)
5794 /* If we did not see a down before this up, ignore the up.
5795 Probably this happened because the down event chose a
5796 menu item. It would be an annoyance to treat the
5797 release of the button that chose the menu item as a
5800 if (!CONSP (start_pos
))
5803 event
->modifiers
&= ~up_modifier
;
5806 Lisp_Object new_down
, down
;
5807 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5809 /* The third element of every position
5810 should be the (x,y) pair. */
5811 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5812 new_down
= Fcar (Fcdr (Fcdr (position
)));
5815 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5817 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5818 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5821 if (ignore_mouse_drag_p
)
5823 event
->modifiers
|= click_modifier
;
5824 ignore_mouse_drag_p
= 0;
5826 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5827 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5828 /* Maybe the mouse has moved a lot, caused scrolling, and
5829 eventually ended up at the same screen position (but
5830 not buffer position) in which case it is a drag, not
5832 /* FIXME: OTOH if the buffer position has changed
5833 because of a timer or process filter rather than
5834 because of mouse movement, it should be considered as
5835 a click. But mouse-drag-region completely ignores
5836 this case and it hasn't caused any real problem, so
5837 it's probably OK to ignore it as well. */
5838 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5839 /* Mouse hasn't moved (much). */
5840 event
->modifiers
|= click_modifier
;
5843 button_down_time
= 0;
5844 event
->modifiers
|= drag_modifier
;
5847 /* Don't check is_double; treat this as multiple
5848 if the down-event was multiple. */
5849 if (double_click_count
> 1)
5850 event
->modifiers
|= ((double_click_count
> 2)
5856 /* Every mouse event should either have the down_modifier or
5857 the up_modifier set. */
5861 /* Get the symbol we should use for the mouse click. */
5864 head
= modify_event_symbol (button
,
5866 Qmouse_click
, Vlispy_mouse_stem
,
5869 ASIZE (mouse_syms
));
5870 if (event
->modifiers
& drag_modifier
)
5871 return list3 (head
, start_pos
, position
);
5872 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5873 return list3 (head
, position
, make_number (double_click_count
));
5875 return list2 (head
, position
);
5880 case HORIZ_WHEEL_EVENT
:
5882 Lisp_Object position
;
5885 /* Build the position as appropriate for this mouse click. */
5886 struct frame
*f
= XFRAME (event
->frame_or_window
);
5888 /* Ignore wheel events that were made on frame that have been
5890 if (! FRAME_LIVE_P (f
))
5893 position
= make_lispy_position (f
, event
->x
, event
->y
,
5896 /* Set double or triple modifiers to indicate the wheel speed. */
5898 /* On window-system frames, use the value of
5899 double-click-fuzz as is. On other frames, interpret it
5900 as a multiple of 1/8 characters. */
5906 if (WINDOWP (event
->frame_or_window
))
5907 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5908 else if (FRAMEP (event
->frame_or_window
))
5909 fr
= XFRAME (event
->frame_or_window
);
5913 fuzz
= FRAME_WINDOW_P (fr
)
5914 ? double_click_fuzz
: double_click_fuzz
/ 8;
5916 if (event
->modifiers
& up_modifier
)
5918 /* Emit a wheel-up event. */
5919 event
->modifiers
&= ~up_modifier
;
5922 else if (event
->modifiers
& down_modifier
)
5924 /* Emit a wheel-down event. */
5925 event
->modifiers
&= ~down_modifier
;
5929 /* Every wheel event should either have the down_modifier or
5930 the up_modifier set. */
5933 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5936 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5937 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5938 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5939 && button_down_time
!= 0
5940 && (EQ (Vdouble_click_time
, Qt
)
5941 || (NATNUMP (Vdouble_click_time
)
5942 && (event
->timestamp
- button_down_time
5943 < XFASTINT (Vdouble_click_time
)))));
5946 double_click_count
++;
5947 event
->modifiers
|= ((double_click_count
> 2)
5953 double_click_count
= 1;
5954 event
->modifiers
|= click_modifier
;
5957 button_down_time
= event
->timestamp
;
5958 /* Use a negative value to distinguish wheel from mouse button. */
5959 last_mouse_button
= - (1 + symbol_num
);
5960 last_mouse_x
= XINT (event
->x
);
5961 last_mouse_y
= XINT (event
->y
);
5963 /* Get the symbol we should use for the wheel event. */
5964 head
= modify_event_symbol (symbol_num
,
5970 ASIZE (wheel_syms
));
5973 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5974 return list3 (head
, position
, make_number (double_click_count
));
5976 return list2 (head
, position
);
5980 #ifdef USE_TOOLKIT_SCROLL_BARS
5982 /* We don't have down and up events if using toolkit scroll bars,
5983 so make this always a click event. Store in the `part' of
5984 the Lisp event a symbol which maps to the following actions:
5986 `above_handle' page up
5987 `below_handle' page down
5991 `bottom' bottom of buffer
5992 `handle' thumb has been dragged.
5993 `end-scroll' end of interaction with scroll bar
5995 The incoming input_event contains in its `part' member an
5996 index of type `enum scroll_bar_part' which we can use as an
5997 index in scroll_bar_parts to get the appropriate symbol. */
5999 case SCROLL_BAR_CLICK_EVENT
:
6001 Lisp_Object position
, head
, window
, portion_whole
, part
;
6003 window
= event
->frame_or_window
;
6004 portion_whole
= Fcons (event
->x
, event
->y
);
6005 part
= *scroll_bar_parts
[(int) event
->part
];
6007 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
6008 make_number (event
->timestamp
), part
);
6010 /* Always treat scroll bar events as clicks. */
6011 event
->modifiers
|= click_modifier
;
6012 event
->modifiers
&= ~up_modifier
;
6014 if (event
->code
>= ASIZE (mouse_syms
))
6015 mouse_syms
= larger_vector (mouse_syms
,
6016 event
->code
- ASIZE (mouse_syms
) + 1,
6019 /* Get the symbol we should use for the mouse click. */
6020 head
= modify_event_symbol (event
->code
,
6025 ASIZE (mouse_syms
));
6026 return list2 (head
, position
);
6029 #endif /* USE_TOOLKIT_SCROLL_BARS */
6031 case DRAG_N_DROP_EVENT
:
6034 Lisp_Object head
, position
;
6037 f
= XFRAME (event
->frame_or_window
);
6040 /* Ignore mouse events that were made on frames that
6041 have been deleted. */
6042 if (! FRAME_LIVE_P (f
))
6045 position
= make_lispy_position (f
, event
->x
, event
->y
,
6048 head
= modify_event_symbol (0, event
->modifiers
,
6050 lispy_drag_n_drop_names
,
6051 &drag_n_drop_syms
, 1);
6052 return list3 (head
, position
, files
);
6055 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6056 || defined (HAVE_NS) || defined (USE_GTK)
6057 case MENU_BAR_EVENT
:
6058 if (EQ (event
->arg
, event
->frame_or_window
))
6059 /* This is the prefix key. We translate this to
6060 `(menu_bar)' because the code in keyboard.c for menu
6061 events, which we use, relies on this. */
6062 return list1 (Qmenu_bar
);
6066 case SELECT_WINDOW_EVENT
:
6067 /* Make an event (select-window (WINDOW)). */
6068 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6070 case TOOL_BAR_EVENT
:
6071 if (EQ (event
->arg
, event
->frame_or_window
))
6072 /* This is the prefix key. We translate this to
6073 `(tool_bar)' because the code in keyboard.c for tool bar
6074 events, which we use, relies on this. */
6075 return list1 (Qtool_bar
);
6076 else if (SYMBOLP (event
->arg
))
6077 return apply_modifiers (event
->modifiers
, event
->arg
);
6080 case USER_SIGNAL_EVENT
:
6081 /* A user signal. */
6083 char *name
= find_user_signal_name (event
->code
);
6086 return intern (name
);
6089 case SAVE_SESSION_EVENT
:
6090 return Qsave_session
;
6095 return Fcons (Qdbus_event
, event
->arg
);
6097 #endif /* HAVE_DBUS */
6099 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6100 case FILE_NOTIFY_EVENT
:
6102 return Fcons (Qfile_notify
, event
->arg
);
6104 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6106 case CONFIG_CHANGED_EVENT
:
6107 return list3 (Qconfig_changed_event
,
6108 event
->arg
, event
->frame_or_window
);
6110 /* The 'kind' field of the event is something we don't recognize. */
6117 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6118 Lisp_Object x
, Lisp_Object y
, Time t
)
6120 /* Is it a scroll bar movement? */
6121 if (frame
&& ! NILP (bar_window
))
6123 Lisp_Object part_sym
;
6125 part_sym
= *scroll_bar_parts
[(int) part
];
6126 return list2 (Qscroll_bar_movement
,
6128 Qvertical_scroll_bar
,
6133 /* Or is it an ordinary mouse movement? */
6136 Lisp_Object position
;
6137 position
= make_lispy_position (frame
, x
, y
, t
);
6138 return list2 (Qmouse_movement
, position
);
6142 /* Construct a switch frame event. */
6144 make_lispy_switch_frame (Lisp_Object frame
)
6146 return list2 (Qswitch_frame
, frame
);
6150 make_lispy_focus_in (Lisp_Object frame
)
6152 return list2 (Qfocus_in
, frame
);
6155 #ifdef HAVE_WINDOW_SYSTEM
6158 make_lispy_focus_out (Lisp_Object frame
)
6160 return list2 (Qfocus_out
, frame
);
6163 #endif /* HAVE_WINDOW_SYSTEM */
6165 /* Manipulating modifiers. */
6167 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6169 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6170 SYMBOL's name of the end of the modifiers; the string from this
6171 position is the unmodified symbol name.
6173 This doesn't use any caches. */
6176 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6182 CHECK_SYMBOL (symbol
);
6185 name
= SYMBOL_NAME (symbol
);
6187 for (i
= 0; i
< SBYTES (name
) - 1; )
6189 ptrdiff_t this_mod_end
= 0;
6192 /* See if the name continues with a modifier word.
6193 Check that the word appears, but don't check what follows it.
6194 Set this_mod and this_mod_end to record what we find. */
6196 switch (SREF (name
, i
))
6198 #define SINGLE_LETTER_MOD(BIT) \
6199 (this_mod_end = i + 1, this_mod = BIT)
6202 SINGLE_LETTER_MOD (alt_modifier
);
6206 SINGLE_LETTER_MOD (ctrl_modifier
);
6210 SINGLE_LETTER_MOD (hyper_modifier
);
6214 SINGLE_LETTER_MOD (meta_modifier
);
6218 SINGLE_LETTER_MOD (shift_modifier
);
6222 SINGLE_LETTER_MOD (super_modifier
);
6225 #undef SINGLE_LETTER_MOD
6227 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6228 if (i + LEN + 1 <= SBYTES (name) \
6229 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6231 this_mod_end = i + LEN; \
6236 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6237 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6238 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6242 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6244 #undef MULTI_LETTER_MOD
6248 /* If we found no modifier, stop looking for them. */
6249 if (this_mod_end
== 0)
6252 /* Check there is a dash after the modifier, so that it
6253 really is a modifier. */
6254 if (this_mod_end
>= SBYTES (name
)
6255 || SREF (name
, this_mod_end
) != '-')
6258 /* This modifier is real; look for another. */
6259 modifiers
|= this_mod
;
6260 i
= this_mod_end
+ 1;
6263 /* Should we include the `click' modifier? */
6264 if (! (modifiers
& (down_modifier
| drag_modifier
6265 | double_modifier
| triple_modifier
))
6266 && i
+ 7 == SBYTES (name
)
6267 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6268 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6269 modifiers
|= click_modifier
;
6271 if (! (modifiers
& (double_modifier
| triple_modifier
))
6272 && i
+ 6 < SBYTES (name
)
6273 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6274 modifiers
|= click_modifier
;
6282 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6283 prepended to the string BASE[0..BASE_LEN-1].
6284 This doesn't use any caches. */
6286 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6288 /* Since BASE could contain nulls, we can't use intern here; we have
6289 to use Fintern, which expects a genuine Lisp_String, and keeps a
6291 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6297 /* Only the event queue may use the `up' modifier; it should always
6298 be turned into a click or drag event before presented to lisp code. */
6299 if (modifiers
& up_modifier
)
6302 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6303 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6304 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6305 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6306 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6307 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6308 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6309 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6310 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6311 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6312 /* The click modifier is denoted by the absence of other modifiers. */
6316 mod_len
= p
- new_mods
;
6320 Lisp_Object new_name
;
6322 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6323 mod_len
+ base_len_byte
);
6324 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6325 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6327 return Fintern (new_name
, Qnil
);
6332 static const char *const modifier_names
[] =
6334 "up", "down", "drag", "click", "double", "triple", 0, 0,
6335 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6336 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6338 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6340 static Lisp_Object modifier_symbols
;
6342 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6344 lispy_modifier_list (int modifiers
)
6346 Lisp_Object modifier_list
;
6349 modifier_list
= Qnil
;
6350 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6351 if (modifiers
& (1<<i
))
6352 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6355 return modifier_list
;
6359 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6360 where UNMODIFIED is the unmodified form of SYMBOL,
6361 MASK is the set of modifiers present in SYMBOL's name.
6362 This is similar to parse_modifiers_uncached, but uses the cache in
6363 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6364 Qevent_symbol_elements property. */
6366 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6369 parse_modifiers (Lisp_Object symbol
)
6371 Lisp_Object elements
;
6373 if (INTEGERP (symbol
))
6374 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6375 else if (!SYMBOLP (symbol
))
6378 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6379 if (CONSP (elements
))
6384 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6385 Lisp_Object unmodified
;
6388 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6389 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6392 if (modifiers
& ~INTMASK
)
6394 XSETFASTINT (mask
, modifiers
);
6395 elements
= list2 (unmodified
, mask
);
6397 /* Cache the parsing results on SYMBOL. */
6398 Fput (symbol
, Qevent_symbol_element_mask
,
6400 Fput (symbol
, Qevent_symbol_elements
,
6401 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6403 /* Since we know that SYMBOL is modifiers applied to unmodified,
6404 it would be nice to put that in unmodified's cache.
6405 But we can't, since we're not sure that parse_modifiers is
6412 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6413 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6414 doc
: /* Parse the event symbol. For internal use. */)
6415 (Lisp_Object symbol
)
6417 /* Fill the cache if needed. */
6418 parse_modifiers (symbol
);
6419 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6420 and use the Lispier representation stored on Qevent_symbol_elements
6422 return Fget (symbol
, Qevent_symbol_elements
);
6425 /* Apply the modifiers MODIFIERS to the symbol BASE.
6426 BASE must be unmodified.
6428 This is like apply_modifiers_uncached, but uses BASE's
6429 Qmodifier_cache property, if present. It also builds
6430 Qevent_symbol_elements properties, since it has that info anyway.
6432 apply_modifiers copies the value of BASE's Qevent_kind property to
6433 the modified symbol. */
6435 apply_modifiers (int modifiers
, Lisp_Object base
)
6437 Lisp_Object cache
, idx
, entry
, new_symbol
;
6439 /* Mask out upper bits. We don't know where this value's been. */
6440 modifiers
&= INTMASK
;
6442 if (INTEGERP (base
))
6443 return make_number (XINT (base
) | modifiers
);
6445 /* The click modifier never figures into cache indices. */
6446 cache
= Fget (base
, Qmodifier_cache
);
6447 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6448 entry
= assq_no_quit (idx
, cache
);
6451 new_symbol
= XCDR (entry
);
6454 /* We have to create the symbol ourselves. */
6455 new_symbol
= apply_modifiers_uncached (modifiers
,
6456 SSDATA (SYMBOL_NAME (base
)),
6457 SCHARS (SYMBOL_NAME (base
)),
6458 SBYTES (SYMBOL_NAME (base
)));
6460 /* Add the new symbol to the base's cache. */
6461 entry
= Fcons (idx
, new_symbol
);
6462 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6464 /* We have the parsing info now for free, so we could add it to
6466 XSETFASTINT (idx, modifiers);
6467 Fput (new_symbol, Qevent_symbol_element_mask,
6469 Fput (new_symbol, Qevent_symbol_elements,
6470 Fcons (base, lispy_modifier_list (modifiers)));
6471 Sadly, this is only correct if `base' is indeed a base event,
6472 which is not necessarily the case. -stef */
6475 /* Make sure this symbol is of the same kind as BASE.
6477 You'd think we could just set this once and for all when we
6478 intern the symbol above, but reorder_modifiers may call us when
6479 BASE's property isn't set right; we can't assume that just
6480 because it has a Qmodifier_cache property it must have its
6481 Qevent_kind set right as well. */
6482 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6486 kind
= Fget (base
, Qevent_kind
);
6488 Fput (new_symbol
, Qevent_kind
, kind
);
6495 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6496 return a symbol with the modifiers placed in the canonical order.
6497 Canonical order is alphabetical, except for down and drag, which
6498 always come last. The 'click' modifier is never written out.
6500 Fdefine_key calls this to make sure that (for example) C-M-foo
6501 and M-C-foo end up being equivalent in the keymap. */
6504 reorder_modifiers (Lisp_Object symbol
)
6506 /* It's hopefully okay to write the code this way, since everything
6507 will soon be in caches, and no consing will be done at all. */
6510 parsed
= parse_modifiers (symbol
);
6511 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6516 /* For handling events, we often want to produce a symbol whose name
6517 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6518 to some base, like the name of a function key or mouse button.
6519 modify_event_symbol produces symbols of this sort.
6521 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6522 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6525 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6526 into symbol names, or a string specifying a name stem used to
6527 construct a symbol name or the form `STEM-N', where N is the decimal
6528 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6529 non-nil; otherwise NAME_TABLE is used.
6531 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6532 persist between calls to modify_event_symbol that it can use to
6533 store a cache of the symbols it's generated for this NAME_TABLE
6534 before. The object stored there may be a vector or an alist.
6536 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6538 MODIFIERS is a set of modifier bits (as given in struct input_events)
6539 whose prefixes should be applied to the symbol name.
6541 SYMBOL_KIND is the value to be placed in the event_kind property of
6542 the returned symbol.
6544 The symbols we create are supposed to have an
6545 `event-symbol-elements' property, which lists the modifiers present
6546 in the symbol's name. */
6549 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6550 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6551 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6554 Lisp_Object symbol_int
;
6556 /* Get rid of the "vendor-specific" bit here. */
6557 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6559 /* Is this a request for a valid symbol? */
6560 if (symbol_num
< 0 || symbol_num
>= table_size
)
6563 if (CONSP (*symbol_table
))
6564 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6566 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6567 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6568 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6569 we've never used that symbol before. */
6572 if (! VECTORP (*symbol_table
)
6573 || ASIZE (*symbol_table
) != table_size
)
6577 XSETFASTINT (size
, table_size
);
6578 *symbol_table
= Fmake_vector (size
, Qnil
);
6581 value
= AREF (*symbol_table
, symbol_num
);
6584 /* Have we already used this symbol before? */
6587 /* No; let's create it. */
6588 if (CONSP (name_alist_or_stem
))
6589 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6590 else if (STRINGP (name_alist_or_stem
))
6593 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6594 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6596 buf
= SAFE_ALLOCA (len
);
6597 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6598 XINT (symbol_int
) + 1);
6599 value
= intern (buf
);
6602 else if (name_table
!= 0 && name_table
[symbol_num
])
6603 value
= intern (name_table
[symbol_num
]);
6605 #ifdef HAVE_WINDOW_SYSTEM
6608 char *name
= x_get_keysym_name (symbol_num
);
6610 value
= intern (name
);
6616 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6617 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6618 value
= intern (buf
);
6621 if (CONSP (*symbol_table
))
6622 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6624 ASET (*symbol_table
, symbol_num
, value
);
6626 /* Fill in the cache entries for this symbol; this also
6627 builds the Qevent_symbol_elements property, which the user
6629 apply_modifiers (modifiers
& click_modifier
, value
);
6630 Fput (value
, Qevent_kind
, symbol_kind
);
6633 /* Apply modifiers to that symbol. */
6634 return apply_modifiers (modifiers
, value
);
6637 /* Convert a list that represents an event type,
6638 such as (ctrl meta backspace), into the usual representation of that
6639 event type as a number or a symbol. */
6641 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6642 doc
: /* Convert the event description list EVENT-DESC to an event type.
6643 EVENT-DESC should contain one base event type (a character or symbol)
6644 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6645 drag, down, double or triple). The base must be last.
6646 The return value is an event type (a character or symbol) which
6647 has the same base event type and all the specified modifiers. */)
6648 (Lisp_Object event_desc
)
6656 while (CONSP (rest
))
6664 /* Given a symbol, see if it is a modifier name. */
6665 if (SYMBOLP (elt
) && CONSP (rest
))
6666 this = parse_solitary_modifier (elt
);
6670 else if (!NILP (base
))
6671 error ("Two bases given in one event");
6677 /* Let the symbol A refer to the character A. */
6678 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6679 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6681 if (INTEGERP (base
))
6683 /* Turn (shift a) into A. */
6684 if ((modifiers
& shift_modifier
) != 0
6685 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6687 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6688 modifiers
&= ~shift_modifier
;
6691 /* Turn (control a) into C-a. */
6692 if (modifiers
& ctrl_modifier
)
6693 return make_number ((modifiers
& ~ctrl_modifier
)
6694 | make_ctrl_char (XINT (base
)));
6696 return make_number (modifiers
| XINT (base
));
6698 else if (SYMBOLP (base
))
6699 return apply_modifiers (modifiers
, base
);
6701 error ("Invalid base event");
6704 /* Try to recognize SYMBOL as a modifier name.
6705 Return the modifier flag bit, or 0 if not recognized. */
6708 parse_solitary_modifier (Lisp_Object symbol
)
6710 Lisp_Object name
= SYMBOL_NAME (symbol
);
6712 switch (SREF (name
, 0))
6714 #define SINGLE_LETTER_MOD(BIT) \
6715 if (SBYTES (name) == 1) \
6718 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6719 if (LEN == SBYTES (name) \
6720 && ! memcmp (SDATA (name), NAME, LEN)) \
6724 SINGLE_LETTER_MOD (alt_modifier
);
6728 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6732 SINGLE_LETTER_MOD (ctrl_modifier
);
6736 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6737 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6741 SINGLE_LETTER_MOD (hyper_modifier
);
6745 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6749 SINGLE_LETTER_MOD (meta_modifier
);
6753 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6757 SINGLE_LETTER_MOD (shift_modifier
);
6761 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6762 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6763 SINGLE_LETTER_MOD (super_modifier
);
6767 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6768 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6769 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6773 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6776 #undef SINGLE_LETTER_MOD
6777 #undef MULTI_LETTER_MOD
6783 /* Return true if EVENT is a list whose elements are all integers or symbols.
6784 Such a list is not valid as an event,
6785 but it can be a Lucid-style event type list. */
6788 lucid_event_type_list_p (Lisp_Object object
)
6792 if (! CONSP (object
))
6795 if (EQ (XCAR (object
), Qhelp_echo
)
6796 || EQ (XCAR (object
), Qvertical_line
)
6797 || EQ (XCAR (object
), Qmode_line
)
6798 || EQ (XCAR (object
), Qheader_line
))
6801 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6805 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6812 /* Return true if terminal input chars are available.
6813 Also, store the return value into INPUT_PENDING.
6815 Serves the purpose of ioctl (0, FIONREAD, ...)
6816 but works even if FIONREAD does not exist.
6817 (In fact, this may actually read some input.)
6819 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6820 timer events that are ripe.
6821 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6822 events (FOCUS_IN_EVENT).
6823 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6824 movements and toolkit scroll bar thumb drags. */
6827 get_input_pending (int flags
)
6829 /* First of all, have we already counted some input? */
6830 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6832 /* If input is being read as it arrives, and we have none, there is none. */
6833 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6835 /* Try to read some input and see how much we get. */
6837 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6840 return input_pending
;
6843 /* Put a BUFFER_SWITCH_EVENT in the buffer
6844 so that read_key_sequence will notice the new current buffer. */
6847 record_asynch_buffer_change (void)
6849 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6850 The purpose of the event is to make read_key_sequence look up the
6851 keymaps again. If we aren't in read_key_sequence, we don't need one,
6852 and the event could cause trouble by messing up (input-pending-p).
6853 Note: Fwaiting_for_user_input_p always returns nil when async
6854 subprocesses aren't supported. */
6855 if (!NILP (Fwaiting_for_user_input_p ()))
6857 struct input_event event
;
6860 event
.kind
= BUFFER_SWITCH_EVENT
;
6861 event
.frame_or_window
= Qnil
;
6864 /* Make sure no interrupt happens while storing the event. */
6866 if (interrupt_input
)
6867 kbd_buffer_store_event (&event
);
6872 kbd_buffer_store_event (&event
);
6878 /* Read any terminal input already buffered up by the system
6879 into the kbd_buffer, but do not wait.
6881 Return the number of keyboard chars read, or -1 meaning
6882 this is a bad time to try to read input. */
6891 /* Store pending user signal events, if any. */
6892 store_user_signal_events ();
6894 /* Loop through the available terminals, and call their input hooks. */
6898 struct terminal
*next
= t
->next_terminal
;
6900 if (t
->read_socket_hook
)
6903 struct input_event hold_quit
;
6905 if (input_blocked_p ())
6907 pending_signals
= 1;
6911 EVENT_INIT (hold_quit
);
6912 hold_quit
.kind
= NO_EVENT
;
6914 /* No need for FIONREAD or fcntl; just say don't wait. */
6915 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6918 if (nr
== -1) /* Not OK to read input now. */
6922 else if (nr
== -2) /* Non-transient error. */
6924 /* The terminal device terminated; it should be closed. */
6926 /* Kill Emacs if this was our last terminal. */
6927 if (!terminal_list
->next_terminal
)
6928 /* Formerly simply reported no input, but that
6929 sometimes led to a failure of Emacs to terminate.
6930 SIGHUP seems appropriate if we can't reach the
6932 /* ??? Is it really right to send the signal just to
6933 this process rather than to the whole process
6934 group? Perhaps on systems with FIONREAD Emacs is
6935 alone in its group. */
6936 terminate_due_to_signal (SIGHUP
, 10);
6938 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6941 XSETTERMINAL (tmp
, t
);
6942 Fdelete_terminal (tmp
, Qnoelisp
);
6946 /* If there was no error, make sure the pointer
6947 is visible for all frames on this terminal. */
6950 Lisp_Object tail
, frame
;
6952 FOR_EACH_FRAME (tail
, frame
)
6954 struct frame
*f
= XFRAME (frame
);
6955 if (FRAME_TERMINAL (f
) == t
)
6956 frame_make_pointer_visible (f
);
6960 if (hold_quit
.kind
!= NO_EVENT
)
6961 kbd_buffer_store_event (&hold_quit
);
6973 /* This is the tty way of reading available input.
6975 Note that each terminal device has its own `struct terminal' object,
6976 and so this function is called once for each individual termcap
6977 terminal. The first parameter indicates which terminal to read from. */
6980 tty_read_avail_input (struct terminal
*terminal
,
6981 struct input_event
*hold_quit
)
6983 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6984 the kbd_buffer can really hold. That may prevent loss
6985 of characters on some systems when input is stuffed at us. */
6986 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6988 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6991 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6993 if (kbd_on_hold_p () || buffer_free
<= 0)
6995 #endif /* subprocesses */
6997 if (!terminal
->name
) /* Don't read from a dead terminal. */
7000 if (terminal
->type
!= output_termcap
7001 && terminal
->type
!= output_msdos_raw
)
7004 /* XXX I think the following code should be moved to separate hook
7005 functions in system-dependent files. */
7007 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
7008 code sets read_socket_hook to w32_console_read_socket instead! */
7010 #else /* not WINDOWSNT */
7011 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7015 return 0; /* The terminal is suspended. */
7018 n_to_read
= dos_keysns ();
7022 cbuf
[0] = dos_keyread ();
7025 #else /* not MSDOS */
7030 struct input_event gpm_hold_quit
;
7031 int gpm
, fd
= gpm_fd
;
7033 EVENT_INIT (gpm_hold_quit
);
7034 gpm_hold_quit
.kind
= NO_EVENT
;
7036 /* gpm==1 if event received.
7037 gpm==0 if the GPM daemon has closed the connection, in which case
7038 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7039 we save it in `fd' so close_gpm can remove it from the
7041 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7042 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7043 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7046 /* Presumably the GPM daemon has closed the connection. */
7048 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7049 kbd_buffer_store_event (&gpm_hold_quit
);
7053 #endif /* HAVE_GPM */
7055 /* Determine how many characters we should *try* to read. */
7056 #ifdef USABLE_FIONREAD
7057 /* Find out how much input is available. */
7058 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7060 if (! noninteractive
)
7061 return -2; /* Close this terminal. */
7067 if (n_to_read
> sizeof cbuf
)
7068 n_to_read
= sizeof cbuf
;
7069 #elif defined USG || defined CYGWIN
7070 /* Read some input if available, but don't wait. */
7071 n_to_read
= sizeof cbuf
;
7072 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7074 # error "Cannot read without possibly delaying"
7078 /* Don't read more than we can store. */
7079 if (n_to_read
> buffer_free
)
7080 n_to_read
= buffer_free
;
7081 #endif /* subprocesses */
7083 /* Now read; for one reason or another, this will not block.
7084 NREAD is set to the number of chars read. */
7087 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7088 /* POSIX infers that processes which are not in the session leader's
7089 process group won't get SIGHUPs at logout time. BSDI adheres to
7090 this part standard and returns -1 from read (0) with errno==EIO
7091 when the control tty is taken away.
7092 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7093 if (nread
== -1 && errno
== EIO
)
7094 return -2; /* Close this terminal. */
7095 #if defined (AIX) && defined (_BSD)
7096 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7097 This looks incorrect, but it isn't, because _BSD causes
7098 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7099 and that causes a value other than 0 when there is no input. */
7101 return -2; /* Close this terminal. */
7105 /* We used to retry the read if it was interrupted.
7106 But this does the wrong thing when O_NONBLOCK causes
7107 an EAGAIN error. Does anybody know of a situation
7108 where a retry is actually needed? */
7110 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7120 #ifndef USABLE_FIONREAD
7121 #if defined (USG) || defined (CYGWIN)
7122 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7123 #endif /* USG or CYGWIN */
7124 #endif /* no FIONREAD */
7129 #endif /* not MSDOS */
7130 #endif /* not WINDOWSNT */
7132 for (i
= 0; i
< nread
; i
++)
7134 struct input_event buf
;
7136 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7138 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7139 buf
.modifiers
= meta_modifier
;
7140 if (tty
->meta_key
!= 2)
7144 /* Set the frame corresponding to the active tty. Note that the
7145 value of selected_frame is not reliable here, redisplay tends
7146 to temporarily change it. */
7147 buf
.frame_or_window
= tty
->top_frame
;
7150 kbd_buffer_store_event (&buf
);
7151 /* Don't look at input that follows a C-g too closely.
7152 This reduces lossage due to autorepeat on C-g. */
7153 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7154 && buf
.code
== quit_char
)
7162 handle_async_input (void)
7167 int nread
= gobble_input ();
7168 /* -1 means it's not ok to read the input now.
7169 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7170 0 means there was no keyboard input available. */
7178 process_pending_signals (void)
7180 pending_signals
= 0;
7181 handle_async_input ();
7182 do_pending_atimers ();
7185 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7186 and reinvoke any pending signal if the level is now 0 and
7187 a fatal error is not already in progress. */
7190 unblock_input_to (int level
)
7192 interrupt_input_blocked
= level
;
7195 if (pending_signals
&& !fatal_error_in_progress
)
7196 process_pending_signals ();
7202 /* End critical section.
7204 If doing signal-driven input, and a signal came in when input was
7205 blocked, reinvoke the signal handler now to deal with it.
7207 It will also process queued input, if it was not read before.
7208 When a longer code sequence does not use block/unblock input
7209 at all, the whole input gathered up to the next call to
7210 unblock_input will be processed inside that call. */
7213 unblock_input (void)
7215 unblock_input_to (interrupt_input_blocked
- 1);
7218 /* Undo any number of BLOCK_INPUT calls,
7219 and also reinvoke any pending signal. */
7222 totally_unblock_input (void)
7224 unblock_input_to (0);
7230 handle_input_available_signal (int sig
)
7232 pending_signals
= 1;
7234 if (input_available_clear_time
)
7235 *input_available_clear_time
= make_timespec (0, 0);
7239 deliver_input_available_signal (int sig
)
7241 deliver_process_signal (sig
, handle_input_available_signal
);
7243 #endif /* USABLE_SIGIO */
7246 /* User signal events. */
7248 struct user_signal_info
7250 /* Signal number. */
7253 /* Name of the signal. */
7256 /* Number of pending signals. */
7259 struct user_signal_info
*next
;
7262 /* List of user signals. */
7263 static struct user_signal_info
*user_signals
= NULL
;
7266 add_user_signal (int sig
, const char *name
)
7268 struct sigaction action
;
7269 struct user_signal_info
*p
;
7271 for (p
= user_signals
; p
; p
= p
->next
)
7273 /* Already added. */
7276 p
= xmalloc (sizeof *p
);
7278 p
->name
= xstrdup (name
);
7280 p
->next
= user_signals
;
7283 emacs_sigaction_init (&action
, deliver_user_signal
);
7284 sigaction (sig
, &action
, 0);
7288 handle_user_signal (int sig
)
7290 struct user_signal_info
*p
;
7291 const char *special_event_name
= NULL
;
7293 if (SYMBOLP (Vdebug_on_event
))
7294 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7296 for (p
= user_signals
; p
; p
= p
->next
)
7299 if (special_event_name
7300 && strcmp (special_event_name
, p
->name
) == 0)
7302 /* Enter the debugger in many ways. */
7303 debug_on_next_call
= 1;
7306 Vinhibit_quit
= Qnil
;
7308 /* Eat the event. */
7314 if (interrupt_input
)
7315 handle_input_available_signal (sig
);
7319 /* Tell wait_reading_process_output that it needs to wake
7320 up and look around. */
7321 if (input_available_clear_time
)
7322 *input_available_clear_time
= make_timespec (0, 0);
7329 deliver_user_signal (int sig
)
7331 deliver_process_signal (sig
, handle_user_signal
);
7335 find_user_signal_name (int sig
)
7337 struct user_signal_info
*p
;
7339 for (p
= user_signals
; p
; p
= p
->next
)
7347 store_user_signal_events (void)
7349 struct user_signal_info
*p
;
7350 struct input_event buf
;
7351 bool buf_initialized
= 0;
7353 for (p
= user_signals
; p
; p
= p
->next
)
7354 if (p
->npending
> 0)
7356 if (! buf_initialized
)
7358 memset (&buf
, 0, sizeof buf
);
7359 buf
.kind
= USER_SIGNAL_EVENT
;
7360 buf
.frame_or_window
= selected_frame
;
7361 buf_initialized
= 1;
7367 kbd_buffer_store_event (&buf
);
7370 while (p
->npending
> 0);
7375 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7376 static Lisp_Object menu_bar_one_keymap_changed_items
;
7378 /* These variables hold the vector under construction within
7379 menu_bar_items and its subroutines, and the current index
7380 for storing into that vector. */
7381 static Lisp_Object menu_bar_items_vector
;
7382 static int menu_bar_items_index
;
7385 static const char *separator_names
[] = {
7390 "single-dashed-line",
7391 "double-dashed-line",
7393 "shadow-etched-out",
7394 "shadow-etched-in-dash",
7395 "shadow-etched-out-dash",
7396 "shadow-double-etched-in",
7397 "shadow-double-etched-out",
7398 "shadow-double-etched-in-dash",
7399 "shadow-double-etched-out-dash",
7403 /* Return true if LABEL specifies a separator. */
7406 menu_separator_name_p (const char *label
)
7410 else if (strlen (label
) > 3
7411 && memcmp (label
, "--", 2) == 0
7416 for (i
= 0; separator_names
[i
]; ++i
)
7417 if (strcmp (label
, separator_names
[i
]) == 0)
7422 /* It's a separator if it contains only dashes. */
7423 while (*label
== '-')
7425 return (*label
== 0);
7432 /* Return a vector of menu items for a menu bar, appropriate
7433 to the current buffer. Each item has three elements in the vector:
7436 OLD is an old vector we can optionally reuse, or nil. */
7439 menu_bar_items (Lisp_Object old
)
7441 /* The number of keymaps we're scanning right now, and the number of
7442 keymaps we have allocated space for. */
7445 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7446 in the current keymaps, or nil where it is not a prefix. */
7449 Lisp_Object def
, tail
;
7454 /* In order to build the menus, we need to call the keymap
7455 accessors. They all call QUIT. But this function is called
7456 during redisplay, during which a quit is fatal. So inhibit
7457 quitting while building the menus.
7458 We do this instead of specbind because (1) errors will clear it anyway
7459 and (2) this avoids risk of specpdl overflow. */
7460 oquit
= Vinhibit_quit
;
7464 menu_bar_items_vector
= old
;
7466 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7467 menu_bar_items_index
= 0;
7469 /* Build our list of keymaps.
7470 If we recognize a function key and replace its escape sequence in
7471 keybuf with its symbol, or if the sequence starts with a mouse
7472 click and we need to switch buffers, we jump back here to rebuild
7473 the initial keymaps from the current buffer. */
7477 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7478 if (!NILP (Voverriding_local_map_menu_flag
)
7479 && !NILP (Voverriding_local_map
))
7481 /* Yes, use them (if non-nil) as well as the global map. */
7482 maps
= alloca (3 * sizeof (maps
[0]));
7484 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7485 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7486 if (!NILP (Voverriding_local_map
))
7487 maps
[nmaps
++] = Voverriding_local_map
;
7491 /* No, so use major and minor mode keymaps and keymap property.
7492 Note that menu-bar bindings in the local-map and keymap
7493 properties may not work reliable, as they are only
7494 recognized when the menu-bar (or mode-line) is updated,
7495 which does not normally happen after every command. */
7498 nminor
= current_minor_maps (NULL
, &tmaps
);
7499 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7501 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7502 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7503 maps
[nmaps
++] = tem
;
7504 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7505 maps
[nmaps
++] = tem
;
7506 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7508 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7510 maps
[nmaps
++] = current_global_map
;
7513 /* Look up in each map the dummy prefix key `menu-bar'. */
7515 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7516 if (!NILP (maps
[mapno
]))
7518 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7522 menu_bar_one_keymap_changed_items
= Qnil
;
7523 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7527 /* Move to the end those items that should be at the end. */
7529 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7532 int end
= menu_bar_items_index
;
7534 for (i
= 0; i
< end
; i
+= 4)
7535 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7537 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7538 /* Move the item at index I to the end,
7539 shifting all the others forward. */
7540 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7541 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7542 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7543 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7545 memmove (aref_addr (menu_bar_items_vector
, i
),
7546 aref_addr (menu_bar_items_vector
, i
+ 4),
7547 (end
- i
- 4) * word_size
);
7548 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7549 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7550 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7551 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7556 /* Add nil, nil, nil, nil at the end. */
7558 int i
= menu_bar_items_index
;
7559 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7560 menu_bar_items_vector
7561 = larger_vector (menu_bar_items_vector
, 4, -1);
7562 /* Add this item. */
7563 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7564 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7565 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7566 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7567 menu_bar_items_index
= i
;
7570 Vinhibit_quit
= oquit
;
7571 return menu_bar_items_vector
;
7574 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7575 If there's already an item for KEY, add this DEF to it. */
7577 Lisp_Object item_properties
;
7580 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7582 struct gcpro gcpro1
;
7587 if (EQ (item
, Qundefined
))
7589 /* If a map has an explicit `undefined' as definition,
7590 discard any previously made menu bar item. */
7592 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7593 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7595 if (menu_bar_items_index
> i
+ 4)
7596 memmove (aref_addr (menu_bar_items_vector
, i
),
7597 aref_addr (menu_bar_items_vector
, i
+ 4),
7598 (menu_bar_items_index
- i
- 4) * word_size
);
7599 menu_bar_items_index
-= 4;
7603 /* If this keymap has already contributed to this KEY,
7604 don't contribute to it a second time. */
7605 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7606 if (!NILP (tem
) || NILP (item
))
7609 menu_bar_one_keymap_changed_items
7610 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7612 /* We add to menu_bar_one_keymap_changed_items before doing the
7613 parse_menu_item, so that if it turns out it wasn't a menu item,
7614 it still correctly hides any further menu item. */
7616 parsed
= parse_menu_item (item
, 1);
7621 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7623 /* Find any existing item for this KEY. */
7624 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7625 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7628 /* If we did not find this KEY, add it at the end. */
7629 if (i
== menu_bar_items_index
)
7631 /* If vector is too small, get a bigger one. */
7632 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7633 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7634 /* Add this item. */
7635 ASET (menu_bar_items_vector
, i
, key
); i
++;
7636 ASET (menu_bar_items_vector
, i
,
7637 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7638 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7639 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7640 menu_bar_items_index
= i
;
7642 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7646 old
= AREF (menu_bar_items_vector
, i
+ 2);
7647 /* If the new and the old items are not both keymaps,
7648 the lookup will only find `item'. */
7649 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7650 ASET (menu_bar_items_vector
, i
+ 2, item
);
7654 /* This is used as the handler when calling menu_item_eval_property. */
7656 menu_item_eval_property_1 (Lisp_Object arg
)
7658 /* If we got a quit from within the menu computation,
7659 quit all the way out of it. This takes care of C-] in the debugger. */
7660 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7661 Fsignal (Qquit
, Qnil
);
7667 eval_dyn (Lisp_Object form
)
7669 return Feval (form
, Qnil
);
7672 /* Evaluate an expression and return the result (or nil if something
7673 went wrong). Used to evaluate dynamic parts of menu items. */
7675 menu_item_eval_property (Lisp_Object sexpr
)
7679 specbind (Qinhibit_redisplay
, Qt
);
7680 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7681 menu_item_eval_property_1
);
7686 /* This function parses a menu item and leaves the result in the
7687 vector item_properties.
7688 ITEM is a key binding, a possible menu item.
7689 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7691 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7692 parse_menu_item returns true if the item is a menu item and false
7696 parse_menu_item (Lisp_Object item
, int inmenubar
)
7698 Lisp_Object def
, tem
, item_string
, start
;
7700 Lisp_Object keyhint
;
7709 /* Create item_properties vector if necessary. */
7710 if (NILP (item_properties
))
7712 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7714 /* Initialize optional entries. */
7715 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7716 ASET (item_properties
, i
, Qnil
);
7717 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7719 /* Save the item here to protect it from GC. */
7720 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7722 item_string
= XCAR (item
);
7726 if (STRINGP (item_string
))
7728 /* Old format menu item. */
7729 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7731 /* Maybe help string. */
7732 if (CONSP (item
) && STRINGP (XCAR (item
)))
7734 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7739 /* Maybe an obsolete key binding cache. */
7740 if (CONSP (item
) && CONSP (XCAR (item
))
7741 && (NILP (XCAR (XCAR (item
)))
7742 || VECTORP (XCAR (XCAR (item
)))))
7745 /* This is the real definition--the function to run. */
7746 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7748 /* Get enable property, if any. */
7751 tem
= Fget (item
, Qmenu_enable
);
7752 if (!NILP (Venable_disabled_menus_and_buttons
))
7753 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7754 else if (!NILP (tem
))
7755 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7758 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7760 /* New format menu item. */
7761 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7762 start
= XCDR (item
);
7765 /* We have a real binding. */
7766 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7768 item
= XCDR (start
);
7769 /* Is there an obsolete cache list with key equivalences. */
7770 if (CONSP (item
) && CONSP (XCAR (item
)))
7773 /* Parse properties. */
7774 while (CONSP (item
) && CONSP (XCDR (item
)))
7779 if (EQ (tem
, QCenable
))
7781 if (!NILP (Venable_disabled_menus_and_buttons
))
7782 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7784 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7786 else if (EQ (tem
, QCvisible
))
7788 /* If got a visible property and that evaluates to nil
7789 then ignore this item. */
7790 tem
= menu_item_eval_property (XCAR (item
));
7794 else if (EQ (tem
, QChelp
))
7795 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7796 else if (EQ (tem
, QCfilter
))
7798 else if (EQ (tem
, QCkey_sequence
))
7801 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7802 /* Be GC protected. Set keyhint to item instead of tem. */
7805 else if (EQ (tem
, QCkeys
))
7808 if (CONSP (tem
) || STRINGP (tem
))
7809 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7811 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7816 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7818 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7820 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7826 else if (inmenubar
|| !NILP (start
))
7830 return 0; /* not a menu item */
7832 /* If item string is not a string, evaluate it to get string.
7833 If we don't get a string, skip this item. */
7834 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7835 if (!(STRINGP (item_string
)))
7837 item_string
= menu_item_eval_property (item_string
);
7838 if (!STRINGP (item_string
))
7840 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7843 /* If got a filter apply it on definition. */
7844 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7847 def
= menu_item_eval_property (list2 (XCAR (filter
),
7848 list2 (Qquote
, def
)));
7850 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7853 /* Enable or disable selection of item. */
7854 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7857 tem
= menu_item_eval_property (tem
);
7858 if (inmenubar
&& NILP (tem
))
7859 return 0; /* Ignore disabled items in menu bar. */
7860 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7863 /* If we got no definition, this item is just unselectable text which
7864 is OK in a submenu but not in the menubar. */
7866 return (!inmenubar
);
7868 /* See if this is a separate pane or a submenu. */
7869 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7870 tem
= get_keymap (def
, 0, 1);
7871 /* For a subkeymap, just record its details and exit. */
7874 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7875 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7879 /* At the top level in the menu bar, do likewise for commands also.
7880 The menu bar does not display equivalent key bindings anyway.
7881 ITEM_PROPERTY_DEF is already set up properly. */
7885 { /* This is a command. See if there is an equivalent key binding. */
7886 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7888 /* The previous code preferred :key-sequence to :keys, so we
7889 preserve this behavior. */
7890 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7891 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7894 Lisp_Object prefix
= keyeq
;
7895 Lisp_Object keys
= Qnil
;
7899 def
= XCAR (prefix
);
7900 prefix
= XCDR (prefix
);
7903 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7905 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7907 keys
= XCAR (keyhint
);
7908 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7910 /* We have a suggested key. Is it bound to the command? */
7913 /* If the command is an alias for another
7914 (such as lmenu.el set it up), check if the
7915 original command matches the cached command. */
7917 && EQ (tem
, SYMBOL_FUNCTION (def
)))))
7922 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7926 tem
= Fkey_description (keys
, Qnil
);
7929 if (STRINGP (XCAR (prefix
)))
7930 tem
= concat2 (XCAR (prefix
), tem
);
7931 if (STRINGP (XCDR (prefix
)))
7932 tem
= concat2 (tem
, XCDR (prefix
));
7934 keyeq
= concat2 (build_string (" "), tem
);
7935 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7941 /* If we have an equivalent key binding, use that. */
7942 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7945 /* Include this when menu help is implemented.
7946 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7947 if (!(NILP (tem) || STRINGP (tem)))
7949 tem = menu_item_eval_property (tem);
7952 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7956 /* Handle radio buttons or toggle boxes. */
7957 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7959 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7960 menu_item_eval_property (tem
));
7967 /***********************************************************************
7969 ***********************************************************************/
7971 /* A vector holding tool bar items while they are parsed in function
7972 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7975 static Lisp_Object tool_bar_items_vector
;
7977 /* A vector holding the result of parse_tool_bar_item. Layout is like
7978 the one for a single item in tool_bar_items_vector. */
7980 static Lisp_Object tool_bar_item_properties
;
7982 /* Next free index in tool_bar_items_vector. */
7984 static int ntool_bar_items
;
7986 /* The symbols `:image' and `:rtl'. */
7988 static Lisp_Object QCimage
;
7989 static Lisp_Object QCrtl
;
7991 /* Function prototypes. */
7993 static void init_tool_bar_items (Lisp_Object
);
7994 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7996 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7997 static void append_tool_bar_item (void);
8000 /* Return a vector of tool bar items for keymaps currently in effect.
8001 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8002 tool bar items found. */
8005 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8014 /* In order to build the menus, we need to call the keymap
8015 accessors. They all call QUIT. But this function is called
8016 during redisplay, during which a quit is fatal. So inhibit
8017 quitting while building the menus. We do this instead of
8018 specbind because (1) errors will clear it anyway and (2) this
8019 avoids risk of specpdl overflow. */
8020 oquit
= Vinhibit_quit
;
8023 /* Initialize tool_bar_items_vector and protect it from GC. */
8024 init_tool_bar_items (reuse
);
8026 /* Build list of keymaps in maps. Set nmaps to the number of maps
8029 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8030 if (!NILP (Voverriding_local_map_menu_flag
)
8031 && !NILP (Voverriding_local_map
))
8033 /* Yes, use them (if non-nil) as well as the global map. */
8034 maps
= alloca (3 * sizeof *maps
);
8036 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8037 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8038 if (!NILP (Voverriding_local_map
))
8039 maps
[nmaps
++] = Voverriding_local_map
;
8043 /* No, so use major and minor mode keymaps and keymap property.
8044 Note that tool-bar bindings in the local-map and keymap
8045 properties may not work reliable, as they are only
8046 recognized when the tool-bar (or mode-line) is updated,
8047 which does not normally happen after every command. */
8050 nminor
= current_minor_maps (NULL
, &tmaps
);
8051 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8053 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8054 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8055 maps
[nmaps
++] = tem
;
8056 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8057 maps
[nmaps
++] = tem
;
8058 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8060 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8063 /* Add global keymap at the end. */
8064 maps
[nmaps
++] = current_global_map
;
8066 /* Process maps in reverse order and look up in each map the prefix
8068 for (i
= nmaps
- 1; i
>= 0; --i
)
8069 if (!NILP (maps
[i
]))
8073 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8075 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8078 Vinhibit_quit
= oquit
;
8079 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8080 return tool_bar_items_vector
;
8084 /* Process the definition of KEY which is DEF. */
8087 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8090 struct gcpro gcpro1
, gcpro2
;
8092 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8096 if (EQ (def
, Qundefined
))
8098 /* If a map has an explicit `undefined' as definition,
8099 discard any previously made item. */
8100 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8102 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8104 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8106 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8107 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8108 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8110 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8115 else if (parse_tool_bar_item (key
, def
))
8116 /* Append a new tool bar item to tool_bar_items_vector. Accept
8117 more than one definition for the same key. */
8118 append_tool_bar_item ();
8123 /* Access slot with index IDX of vector tool_bar_item_properties. */
8124 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8126 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8128 ASET (tool_bar_item_properties
, idx
, val
);
8132 /* Parse a tool bar item specification ITEM for key KEY and return the
8133 result in tool_bar_item_properties. Value is false if ITEM is
8136 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8138 CAPTION is the caption of the item, If it's not a string, it is
8139 evaluated to get a string.
8141 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8142 as binding are currently ignored.
8144 The following properties are recognized:
8148 FORM is evaluated and specifies whether the tool bar item is
8149 enabled or disabled.
8153 FORM is evaluated and specifies whether the tool bar item is visible.
8155 - `:filter FUNCTION'
8157 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8158 result is stored as the new binding.
8160 - `:button (TYPE SELECTED)'
8162 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8163 and specifies whether the button is selected (pressed) or not.
8167 IMAGES is either a single image specification or a vector of four
8168 image specifications. See enum tool_bar_item_images.
8170 - `:help HELP-STRING'.
8172 Gives a help string to display for the tool bar item.
8174 - `:label LABEL-STRING'.
8176 A text label to show with the tool bar button if labels are enabled. */
8179 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8181 Lisp_Object filter
= Qnil
;
8182 Lisp_Object caption
;
8184 bool have_label
= 0;
8186 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8187 Rule out items that aren't lists, don't start with
8188 `menu-item' or whose rest following `tool-bar-item' is not a
8193 /* As an exception, allow old-style menu separators. */
8194 if (STRINGP (XCAR (item
)))
8195 item
= list1 (XCAR (item
));
8196 else if (!EQ (XCAR (item
), Qmenu_item
)
8197 || (item
= XCDR (item
), !CONSP (item
)))
8200 /* Create tool_bar_item_properties vector if necessary. Reset it to
8202 if (VECTORP (tool_bar_item_properties
))
8204 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8208 tool_bar_item_properties
8209 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8212 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8213 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8215 /* Get the caption of the item. If the caption is not a string,
8216 evaluate it to get a string. If we don't get a string, skip this
8218 caption
= XCAR (item
);
8219 if (!STRINGP (caption
))
8221 caption
= menu_item_eval_property (caption
);
8222 if (!STRINGP (caption
))
8225 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8227 /* If the rest following the caption is not a list, the menu item is
8228 either a separator, or invalid. */
8232 if (menu_separator_name_p (SSDATA (caption
)))
8234 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8235 #if !defined (USE_GTK) && !defined (HAVE_NS)
8236 /* If we use build_desired_tool_bar_string to render the
8237 tool bar, the separator is rendered as an image. */
8238 set_prop (TOOL_BAR_ITEM_IMAGES
,
8239 (menu_item_eval_property
8240 (Vtool_bar_separator_image_expression
)));
8241 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8242 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8243 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8250 /* Store the binding. */
8251 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8254 /* Ignore cached key binding, if any. */
8255 if (CONSP (item
) && CONSP (XCAR (item
)))
8258 /* Process the rest of the properties. */
8259 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8261 Lisp_Object ikey
, value
;
8264 value
= XCAR (XCDR (item
));
8266 if (EQ (ikey
, QCenable
))
8268 /* `:enable FORM'. */
8269 if (!NILP (Venable_disabled_menus_and_buttons
))
8270 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8272 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8274 else if (EQ (ikey
, QCvisible
))
8276 /* `:visible FORM'. If got a visible property and that
8277 evaluates to nil then ignore this item. */
8278 if (NILP (menu_item_eval_property (value
)))
8281 else if (EQ (ikey
, QChelp
))
8282 /* `:help HELP-STRING'. */
8283 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8284 else if (EQ (ikey
, QCvert_only
))
8285 /* `:vert-only t/nil'. */
8286 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8287 else if (EQ (ikey
, QClabel
))
8289 const char *bad_label
= "!!?GARBLED ITEM?!!";
8290 /* `:label LABEL-STRING'. */
8291 set_prop (TOOL_BAR_ITEM_LABEL
,
8292 STRINGP (value
) ? value
: build_string (bad_label
));
8295 else if (EQ (ikey
, QCfilter
))
8296 /* ':filter FORM'. */
8298 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8300 /* `:button (TYPE . SELECTED)'. */
8301 Lisp_Object type
, selected
;
8303 type
= XCAR (value
);
8304 selected
= XCDR (value
);
8305 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8307 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8308 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8311 else if (EQ (ikey
, QCimage
)
8313 || (VECTORP (value
) && ASIZE (value
) == 4)))
8314 /* Value is either a single image specification or a vector
8315 of 4 such specifications for the different button states. */
8316 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8317 else if (EQ (ikey
, QCrtl
))
8319 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8325 /* Try to make one from caption and key. */
8326 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8327 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8328 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8329 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8331 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8332 char *buf
= xmalloc_atomic (max_lbl
+ 1);
8333 Lisp_Object new_lbl
;
8334 ptrdiff_t caption_len
= strlen (capt
);
8336 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8339 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8341 buf
[caption_len
] = '\0';
8345 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8349 strcpy (buf
, label
);
8351 for (j
= 0; buf
[j
] != '\0'; ++j
)
8359 new_lbl
= Fupcase_initials (build_string (label
));
8360 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8361 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8363 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8367 /* If got a filter apply it on binding. */
8369 set_prop (TOOL_BAR_ITEM_BINDING
,
8370 (menu_item_eval_property
8373 PROP (TOOL_BAR_ITEM_BINDING
))))));
8375 /* See if the binding is a keymap. Give up if it is. */
8376 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8379 /* Enable or disable selection of item. */
8380 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8381 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8382 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8384 /* Handle radio buttons or toggle boxes. */
8385 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8386 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8387 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8395 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8396 that can be reused. */
8399 init_tool_bar_items (Lisp_Object reuse
)
8401 if (VECTORP (reuse
))
8402 tool_bar_items_vector
= reuse
;
8404 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8405 ntool_bar_items
= 0;
8409 /* Append parsed tool bar item properties from
8410 tool_bar_item_properties */
8413 append_tool_bar_item (void)
8417 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8419 /* Enlarge tool_bar_items_vector if necessary. */
8421 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8423 /* Append entries from tool_bar_item_properties to the end of
8424 tool_bar_items_vector. */
8425 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8426 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8427 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8434 /* Read a character using menus based on the keymap MAP.
8435 Return nil if there are no menus in the maps.
8436 Return t if we displayed a menu but the user rejected it.
8438 PREV_EVENT is the previous input event, or nil if we are reading
8439 the first event of a key sequence.
8441 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8442 if we used a mouse menu to read the input, or false otherwise. If
8443 USED_MOUSE_MENU is null, don't dereference it.
8445 The prompting is done based on the prompt-string of the map
8446 and the strings associated with various map elements.
8448 This can be done with X menus or with menus put in the minibuf.
8449 These are done in different ways, depending on how the input will be read.
8450 Menus using X are done after auto-saving in read-char, getting the input
8451 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8452 and do auto-saving in the inner call of read_char. */
8455 read_char_x_menu_prompt (Lisp_Object map
,
8456 Lisp_Object prev_event
, bool *used_mouse_menu
)
8458 if (used_mouse_menu
)
8459 *used_mouse_menu
= 0;
8461 /* Use local over global Menu maps. */
8463 if (! menu_prompting
)
8466 /* If we got to this point via a mouse click,
8467 use a real menu for mouse selection. */
8468 if (EVENT_HAS_PARAMETERS (prev_event
)
8469 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8470 && !EQ (XCAR (prev_event
), Qtool_bar
))
8472 /* Display the menu and get the selection. */
8475 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8480 record_menu_key (XCAR (value
));
8482 /* If we got multiple events, unread all but
8484 There is no way to prevent those unread events
8485 from showing up later in last_nonmenu_event.
8486 So turn symbol and integer events into lists,
8487 to indicate that they came from a mouse menu,
8488 so that when present in last_nonmenu_event
8489 they won't confuse things. */
8490 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8492 record_menu_key (XCAR (tem
));
8493 if (SYMBOLP (XCAR (tem
))
8494 || INTEGERP (XCAR (tem
)))
8495 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8498 /* If we got more than one event, put all but the first
8499 onto this list to be read later.
8500 Return just the first event now. */
8501 Vunread_command_events
8502 = nconc2 (XCDR (value
), Vunread_command_events
);
8503 value
= XCAR (value
);
8505 else if (NILP (value
))
8507 if (used_mouse_menu
)
8508 *used_mouse_menu
= 1;
8515 read_char_minibuf_menu_prompt (int commandflag
,
8518 register Lisp_Object name
;
8520 /* FIXME: Use the minibuffer's frame width. */
8521 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8523 bool nobindings
= 1;
8524 Lisp_Object rest
, vector
;
8525 Lisp_Object prompt_strings
= Qnil
;
8529 if (! menu_prompting
)
8532 map
= get_keymap (map
, 0, 1);
8533 name
= Fkeymap_prompt (map
);
8535 /* If we don't have any menus, just read a character normally. */
8536 if (!STRINGP (name
))
8539 #define PUSH_C_STR(str, listvar) \
8540 listvar = Fcons (build_unibyte_string (str), listvar)
8542 /* Prompt string always starts with map's prompt, and a space. */
8543 prompt_strings
= Fcons (name
, prompt_strings
);
8544 PUSH_C_STR (": ", prompt_strings
);
8545 nlength
= SCHARS (name
) + 2;
8549 /* Present the documented bindings, a line at a time. */
8553 Lisp_Object menu_strings
= prompt_strings
;
8554 ptrdiff_t i
= nlength
;
8556 Lisp_Object orig_defn_macro
;
8558 /* Loop over elements of map. */
8563 /* FIXME: Use map_keymap to handle new keymap formats. */
8565 /* At end of map, wrap around if just starting,
8566 or end this line if already have something on it. */
8569 if (notfirst
|| nobindings
)
8575 /* Look at the next element of the map. */
8577 elt
= AREF (vector
, idx
);
8579 elt
= Fcar_safe (rest
);
8581 if (idx
< 0 && VECTORP (elt
))
8583 /* If we found a dense table in the keymap,
8584 advanced past it, but start scanning its contents. */
8585 rest
= Fcdr_safe (rest
);
8591 /* An ordinary element. */
8592 Lisp_Object event
, tem
;
8596 event
= Fcar_safe (elt
); /* alist */
8597 elt
= Fcdr_safe (elt
);
8601 XSETINT (event
, idx
); /* vector */
8604 /* Ignore the element if it has no prompt string. */
8605 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8607 /* True if the char to type matches the string. */
8609 Lisp_Object upcased_event
, downcased_event
;
8610 Lisp_Object desc
= Qnil
;
8612 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8614 upcased_event
= Fupcase (event
);
8615 downcased_event
= Fdowncase (event
);
8616 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8617 || XINT (downcased_event
) == SREF (s
, 0));
8619 desc
= Fsingle_key_description (event
, Qnil
);
8621 #if 0 /* It is redundant to list the equivalent key bindings because
8622 the prefix is what the user has already typed. */
8624 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8626 /* Insert equivalent keybinding. */
8627 s
= concat2 (s
, tem
);
8630 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8631 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8633 /* Insert button prefix. */
8634 Lisp_Object selected
8635 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8636 if (EQ (tem
, QCradio
))
8637 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8639 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8640 s
= concat2 (tem
, s
);
8644 /* If we have room for the prompt string, add it to this line.
8645 If this is the first on the line, always add it. */
8646 if ((SCHARS (s
) + i
+ 2
8647 + (char_matches
? 0 : SCHARS (desc
) + 3))
8651 ptrdiff_t thiswidth
;
8653 /* Punctuate between strings. */
8656 PUSH_C_STR (", ", menu_strings
);
8662 /* If the char to type doesn't match the string's
8663 first char, explicitly show what char to type. */
8666 /* Add as much of string as fits. */
8667 thiswidth
= min (SCHARS (desc
), width
- i
);
8669 = Fcons (Fsubstring (desc
, make_number (0),
8670 make_number (thiswidth
)),
8673 PUSH_C_STR (" = ", menu_strings
);
8677 /* Add as much of string as fits. */
8678 thiswidth
= min (SCHARS (s
), width
- i
);
8680 = Fcons (Fsubstring (s
, make_number (0),
8681 make_number (thiswidth
)),
8687 /* If this element does not fit, end the line now,
8688 and save the element for the next line. */
8689 PUSH_C_STR ("...", menu_strings
);
8694 /* Move past this element. */
8695 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8696 /* Handle reaching end of dense table. */
8701 rest
= Fcdr_safe (rest
);
8705 /* Prompt with that and read response. */
8706 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8708 /* Make believe it's not a keyboard macro in case the help char
8709 is pressed. Help characters are not recorded because menu prompting
8710 is not used on replay. */
8711 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8712 kset_defining_kbd_macro (current_kboard
, Qnil
);
8714 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8715 while (BUFFERP (obj
));
8716 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8718 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8721 if (! EQ (obj
, menu_prompt_more_char
)
8722 && (!INTEGERP (menu_prompt_more_char
)
8723 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8725 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8726 store_kbd_macro_char (obj
);
8729 /* Help char - go round again. */
8733 /* Reading key sequences. */
8736 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8738 return access_keymap (get_keymap (keymap
, 0, 1),
8743 active_maps (Lisp_Object first_event
)
8745 Lisp_Object position
8746 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8747 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8750 /* Structure used to keep track of partial application of key remapping
8751 such as Vfunction_key_map and Vkey_translation_map. */
8752 typedef struct keyremap
8754 /* This is the map originally specified for this use. */
8756 /* This is a submap reached by looking up, in PARENT,
8757 the events from START to END. */
8759 /* Positions [START, END) in the key sequence buffer
8760 are the key that we have scanned so far.
8761 Those events are the ones that we will replace
8762 if PARENT maps them into a key sequence. */
8766 /* Lookup KEY in MAP.
8767 MAP is a keymap mapping keys to key vectors or functions.
8768 If the mapping is a function and DO_FUNCALL is true,
8769 the function is called with PROMPT as parameter and its return
8770 value is used as the return value of this function (after checking
8771 that it is indeed a vector). */
8774 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8779 next
= access_keymap (map
, key
, 1, 0, 1);
8781 /* Handle a symbol whose function definition is a keymap
8783 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8784 && (ARRAYP (SYMBOL_FUNCTION (next
))
8785 || KEYMAPP (SYMBOL_FUNCTION (next
))))
8786 next
= Fautoload_do_load (SYMBOL_FUNCTION (next
),
8789 /* If the keymap gives a function, not an
8790 array, then call the function with one arg and use
8791 its value instead. */
8792 if (do_funcall
&& FUNCTIONP (next
))
8797 next
= call1 (next
, prompt
);
8798 /* If the function returned something invalid,
8799 barf--don't ignore it.
8800 (To ignore it safely, we would need to gcpro a bunch of
8801 other variables.) */
8802 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8803 error ("Function %s returns invalid key sequence",
8804 SSDATA (SYMBOL_NAME (tem
)));
8809 /* Do one step of the key remapping used for function-key-map and
8810 key-translation-map:
8811 KEYBUF is the buffer holding the input events.
8812 BUFSIZE is its maximum size.
8813 FKEY is a pointer to the keyremap structure to use.
8814 INPUT is the index of the last element in KEYBUF.
8815 DOIT if true says that the remapping can actually take place.
8816 DIFF is used to return the number of keys added/removed by the remapping.
8817 PARENT is the root of the keymap.
8818 PROMPT is the prompt to use if the remapping happens through a function.
8819 Return true if the remapping actually took place. */
8822 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8823 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8825 Lisp_Object next
, key
;
8827 key
= keybuf
[fkey
->end
++];
8829 if (KEYMAPP (fkey
->parent
))
8830 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8834 /* If keybuf[fkey->start..fkey->end] is bound in the
8835 map and we're in a position to do the key remapping, replace it with
8836 the binding and restart with fkey->start at the end. */
8837 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8839 int len
= XFASTINT (Flength (next
));
8842 *diff
= len
- (fkey
->end
- fkey
->start
);
8844 if (bufsize
- input
<= *diff
)
8845 error ("Key sequence too long");
8847 /* Shift the keys that follow fkey->end. */
8849 for (i
= fkey
->end
; i
< input
; i
++)
8850 keybuf
[i
+ *diff
] = keybuf
[i
];
8852 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8853 keybuf
[i
+ *diff
] = keybuf
[i
];
8854 /* Overwrite the old keys with the new ones. */
8855 for (i
= 0; i
< len
; i
++)
8856 keybuf
[fkey
->start
+ i
]
8857 = Faref (next
, make_number (i
));
8859 fkey
->start
= fkey
->end
+= *diff
;
8860 fkey
->map
= fkey
->parent
;
8865 fkey
->map
= get_keymap (next
, 0, 1);
8867 /* If we no longer have a bound suffix, try a new position for
8869 if (!CONSP (fkey
->map
))
8871 fkey
->end
= ++fkey
->start
;
8872 fkey
->map
= fkey
->parent
;
8878 test_undefined (Lisp_Object binding
)
8880 return (NILP (binding
)
8881 || EQ (binding
, Qundefined
)
8882 || (SYMBOLP (binding
)
8883 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8886 /* Read a sequence of keys that ends with a non prefix character,
8887 storing it in KEYBUF, a buffer of size BUFSIZE.
8889 Return the length of the key sequence stored.
8890 Return -1 if the user rejected a command menu.
8892 Echo starting immediately unless `prompt' is 0.
8894 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8895 read_char with a suitable COMMANDFLAG argument.
8897 Where a key sequence ends depends on the currently active keymaps.
8898 These include any minor mode keymaps active in the current buffer,
8899 the current buffer's local map, and the global map.
8901 If a key sequence has no other bindings, we check Vfunction_key_map
8902 to see if some trailing subsequence might be the beginning of a
8903 function key's sequence. If so, we try to read the whole function
8904 key, and substitute its symbolic name into the key sequence.
8906 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8907 `double-' events into similar click events, if that would make them
8908 bound. We try to turn `triple-' events first into `double-' events,
8911 If we get a mouse click in a mode line, vertical divider, or other
8912 non-text area, we treat the click as if it were prefixed by the
8913 symbol denoting that area - `mode-line', `vertical-line', or
8916 If the sequence starts with a mouse click, we read the key sequence
8917 with respect to the buffer clicked on, not the current buffer.
8919 If the user switches frames in the midst of a key sequence, we put
8920 off the switch-frame event until later; the next call to
8921 read_char will return it.
8923 If FIX_CURRENT_BUFFER, we restore current_buffer
8924 from the selected window's buffer. */
8927 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8928 bool dont_downcase_last
, bool can_return_switch_frame
,
8929 bool fix_current_buffer
, bool prevent_redisplay
)
8931 /* How many keys there are in the current key sequence. */
8934 /* The length of the echo buffer when we started reading, and
8935 the length of this_command_keys when we started reading. */
8936 ptrdiff_t echo_start
IF_LINT (= 0);
8937 ptrdiff_t keys_start
;
8939 Lisp_Object current_binding
= Qnil
;
8940 Lisp_Object first_event
= Qnil
;
8942 /* Index of the first key that has no binding.
8943 It is useless to try fkey.start larger than that. */
8946 /* If t < mock_input, then KEYBUF[t] should be read as the next
8949 We use this to recover after recognizing a function key. Once we
8950 realize that a suffix of the current key sequence is actually a
8951 function key's escape sequence, we replace the suffix with the
8952 function key's binding from Vfunction_key_map. Now keybuf
8953 contains a new and different key sequence, so the echo area,
8954 this_command_keys, and the submaps and defs arrays are wrong. In
8955 this situation, we set mock_input to t, set t to 0, and jump to
8956 restart_sequence; the loop will read keys from keybuf up until
8957 mock_input, thus rebuilding the state; and then it will resume
8958 reading characters from the keyboard. */
8961 /* If the sequence is unbound in submaps[], then
8962 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8963 and fkey.map is its binding.
8965 These might be > t, indicating that all function key scanning
8966 should hold off until t reaches them. We do this when we've just
8967 recognized a function key, to avoid searching for the function
8968 key's again in Vfunction_key_map. */
8971 /* Likewise, for key_translation_map and input-decode-map. */
8972 keyremap keytran
, indec
;
8974 /* True if we are trying to map a key by changing an upper-case
8975 letter to lower case, or a shifted function key to an unshifted
8977 bool shift_translated
= 0;
8979 /* If we receive a `switch-frame' or `select-window' event in the middle of
8980 a key sequence, we put it off for later.
8981 While we're reading, we keep the event here. */
8982 Lisp_Object delayed_switch_frame
;
8984 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8985 int original_uppercase_position
= -1;
8987 /* Gets around Microsoft compiler limitations. */
8990 struct buffer
*starting_buffer
;
8992 /* List of events for which a fake prefix key has been generated. */
8993 Lisp_Object fake_prefixed_keys
= Qnil
;
8995 struct gcpro gcpro1
;
8999 GCPRO1 (fake_prefixed_keys
);
9000 raw_keybuf_count
= 0;
9002 last_nonmenu_event
= Qnil
;
9004 delayed_switch_frame
= Qnil
;
9010 /* Install the string PROMPT as the beginning of the string
9011 of echoing, so that it serves as a prompt for the next
9013 kset_echo_string (current_kboard
, prompt
);
9014 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9017 else if (cursor_in_echo_area
9018 && echo_keystrokes_p ())
9019 /* This doesn't put in a dash if the echo buffer is empty, so
9020 you don't always see a dash hanging out in the minibuffer. */
9024 /* Record the initial state of the echo area and this_command_keys;
9025 we will need to restore them if we replay a key sequence. */
9027 echo_start
= echo_length ();
9028 keys_start
= this_command_key_count
;
9029 this_single_command_key_start
= keys_start
;
9031 /* We jump here when we need to reinitialize fkey and keytran; this
9032 happens if we switch keyboards between rescans. */
9033 replay_entire_sequence
:
9035 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9036 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9037 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9038 indec
.start
= indec
.end
= 0;
9039 fkey
.start
= fkey
.end
= 0;
9040 keytran
.start
= keytran
.end
= 0;
9042 /* We jump here when the key sequence has been thoroughly changed, and
9043 we need to rescan it starting from the beginning. When we jump here,
9044 keybuf[0..mock_input] holds the sequence we should reread. */
9047 starting_buffer
= current_buffer
;
9048 first_unbound
= bufsize
+ 1;
9050 /* Build our list of keymaps.
9051 If we recognize a function key and replace its escape sequence in
9052 keybuf with its symbol, or if the sequence starts with a mouse
9053 click and we need to switch buffers, we jump back here to rebuild
9054 the initial keymaps from the current buffer. */
9055 current_binding
= active_maps (first_event
);
9057 /* Start from the beginning in keybuf. */
9060 /* These are no-ops the first time through, but if we restart, they
9061 revert the echo area and this_command_keys to their original state. */
9062 this_command_key_count
= keys_start
;
9063 if (INTERACTIVE
&& t
< mock_input
)
9064 echo_truncate (echo_start
);
9066 /* If the best binding for the current key sequence is a keymap, or
9067 we may be looking at a function key's escape sequence, keep on
9069 while (!NILP (current_binding
)
9070 /* Keep reading as long as there's a prefix binding. */
9071 ? KEYMAPP (current_binding
)
9072 /* Don't return in the middle of a possible function key sequence,
9073 if the only bindings we found were via case conversion.
9074 Thus, if ESC O a has a function-key-map translation
9075 and ESC o has a binding, don't return after ESC O,
9076 so that we can translate ESC O plus the next character. */
9077 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9080 bool used_mouse_menu
= 0;
9082 /* Where the last real key started. If we need to throw away a
9083 key that has expanded into more than one element of keybuf
9084 (say, a mouse click on the mode line which is being treated
9085 as [mode-line (mouse-...)], then we backtrack to this point
9087 int last_real_key_start
;
9089 /* These variables are analogous to echo_start and keys_start;
9090 while those allow us to restart the entire key sequence,
9091 echo_local_start and keys_local_start allow us to throw away
9093 ptrdiff_t echo_local_start
IF_LINT (= 0);
9094 int keys_local_start
;
9095 Lisp_Object new_binding
;
9097 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9098 eassert (indec
.start
<= indec
.end
);
9099 eassert (fkey
.start
<= fkey
.end
);
9100 eassert (keytran
.start
<= keytran
.end
);
9101 /* key-translation-map is applied *after* function-key-map
9102 which is itself applied *after* input-decode-map. */
9103 eassert (fkey
.end
<= indec
.start
);
9104 eassert (keytran
.end
<= fkey
.start
);
9106 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9107 first_unbound
< keytran
.start
)
9108 { /* The prefix upto first_unbound has no binding and has
9109 no translation left to do either, so we know it's unbound.
9110 If we don't stop now, we risk staying here indefinitely
9111 (if the user keeps entering fkey or keytran prefixes
9112 like C-c ESC ESC ESC ESC ...) */
9114 for (i
= first_unbound
+ 1; i
< t
; i
++)
9115 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9116 mock_input
= t
- first_unbound
- 1;
9117 indec
.end
= indec
.start
-= first_unbound
+ 1;
9118 indec
.map
= indec
.parent
;
9119 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9120 fkey
.map
= fkey
.parent
;
9121 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9122 keytran
.map
= keytran
.parent
;
9123 goto replay_sequence
;
9127 error ("Key sequence too long");
9130 echo_local_start
= echo_length ();
9131 keys_local_start
= this_command_key_count
;
9134 /* These are no-ops, unless we throw away a keystroke below and
9135 jumped back up to replay_key; in that case, these restore the
9136 variables to their original state, allowing us to replay the
9138 if (INTERACTIVE
&& t
< mock_input
)
9139 echo_truncate (echo_local_start
);
9140 this_command_key_count
= keys_local_start
;
9142 /* By default, assume each event is "real". */
9143 last_real_key_start
= t
;
9145 /* Does mock_input indicate that we are re-reading a key sequence? */
9149 add_command_key (key
);
9150 if (echo_keystrokes_p ()
9151 && current_kboard
->immediate_echo
)
9158 /* If not, we should actually read a character. */
9162 KBOARD
*interrupted_kboard
= current_kboard
;
9163 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9164 /* Calling read_char with COMMANDFLAG = -2 avoids
9165 redisplay in read_char and its subroutines. */
9166 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9167 current_binding
, last_nonmenu_event
,
9168 &used_mouse_menu
, NULL
);
9169 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9170 /* When switching to a new tty (with a new keyboard),
9171 read_char returns the new buffer, rather than -2
9172 (Bug#5095). This is because `terminal-init-xterm'
9173 calls read-char, which eats the wrong_kboard_jmpbuf
9174 return. Any better way to fix this? -- cyd */
9175 || (interrupted_kboard
!= current_kboard
))
9180 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9181 if (k
== interrupted_kboard
)
9186 /* Don't touch interrupted_kboard when it's been
9188 delayed_switch_frame
= Qnil
;
9189 goto replay_entire_sequence
;
9192 if (!NILP (delayed_switch_frame
))
9195 (interrupted_kboard
,
9196 Fcons (delayed_switch_frame
,
9197 KVAR (interrupted_kboard
, kbd_queue
)));
9198 delayed_switch_frame
= Qnil
;
9203 (interrupted_kboard
,
9204 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9206 /* If the side queue is non-empty, ensure it begins with a
9207 switch-frame, so we'll replay it in the right context. */
9208 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9209 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9210 !(EVENT_HAS_PARAMETERS (key
)
9211 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9215 XSETFRAME (frame
, interrupted_frame
);
9217 (interrupted_kboard
,
9218 Fcons (make_lispy_switch_frame (frame
),
9219 KVAR (interrupted_kboard
, kbd_queue
)));
9222 goto replay_entire_sequence
;
9226 /* read_char returns t when it shows a menu and the user rejects it.
9235 /* read_char returns -1 at the end of a macro.
9236 Emacs 18 handles this by returning immediately with a
9237 zero, so that's what we'll do. */
9238 if (INTEGERP (key
) && XINT (key
) == -1)
9241 /* The Microsoft C compiler can't handle the goto that
9247 /* If the current buffer has been changed from under us, the
9248 keymap may have changed, so replay the sequence. */
9251 timer_resume_idle ();
9254 /* Reset the current buffer from the selected window
9255 in case something changed the former and not the latter.
9256 This is to be more consistent with the behavior
9257 of the command_loop_1. */
9258 if (fix_current_buffer
)
9260 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9262 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9264 Fset_buffer (XWINDOW (selected_window
)->contents
);
9267 goto replay_sequence
;
9270 /* If we have a quit that was typed in another frame, and
9271 quit_throw_to_read_char switched buffers,
9272 replay to get the right keymap. */
9274 && XINT (key
) == quit_char
9275 && current_buffer
!= starting_buffer
)
9278 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9283 goto replay_sequence
;
9288 if (EVENT_HAS_PARAMETERS (key
)
9289 /* Either a `switch-frame' or a `select-window' event. */
9290 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9292 /* If we're at the beginning of a key sequence, and the caller
9293 says it's okay, go ahead and return this event. If we're
9294 in the midst of a key sequence, delay it until the end. */
9295 if (t
> 0 || !can_return_switch_frame
)
9297 delayed_switch_frame
= key
;
9302 if (NILP (first_event
))
9305 /* Even if first_event does not specify a particular
9306 window/position, it's important to recompute the maps here
9307 since a long time might have passed since we entered
9308 read_key_sequence, and a timer (or process-filter or
9309 special-event-map, ...) might have switched the current buffer
9310 or the selected window from under us in the mean time. */
9311 if (fix_current_buffer
9312 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9314 Fset_buffer (XWINDOW (selected_window
)->contents
);
9315 current_binding
= active_maps (first_event
);
9319 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9323 /* Clicks in non-text areas get prefixed by the symbol
9324 in their CHAR-ADDRESS field. For example, a click on
9325 the mode line is prefixed by the symbol `mode-line'.
9327 Furthermore, key sequences beginning with mouse clicks
9328 are read using the keymaps of the buffer clicked on, not
9329 the current buffer. So we may have to switch the buffer
9332 When we turn one event into two events, we must make sure
9333 that neither of the two looks like the original--so that,
9334 if we replay the events, they won't be expanded again.
9335 If not for this, such reexpansion could happen either here
9336 or when user programs play with this-command-keys. */
9337 if (EVENT_HAS_PARAMETERS (key
))
9339 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9340 if (EQ (kind
, Qmouse_click
))
9342 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9343 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9346 || (!NILP (fake_prefixed_keys
)
9347 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9349 /* We're looking a second time at an event for which
9350 we generated a fake prefix key. Set
9351 last_real_key_start appropriately. */
9353 last_real_key_start
= t
- 1;
9356 if (last_real_key_start
== 0)
9358 /* Key sequences beginning with mouse clicks are
9359 read using the keymaps in the buffer clicked on,
9360 not the current buffer. If we're at the
9361 beginning of a key sequence, switch buffers. */
9362 if (WINDOWP (window
)
9363 && BUFFERP (XWINDOW (window
)->contents
)
9364 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9366 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9371 /* Arrange to go back to the original buffer once we're
9372 done reading the key sequence. Note that we can't
9373 use save_excursion_{save,restore} here, because they
9374 save point as well as the current buffer; we don't
9375 want to save point, because redisplay may change it,
9376 to accommodate a Fset_window_start or something. We
9377 don't want to do this at the top of the function,
9378 because we may get input from a subprocess which
9379 wants to change the selected window and stuff (say,
9381 record_unwind_current_buffer ();
9383 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9385 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9386 goto replay_sequence
;
9390 /* Expand mode-line and scroll-bar events into two events:
9391 use posn as a fake prefix key. */
9393 && (NILP (fake_prefixed_keys
)
9394 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9396 if (bufsize
- t
<= 1)
9397 error ("Key sequence too long");
9400 keybuf
[t
+ 1] = key
;
9403 /* Record that a fake prefix key has been generated
9404 for KEY. Don't modify the event; this would
9405 prevent proper action when the event is pushed
9406 back into unread-command-events. */
9407 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9411 else if (CONSP (XCDR (key
))
9412 && CONSP (EVENT_START (key
))
9413 && CONSP (XCDR (EVENT_START (key
))))
9417 posn
= POSN_POSN (EVENT_START (key
));
9418 /* Handle menu-bar events:
9419 insert the dummy prefix event `menu-bar'. */
9420 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9422 if (bufsize
- t
<= 1)
9423 error ("Key sequence too long");
9425 keybuf
[t
+ 1] = key
;
9427 /* Zap the position in key, so we know that we've
9428 expanded it, and don't try to do so again. */
9429 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9432 goto replay_sequence
;
9434 else if (CONSP (posn
))
9436 /* We're looking at the second event of a
9437 sequence which we expanded before. Set
9438 last_real_key_start appropriately. */
9439 if (last_real_key_start
== t
&& t
> 0)
9440 last_real_key_start
= t
- 1;
9445 /* We have finally decided that KEY is something we might want
9447 new_binding
= follow_key (current_binding
, key
);
9449 /* If KEY wasn't bound, we'll try some fallbacks. */
9450 if (!NILP (new_binding
))
9451 /* This is needed for the following scenario:
9452 event 0: a down-event that gets dropped by calling replay_key.
9453 event 1: some normal prefix like C-h.
9454 After event 0, first_unbound is 0, after event 1 indec.start,
9455 fkey.start, and keytran.start are all 1, so when we see that
9456 C-h is bound, we need to update first_unbound. */
9457 first_unbound
= max (t
+ 1, first_unbound
);
9462 /* Remember the position to put an upper bound on indec.start. */
9463 first_unbound
= min (t
, first_unbound
);
9465 head
= EVENT_HEAD (key
);
9469 Lisp_Object breakdown
;
9472 breakdown
= parse_modifiers (head
);
9473 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9474 /* Attempt to reduce an unbound mouse event to a simpler
9475 event that is bound:
9476 Drags reduce to clicks.
9477 Double-clicks reduce to clicks.
9478 Triple-clicks reduce to double-clicks, then to clicks.
9479 Down-clicks are eliminated.
9480 Double-downs reduce to downs, then are eliminated.
9481 Triple-downs reduce to double-downs, then to downs,
9482 then are eliminated. */
9483 if (modifiers
& (down_modifier
| drag_modifier
9484 | double_modifier
| triple_modifier
))
9486 while (modifiers
& (down_modifier
| drag_modifier
9487 | double_modifier
| triple_modifier
))
9489 Lisp_Object new_head
, new_click
;
9490 if (modifiers
& triple_modifier
)
9491 modifiers
^= (double_modifier
| triple_modifier
);
9492 else if (modifiers
& double_modifier
)
9493 modifiers
&= ~double_modifier
;
9494 else if (modifiers
& drag_modifier
)
9495 modifiers
&= ~drag_modifier
;
9498 /* Dispose of this `down' event by simply jumping
9499 back to replay_key, to get another event.
9501 Note that if this event came from mock input,
9502 then just jumping back to replay_key will just
9503 hand it to us again. So we have to wipe out any
9506 We could delete keybuf[t] and shift everything
9507 after that to the left by one spot, but we'd also
9508 have to fix up any variable that points into
9509 keybuf, and shifting isn't really necessary
9512 Adding prefixes for non-textual mouse clicks
9513 creates two characters of mock input, and both
9514 must be thrown away. If we're only looking at
9515 the prefix now, we can just jump back to
9516 replay_key. On the other hand, if we've already
9517 processed the prefix, and now the actual click
9518 itself is giving us trouble, then we've lost the
9519 state of the keymaps we want to backtrack to, and
9520 we need to replay the whole sequence to rebuild
9523 Beyond that, only function key expansion could
9524 create more than two keys, but that should never
9525 generate mouse events, so it's okay to zero
9526 mock_input in that case too.
9528 FIXME: The above paragraph seems just plain
9529 wrong, if you consider things like
9530 xterm-mouse-mode. -stef
9532 Isn't this just the most wonderful code ever? */
9534 /* If mock_input > t + 1, the above simplification
9535 will actually end up dropping keys on the floor.
9536 This is probably OK for now, but even
9537 if mock_input <= t + 1, we need to adjust indec,
9539 Typical case [header-line down-mouse-N]:
9540 mock_input = 2, t = 1, fkey.end = 1,
9541 last_real_key_start = 0. */
9542 if (indec
.end
> last_real_key_start
)
9544 indec
.end
= indec
.start
9545 = min (last_real_key_start
, indec
.start
);
9546 indec
.map
= indec
.parent
;
9547 if (fkey
.end
> last_real_key_start
)
9549 fkey
.end
= fkey
.start
9550 = min (last_real_key_start
, fkey
.start
);
9551 fkey
.map
= fkey
.parent
;
9552 if (keytran
.end
> last_real_key_start
)
9554 keytran
.end
= keytran
.start
9555 = min (last_real_key_start
, keytran
.start
);
9556 keytran
.map
= keytran
.parent
;
9560 if (t
== last_real_key_start
)
9567 mock_input
= last_real_key_start
;
9568 goto replay_sequence
;
9573 = apply_modifiers (modifiers
, XCAR (breakdown
));
9574 new_click
= list2 (new_head
, EVENT_START (key
));
9576 /* Look for a binding for this new key. */
9577 new_binding
= follow_key (current_binding
, new_click
);
9579 /* If that click is bound, go for it. */
9580 if (!NILP (new_binding
))
9582 current_binding
= new_binding
;
9586 /* Otherwise, we'll leave key set to the drag event. */
9591 current_binding
= new_binding
;
9594 /* Normally, last_nonmenu_event gets the previous key we read.
9595 But when a mouse popup menu is being used,
9596 we don't update last_nonmenu_event; it continues to hold the mouse
9597 event that preceded the first level of menu. */
9598 if (!used_mouse_menu
)
9599 last_nonmenu_event
= key
;
9601 /* Record what part of this_command_keys is the current key sequence. */
9602 this_single_command_key_start
= this_command_key_count
- t
;
9604 /* Look for this sequence in input-decode-map.
9605 Scan from indec.end until we find a bound suffix. */
9606 while (indec
.end
< t
)
9608 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9612 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9613 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9618 mock_input
= diff
+ max (t
, mock_input
);
9619 goto replay_sequence
;
9623 if (!KEYMAPP (current_binding
)
9624 && !test_undefined (current_binding
)
9625 && indec
.start
>= t
)
9626 /* There is a binding and it's not a prefix.
9627 (and it doesn't have any input-decode-map translation pending).
9628 There is thus no function-key in this sequence.
9629 Moving fkey.start is important in this case to allow keytran.start
9630 to go over the sequence before we return (since we keep the
9631 invariant that keytran.end <= fkey.start). */
9634 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9637 /* If the sequence is unbound, see if we can hang a function key
9638 off the end of it. */
9639 /* Continue scan from fkey.end until we find a bound suffix. */
9640 while (fkey
.end
< indec
.start
)
9642 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9646 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9647 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9648 max (t
, mock_input
),
9649 /* If there's a binding (i.e.
9650 first_binding >= nmaps) we don't want
9651 to apply this function-key-mapping. */
9653 && (test_undefined (current_binding
)),
9658 mock_input
= diff
+ max (t
, mock_input
);
9659 /* Adjust the input-decode-map counters. */
9661 indec
.start
+= diff
;
9663 goto replay_sequence
;
9667 /* Look for this sequence in key-translation-map.
9668 Scan from keytran.end until we find a bound suffix. */
9669 while (keytran
.end
< fkey
.start
)
9671 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9675 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9676 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9681 mock_input
= diff
+ max (t
, mock_input
);
9682 /* Adjust the function-key-map and input-decode-map counters. */
9684 indec
.start
+= diff
;
9688 goto replay_sequence
;
9692 /* If KEY is not defined in any of the keymaps,
9693 and cannot be part of a function key or translation,
9694 and is an upper case letter
9695 use the corresponding lower-case letter instead. */
9696 if (NILP (current_binding
)
9697 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9699 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9700 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9701 || (XINT (key
) & shift_modifier
)))
9703 Lisp_Object new_key
;
9705 original_uppercase
= key
;
9706 original_uppercase_position
= t
- 1;
9708 if (XINT (key
) & shift_modifier
)
9709 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9711 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9712 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9714 /* We have to do this unconditionally, regardless of whether
9715 the lower-case char is defined in the keymaps, because they
9716 might get translated through function-key-map. */
9717 keybuf
[t
- 1] = new_key
;
9718 mock_input
= max (t
, mock_input
);
9719 shift_translated
= 1;
9721 goto replay_sequence
;
9724 if (NILP (current_binding
)
9725 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9727 read_key_sequence_cmd
= Vprefix_help_command
;
9728 /* The Microsoft C compiler can't handle the goto that
9734 /* If KEY is not defined in any of the keymaps,
9735 and cannot be part of a function key or translation,
9736 and is a shifted function key,
9737 use the corresponding unshifted function key instead. */
9738 if (NILP (current_binding
)
9739 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9741 Lisp_Object breakdown
= parse_modifiers (key
);
9743 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9745 if (modifiers
& shift_modifier
9746 /* Treat uppercase keys as shifted. */
9748 && (KEY_TO_CHAR (key
)
9749 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9750 && uppercasep (KEY_TO_CHAR (key
))))
9753 = (modifiers
& shift_modifier
9754 ? apply_modifiers (modifiers
& ~shift_modifier
,
9756 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9758 original_uppercase
= key
;
9759 original_uppercase_position
= t
- 1;
9761 /* We have to do this unconditionally, regardless of whether
9762 the lower-case char is defined in the keymaps, because they
9763 might get translated through function-key-map. */
9764 keybuf
[t
- 1] = new_key
;
9765 mock_input
= max (t
, mock_input
);
9766 /* Reset fkey (and consequently keytran) to apply
9767 function-key-map on the result, so that S-backspace is
9768 correctly mapped to DEL (via backspace). OTOH,
9769 input-decode-map doesn't need to go through it again. */
9770 fkey
.start
= fkey
.end
= 0;
9771 keytran
.start
= keytran
.end
= 0;
9772 shift_translated
= 1;
9774 goto replay_sequence
;
9779 read_key_sequence_cmd
= current_binding
;
9780 read_key_sequence_remapped
9781 /* Remap command through active keymaps.
9782 Do the remapping here, before the unbind_to so it uses the keymaps
9783 of the appropriate buffer. */
9784 = SYMBOLP (read_key_sequence_cmd
)
9785 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9788 unread_switch_frame
= delayed_switch_frame
;
9791 /* Don't downcase the last character if the caller says don't.
9792 Don't downcase it if the result is undefined, either. */
9793 if ((dont_downcase_last
|| NILP (current_binding
))
9795 && t
- 1 == original_uppercase_position
)
9797 keybuf
[t
- 1] = original_uppercase
;
9798 shift_translated
= 0;
9801 if (shift_translated
)
9802 Vthis_command_keys_shift_translated
= Qt
;
9804 /* Occasionally we fabricate events, perhaps by expanding something
9805 according to function-key-map, or by adding a prefix symbol to a
9806 mouse click in the scroll bar or modeline. In this cases, return
9807 the entire generated key sequence, even if we hit an unbound
9808 prefix or a definition before the end. This means that you will
9809 be able to push back the event properly, and also means that
9810 read-key-sequence will always return a logical unit.
9813 for (; t
< mock_input
; t
++)
9815 if (echo_keystrokes_p ())
9816 echo_char (keybuf
[t
]);
9817 add_command_key (keybuf
[t
]);
9825 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9826 Lisp_Object dont_downcase_last
,
9827 Lisp_Object can_return_switch_frame
,
9828 Lisp_Object cmd_loop
, bool allow_string
)
9830 Lisp_Object keybuf
[30];
9832 struct gcpro gcpro1
;
9836 CHECK_STRING (prompt
);
9839 specbind (Qinput_method_exit_on_first_char
,
9840 (NILP (cmd_loop
) ? Qt
: Qnil
));
9841 specbind (Qinput_method_use_echo_area
,
9842 (NILP (cmd_loop
) ? Qt
: Qnil
));
9844 memset (keybuf
, 0, sizeof keybuf
);
9846 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9848 if (NILP (continue_echo
))
9850 this_command_key_count
= 0;
9851 this_command_key_count_reset
= 0;
9852 this_single_command_key_start
= 0;
9855 #ifdef HAVE_WINDOW_SYSTEM
9856 if (display_hourglass_p
)
9857 cancel_hourglass ();
9860 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9861 prompt
, ! NILP (dont_downcase_last
),
9862 ! NILP (can_return_switch_frame
), 0, 0);
9864 #if 0 /* The following is fine for code reading a key sequence and
9865 then proceeding with a lengthy computation, but it's not good
9866 for code reading keys in a loop, like an input method. */
9867 #ifdef HAVE_WINDOW_SYSTEM
9868 if (display_hourglass_p
)
9879 Lisp_Object tem0
= ((allow_string
? make_event_array
: Fvector
) (i
, keybuf
));
9884 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9885 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9886 The sequence is sufficient to specify a non-prefix command in the
9887 current local and global maps.
9889 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9890 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9891 as a continuation of the previous key.
9893 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9894 convert the last event to lower case. (Normally any upper case event
9895 is converted to lower case if the original event is undefined and the lower
9896 case equivalent is defined.) A non-nil value is appropriate for reading
9897 a key sequence to be defined.
9899 A C-g typed while in this function is treated like any other character,
9900 and `quit-flag' is not set.
9902 If the key sequence starts with a mouse click, then the sequence is read
9903 using the keymaps of the buffer of the window clicked in, not the buffer
9904 of the selected window as normal.
9906 `read-key-sequence' drops unbound button-down events, since you normally
9907 only care about the click or drag events which follow them. If a drag
9908 or multi-click event is unbound, but the corresponding click event would
9909 be bound, `read-key-sequence' turns the event into a click event at the
9910 drag's starting position. This means that you don't have to distinguish
9911 between click and drag, double, or triple events unless you want to.
9913 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9914 lines separating windows, and scroll bars with imaginary keys
9915 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9917 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9918 function will process a switch-frame event if the user switches frames
9919 before typing anything. If the user switches frames in the middle of a
9920 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9921 is nil, then the event will be put off until after the current key sequence.
9923 `read-key-sequence' checks `function-key-map' for function key
9924 sequences, where they wouldn't conflict with ordinary bindings. See
9925 `function-key-map' for more details.
9927 The optional fifth argument CMD-LOOP, if non-nil, means
9928 that this key sequence is being read by something that will
9929 read commands one after another. It should be nil if the caller
9930 will read just one key sequence. */)
9931 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9933 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9934 can_return_switch_frame
, cmd_loop
, true);
9937 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9938 Sread_key_sequence_vector
, 1, 5, 0,
9939 doc
: /* Like `read-key-sequence' but always return a vector. */)
9940 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9942 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9943 can_return_switch_frame
, cmd_loop
, false);
9946 /* Return true if input events are pending. */
9949 detect_input_pending (void)
9951 return input_pending
|| get_input_pending (0);
9954 /* Return true if input events other than mouse movements are
9958 detect_input_pending_ignore_squeezables (void)
9960 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9963 /* Return true if input events are pending, and run any pending timers. */
9966 detect_input_pending_run_timers (bool do_display
)
9968 unsigned old_timers_run
= timers_run
;
9971 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9973 if (old_timers_run
!= timers_run
&& do_display
)
9974 redisplay_preserve_echo_area (8);
9976 return input_pending
;
9979 /* This is called in some cases before a possible quit.
9980 It cases the next call to detect_input_pending to recompute input_pending.
9981 So calling this function unnecessarily can't do any harm. */
9984 clear_input_pending (void)
9989 /* Return true if there are pending requeued events.
9990 This isn't used yet. The hope is to make wait_reading_process_output
9991 call it, and return if it runs Lisp code that unreads something.
9992 The problem is, kbd_buffer_get_event needs to be fixed to know what
9993 to do in that case. It isn't trivial. */
9996 requeued_events_pending_p (void)
9998 return (!NILP (Vunread_command_events
));
10001 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
10002 doc
: /* Return t if command input is currently available with no wait.
10003 Actually, the value is nil only if we can be sure that no input is available;
10004 if there is a doubt, the value is t.
10006 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
10007 (Lisp_Object check_timers
)
10009 if (!NILP (Vunread_command_events
)
10010 || !NILP (Vunread_post_input_method_events
)
10011 || !NILP (Vunread_input_method_events
))
10014 /* Process non-user-visible events (Bug#10195). */
10015 process_special_events ();
10017 return (get_input_pending ((NILP (check_timers
)
10018 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10019 | READABLE_EVENTS_FILTER_EVENTS
)
10023 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10024 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10027 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10030 if (total_keys
< NUM_RECENT_KEYS
)
10031 return Fvector (total_keys
, keys
);
10034 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10035 vcopy (val
, 0, keys
+ recent_keys_index
,
10036 NUM_RECENT_KEYS
- recent_keys_index
);
10037 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10038 keys
, recent_keys_index
);
10043 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10044 doc
: /* Return the key sequence that invoked this command.
10045 However, if the command has called `read-key-sequence', it returns
10046 the last key sequence that has been read.
10047 The value is a string or a vector.
10049 See also `this-command-keys-vector'. */)
10052 return make_event_array (this_command_key_count
,
10053 XVECTOR (this_command_keys
)->contents
);
10056 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10057 doc
: /* Return the key sequence that invoked this command, as a vector.
10058 However, if the command has called `read-key-sequence', it returns
10059 the last key sequence that has been read.
10061 See also `this-command-keys'. */)
10064 return Fvector (this_command_key_count
,
10065 XVECTOR (this_command_keys
)->contents
);
10068 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10069 Sthis_single_command_keys
, 0, 0, 0,
10070 doc
: /* Return the key sequence that invoked this command.
10071 More generally, it returns the last key sequence read, either by
10072 the command loop or by `read-key-sequence'.
10073 Unlike `this-command-keys', this function's value
10074 does not include prefix arguments.
10075 The value is always a vector. */)
10078 return Fvector (this_command_key_count
10079 - this_single_command_key_start
,
10080 (XVECTOR (this_command_keys
)->contents
10081 + this_single_command_key_start
));
10084 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10085 Sthis_single_command_raw_keys
, 0, 0, 0,
10086 doc
: /* Return the raw events that were read for this command.
10087 More generally, it returns the last key sequence read, either by
10088 the command loop or by `read-key-sequence'.
10089 Unlike `this-single-command-keys', this function's value
10090 shows the events before all translations (except for input methods).
10091 The value is always a vector. */)
10094 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10097 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10098 Sreset_this_command_lengths
, 0, 0, 0,
10099 doc
: /* Make the unread events replace the last command and echo.
10100 Used in `universal-argument-other-key'.
10102 `universal-argument-other-key' rereads the event just typed.
10103 It then gets translated through `function-key-map'.
10104 The translated event has to replace the real events,
10105 both in the value of (this-command-keys) and in echoing.
10106 To achieve this, `universal-argument-other-key' calls
10107 `reset-this-command-lengths', which discards the record of reading
10108 these events the first time. */)
10111 this_command_key_count
= before_command_key_count
;
10112 if (this_command_key_count
< this_single_command_key_start
)
10113 this_single_command_key_start
= this_command_key_count
;
10115 echo_truncate (before_command_echo_length
);
10117 /* Cause whatever we put into unread-command-events
10118 to echo as if it were being freshly read from the keyboard. */
10119 this_command_key_count_reset
= 1;
10124 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10125 Sclear_this_command_keys
, 0, 1, 0,
10126 doc
: /* Clear out the vector that `this-command-keys' returns.
10127 Also clear the record of the last 100 events, unless optional arg
10128 KEEP-RECORD is non-nil. */)
10129 (Lisp_Object keep_record
)
10133 this_command_key_count
= 0;
10134 this_command_key_count_reset
= 0;
10136 if (NILP (keep_record
))
10138 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10139 ASET (recent_keys
, i
, Qnil
);
10141 recent_keys_index
= 0;
10146 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10147 doc
: /* Return the current depth in recursive edits. */)
10151 /* Wrap around reliably on integer overflow. */
10152 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10153 XSETINT (temp
, sum
);
10157 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10158 "FOpen dribble file: ",
10159 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10160 If FILE is nil, close any open dribble file.
10161 The file will be closed when Emacs exits.
10163 Be aware that this records ALL characters you type!
10164 This may include sensitive information such as passwords. */)
10177 Lisp_Object encfile
;
10179 file
= Fexpand_file_name (file
, Qnil
);
10180 encfile
= ENCODE_FILE (file
);
10181 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10182 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10183 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10184 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10186 report_file_error ("Opening dribble", file
);
10191 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10192 doc
: /* Discard the contents of the terminal input buffer.
10193 Also end any kbd macro being defined. */)
10196 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10198 /* Discard the last command from the macro. */
10199 Fcancel_kbd_macro_events ();
10203 Vunread_command_events
= Qnil
;
10205 discard_tty_input ();
10207 kbd_fetch_ptr
= kbd_store_ptr
;
10213 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10214 doc
: /* Stop Emacs and return to superior process. You can resume later.
10215 If `cannot-suspend' is non-nil, or if the system doesn't support job
10216 control, run a subshell instead.
10218 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10219 to be read as terminal input by Emacs's parent, after suspension.
10221 Before suspending, run the normal hook `suspend-hook'.
10222 After resumption run the normal hook `suspend-resume-hook'.
10224 Some operating systems cannot stop the Emacs process and resume it later.
10225 On such systems, Emacs starts a subshell instead of suspending. */)
10226 (Lisp_Object stuffstring
)
10229 int old_height
, old_width
;
10231 struct gcpro gcpro1
;
10234 if (tty_list
&& tty_list
->next
)
10235 error ("There are other tty frames open; close them before suspending Emacs");
10237 if (!NILP (stuffstring
))
10238 CHECK_STRING (stuffstring
);
10240 /* Run the functions in suspend-hook. */
10241 hook
= intern ("suspend-hook");
10242 Frun_hooks (1, &hook
);
10244 GCPRO1 (stuffstring
);
10245 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10246 reset_all_sys_modes ();
10247 /* sys_suspend can get an error if it tries to fork a subshell
10248 and the system resources aren't available for that. */
10249 record_unwind_protect_void (init_all_sys_modes
);
10250 stuff_buffered_input (stuffstring
);
10251 if (cannot_suspend
)
10257 /* Check if terminal/window size has changed.
10258 Note that this is not useful when we are running directly
10259 with a window system; but suspend should be disabled in that case. */
10260 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10261 if (width
!= old_width
|| height
!= old_height
)
10262 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10264 /* Run suspend-resume-hook. */
10265 hook
= intern ("suspend-resume-hook");
10266 Frun_hooks (1, &hook
);
10272 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10273 Then in any case stuff anything Emacs has read ahead and not used. */
10276 stuff_buffered_input (Lisp_Object stuffstring
)
10278 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10279 register unsigned char *p
;
10281 if (STRINGP (stuffstring
))
10283 register ptrdiff_t count
;
10285 p
= SDATA (stuffstring
);
10286 count
= SBYTES (stuffstring
);
10287 while (count
-- > 0)
10292 /* Anything we have read ahead, put back for the shell to read. */
10293 /* ?? What should this do when we have multiple keyboards??
10294 Should we ignore anything that was typed in at the "wrong" kboard?
10296 rms: we should stuff everything back into the kboard
10298 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10301 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10302 kbd_fetch_ptr
= kbd_buffer
;
10303 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10304 stuff_char (kbd_fetch_ptr
->code
);
10306 clear_event (kbd_fetch_ptr
);
10310 #endif /* SIGTSTP */
10314 set_waiting_for_input (struct timespec
*time_to_clear
)
10316 input_available_clear_time
= time_to_clear
;
10318 /* Tell handle_interrupt to throw back to read_char, */
10319 waiting_for_input
= 1;
10321 /* If handle_interrupt was called before and buffered a C-g,
10322 make it run again now, to avoid timing error. */
10323 if (!NILP (Vquit_flag
))
10324 quit_throw_to_read_char (0);
10328 clear_waiting_for_input (void)
10330 /* Tell handle_interrupt not to throw back to read_char, */
10331 waiting_for_input
= 0;
10332 input_available_clear_time
= 0;
10335 /* The SIGINT handler.
10337 If we have a frame on the controlling tty, we assume that the
10338 SIGINT was generated by C-g, so we call handle_interrupt.
10339 Otherwise, tell QUIT to kill Emacs. */
10342 handle_interrupt_signal (int sig
)
10344 /* See if we have an active terminal on our controlling tty. */
10345 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10348 /* If there are no frames there, let's pretend that we are a
10349 well-behaving UN*X program and quit. We must not call Lisp
10350 in a signal handler, so tell QUIT to exit when it is
10352 Vquit_flag
= Qkill_emacs
;
10356 /* Otherwise, the SIGINT was probably generated by C-g. */
10358 /* Set internal_last_event_frame to the top frame of the
10359 controlling tty, if we have a frame there. We disable the
10360 interrupt key on secondary ttys, so the SIGINT must have come
10361 from the controlling tty. */
10362 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10364 handle_interrupt (1);
10369 deliver_interrupt_signal (int sig
)
10371 deliver_process_signal (sig
, handle_interrupt_signal
);
10375 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10376 of the number of times C-g has been requested. If C-g is pressed
10377 enough times, then quit anyway. See bug#6585. */
10378 static int volatile force_quit_count
;
10380 /* This routine is called at interrupt level in response to C-g.
10382 It is called from the SIGINT handler or kbd_buffer_store_event.
10384 If `waiting_for_input' is non zero, then unless `echoing' is
10385 nonzero, immediately throw back to read_char.
10387 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10388 eval to throw, when it gets a chance. If quit-flag is already
10389 non-nil, it stops the job right away. */
10392 handle_interrupt (bool in_signal_handler
)
10398 /* XXX This code needs to be revised for multi-tty support. */
10399 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10401 if (! in_signal_handler
)
10403 /* If SIGINT isn't blocked, don't let us be interrupted by
10404 a SIGINT. It might be harmful due to non-reentrancy
10405 in I/O functions. */
10407 sigemptyset (&blocked
);
10408 sigaddset (&blocked
, SIGINT
);
10409 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10413 reset_all_sys_modes ();
10417 * On systems which can suspend the current process and return to the original
10418 * shell, this command causes the user to end up back at the shell.
10419 * The "Auto-save" and "Abort" questions are not asked until
10420 * the user elects to return to emacs, at which point he can save the current
10421 * job and either dump core or continue.
10425 /* Perhaps should really fork an inferior shell?
10426 But that would not provide any way to get back
10427 to the original shell, ever. */
10428 printf ("No support for stopping a process on this operating system;\n");
10429 printf ("you can continue or abort.\n");
10430 #endif /* not SIGTSTP */
10432 /* We must remain inside the screen area when the internal terminal
10433 is used. Note that [Enter] is not echoed by dos. */
10434 cursor_to (SELECTED_FRAME (), 0, 0);
10436 printf ("Auto-save? (y or n) ");
10438 if (((c
= getchar ()) & ~040) == 'Y')
10440 Fdo_auto_save (Qt
, Qnil
);
10442 printf ("\r\nAuto-save done");
10443 #else /* not MSDOS */
10444 printf ("Auto-save done\n");
10445 #endif /* not MSDOS */
10447 while (c
!= '\n') c
= getchar ();
10450 printf ("\r\nAbort? (y or n) ");
10451 #else /* not MSDOS */
10452 printf ("Abort (and dump core)? (y or n) ");
10453 #endif /* not MSDOS */
10455 if (((c
= getchar ()) & ~040) == 'Y')
10457 while (c
!= '\n') c
= getchar ();
10459 printf ("\r\nContinuing...\r\n");
10460 #else /* not MSDOS */
10461 printf ("Continuing...\n");
10462 #endif /* not MSDOS */
10464 init_all_sys_modes ();
10468 /* If executing a function that wants to be interrupted out of
10469 and the user has not deferred quitting by binding `inhibit-quit'
10470 then quit right away. */
10471 if (immediate_quit
&& NILP (Vinhibit_quit
))
10473 struct gl_state_s saved
;
10474 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10476 immediate_quit
= 0;
10477 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10479 GCPRO4 (saved
.object
, saved
.global_code
,
10480 saved
.current_syntax_table
, saved
.old_prop
);
10481 Fsignal (Qquit
, Qnil
);
10486 { /* Else request quit when it's safe. */
10487 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10488 force_quit_count
= count
;
10491 immediate_quit
= 1;
10492 Vinhibit_quit
= Qnil
;
10498 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10500 /* TODO: The longjmp in this call throws the NS event loop integration off,
10501 and it seems to do fine without this. Probably some attention
10502 needs to be paid to the setting of waiting_for_input in
10503 wait_reading_process_output() under HAVE_NS because of the call
10504 to ns_select there (needed because otherwise events aren't picked up
10505 outside of polling since we don't get SIGIO like X and we don't have a
10506 separate event loop thread like W32. */
10508 if (waiting_for_input
&& !echoing
)
10509 quit_throw_to_read_char (in_signal_handler
);
10513 /* Handle a C-g by making read_char return C-g. */
10516 quit_throw_to_read_char (bool from_signal
)
10518 /* When not called from a signal handler it is safe to call
10520 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10521 Fkill_emacs (Qnil
);
10523 /* Prevent another signal from doing this before we finish. */
10524 clear_waiting_for_input ();
10527 Vunread_command_events
= Qnil
;
10529 if (FRAMEP (internal_last_event_frame
)
10530 && !EQ (internal_last_event_frame
, selected_frame
))
10531 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10534 abort_to_prompt (getctag
, SCM_EOL
);
10537 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10538 Sset_input_interrupt_mode
, 1, 1, 0,
10539 doc
: /* Set interrupt mode of reading keyboard input.
10540 If INTERRUPT is non-nil, Emacs will use input interrupts;
10541 otherwise Emacs uses CBREAK mode.
10543 See also `current-input-mode'. */)
10544 (Lisp_Object interrupt
)
10546 bool new_interrupt_input
;
10547 #ifdef USABLE_SIGIO
10548 #ifdef HAVE_X_WINDOWS
10549 if (x_display_list
!= NULL
)
10551 /* When using X, don't give the user a real choice,
10552 because we haven't implemented the mechanisms to support it. */
10553 new_interrupt_input
= 1;
10556 #endif /* HAVE_X_WINDOWS */
10557 new_interrupt_input
= !NILP (interrupt
);
10558 #else /* not USABLE_SIGIO */
10559 new_interrupt_input
= 0;
10560 #endif /* not USABLE_SIGIO */
10562 if (new_interrupt_input
!= interrupt_input
)
10564 #ifdef POLL_FOR_INPUT
10568 /* this causes startup screen to be restored and messes with the mouse */
10569 reset_all_sys_modes ();
10570 interrupt_input
= new_interrupt_input
;
10571 init_all_sys_modes ();
10573 interrupt_input
= new_interrupt_input
;
10576 #ifdef POLL_FOR_INPUT
10577 poll_suppress_count
= 1;
10584 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10585 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10586 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10587 C-q in key sequences.
10589 This setting only has an effect on tty terminals and only when
10590 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10592 See also `current-input-mode'. */)
10593 (Lisp_Object flow
, Lisp_Object terminal
)
10595 struct terminal
*t
= get_terminal (terminal
, 1);
10596 struct tty_display_info
*tty
;
10597 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10599 tty
= t
->display_info
.tty
;
10601 if (tty
->flow_control
!= !NILP (flow
))
10604 /* This causes startup screen to be restored and messes with the mouse. */
10605 reset_sys_modes (tty
);
10608 tty
->flow_control
= !NILP (flow
);
10611 init_sys_modes (tty
);
10617 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10618 doc
: /* Enable or disable 8-bit input on TERMINAL.
10619 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10620 bit as the Meta modifier.
10622 If META is nil, Emacs will ignore the top bit, on the assumption it is
10625 Otherwise, Emacs will accept and pass through 8-bit input without
10626 specially interpreting the top bit.
10628 This setting only has an effect on tty terminal devices.
10630 Optional parameter TERMINAL specifies the tty terminal device to use.
10631 It may be a terminal object, a frame, or nil for the terminal used by
10632 the currently selected frame.
10634 See also `current-input-mode'. */)
10635 (Lisp_Object meta
, Lisp_Object terminal
)
10637 struct terminal
*t
= get_terminal (terminal
, 1);
10638 struct tty_display_info
*tty
;
10641 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10643 tty
= t
->display_info
.tty
;
10647 else if (EQ (meta
, Qt
))
10652 if (tty
->meta_key
!= new_meta
)
10655 /* this causes startup screen to be restored and messes with the mouse */
10656 reset_sys_modes (tty
);
10659 tty
->meta_key
= new_meta
;
10662 init_sys_modes (tty
);
10668 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10669 doc
: /* Specify character used for quitting.
10670 QUIT must be an ASCII character.
10672 This function only has an effect on the controlling tty of the Emacs
10675 See also `current-input-mode'. */)
10678 struct terminal
*t
= get_named_tty ("/dev/tty");
10679 struct tty_display_info
*tty
;
10680 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10682 tty
= t
->display_info
.tty
;
10684 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10685 error ("QUIT must be an ASCII character");
10688 /* this causes startup screen to be restored and messes with the mouse */
10689 reset_sys_modes (tty
);
10692 /* Don't let this value be out of range. */
10693 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10696 init_sys_modes (tty
);
10702 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10703 doc
: /* Set mode of reading keyboard input.
10704 First arg INTERRUPT non-nil means use input interrupts;
10705 nil means use CBREAK mode.
10706 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10707 (no effect except in CBREAK mode).
10708 Third arg META t means accept 8-bit input (for a Meta key).
10709 META nil means ignore the top bit, on the assumption it is parity.
10710 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10711 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10712 See also `current-input-mode'. */)
10713 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10715 Fset_input_interrupt_mode (interrupt
);
10716 Fset_output_flow_control (flow
, Qnil
);
10717 Fset_input_meta_mode (meta
, Qnil
);
10719 Fset_quit_char (quit
);
10723 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10724 doc
: /* Return information about the way Emacs currently reads keyboard input.
10725 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10726 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10727 nil, Emacs is using CBREAK mode.
10728 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10729 terminal; this does not apply if Emacs uses interrupt-driven input.
10730 META is t if accepting 8-bit input with 8th bit as Meta flag.
10731 META nil means ignoring the top bit, on the assumption it is parity.
10732 META is neither t nor nil if accepting 8-bit input and using
10733 all 8 bits as the character code.
10734 QUIT is the character Emacs currently uses to quit.
10735 The elements of this list correspond to the arguments of
10736 `set-input-mode'. */)
10739 Lisp_Object val
[4];
10740 struct frame
*sf
= XFRAME (selected_frame
);
10742 val
[0] = interrupt_input
? Qt
: Qnil
;
10743 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10745 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10746 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10748 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10755 XSETFASTINT (val
[3], quit_char
);
10757 return Flist (ARRAYELTS (val
), val
);
10760 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10761 doc
: /* Return position information for pixel coordinates X and Y.
10762 By default, X and Y are relative to text area of the selected window.
10763 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10764 If optional fourth arg WHOLE is non-nil, X is relative to the left
10765 edge of the window.
10767 The return value is similar to a mouse click position:
10768 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10769 IMAGE (DX . DY) (WIDTH . HEIGHT))
10770 The `posn-' functions access elements of such lists. */)
10771 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10776 if (NILP (frame_or_window
))
10777 frame_or_window
= selected_window
;
10779 if (WINDOWP (frame_or_window
))
10781 struct window
*w
= decode_live_window (frame_or_window
);
10783 XSETINT (x
, (XINT (x
)
10784 + WINDOW_LEFT_EDGE_X (w
)
10786 ? window_box_left_offset (w
, TEXT_AREA
)
10788 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10789 frame_or_window
= w
->frame
;
10792 CHECK_LIVE_FRAME (frame_or_window
);
10794 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10797 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10798 doc
: /* Return position information for buffer POS in WINDOW.
10799 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10801 Return nil if position is not visible in window. Otherwise,
10802 the return value is similar to that returned by `event-start' for
10803 a mouse click at the upper left corner of the glyph corresponding
10804 to the given buffer position:
10805 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10806 IMAGE (DX . DY) (WIDTH . HEIGHT))
10807 The `posn-' functions access elements of such lists. */)
10808 (Lisp_Object pos
, Lisp_Object window
)
10813 window
= selected_window
;
10815 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10818 Lisp_Object x
= XCAR (tem
);
10819 Lisp_Object y
= XCAR (XCDR (tem
));
10821 /* Point invisible due to hscrolling? */
10824 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10830 /* Set up a new kboard object with reasonable initial values.
10831 TYPE is a window system for which this keyboard is used. */
10834 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10836 kset_overriding_terminal_local_map (kb
, Qnil
);
10837 kset_last_command (kb
, Qnil
);
10838 kset_real_last_command (kb
, Qnil
);
10839 kset_keyboard_translate_table (kb
, Qnil
);
10840 kset_last_repeatable_command (kb
, Qnil
);
10841 kset_prefix_arg (kb
, Qnil
);
10842 kset_last_prefix_arg (kb
, Qnil
);
10843 kset_kbd_queue (kb
, Qnil
);
10844 kb
->kbd_queue_has_data
= 0;
10845 kb
->immediate_echo
= 0;
10846 kset_echo_string (kb
, Qnil
);
10847 kb
->echo_after_prompt
= -1;
10848 kb
->kbd_macro_buffer
= 0;
10849 kb
->kbd_macro_bufsize
= 0;
10850 kset_defining_kbd_macro (kb
, Qnil
);
10851 kset_last_kbd_macro (kb
, Qnil
);
10852 kb
->reference_count
= 0;
10853 kset_system_key_alist (kb
, Qnil
);
10854 kset_system_key_syms (kb
, Qnil
);
10855 kset_window_system (kb
, type
);
10856 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10857 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10858 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10859 kset_default_minibuffer_frame (kb
, Qnil
);
10862 /* Allocate and basically initialize keyboard
10863 object to use with window system TYPE. */
10866 allocate_kboard (Lisp_Object type
)
10868 KBOARD
*kb
= xmalloc (sizeof *kb
);
10870 init_kboard (kb
, type
);
10871 kb
->next_kboard
= all_kboards
;
10877 * Destroy the contents of a kboard object, but not the object itself.
10878 * We use this just before deleting it, or if we're going to initialize
10879 * it a second time.
10882 wipe_kboard (KBOARD
*kb
)
10884 xfree (kb
->kbd_macro_buffer
);
10887 /* Free KB and memory referenced from it. */
10890 delete_kboard (KBOARD
*kb
)
10894 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10897 *kbp
= kb
->next_kboard
;
10899 /* Prevent a dangling reference to KB. */
10900 if (kb
== current_kboard
10901 && FRAMEP (selected_frame
)
10902 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10904 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10906 if (current_kboard
== kb
)
10915 init_keyboard (void)
10917 /* This is correct before outermost invocation of the editor loop. */
10918 command_loop_level
= -1;
10919 immediate_quit
= 0;
10920 quit_char
= Ctl ('g');
10921 Vunread_command_events
= Qnil
;
10922 timer_idleness_start_time
= invalid_timespec ();
10924 recent_keys_index
= 0;
10925 kbd_fetch_ptr
= kbd_buffer
;
10926 kbd_store_ptr
= kbd_buffer
;
10927 do_mouse_tracking
= Qnil
;
10929 interrupt_input_blocked
= 0;
10930 pending_signals
= 0;
10932 /* This means that command_loop_1 won't try to select anything the first
10934 internal_last_event_frame
= Qnil
;
10935 Vlast_event_frame
= internal_last_event_frame
;
10937 current_kboard
= initial_kboard
;
10938 /* Re-initialize the keyboard again. */
10939 wipe_kboard (current_kboard
);
10940 /* A value of nil for Vwindow_system normally means a tty, but we also use
10941 it for the initial terminal since there is no window system there. */
10942 init_kboard (current_kboard
, Qnil
);
10944 if (!noninteractive
)
10946 /* Before multi-tty support, these handlers used to be installed
10947 only if the current session was a tty session. Now an Emacs
10948 session may have multiple display types, so we always handle
10949 SIGINT. There is special code in handle_interrupt_signal to exit
10950 Emacs on SIGINT when there are no termcap frames on the
10951 controlling terminal. */
10952 struct sigaction action
;
10953 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10954 sigaction (SIGINT
, &action
, 0);
10956 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10957 SIGQUIT and we can't tell which one it will give us. */
10958 sigaction (SIGQUIT
, &action
, 0);
10959 #endif /* not DOS_NT */
10961 #ifdef USABLE_SIGIO
10962 if (!noninteractive
)
10964 struct sigaction action
;
10965 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10966 sigaction (SIGIO
, &action
, 0);
10970 /* Use interrupt input by default, if it works and noninterrupt input
10971 has deficiencies. */
10973 #ifdef INTERRUPT_INPUT
10974 interrupt_input
= 1;
10976 interrupt_input
= 0;
10979 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10982 if (keyboard_init_hook
)
10983 (*keyboard_init_hook
) ();
10985 #ifdef POLL_FOR_INPUT
10987 poll_suppress_count
= 1;
10992 /* This type's only use is in syms_of_keyboard, to initialize the
10993 event header symbols and put properties on them. */
10994 struct event_head
{
11000 static const struct event_head head_table
[] = {
11001 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11002 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11003 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11004 {&Qfocus_in
, "focus-in", &Qfocus_in
},
11005 {&Qfocus_out
, "focus-out", &Qfocus_out
},
11006 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11007 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11008 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11009 /* `select-window' should be handled just like `switch-frame'
11010 in read_key_sequence. */
11011 {&Qselect_window
, "select-window", &Qswitch_frame
}
11015 syms_of_keyboard (void)
11017 #include "keyboard.x"
11019 pending_funcalls
= Qnil
;
11020 staticpro (&pending_funcalls
);
11022 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11023 staticpro (&Vlispy_mouse_stem
);
11026 DEFSYM (QCimage
, ":image");
11027 DEFSYM (Qhelp_echo
, "help-echo");
11028 DEFSYM (QCrtl
, ":rtl");
11030 staticpro (&item_properties
);
11031 item_properties
= Qnil
;
11033 staticpro (&tool_bar_item_properties
);
11034 tool_bar_item_properties
= Qnil
;
11035 staticpro (&tool_bar_items_vector
);
11036 tool_bar_items_vector
= Qnil
;
11038 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11039 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11040 DEFSYM (Qself_insert_command
, "self-insert-command");
11041 DEFSYM (Qforward_char
, "forward-char");
11042 DEFSYM (Qbackward_char
, "backward-char");
11043 DEFSYM (Qdisabled
, "disabled");
11044 DEFSYM (Qundefined
, "undefined");
11045 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11046 DEFSYM (Qpost_command_hook
, "post-command-hook");
11047 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11048 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11049 DEFSYM (Qfunction_key
, "function-key");
11050 DEFSYM (Qmouse_click
, "mouse-click");
11051 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11052 DEFSYM (Qsave_session
, "save-session");
11053 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11054 DEFSYM (Qmenu_enable
, "menu-enable");
11057 DEFSYM (Qlanguage_change
, "language-change");
11061 DEFSYM (Qdbus_event
, "dbus-event");
11064 #ifdef USE_FILE_NOTIFY
11065 DEFSYM (Qfile_notify
, "file-notify");
11066 #endif /* USE_FILE_NOTIFY */
11068 DEFSYM (QCenable
, ":enable");
11069 DEFSYM (QCvisible
, ":visible");
11070 DEFSYM (QChelp
, ":help");
11071 DEFSYM (QCfilter
, ":filter");
11072 DEFSYM (QCbutton
, ":button");
11073 DEFSYM (QCkeys
, ":keys");
11074 DEFSYM (QCkey_sequence
, ":key-sequence");
11075 DEFSYM (QCtoggle
, ":toggle");
11076 DEFSYM (QCradio
, ":radio");
11077 DEFSYM (QClabel
, ":label");
11078 DEFSYM (QCvert_only
, ":vert-only");
11080 DEFSYM (Qmode_line
, "mode-line");
11081 DEFSYM (Qvertical_line
, "vertical-line");
11082 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11083 DEFSYM (Qmenu_bar
, "menu-bar");
11084 DEFSYM (Qright_divider
, "right-divider");
11085 DEFSYM (Qbottom_divider
, "bottom-divider");
11087 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11089 DEFSYM (Qabove_handle
, "above-handle");
11090 DEFSYM (Qhandle
, "handle");
11091 DEFSYM (Qbelow_handle
, "below-handle");
11092 DEFSYM (Qup
, "up");
11093 DEFSYM (Qdown
, "down");
11094 DEFSYM (Qtop
, "top");
11095 DEFSYM (Qbottom
, "bottom");
11096 DEFSYM (Qend_scroll
, "end-scroll");
11097 DEFSYM (Qratio
, "ratio");
11099 DEFSYM (Qevent_kind
, "event-kind");
11100 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11101 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11102 DEFSYM (Qmodifier_cache
, "modifier-cache");
11104 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11105 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11107 DEFSYM (Qpolling_period
, "polling-period");
11109 DEFSYM (Qx_set_selection
, "x-set-selection");
11110 DEFSYM (QPRIMARY
, "PRIMARY");
11111 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11112 DEFSYM (Qhandle_select_window
, "handle-select-window");
11114 DEFSYM (Qinput_method_function
, "input-method-function");
11115 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11116 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11118 DEFSYM (Qhelp_form_show
, "help-form-show");
11120 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11122 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11123 Fset (Qinput_method_use_echo_area
, Qnil
);
11127 int len
= ARRAYELTS (head_table
);
11129 for (i
= 0; i
< len
; i
++)
11131 const struct event_head
*p
= &head_table
[i
];
11132 *p
->var
= intern_c_string (p
->name
);
11133 staticpro (p
->var
);
11134 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11135 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11139 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11140 staticpro (&button_down_location
);
11141 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11142 staticpro (&mouse_syms
);
11143 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11145 staticpro (&wheel_syms
);
11149 int len
= ARRAYELTS (modifier_names
);
11151 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11152 for (i
= 0; i
< len
; i
++)
11153 if (modifier_names
[i
])
11154 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11155 staticpro (&modifier_symbols
);
11158 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11159 staticpro (&recent_keys
);
11161 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11162 staticpro (&this_command_keys
);
11164 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11165 staticpro (&raw_keybuf
);
11167 DEFSYM (Qcommand_execute
, "command-execute");
11169 accent_key_syms
= Qnil
;
11170 staticpro (&accent_key_syms
);
11172 func_key_syms
= Qnil
;
11173 staticpro (&func_key_syms
);
11175 drag_n_drop_syms
= Qnil
;
11176 staticpro (&drag_n_drop_syms
);
11178 unread_switch_frame
= Qnil
;
11179 staticpro (&unread_switch_frame
);
11181 internal_last_event_frame
= Qnil
;
11182 staticpro (&internal_last_event_frame
);
11184 read_key_sequence_cmd
= Qnil
;
11185 staticpro (&read_key_sequence_cmd
);
11186 read_key_sequence_remapped
= Qnil
;
11187 staticpro (&read_key_sequence_remapped
);
11189 menu_bar_one_keymap_changed_items
= Qnil
;
11190 staticpro (&menu_bar_one_keymap_changed_items
);
11192 menu_bar_items_vector
= Qnil
;
11193 staticpro (&menu_bar_items_vector
);
11195 help_form_saved_window_configs
= Qnil
;
11196 staticpro (&help_form_saved_window_configs
);
11198 DEFVAR_LISP ("last-command-event", last_command_event
,
11199 doc
: /* Last input event that was part of a command. */);
11201 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11202 doc
: /* Last input event in a command, except for mouse menu events.
11203 Mouse menus give back keys that don't look like mouse events;
11204 this variable holds the actual mouse event that led to the menu,
11205 so that you can determine whether the command was run by mouse or not. */);
11207 DEFVAR_LISP ("last-input-event", last_input_event
,
11208 doc
: /* Last input event. */);
11210 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11211 doc
: /* List of events to be read as the command input.
11212 These events are processed first, before actual keyboard input.
11213 Events read from this list are not normally added to `this-command-keys',
11214 as they will already have been added once as they were read for the first time.
11215 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11216 Vunread_command_events
= Qnil
;
11218 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11219 doc
: /* List of events to be processed as input by input methods.
11220 These events are processed before `unread-command-events'
11221 and actual keyboard input, but are not given to `input-method-function'. */);
11222 Vunread_post_input_method_events
= Qnil
;
11224 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11225 doc
: /* List of events to be processed as input by input methods.
11226 These events are processed after `unread-command-events', but
11227 before actual keyboard input.
11228 If there's an active input method, the events are given to
11229 `input-method-function'. */);
11230 Vunread_input_method_events
= Qnil
;
11232 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11233 doc
: /* Meta-prefix character code.
11234 Meta-foo as command input turns into this character followed by foo. */);
11235 XSETINT (meta_prefix_char
, 033);
11237 DEFVAR_KBOARD ("last-command", Vlast_command
,
11238 doc
: /* The last command executed.
11239 Normally a symbol with a function definition, but can be whatever was found
11240 in the keymap, or whatever the variable `this-command' was set to by that
11243 The value `mode-exit' is special; it means that the previous command
11244 read an event that told it to exit, and it did so and unread that event.
11245 In other words, the present command is the event that made the previous
11248 The value `kill-region' is special; it means that the previous command
11249 was a kill command.
11251 `last-command' has a separate binding for each terminal device.
11252 See Info node `(elisp)Multiple Terminals'. */);
11254 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11255 doc
: /* Same as `last-command', but never altered by Lisp code.
11256 Taken from the previous value of `real-this-command'. */);
11258 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11259 doc
: /* Last command that may be repeated.
11260 The last command executed that was not bound to an input event.
11261 This is the command `repeat' will try to repeat.
11262 Taken from a previous value of `real-this-command'. */);
11264 DEFVAR_LISP ("this-command", Vthis_command
,
11265 doc
: /* The command now being executed.
11266 The command can set this variable; whatever is put here
11267 will be in `last-command' during the following command. */);
11268 Vthis_command
= Qnil
;
11270 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11271 doc
: /* This is like `this-command', except that commands should never modify it. */);
11272 Vreal_this_command
= Qnil
;
11274 DEFVAR_LISP ("this-command-keys-shift-translated",
11275 Vthis_command_keys_shift_translated
,
11276 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11277 Shift-translation occurs when there is no binding for the key sequence
11278 as entered, but a binding was found by changing an upper-case letter
11279 to lower-case, or a shifted function key to an unshifted one. */);
11280 Vthis_command_keys_shift_translated
= Qnil
;
11282 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11283 doc
: /* The command bound to the current key sequence before remapping.
11284 It equals `this-command' if the original command was not remapped through
11285 any of the active keymaps. Otherwise, the value of `this-command' is the
11286 result of looking up the original command in the active keymaps. */);
11287 Vthis_original_command
= Qnil
;
11289 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11290 doc
: /* Number of input events between auto-saves.
11291 Zero means disable autosaving due to number of characters typed. */);
11292 auto_save_interval
= 300;
11294 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11295 doc
: /* Number of seconds idle time before auto-save.
11296 Zero or nil means disable auto-saving due to idleness.
11297 After auto-saving due to this many seconds of idle time,
11298 Emacs also does a garbage collection if that seems to be warranted. */);
11299 XSETFASTINT (Vauto_save_timeout
, 30);
11301 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11302 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11303 The value may be integer or floating point.
11304 If the value is zero, don't echo at all. */);
11305 Vecho_keystrokes
= make_number (1);
11307 DEFVAR_INT ("polling-period", polling_period
,
11308 doc
: /* Interval between polling for input during Lisp execution.
11309 The reason for polling is to make C-g work to stop a running program.
11310 Polling is needed only when using X windows and SIGIO does not work.
11311 Polling is automatically disabled in all other cases. */);
11312 polling_period
= 2;
11314 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11315 doc
: /* Maximum time between mouse clicks to make a double-click.
11316 Measured in milliseconds. The value nil means disable double-click
11317 recognition; t means double-clicks have no time limit and are detected
11318 by position only. */);
11319 Vdouble_click_time
= make_number (500);
11321 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11322 doc
: /* Maximum mouse movement between clicks to make a double-click.
11323 On window-system frames, value is the number of pixels the mouse may have
11324 moved horizontally or vertically between two clicks to make a double-click.
11325 On non window-system frames, value is interpreted in units of 1/8 characters
11328 This variable is also the threshold for motion of the mouse
11329 to count as a drag. */);
11330 double_click_fuzz
= 3;
11332 DEFVAR_INT ("num-input-keys", num_input_keys
,
11333 doc
: /* Number of complete key sequences read as input so far.
11334 This includes key sequences read from keyboard macros.
11335 The number is effectively the number of interactive command invocations. */);
11336 num_input_keys
= 0;
11338 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11339 doc
: /* Number of input events read from the keyboard so far.
11340 This does not include events generated by keyboard macros. */);
11341 num_nonmacro_input_events
= 0;
11343 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11344 doc
: /* The frame in which the most recently read event occurred.
11345 If the last event came from a keyboard macro, this is set to `macro'. */);
11346 Vlast_event_frame
= Qnil
;
11348 /* This variable is set up in sysdep.c. */
11349 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11350 doc
: /* The ERASE character as set by the user with stty. */);
11352 DEFVAR_LISP ("help-char", Vhelp_char
,
11353 doc
: /* Character to recognize as meaning Help.
11354 When it is read, do `(eval help-form)', and display result if it's a string.
11355 If the value of `help-form' is nil, this char can be read normally. */);
11356 XSETINT (Vhelp_char
, Ctl ('H'));
11358 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11359 doc
: /* List of input events to recognize as meaning Help.
11360 These work just like the value of `help-char' (see that). */);
11361 Vhelp_event_list
= Qnil
;
11363 DEFVAR_LISP ("help-form", Vhelp_form
,
11364 doc
: /* Form to execute when character `help-char' is read.
11365 If the form returns a string, that string is displayed.
11366 If `help-form' is nil, the help char is not recognized. */);
11369 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11370 doc
: /* Command to run when `help-char' character follows a prefix key.
11371 This command is used only when there is no actual binding
11372 for that character after that prefix key. */);
11373 Vprefix_help_command
= Qnil
;
11375 DEFVAR_LISP ("top-level", Vtop_level
,
11376 doc
: /* Form to evaluate when Emacs starts up.
11377 Useful to set before you dump a modified Emacs. */);
11380 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11381 doc
: /* Translate table for local keyboard input, or nil.
11382 If non-nil, the value should be a char-table. Each character read
11383 from the keyboard is looked up in this char-table. If the value found
11384 there is non-nil, then it is used instead of the actual input character.
11386 The value can also be a string or vector, but this is considered obsolete.
11387 If it is a string or vector of length N, character codes N and up are left
11388 untranslated. In a vector, an element which is nil means "no translation".
11390 This is applied to the characters supplied to input methods, not their
11391 output. See also `translation-table-for-input'.
11393 This variable has a separate binding for each terminal.
11394 See Info node `(elisp)Multiple Terminals'. */);
11396 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11397 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11398 \(Even if the operating system has support for stopping a process.\) */);
11399 cannot_suspend
= 0;
11401 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11402 doc
: /* Non-nil means prompt with menus when appropriate.
11403 This is done when reading from a keymap that has a prompt string,
11404 for elements that have prompt strings.
11405 The menu is displayed on the screen
11406 if X menus were enabled at configuration
11407 time and the previous event was a mouse click prefix key.
11408 Otherwise, menu prompting uses the echo area. */);
11409 menu_prompting
= 1;
11411 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11412 doc
: /* Character to see next line of menu prompt.
11413 Type this character while in a menu prompt to rotate around the lines of it. */);
11414 XSETINT (menu_prompt_more_char
, ' ');
11416 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11417 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11418 Emacs applies the modifiers of the character stored here to each keyboard
11419 character it reads. For example, after evaluating the expression
11420 (setq extra-keyboard-modifiers ?\\C-x)
11421 all input characters will have the control modifier applied to them.
11423 Note that the character ?\\C-@, equivalent to the integer zero, does
11424 not count as a control character; rather, it counts as a character
11425 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11426 cancels any modification. */);
11427 extra_keyboard_modifiers
= 0;
11429 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11430 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11431 The command loop sets this to nil before each command,
11432 and tests the value when the command returns.
11433 Buffer modification stores t in this variable. */);
11434 Vdeactivate_mark
= Qnil
;
11435 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11436 Fmake_variable_buffer_local (Qdeactivate_mark
);
11438 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11439 doc
: /* Normal hook run before each command is executed.
11440 If an unhandled error happens in running this hook,
11441 the function in which the error occurred is unconditionally removed, since
11442 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11443 Vpre_command_hook
= Qnil
;
11445 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11446 doc
: /* Normal hook run after each command is executed.
11447 If an unhandled error happens in running this hook,
11448 the function in which the error occurred is unconditionally removed, since
11449 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11450 Vpost_command_hook
= Qnil
;
11453 DEFVAR_LISP ("echo-area-clear-hook", ...,
11454 doc
: /* Normal hook run when clearing the echo area. */);
11456 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11457 Fset (Qecho_area_clear_hook
, Qnil
);
11459 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11460 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11461 Vlucid_menu_bar_dirty_flag
= Qnil
;
11463 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11464 doc
: /* List of menu bar items to move to the end of the menu bar.
11465 The elements of the list are event types that may have menu bar bindings. */);
11466 Vmenu_bar_final_items
= Qnil
;
11468 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11469 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11470 This is used internally by graphical displays that do not render
11471 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11472 Vtool_bar_separator_image_expression
= Qnil
;
11474 DEFVAR_KBOARD ("overriding-terminal-local-map",
11475 Voverriding_terminal_local_map
,
11476 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11477 This variable is intended to let commands such as `universal-argument'
11478 set up a different keymap for reading the next command.
11480 `overriding-terminal-local-map' has a separate binding for each
11481 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11483 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11484 doc
: /* Keymap that replaces (overrides) local keymaps.
11485 If this variable is non-nil, Emacs looks up key bindings in this
11486 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11487 buffer's local map. Hence, the only active keymaps would be
11488 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11489 order of precedence. */);
11490 Voverriding_local_map
= Qnil
;
11492 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11493 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11494 Otherwise, the menu bar continues to reflect the buffer's local map
11495 and the minor mode maps regardless of `overriding-local-map'. */);
11496 Voverriding_local_map_menu_flag
= Qnil
;
11498 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11499 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11500 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11502 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11503 doc
: /* Non-nil means generate motion events for mouse motion. */);
11505 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11506 doc
: /* Alist of system-specific X windows key symbols.
11507 Each element should have the form (N . SYMBOL) where N is the
11508 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11509 and SYMBOL is its name.
11511 `system-key-alist' has a separate binding for each terminal device.
11512 See Info node `(elisp)Multiple Terminals'. */);
11514 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11515 doc
: /* Keymap that translates key sequences to key sequences during input.
11516 This is used mainly for mapping key sequences into some preferred
11517 key events (symbols).
11519 The `read-key-sequence' function replaces any subsequence bound by
11520 `local-function-key-map' with its binding. More precisely, when the
11521 active keymaps have no binding for the current key sequence but
11522 `local-function-key-map' binds a suffix of the sequence to a vector or
11523 string, `read-key-sequence' replaces the matching suffix with its
11524 binding, and continues with the new sequence.
11526 If the binding is a function, it is called with one argument (the prompt)
11527 and its return value (a key sequence) is used.
11529 The events that come from bindings in `local-function-key-map' are not
11530 themselves looked up in `local-function-key-map'.
11532 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11533 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11534 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11535 typing `ESC O P x' would return [f1 x].
11537 `local-function-key-map' has a separate binding for each terminal
11538 device. See Info node `(elisp)Multiple Terminals'. If you need to
11539 define a binding on all terminals, change `function-key-map'
11540 instead. Initially, `local-function-key-map' is an empty keymap that
11541 has `function-key-map' as its parent on all terminal devices. */);
11543 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11544 doc
: /* Keymap that decodes input escape sequences.
11545 This is used mainly for mapping ASCII function key sequences into
11546 real Emacs function key events (symbols).
11548 The `read-key-sequence' function replaces any subsequence bound by
11549 `input-decode-map' with its binding. Contrary to `function-key-map',
11550 this map applies its rebinding regardless of the presence of an ordinary
11551 binding. So it is more like `key-translation-map' except that it applies
11552 before `function-key-map' rather than after.
11554 If the binding is a function, it is called with one argument (the prompt)
11555 and its return value (a key sequence) is used.
11557 The events that come from bindings in `input-decode-map' are not
11558 themselves looked up in `input-decode-map'. */);
11560 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11561 doc
: /* The parent keymap of all `local-function-key-map' instances.
11562 Function key definitions that apply to all terminal devices should go
11563 here. If a mapping is defined in both the current
11564 `local-function-key-map' binding and this variable, then the local
11565 definition will take precedence. */);
11566 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11568 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11569 doc
: /* Keymap of key translations that can override keymaps.
11570 This keymap works like `input-decode-map', but comes after `function-key-map'.
11571 Another difference is that it is global rather than terminal-local. */);
11572 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11574 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11575 doc
: /* List of deferred actions to be performed at a later time.
11576 The precise format isn't relevant here; we just check whether it is nil. */);
11577 Vdeferred_action_list
= Qnil
;
11579 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11580 doc
: /* Function to call to handle deferred actions, after each command.
11581 This function is called with no arguments after each command
11582 whenever `deferred-action-list' is non-nil. */);
11583 Vdeferred_action_function
= Qnil
;
11585 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11586 doc
: /* List of warnings to be displayed after this command.
11587 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11588 as per the args of `display-warning' (which see).
11589 If this variable is non-nil, `delayed-warnings-hook' will be run
11590 immediately after running `post-command-hook'. */);
11591 Vdelayed_warnings_list
= Qnil
;
11593 DEFVAR_LISP ("timer-list", Vtimer_list
,
11594 doc
: /* List of active absolute time timers in order of increasing time. */);
11595 Vtimer_list
= Qnil
;
11597 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11598 doc
: /* List of active idle-time timers in order of increasing time. */);
11599 Vtimer_idle_list
= Qnil
;
11601 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11602 doc
: /* If non-nil, the function that implements the current input method.
11603 It's called with one argument, a printing character that was just read.
11604 \(That means a character with code 040...0176.)
11605 Typically this function uses `read-event' to read additional events.
11606 When it does so, it should first bind `input-method-function' to nil
11607 so it will not be called recursively.
11609 The function should return a list of zero or more events
11610 to be used as input. If it wants to put back some events
11611 to be reconsidered, separately, by the input method,
11612 it can add them to the beginning of `unread-command-events'.
11614 The input method function can find in `input-method-previous-message'
11615 the previous echo area message.
11617 The input method function should refer to the variables
11618 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11619 for guidance on what to do. */);
11620 Vinput_method_function
= Qnil
;
11622 DEFVAR_LISP ("input-method-previous-message",
11623 Vinput_method_previous_message
,
11624 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11625 This variable exists because `read-event' clears the echo area
11626 before running the input method. It is nil if there was no message. */);
11627 Vinput_method_previous_message
= Qnil
;
11629 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11630 doc
: /* If non-nil, the function that implements the display of help.
11631 It's called with one argument, the help string to display. */);
11632 Vshow_help_function
= Qnil
;
11634 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11635 doc
: /* If non-nil, suppress point adjustment after executing a command.
11637 After a command is executed, if point is moved into a region that has
11638 special properties (e.g. composition, display), we adjust point to
11639 the boundary of the region. But, when a command sets this variable to
11640 non-nil, we suppress the point adjustment.
11642 This variable is set to nil before reading a command, and is checked
11643 just after executing the command. */);
11644 Vdisable_point_adjustment
= Qnil
;
11646 DEFVAR_LISP ("global-disable-point-adjustment",
11647 Vglobal_disable_point_adjustment
,
11648 doc
: /* If non-nil, always suppress point adjustment.
11650 The default value is nil, in which case, point adjustment are
11651 suppressed only after special commands that set
11652 `disable-point-adjustment' (which see) to non-nil. */);
11653 Vglobal_disable_point_adjustment
= Qnil
;
11655 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11656 doc
: /* How long to display an echo-area message when the minibuffer is active.
11657 If the value is not a number, such messages don't time out. */);
11658 Vminibuffer_message_timeout
= make_number (2);
11660 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11661 doc
: /* If non-nil, any keyboard input throws to this symbol.
11662 The value of that variable is passed to `quit-flag' and later causes a
11663 peculiar kind of quitting. */);
11664 Vthrow_on_input
= Qnil
;
11666 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11667 doc
: /* Function to output error messages.
11668 Called with three arguments:
11669 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11670 such as what `condition-case' would bind its variable to,
11671 - the context (a string which normally goes at the start of the message),
11672 - the Lisp function within which the error was signaled. */);
11673 Vcommand_error_function
= intern ("command-error-default-function");
11675 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11676 Venable_disabled_menus_and_buttons
,
11677 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11679 Help functions bind this to allow help on disabled menu items
11680 and tool-bar buttons. */);
11681 Venable_disabled_menus_and_buttons
= Qnil
;
11683 DEFVAR_LISP ("select-active-regions",
11684 Vselect_active_regions
,
11685 doc
: /* If non-nil, an active region automatically sets the primary selection.
11686 If the value is `only', only temporarily active regions (usually made
11687 by mouse-dragging or shift-selection) set the window selection.
11689 This takes effect only when Transient Mark mode is enabled. */);
11690 Vselect_active_regions
= Qt
;
11692 DEFVAR_LISP ("saved-region-selection",
11693 Vsaved_region_selection
,
11694 doc
: /* Contents of active region prior to buffer modification.
11695 If `select-active-regions' is non-nil, Emacs sets this to the
11696 text in the region before modifying the buffer. The next call to
11697 the function `deactivate-mark' uses this to set the window selection. */);
11698 Vsaved_region_selection
= Qnil
;
11700 DEFVAR_LISP ("selection-inhibit-update-commands",
11701 Vselection_inhibit_update_commands
,
11702 doc
: /* List of commands which should not update the selection.
11703 Normally, if `select-active-regions' is non-nil and the mark remains
11704 active after a command (i.e. the mark was not deactivated), the Emacs
11705 command loop sets the selection to the text in the region. However,
11706 if the command is in this list, the selection is not updated. */);
11707 Vselection_inhibit_update_commands
11708 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11710 DEFVAR_LISP ("debug-on-event",
11712 doc
: /* Enter debugger on this event. When Emacs
11713 receives the special event specified by this variable, it will try to
11714 break into the debugger as soon as possible instead of processing the
11715 event normally through `special-event-map'.
11717 Currently, the only supported values for this
11718 variable are `sigusr1' and `sigusr2'. */);
11719 Vdebug_on_event
= intern_c_string ("sigusr2");
11721 /* Create the initial keyboard. Qt means 'unset'. */
11722 initial_kboard
= allocate_kboard (Qt
);
11726 keys_of_keyboard (void)
11728 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11729 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11730 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11731 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11732 initial_define_key (meta_map
, 'x', "execute-extended-command");
11734 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11735 "handle-delete-frame");
11736 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11737 "ns-put-working-text");
11738 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11739 "ns-unput-working-text");
11740 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11741 current-prefix-arg, as is done in `handle-switch-frame'.
11742 But `handle-switch-frame is not run from the special-map.
11743 Commands from that map are run in a special way that automatically
11744 preserves the prefix-arg. Restoring the prefix arg here is not just
11745 redundant but harmful:
11747 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11748 - after the first prompt, the exit-minibuffer-hook is run which may
11749 iconify a frame and thus push a `iconify-frame' event.
11750 - after running exit-minibuffer-hook, current-prefix-arg is
11751 restored to the non-nil value it had before the prompt.
11752 - we enter the second prompt.
11753 current-prefix-arg is non-nil, prefix-arg is nil.
11754 - before running the first real event, we run the special iconify-frame
11755 event, but we pass the `special' arg to execute-command so
11756 current-prefix-arg and prefix-arg are left untouched.
11757 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11758 - the next key event will have a spuriously non-nil current-prefix-arg. */
11759 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11761 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11763 /* Handling it at such a low-level causes read_key_sequence to get
11764 * confused because it doesn't realize that the current_buffer was
11765 * changed by read_char.
11767 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11768 * "handle-select-window"); */
11769 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11770 "handle-save-session");
11773 /* Define a special event which is raised for dbus callback
11775 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11776 "dbus-handle-event");
11779 #ifdef USE_FILE_NOTIFY
11780 /* Define a special event which is raised for notification callback
11782 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11783 "file-notify-handle-event");
11784 #endif /* USE_FILE_NOTIFY */
11786 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11788 #if defined (WINDOWSNT)
11789 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11792 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11793 "handle-focus-in");
11794 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11795 "handle-focus-out");