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
));
1204 top_level_2_body (void *ignore
)
1206 return Feval (Vtop_level
, Qnil
);
1212 return scm_c_with_throw_handler (SCM_BOOL_T
,
1213 top_level_2_body
, NULL
,
1214 command_loop_2_handler
, NULL
,
1219 top_level_1 (Lisp_Object ignore
)
1221 /* On entry to the outer level, run the startup file. */
1222 if (!NILP (Vtop_level
))
1223 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1224 else if (!NILP (Vpurify_flag
))
1225 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1227 message1 ("Bare Emacs (standard Lisp code not loaded)");
1231 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1232 doc
: /* Exit all recursive editing levels.
1233 This also exits all active minibuffers. */)
1236 #ifdef HAVE_WINDOW_SYSTEM
1237 if (display_hourglass_p
)
1238 cancel_hourglass ();
1241 /* Unblock input if we enter with input blocked. This may happen if
1242 redisplay traps e.g. during tool-bar update with input blocked. */
1243 totally_unblock_input ();
1245 Fthrow (Qtop_level
, Qnil
);
1248 static _Noreturn
void
1249 user_error (const char *msg
)
1251 xsignal1 (Quser_error
, build_string (msg
));
1254 /* _Noreturn will be added to prototype by make-docfile. */
1255 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1256 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1259 if (command_loop_level
> 0 || minibuf_level
> 0)
1260 Fthrow (Qexit
, Qnil
);
1262 user_error ("No recursive edit is in progress");
1265 /* _Noreturn will be added to prototype by make-docfile. */
1266 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1267 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1270 if (command_loop_level
> 0 || minibuf_level
> 0)
1273 user_error ("No recursive edit is in progress");
1276 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1277 of this function. */
1280 tracking_off (Lisp_Object old_value
)
1282 do_mouse_tracking
= old_value
;
1283 if (NILP (old_value
))
1285 /* Redisplay may have been preempted because there was input
1286 available, and it assumes it will be called again after the
1287 input has been processed. If the only input available was
1288 the sort that we have just disabled, then we need to call
1290 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1292 redisplay_preserve_echo_area (6);
1293 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1298 DEFUN ("call-with-track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1299 doc
: /* Evaluate BODY with mouse movement events enabled.
1300 Within a `track-mouse' form, mouse motion generates input events that
1301 you can read with `read-event'.
1302 Normally, mouse motion is ignored.
1303 usage: (track-mouse BODY...) */)
1309 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1311 do_mouse_tracking
= Qt
;
1313 val
= call0 (thunk
);
1318 /* If mouse has moved on some frame, return one of those frames.
1322 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1323 after resizing the tool-bar window. */
1325 bool ignore_mouse_drag_p
;
1327 static struct frame
*
1328 some_mouse_moved (void)
1330 Lisp_Object tail
, frame
;
1332 if (ignore_mouse_drag_p
)
1334 /* ignore_mouse_drag_p = 0; */
1338 FOR_EACH_FRAME (tail
, frame
)
1340 if (XFRAME (frame
)->mouse_moved
)
1341 return XFRAME (frame
);
1348 /* This is the actual command reading loop,
1349 sans error-handling encapsulation. */
1351 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1352 bool, bool, bool, bool);
1353 static void adjust_point_for_property (ptrdiff_t, bool);
1355 /* The last boundary auto-added to buffer-undo-list. */
1356 Lisp_Object last_undo_boundary
;
1358 /* FIXME: This is wrong rather than test window-system, we should call
1359 a new set-selection, which will then dispatch to x-set-selection, or
1360 tty-set-selection, or w32-set-selection, ... */
1363 command_loop_1 (void)
1366 Lisp_Object keybuf
[30];
1368 EMACS_INT prev_modiff
= 0;
1369 struct buffer
*prev_buffer
= NULL
;
1370 bool already_adjusted
= 0;
1372 kset_prefix_arg (current_kboard
, Qnil
);
1373 kset_last_prefix_arg (current_kboard
, Qnil
);
1374 Vdeactivate_mark
= Qnil
;
1375 waiting_for_input
= 0;
1378 this_command_key_count
= 0;
1379 this_command_key_count_reset
= 0;
1380 this_single_command_key_start
= 0;
1382 if (NILP (Vmemory_full
))
1384 /* Make sure this hook runs after commands that get errors and
1385 throw to top level. */
1386 /* Note that the value cell will never directly contain nil
1387 if the symbol is a local variable. */
1388 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1389 safe_run_hooks (Qpost_command_hook
);
1391 /* If displaying a message, resize the echo area window to fit
1392 that message's size exactly. */
1393 if (!NILP (echo_area_buffer
[0]))
1394 resize_echo_area_exactly ();
1396 /* If there are warnings waiting, process them. */
1397 if (!NILP (Vdelayed_warnings_list
))
1398 safe_run_hooks (Qdelayed_warnings_hook
);
1400 if (!NILP (Vdeferred_action_list
))
1401 safe_run_hooks (Qdeferred_action_function
);
1404 /* Do this after running Vpost_command_hook, for consistency. */
1405 kset_last_command (current_kboard
, Vthis_command
);
1406 kset_real_last_command (current_kboard
, Vreal_this_command
);
1407 if (!CONSP (last_command_event
))
1408 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1412 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1415 /* Make sure the current window's buffer is selected. */
1416 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1418 /* Display any malloc warning that just came out. Use while because
1419 displaying one warning can cause another. */
1421 while (pending_malloc_warning
)
1422 display_malloc_warning ();
1424 Vdeactivate_mark
= Qnil
;
1426 /* Don't ignore mouse movements for more than a single command
1427 loop. (This flag is set in xdisp.c whenever the tool bar is
1428 resized, because the resize moves text up or down, and would
1429 generate false mouse drag events if we don't ignore them.) */
1430 ignore_mouse_drag_p
= 0;
1432 /* If minibuffer on and echo area in use,
1433 wait a short time and redraw minibuffer. */
1436 && !NILP (echo_area_buffer
[0])
1437 && EQ (minibuf_window
, echo_area_window
)
1438 && NUMBERP (Vminibuffer_message_timeout
))
1440 /* Bind inhibit-quit to t so that C-g gets read in
1441 rather than quitting back to the minibuffer. */
1443 specbind (Qinhibit_quit
, Qt
);
1445 sit_for (Vminibuffer_message_timeout
, 0, 2);
1447 /* Clear the echo area. */
1449 safe_run_hooks (Qecho_area_clear_hook
);
1453 /* If a C-g came in before, treat it as input now. */
1454 if (!NILP (Vquit_flag
))
1457 Vunread_command_events
= list1 (make_number (quit_char
));
1461 /* If it has changed current-menubar from previous value,
1462 really recompute the menubar from the value. */
1463 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1464 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1465 call0 (Qrecompute_lucid_menubar
);
1467 before_command_key_count
= this_command_key_count
;
1468 before_command_echo_length
= echo_length ();
1470 Vthis_command
= Qnil
;
1471 Vreal_this_command
= Qnil
;
1472 Vthis_original_command
= Qnil
;
1473 Vthis_command_keys_shift_translated
= Qnil
;
1475 /* Read next key sequence; i gets its length. */
1476 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1479 /* A filter may have run while we were reading the input. */
1480 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1482 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1486 /* Now we have read a key sequence of length I,
1487 or else I is 0 and we found end of file. */
1489 if (i
== 0) /* End of file -- happens only in */
1490 return Qnil
; /* a kbd macro, at the end. */
1491 /* -1 means read_key_sequence got a menu that was rejected.
1492 Just loop around and read another command. */
1496 this_command_key_count
= 0;
1497 this_command_key_count_reset
= 0;
1498 this_single_command_key_start
= 0;
1502 last_command_event
= keybuf
[i
- 1];
1504 /* If the previous command tried to force a specific window-start,
1505 forget about that, in case this command moves point far away
1506 from that position. But also throw away beg_unchanged and
1507 end_unchanged information in that case, so that redisplay will
1508 update the whole window properly. */
1509 if (XWINDOW (selected_window
)->force_start
)
1512 XWINDOW (selected_window
)->force_start
= 0;
1513 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1514 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1517 cmd
= read_key_sequence_cmd
;
1518 if (!NILP (Vexecuting_kbd_macro
))
1520 if (!NILP (Vquit_flag
))
1522 Vexecuting_kbd_macro
= Qt
;
1523 QUIT
; /* Make some noise. */
1524 /* Will return since macro now empty. */
1528 /* Do redisplay processing after this command except in special
1529 cases identified below. */
1530 prev_buffer
= current_buffer
;
1531 prev_modiff
= MODIFF
;
1532 last_point_position
= PT
;
1534 /* By default, we adjust point to a boundary of a region that
1535 has such a property that should be treated intangible
1536 (e.g. composition, display). But, some commands will set
1537 this variable differently. */
1538 Vdisable_point_adjustment
= Qnil
;
1540 /* Process filters and timers may have messed with deactivate-mark.
1541 reset it before we execute the command. */
1542 Vdeactivate_mark
= Qnil
;
1544 /* Remap command through active keymaps. */
1545 Vthis_original_command
= cmd
;
1546 if (!NILP (read_key_sequence_remapped
))
1547 cmd
= read_key_sequence_remapped
;
1549 /* Execute the command. */
1551 Vthis_command
= cmd
;
1552 Vreal_this_command
= cmd
;
1553 safe_run_hooks (Qpre_command_hook
);
1555 already_adjusted
= 0;
1557 if (NILP (Vthis_command
))
1558 /* nil means key is undefined. */
1562 /* Here for a command that isn't executed directly. */
1564 #ifdef HAVE_WINDOW_SYSTEM
1567 if (display_hourglass_p
1568 && NILP (Vexecuting_kbd_macro
))
1570 record_unwind_protect_void (cancel_hourglass
);
1575 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1577 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1580 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1581 ? Qnil
: BVAR (current_buffer
, undo_list
));
1583 call1 (Qcommand_execute
, Vthis_command
);
1585 #ifdef HAVE_WINDOW_SYSTEM
1586 /* Do not check display_hourglass_p here, because
1587 `command-execute' could change it, but we should cancel
1588 hourglass cursor anyway.
1589 But don't cancel the hourglass within a macro
1590 just because a command in the macro finishes. */
1594 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1596 safe_run_hooks (Qpost_command_hook
);
1598 /* If displaying a message, resize the echo area window to fit
1599 that message's size exactly. */
1600 if (!NILP (echo_area_buffer
[0]))
1601 resize_echo_area_exactly ();
1603 /* If there are warnings waiting, process them. */
1604 if (!NILP (Vdelayed_warnings_list
))
1605 safe_run_hooks (Qdelayed_warnings_hook
);
1607 safe_run_hooks (Qdeferred_action_function
);
1609 /* If there is a prefix argument,
1610 1) We don't want Vlast_command to be ``universal-argument''
1611 (that would be dumb), so don't set Vlast_command,
1612 2) we want to leave echoing on so that the prefix will be
1613 echoed as part of this key sequence, so don't call
1615 3) we want to leave this_command_key_count non-zero, so that
1616 read_char will realize that it is re-reading a character, and
1617 not echo it a second time.
1619 If the command didn't actually create a prefix arg,
1620 but is merely a frame event that is transparent to prefix args,
1621 then the above doesn't apply. */
1622 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1623 || CONSP (last_command_event
))
1625 kset_last_command (current_kboard
, Vthis_command
);
1626 kset_real_last_command (current_kboard
, Vreal_this_command
);
1627 if (!CONSP (last_command_event
))
1628 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1630 this_command_key_count
= 0;
1631 this_command_key_count_reset
= 0;
1632 this_single_command_key_start
= 0;
1635 if (!NILP (BVAR (current_buffer
, mark_active
))
1636 && !NILP (Vrun_hooks
))
1638 /* In Emacs 22, setting transient-mark-mode to `only' was a
1639 way of turning it on for just one command. This usage is
1640 obsolete, but support it anyway. */
1641 if (EQ (Vtransient_mark_mode
, Qidentity
))
1642 Vtransient_mark_mode
= Qnil
;
1643 else if (EQ (Vtransient_mark_mode
, Qonly
))
1644 Vtransient_mark_mode
= Qidentity
;
1646 if (!NILP (Vdeactivate_mark
))
1647 /* If `select-active-regions' is non-nil, this call to
1648 `deactivate-mark' also sets the PRIMARY selection. */
1649 call0 (Qdeactivate_mark
);
1652 /* Even if not deactivating the mark, set PRIMARY if
1653 `select-active-regions' is non-nil. */
1654 if (!NILP (Fwindow_system (Qnil
))
1655 /* Even if mark_active is non-nil, the actual buffer
1656 marker may not have been set yet (Bug#7044). */
1657 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1658 && (EQ (Vselect_active_regions
, Qonly
)
1659 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1660 : (!NILP (Vselect_active_regions
)
1661 && !NILP (Vtransient_mark_mode
)))
1662 && NILP (Fmemq (Vthis_command
,
1663 Vselection_inhibit_update_commands
)))
1666 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1667 if (XINT (Flength (txt
)) > 0)
1668 /* Don't set empty selections. */
1669 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1672 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1674 Lisp_Object hook
= intern ("activate-mark-hook");
1675 Frun_hooks (1, &hook
);
1679 Vsaved_region_selection
= Qnil
;
1684 if (current_buffer
== prev_buffer
1685 && last_point_position
!= PT
1686 && NILP (Vdisable_point_adjustment
)
1687 && NILP (Vglobal_disable_point_adjustment
))
1689 if (last_point_position
> BEGV
1690 && last_point_position
< ZV
1691 && (composition_adjust_point (last_point_position
,
1692 last_point_position
)
1693 != last_point_position
))
1694 /* The last point was temporarily set within a grapheme
1695 cluster to prevent automatic composition. To recover
1696 the automatic composition, we must update the
1698 windows_or_buffers_changed
= 21;
1699 if (!already_adjusted
)
1700 adjust_point_for_property (last_point_position
,
1701 MODIFF
!= prev_modiff
);
1704 /* Install chars successfully executed in kbd macro. */
1706 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1707 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1708 finalize_kbd_macro_chars ();
1713 read_menu_command (void)
1715 Lisp_Object keybuf
[30];
1719 /* We don't want to echo the keystrokes while navigating the
1721 specbind (Qecho_keystrokes
, make_number (0));
1723 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1728 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1730 if (i
== 0 || i
== -1)
1733 return read_key_sequence_cmd
;
1736 /* Adjust point to a boundary of a region that has such a property
1737 that should be treated intangible. For the moment, we check
1738 `composition', `display' and `invisible' properties.
1739 LAST_PT is the last position of point. */
1742 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1745 Lisp_Object val
, overlay
, tmp
;
1746 /* When called after buffer modification, we should temporarily
1747 suppress the point adjustment for automatic composition so that a
1748 user can keep inserting another character at point or keep
1749 deleting characters around point. */
1750 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1751 ptrdiff_t orig_pt
= PT
;
1753 /* FIXME: cycling is probably not necessary because these properties
1754 can't be usefully combined anyway. */
1755 while (check_composition
|| check_display
|| check_invisible
)
1757 /* FIXME: check `intangible'. */
1758 if (check_composition
1759 && PT
> BEGV
&& PT
< ZV
1760 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1763 check_display
= check_invisible
= 1;
1765 check_composition
= 0;
1767 && PT
> BEGV
&& PT
< ZV
1768 && !NILP (val
= get_char_property_and_overlay
1769 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1770 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1771 && (!OVERLAYP (overlay
)
1772 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1773 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1774 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1775 && (beg
< PT
/* && end > PT <- It's always the case. */
1776 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1779 SET_PT (PT
< last_pt
1780 ? (STRINGP (val
) && SCHARS (val
) == 0
1781 ? max (beg
- 1, BEGV
)
1784 check_composition
= check_invisible
= 1;
1787 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1793 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1796 /* FIXME: We should stop if we find a spot between
1797 two runs of `invisible' where inserted text would
1798 be visible. This is important when we have two
1799 invisible boundaries that enclose an area: if the
1800 area is empty, we need this test in order to make
1801 it possible to place point in the middle rather
1802 than skip both boundaries. However, this code
1803 also stops anywhere in a non-sticky text-property,
1804 which breaks (e.g.) Org mode. */
1805 && (val
= Fget_pos_property (make_number (end
),
1807 TEXT_PROP_MEANS_INVISIBLE (val
))
1809 && !NILP (val
= get_char_property_and_overlay
1810 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1811 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1813 ellipsis
= ellipsis
|| inv
> 1
1814 || (OVERLAYP (overlay
)
1815 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1816 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1817 tmp
= Fnext_single_char_property_change
1818 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1819 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1823 && (val
= Fget_pos_property (make_number (beg
),
1825 TEXT_PROP_MEANS_INVISIBLE (val
))
1827 && !NILP (val
= get_char_property_and_overlay
1828 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1829 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1831 ellipsis
= ellipsis
|| inv
> 1
1832 || (OVERLAYP (overlay
)
1833 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1834 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1835 tmp
= Fprevious_single_char_property_change
1836 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1837 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1840 /* Move away from the inside area. */
1841 if (beg
< PT
&& end
> PT
)
1843 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1844 /* We haven't moved yet (so we don't need to fear
1845 infinite-looping) and we were outside the range
1846 before (so either end of the range still corresponds
1847 to a move in the right direction): pretend we moved
1848 less than we actually did, so that we still have
1849 more freedom below in choosing which end of the range
1851 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1852 /* We either have moved already or the last point
1853 was already in the range: we don't get to choose
1854 which end of the range we have to go to. */
1855 : (PT
< last_pt
? beg
: end
));
1856 check_composition
= check_display
= 1;
1858 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1859 the point to something other than its argument, due to
1860 point-motion hooks, intangibility, etc. */
1861 eassert (PT
== beg
|| PT
== end
);
1864 /* Pretend the area doesn't exist if the buffer is not
1866 if (!modified
&& !ellipsis
&& beg
< end
)
1868 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1869 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1870 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1871 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1872 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1873 /* We've already moved as far as we can. Trying to go
1874 to the other end would mean moving backwards and thus
1875 could lead to an infinite loop. */
1877 else if (val
= Fget_pos_property (make_number (PT
),
1879 TEXT_PROP_MEANS_INVISIBLE (val
)
1880 && (val
= (Fget_pos_property
1881 (make_number (PT
== beg
? end
: beg
),
1883 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1884 (check_composition
= check_display
= 1,
1885 SET_PT (PT
== beg
? end
: beg
));
1888 check_invisible
= 0;
1892 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1895 safe_run_hooks_1 (void)
1897 eassert (CONSP (Vinhibit_quit
));
1898 return call0 (XCDR (Vinhibit_quit
));
1901 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1905 safe_run_hooks_error (Lisp_Object error_data
)
1908 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1909 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1910 Lisp_Object args
[4];
1911 args
[0] = build_string ("Error in %s (%S): %S");
1914 args
[3] = error_data
;
1920 Lisp_Object newval
= Qnil
;
1921 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1922 if (EQ (fun
, XCAR (val
)))
1925 newval
= Fcons (XCAR (val
), newval
);
1927 return Fset (hook
, Fnreverse (newval
));
1928 /* Not found in the local part of the hook. Let's look at the global
1931 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1932 : Fdefault_value (hook
));
1933 CONSP (val
); val
= XCDR (val
))
1934 if (EQ (fun
, XCAR (val
)))
1937 newval
= Fcons (XCAR (val
), newval
);
1939 return Fset_default (hook
, Fnreverse (newval
));
1945 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1947 eassert (nargs
== 1);
1948 if (CONSP (Vinhibit_quit
))
1949 XSETCDR (Vinhibit_quit
, args
[0]);
1951 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1953 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1957 /* If we get an error while running the hook, cause the hook variable
1958 to be nil. Also inhibit quits, so that C-g won't cause the hook
1959 to mysteriously evaporate. */
1962 safe_run_hooks (Lisp_Object hook
)
1964 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1965 to its body or to its handlers other than via globals such as
1966 dynamically-bound variables ;-) */
1968 specbind (Qinhibit_quit
, hook
);
1970 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1976 #ifdef POLL_FOR_INPUT
1978 /* Asynchronous timer for polling. */
1980 static struct atimer
*poll_timer
;
1982 /* Poll for input, so that we catch a C-g if it comes in. */
1984 poll_for_input_1 (void)
1986 if (! input_blocked_p ()
1987 && !waiting_for_input
)
1991 /* Timer callback function for poll_timer. TIMER is equal to
1995 poll_for_input (struct atimer
*timer
)
1999 #endif /* POLL_FOR_INPUT */
2001 /* Begin signals to poll for input, if they are appropriate.
2002 This function is called unconditionally from various places. */
2005 start_polling (void)
2007 #ifdef POLL_FOR_INPUT
2008 /* XXX This condition was (read_socket_hook && !interrupt_input),
2009 but read_socket_hook is not global anymore. Let's pretend that
2011 if (!interrupt_input
)
2013 /* Turn alarm handling on unconditionally. It might have
2014 been turned off in process.c. */
2015 turn_on_atimers (1);
2017 /* If poll timer doesn't exist, or we need one with
2018 a different interval, start a new one. */
2019 if (poll_timer
== NULL
2020 || poll_timer
->interval
.tv_sec
!= polling_period
)
2022 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2023 struct timespec interval
= make_timespec (period
, 0);
2026 cancel_atimer (poll_timer
);
2028 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2029 poll_for_input
, NULL
);
2035 /* True if we are using polling to handle input asynchronously. */
2038 input_polling_used (void)
2040 #ifdef POLL_FOR_INPUT
2041 /* XXX This condition was (read_socket_hook && !interrupt_input),
2042 but read_socket_hook is not global anymore. Let's pretend that
2044 return !interrupt_input
;
2050 /* Bind polling_period to a value at least N.
2051 But don't decrease it. */
2054 bind_polling_period (int n
)
2056 #ifdef POLL_FOR_INPUT
2057 EMACS_INT
new = max (polling_period
, new);
2062 stop_other_atimers (poll_timer
);
2063 specbind (Qpolling_period
, make_number (new));
2064 /* Start a new alarm with the new period. */
2069 /* Apply the control modifier to CHARACTER. */
2072 make_ctrl_char (int c
)
2074 /* Save the upper bits here. */
2075 int upper
= c
& ~0177;
2077 if (! ASCII_CHAR_P (c
))
2078 return c
|= ctrl_modifier
;
2082 /* Everything in the columns containing the upper-case letters
2083 denotes a control character. */
2084 if (c
>= 0100 && c
< 0140)
2088 /* Set the shift modifier for a control char
2089 made from a shifted letter. But only for letters! */
2090 if (oc
>= 'A' && oc
<= 'Z')
2091 c
|= shift_modifier
;
2094 /* The lower-case letters denote control characters too. */
2095 else if (c
>= 'a' && c
<= 'z')
2098 /* Include the bits for control and shift
2099 only if the basic ASCII code can't indicate them. */
2103 /* Replace the high bits. */
2104 c
|= (upper
& ~ctrl_modifier
);
2109 /* Display the help-echo property of the character after the mouse pointer.
2110 Either show it in the echo area, or call show-help-function to display
2111 it by other means (maybe in a tooltip).
2113 If HELP is nil, that means clear the previous help echo.
2115 If HELP is a string, display that string. If HELP is a function,
2116 call it with OBJECT and POS as arguments; the function should
2117 return a help string or nil for none. For all other types of HELP,
2118 evaluate it to obtain a string.
2120 WINDOW is the window in which the help was generated, if any.
2121 It is nil if not in a window.
2123 If OBJECT is a buffer, POS is the position in the buffer where the
2124 `help-echo' text property was found.
2126 If OBJECT is an overlay, that overlay has a `help-echo' property,
2127 and POS is the position in the overlay's buffer under the mouse.
2129 If OBJECT is a string (an overlay string or a string displayed with
2130 the `display' property). POS is the position in that string under
2133 Note: this function may only be called with HELP nil or a string
2134 from X code running asynchronously. */
2137 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2140 if (!NILP (help
) && !STRINGP (help
))
2142 if (FUNCTIONP (help
))
2143 help
= safe_call (4, help
, window
, object
, pos
);
2145 help
= safe_eval (help
);
2147 if (!STRINGP (help
))
2151 if (!noninteractive
&& STRINGP (help
))
2153 /* The mouse-fixup-help-message Lisp function can call
2154 mouse_position_hook, which resets the mouse_moved flags.
2155 This causes trouble if we are trying to read a mouse motion
2156 event (i.e., if we are inside a `track-mouse' form), so we
2157 restore the mouse_moved flag. */
2158 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2159 help
= call1 (Qmouse_fixup_help_message
, help
);
2164 if (STRINGP (help
) || NILP (help
))
2166 if (!NILP (Vshow_help_function
))
2167 call1 (Vshow_help_function
, help
);
2168 help_echo_showing_p
= STRINGP (help
);
2174 /* Input of single characters from keyboard. */
2176 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2177 struct timespec
*end_time
);
2178 static void record_char (Lisp_Object c
);
2180 static Lisp_Object help_form_saved_window_configs
;
2182 read_char_help_form_unwind (void)
2184 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2185 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2186 if (!NILP (window_config
))
2187 Fset_window_configuration (window_config
);
2191 read_event_from_main_queue (struct timespec
*end_time
,
2192 Lisp_Object local_tag
,
2193 bool *used_mouse_menu
)
2195 Lisp_Object c
= Qnil
;
2196 Lisp_Object save_tag
= Qnil
;
2197 sys_jmp_buf
*save_jump
= xmalloc (sizeof *save_jump
);
2198 KBOARD
*kb
IF_LINT (= NULL
);
2202 /* Read from the main queue, and if that gives us something we can't use yet,
2203 we put it on the appropriate side queue and try again. */
2205 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2208 /* Actually read a character, waiting if necessary. */
2210 getctag
= local_tag
;
2212 timer_start_idle ();
2213 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2216 if (! NILP (c
) && (kb
!= current_kboard
))
2218 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2221 while (CONSP (XCDR (last
)))
2223 if (!NILP (XCDR (last
)))
2227 kset_kbd_queue (kb
, list1 (c
));
2229 XSETCDR (last
, list1 (c
));
2230 kb
->kbd_queue_has_data
= 1;
2234 current_kboard
= kb
;
2235 /* This is going to exit from read_char
2236 so we had better get rid of this frame's stuff. */
2237 return make_number (-2);
2240 /* Terminate Emacs in batch mode if at eof. */
2241 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2242 Fkill_emacs (make_number (1));
2246 /* Add in any extra modifiers, where appropriate. */
2247 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2248 || ((extra_keyboard_modifiers
& 0177) < ' '
2249 && (extra_keyboard_modifiers
& 0177) != 0))
2250 XSETINT (c
, make_ctrl_char (XINT (c
)));
2252 /* Transfer any other modifier bits directly from
2253 extra_keyboard_modifiers to c. Ignore the actual character code
2254 in the low 16 bits of extra_keyboard_modifiers. */
2255 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2263 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2266 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2267 Lisp_Object local_getcjmp
,
2268 Lisp_Object prev_event
,
2269 bool *used_mouse_menu
)
2271 #define MAX_ENCODED_BYTES 16
2273 Lisp_Object events
[MAX_ENCODED_BYTES
];
2279 = read_event_from_main_queue (end_time
, local_getcjmp
,
2282 /* w32_console already returns decoded events. It either reads
2283 Unicode characters from the Windows keyboard input, or
2284 converts characters encoded in the current codepage into
2285 Unicode. See w32inevt.c:key_event, near its end. */
2288 struct frame
*frame
= XFRAME (selected_frame
);
2289 struct terminal
*terminal
= frame
->terminal
;
2290 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2291 /* Don't apply decoding if we're just reading a raw event
2292 (e.g. reading bytes sent by the xterm to specify the position
2293 of a mouse click). */
2294 && (!EQ (prev_event
, Qt
))
2295 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2296 & CODING_REQUIRE_DECODING_MASK
)))
2297 return nextevt
; /* No decoding needed. */
2300 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2301 eassert (n
< MAX_ENCODED_BYTES
);
2302 events
[n
++] = nextevt
;
2303 if (NATNUMP (nextevt
)
2304 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2305 { /* An encoded byte sequence, let's try to decode it. */
2306 struct coding_system
*coding
2307 = TERMINAL_KEYBOARD_CODING (terminal
);
2308 unsigned char *src
= alloca (n
);
2310 for (i
= 0; i
< n
; i
++)
2311 src
[i
] = XINT (events
[i
]);
2313 for (i
= 0; i
< n
; i
++)
2315 coding
->destination
= alloca (n
* 4);
2316 coding
->dst_bytes
= n
* 4;
2317 decode_coding_c_string (coding
, src
, n
, Qnil
);
2318 eassert (coding
->produced_char
<= n
);
2319 if (coding
->produced_char
== 0)
2320 { /* The encoded sequence is incomplete. */
2321 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2322 continue; /* Read on! */
2326 const unsigned char *p
= coding
->destination
;
2327 eassert (coding
->carryover_bytes
== 0);
2329 while (n
< coding
->produced_char
)
2330 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2333 /* Now `events' should hold decoded events.
2334 Normally, n should be equal to 1, but better not rely on it.
2335 We can only return one event here, so return the first we
2336 had and keep the others (if any) for later. */
2338 Vunread_command_events
2339 = Fcons (events
[--n
], Vunread_command_events
);
2347 echo_keystrokes_p (void)
2349 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2350 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2353 /* Read a character from the keyboard; call the redisplay if needed. */
2354 /* commandflag 0 means do not autosave, but do redisplay.
2355 -1 means do not redisplay, but do autosave.
2356 -2 means do neither.
2359 /* The argument MAP is a keymap for menu prompting.
2361 PREV_EVENT is the previous input event, or nil if we are reading
2362 the first event of a key sequence (or not reading a key sequence).
2363 If PREV_EVENT is t, that is a "magic" value that says
2364 not to run input methods, but in other respects to act as if
2365 not reading a key sequence.
2367 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2368 if we used a mouse menu to read the input, or false otherwise. If
2369 USED_MOUSE_MENU is null, don't dereference it.
2371 Value is -2 when we find input on another keyboard. A second call
2372 to read_char will read it.
2374 If END_TIME is non-null, it is a pointer to a struct timespec
2375 specifying the maximum time to wait until. If no input arrives by
2376 that time, stop waiting and return nil.
2378 Value is t if we showed a menu and the user rejected it. */
2380 struct read_char_state
2384 Lisp_Object prev_event
;
2385 bool *used_mouse_menu
;
2386 struct timespec
*end_time
;
2389 Lisp_Object local_tag
;
2390 Lisp_Object save_tag
;
2391 Lisp_Object previous_echo_area_message
;
2392 Lisp_Object also_record
;
2394 bool polling_stopped_here
;
2395 struct kboard
*orig_kboard
;
2398 static Lisp_Object
read_char_1 (bool, volatile struct read_char_state
*);
2401 read_char_thunk (void *data
)
2403 return read_char_1 (false, data
);
2407 read_char_handle_quit (void *data
, Lisp_Object k
)
2409 struct read_char_state
*state
= data
;
2410 /* Handle quits while reading the keyboard. */
2411 /* We must have saved the outer value of getcjmp here,
2412 so restore it now. */
2413 getctag
= state
->save_tag
;
2414 XSETINT (state
->c
, quit_char
);
2415 internal_last_event_frame
= selected_frame
;
2416 Vlast_event_frame
= internal_last_event_frame
;
2417 /* If we report the quit char as an event,
2418 don't do so more than once. */
2419 if (!NILP (Vinhibit_quit
))
2423 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2424 if (kb
!= current_kboard
)
2426 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2427 /* We shouldn't get here if we were in single-kboard mode! */
2432 while (CONSP (XCDR (last
)))
2434 if (!NILP (XCDR (last
)))
2438 kset_kbd_queue (kb
, list1 (state
->c
));
2440 XSETCDR (last
, list1 (state
->c
));
2441 kb
->kbd_queue_has_data
= 1;
2442 current_kboard
= kb
;
2443 /* This is going to exit from read_char
2444 so we had better get rid of this frame's stuff. */
2446 return make_number (-2); /* wrong_kboard_jmpbuf */
2449 return read_char_1 (true, state
);
2452 /* {{coccinelle:skip_start}} */
2454 read_char (int commandflag
, Lisp_Object map
,
2455 Lisp_Object prev_event
,
2456 bool *used_mouse_menu
, struct timespec
*end_time
)
2458 struct read_char_state
*state
= xmalloc (sizeof *state
);
2460 state
->commandflag
= commandflag
;
2462 state
->prev_event
= prev_event
;
2463 state
->used_mouse_menu
= used_mouse_menu
;
2464 state
->end_time
= end_time
;
2466 state
->local_tag
= Qnil
;
2467 state
->save_tag
= Qnil
;
2468 state
->previous_echo_area_message
= Qnil
;
2469 state
->also_record
= Qnil
;
2470 state
->reread
= false;
2471 state
->polling_stopped_here
= false;
2472 state
->orig_kboard
= current_kboard
;
2474 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2475 We will do that below, temporarily for short sections of code,
2476 when appropriate. local_getcjmp must be in effect
2477 around any call to sit_for or kbd_buffer_get_event;
2478 it *must not* be in effect when we call redisplay. */
2480 state
->tag
= state
->local_tag
= make_prompt_tag ();
2482 return call_with_prompt (state
->tag
,
2483 make_c_closure (read_char_thunk
, state
, 0, 0),
2484 make_c_closure (read_char_handle_quit
, state
, 1, 0));
2488 read_char_1 (bool jump
, volatile struct read_char_state
*state
)
2490 #define commandflag state->commandflag
2491 #define map state->map
2492 #define prev_event state->prev_event
2493 #define used_mouse_menu state->used_mouse_menu
2494 #define end_time state->end_time
2496 #define jmpcount state->jmpcount
2497 #define local_getcjmp state->local_tag
2498 #define save_jump state->save_tag
2499 #define previous_echo_area_message state->previous_echo_area_message
2500 #define also_record state->also_record
2501 #define reread state->reread
2502 #define polling_stopped_here state->polling_stopped_here
2503 #define orig_kboard state->orig_kboard
2504 #define save_getcjmp(x) (x = getctag)
2505 #define restore_getcjmp(x) (getctag = x)
2506 Lisp_Object tem
, save
;
2513 if (CONSP (Vunread_post_input_method_events
))
2515 c
= XCAR (Vunread_post_input_method_events
);
2516 Vunread_post_input_method_events
2517 = XCDR (Vunread_post_input_method_events
);
2519 /* Undo what read_char_x_menu_prompt did when it unread
2520 additional keys returned by Fx_popup_menu. */
2522 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2533 if (CONSP (Vunread_command_events
))
2535 bool was_disabled
= 0;
2537 c
= XCAR (Vunread_command_events
);
2538 Vunread_command_events
= XCDR (Vunread_command_events
);
2540 /* Undo what sit-for did when it unread additional keys
2541 inside universal-argument. */
2543 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2548 /* Undo what read_char_x_menu_prompt did when it unread
2549 additional keys returned by Fx_popup_menu. */
2551 && EQ (XCDR (c
), Qdisabled
)
2552 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2558 /* If the queued event is something that used the mouse,
2559 set used_mouse_menu accordingly. */
2561 /* Also check was_disabled so last-nonmenu-event won't return
2562 a bad value when submenus are involved. (Bug#447) */
2563 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2564 *used_mouse_menu
= 1;
2566 goto reread_for_input_method
;
2569 if (CONSP (Vunread_input_method_events
))
2571 c
= XCAR (Vunread_input_method_events
);
2572 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2574 /* Undo what read_char_x_menu_prompt did when it unread
2575 additional keys returned by Fx_popup_menu. */
2577 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2581 goto reread_for_input_method
;
2584 this_command_key_count_reset
= 0;
2586 if (!NILP (Vexecuting_kbd_macro
))
2588 /* We set this to Qmacro; since that's not a frame, nobody will
2589 try to switch frames on us, and the selected window will
2592 Since this event came from a macro, it would be misleading to
2593 leave internal_last_event_frame set to wherever the last
2594 real event came from. Normally, a switch-frame event selects
2595 internal_last_event_frame after each command is read, but
2596 events read from a macro should never cause a new frame to be
2598 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2600 /* Exit the macro if we are at the end.
2601 Also, some things replace the macro with t
2602 to force an early exit. */
2603 if (EQ (Vexecuting_kbd_macro
, Qt
)
2604 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2610 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2611 if (STRINGP (Vexecuting_kbd_macro
)
2612 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2613 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2615 executing_kbd_macro_index
++;
2620 if (!NILP (unread_switch_frame
))
2622 c
= unread_switch_frame
;
2623 unread_switch_frame
= Qnil
;
2625 /* This event should make it into this_command_keys, and get echoed
2626 again, so we do not set `reread'. */
2630 /* If redisplay was requested. */
2631 if (commandflag
>= 0)
2633 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2635 /* If there is pending input, process any events which are not
2636 user-visible, such as X selection_request events. */
2638 || detect_input_pending_run_timers (0))
2639 swallow_events (0); /* May clear input_pending. */
2641 /* Redisplay if no pending input. */
2642 while (!input_pending
)
2644 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2645 redisplay_preserve_echo_area (5);
2650 /* Normal case: no input arrived during redisplay. */
2653 /* Input arrived and pre-empted redisplay.
2654 Process any events which are not user-visible. */
2656 /* If that cleared input_pending, try again to redisplay. */
2659 /* Prevent the redisplay we just did
2660 from messing up echoing of the input after the prompt. */
2661 if (commandflag
== 0 && echo_current
)
2662 echo_message_buffer
= echo_area_buffer
[0];
2666 /* Message turns off echoing unless more keystrokes turn it on again.
2668 The code in 20.x for the condition was
2670 1. echo_area_glyphs && *echo_area_glyphs
2671 2. && echo_area_glyphs != current_kboard->echobuf
2672 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2674 (1) means there's a current message displayed
2676 (2) means it's not the message from echoing from the current
2679 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2680 is set to a non-null value. This is done in read_char and it is
2681 set to echo_area_glyphs after a call to echo_char. That means
2682 ok_to_echo_at_next_pause is either null or
2683 current_kboard->echobuf with the appropriate current_kboard at
2686 So, condition (3) means in clear text ok_to_echo_at_next_pause
2687 must be either null, or the current message isn't from echoing at
2688 all, or it's from echoing from a different kboard than the
2691 if (/* There currently is something in the echo area. */
2692 !NILP (echo_area_buffer
[0])
2693 && (/* It's an echo from a different kboard. */
2694 echo_kboard
!= current_kboard
2695 /* Or we explicitly allow overwriting whatever there is. */
2696 || ok_to_echo_at_next_pause
== NULL
))
2701 /* Try reading a character via menu prompting in the minibuf.
2702 Try this before the sit-for, because the sit-for
2703 would do the wrong thing if we are supposed to do
2704 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2705 after a mouse event so don't try a minibuf menu. */
2707 if (KEYMAPP (map
) && INTERACTIVE
2708 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2709 /* Don't bring up a menu if we already have another event. */
2710 && NILP (Vunread_command_events
)
2711 && !detect_input_pending_run_timers (0))
2713 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2715 if (INTEGERP (c
) && XINT (c
) == -2)
2716 return c
; /* wrong_kboard_jmpbuf */
2722 /* Start idle timers if no time limit is supplied. We don't do it
2723 if a time limit is supplied to avoid an infinite recursion in the
2724 situation where an idle timer calls `sit-for'. */
2727 timer_start_idle ();
2729 /* If in middle of key sequence and minibuffer not active,
2730 start echoing if enough time elapses. */
2732 if (minibuf_level
== 0
2734 && !current_kboard
->immediate_echo
2735 && this_command_key_count
> 0
2737 && echo_keystrokes_p ()
2738 && (/* No message. */
2739 NILP (echo_area_buffer
[0])
2740 /* Or empty message. */
2741 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2742 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2743 /* Or already echoing from same kboard. */
2744 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2745 /* Or not echoing before and echoing allowed. */
2746 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2748 /* After a mouse event, start echoing right away.
2749 This is because we are probably about to display a menu,
2750 and we don't want to delay before doing so. */
2751 if (EVENT_HAS_PARAMETERS (prev_event
))
2757 save_getcjmp (save_jump
);
2758 restore_getcjmp (local_getcjmp
);
2759 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2760 restore_getcjmp (save_jump
);
2762 && ! CONSP (Vunread_command_events
))
2767 /* Maybe auto save due to number of keystrokes. */
2769 if (commandflag
!= 0 && commandflag
!= -2
2770 && auto_save_interval
> 0
2771 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2772 && !detect_input_pending_run_timers (0))
2774 Fdo_auto_save (Qnil
, Qnil
);
2775 /* Hooks can actually change some buffers in auto save. */
2779 /* Try reading using an X menu.
2780 This is never confused with reading using the minibuf
2781 because the recursive call of read_char in read_char_minibuf_menu_prompt
2782 does not pass on any keymaps. */
2784 if (KEYMAPP (map
) && INTERACTIVE
2785 && !NILP (prev_event
)
2786 && EVENT_HAS_PARAMETERS (prev_event
)
2787 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2788 && !EQ (XCAR (prev_event
), Qtool_bar
)
2789 /* Don't bring up a menu if we already have another event. */
2790 && NILP (Vunread_command_events
))
2792 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2794 /* Now that we have read an event, Emacs is not idle. */
2801 /* Maybe autosave and/or garbage collect due to idleness. */
2803 if (INTERACTIVE
&& NILP (c
))
2806 ptrdiff_t buffer_size
;
2808 /* Slow down auto saves logarithmically in size of current buffer,
2809 and garbage collect while we're at it. */
2810 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2811 last_non_minibuf_size
= Z
- BEG
;
2812 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2814 while (buffer_size
> 64)
2815 delay_level
++, buffer_size
-= buffer_size
>> 2;
2816 if (delay_level
< 4) delay_level
= 4;
2817 /* delay_level is 4 for files under around 50k, 7 at 100k,
2818 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2820 /* Auto save if enough time goes by without input. */
2821 if (commandflag
!= 0 && commandflag
!= -2
2822 && num_nonmacro_input_events
> last_auto_save
2823 && INTEGERP (Vauto_save_timeout
)
2824 && XINT (Vauto_save_timeout
) > 0)
2827 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2829 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2830 timeout
= delay_level
* timeout
/ 4;
2831 save_getcjmp (save_jump
);
2832 restore_getcjmp (local_getcjmp
);
2833 tem0
= sit_for (make_number (timeout
), 1, 1);
2834 restore_getcjmp (save_jump
);
2837 && ! CONSP (Vunread_command_events
))
2839 Fdo_auto_save (Qnil
, Qnil
);
2844 /* If there is still no input available, ask for GC. */
2845 if (!detect_input_pending_run_timers (0))
2846 GC_collect_a_little ();
2849 /* Notify the caller if an autosave hook, or a timer, sentinel or
2850 filter in the sit_for calls above have changed the current
2851 kboard. This could happen if they use the minibuffer or start a
2852 recursive edit, like the fancy splash screen in server.el's
2853 filter. If this longjmp wasn't here, read_key_sequence would
2854 interpret the next key sequence using the wrong translation
2855 tables and function keymaps. */
2856 if (NILP (c
) && current_kboard
!= orig_kboard
)
2859 return make_number (-2); /* wrong_kboard_jmpbuf */
2862 /* If this has become non-nil here, it has been set by a timer
2863 or sentinel or filter. */
2864 if (CONSP (Vunread_command_events
))
2866 c
= XCAR (Vunread_command_events
);
2867 Vunread_command_events
= XCDR (Vunread_command_events
);
2869 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2875 /* Read something from current KBOARD's side queue, if possible. */
2879 if (current_kboard
->kbd_queue_has_data
)
2881 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2883 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2884 kset_kbd_queue (current_kboard
,
2885 XCDR (KVAR (current_kboard
, kbd_queue
)));
2886 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2887 current_kboard
->kbd_queue_has_data
= 0;
2888 input_pending
= readable_events (0);
2889 if (EVENT_HAS_PARAMETERS (c
)
2890 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2891 internal_last_event_frame
= XCAR (XCDR (c
));
2892 Vlast_event_frame
= internal_last_event_frame
;
2896 /* If current_kboard's side queue is empty check the other kboards.
2897 If one of them has data that we have not yet seen here,
2898 switch to it and process the data waiting for it.
2900 Note: if the events queued up for another kboard
2901 have already been seen here, and therefore are not a complete command,
2902 the kbd_queue_has_data field is 0, so we skip that kboard here.
2903 That's to avoid an infinite loop switching between kboards here. */
2904 if (NILP (c
) && !single_kboard
)
2907 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2908 if (kb
->kbd_queue_has_data
)
2910 current_kboard
= kb
;
2911 /* This is going to exit from read_char
2912 so we had better get rid of this frame's stuff. */
2914 return make_number (-2); /* wrong_kboard_jmpbuf */
2922 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2923 prev_event
, used_mouse_menu
);
2924 if (NILP (c
) && end_time
2925 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2930 if (EQ (c
, make_number (-2)))
2932 /* This is going to exit from read_char
2933 so we had better get rid of this frame's stuff. */
2946 if (commandflag
>= 0
2947 && !input_pending
&& !detect_input_pending_run_timers (0))
2953 /* Buffer switch events are only for internal wakeups
2954 so don't show them to the user.
2955 Also, don't record a key if we already did. */
2959 /* Process special events within read_char
2960 and loop around to read another event. */
2963 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2968 struct buffer
*prev_buffer
= current_buffer
;
2969 last_input_event
= c
;
2970 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2972 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2973 /* We stopped being idle for this event; undo that. This
2974 prevents automatic window selection (under
2975 mouse_autoselect_window from acting as a real input event, for
2976 example banishing the mouse under mouse-avoidance-mode. */
2977 timer_resume_idle ();
2979 if (current_buffer
!= prev_buffer
)
2981 /* The command may have changed the keymaps. Pretend there
2982 is input in another keyboard and return. This will
2983 recalculate keymaps. */
2984 c
= make_number (-2);
2991 /* Handle things that only apply to characters. */
2994 /* If kbd_buffer_get_event gave us an EOF, return that. */
2998 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2999 && UNSIGNED_CMP (XFASTINT (c
), <,
3000 SCHARS (KVAR (current_kboard
,
3001 Vkeyboard_translate_table
))))
3002 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3003 && UNSIGNED_CMP (XFASTINT (c
), <,
3004 ASIZE (KVAR (current_kboard
,
3005 Vkeyboard_translate_table
))))
3006 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3010 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3011 /* nil in keyboard-translate-table means no translation. */
3017 /* If this event is a mouse click in the menu bar,
3018 return just menu-bar for now. Modify the mouse click event
3019 so we won't do this twice, then queue it up. */
3020 if (EVENT_HAS_PARAMETERS (c
)
3022 && CONSP (EVENT_START (c
))
3023 && CONSP (XCDR (EVENT_START (c
))))
3027 posn
= POSN_POSN (EVENT_START (c
));
3028 /* Handle menu-bar events:
3029 insert the dummy prefix event `menu-bar'. */
3030 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3032 /* Change menu-bar to (menu-bar) as the event "position". */
3033 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3036 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3041 /* Store these characters into recent_keys, the dribble file if any,
3042 and the keyboard macro being defined, if any. */
3044 if (! NILP (also_record
))
3045 record_char (also_record
);
3047 /* Wipe the echo area.
3048 But first, if we are about to use an input method,
3049 save the echo area contents for it to refer to. */
3051 && ! NILP (Vinput_method_function
)
3052 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3054 previous_echo_area_message
= Fcurrent_message ();
3055 Vinput_method_previous_message
= previous_echo_area_message
;
3058 /* Now wipe the echo area, except for help events which do their
3059 own stuff with the echo area. */
3061 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3062 && !(EQ (Qswitch_frame
, XCAR (c
)))
3063 /* Don't wipe echo area for select window events: These might
3064 get delayed via `mouse-autoselect-window' (Bug#11304). */
3065 && !(EQ (Qselect_window
, XCAR (c
)))))
3067 if (!NILP (echo_area_buffer
[0]))
3069 safe_run_hooks (Qecho_area_clear_hook
);
3070 clear_message (1, 0);
3074 reread_for_input_method
:
3076 /* Pass this to the input method, if appropriate. */
3078 && ! NILP (Vinput_method_function
)
3079 /* Don't run the input method within a key sequence,
3080 after the first event of the key sequence. */
3081 && NILP (prev_event
)
3082 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3085 ptrdiff_t key_count
;
3086 bool key_count_reset
;
3087 struct gcpro gcpro1
;
3089 /* Save the echo status. */
3090 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3091 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3092 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3093 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3098 if (before_command_restore_flag
)
3100 this_command_key_count
= before_command_key_count_1
;
3101 if (this_command_key_count
< this_single_command_key_start
)
3102 this_single_command_key_start
= this_command_key_count
;
3103 echo_truncate (before_command_echo_length_1
);
3104 before_command_restore_flag
= 0;
3108 /* Save the this_command_keys status. */
3109 key_count
= this_command_key_count
;
3110 key_count_reset
= this_command_key_count_reset
;
3113 keys
= Fcopy_sequence (this_command_keys
);
3118 /* Clear out this_command_keys. */
3119 this_command_key_count
= 0;
3120 this_command_key_count_reset
= 0;
3122 /* Now wipe the echo area. */
3123 if (!NILP (echo_area_buffer
[0]))
3124 safe_run_hooks (Qecho_area_clear_hook
);
3125 clear_message (1, 0);
3128 /* If we are not reading a key sequence,
3129 never use the echo area. */
3132 specbind (Qinput_method_use_echo_area
, Qt
);
3135 /* Call the input method. */
3136 tem
= call1 (Vinput_method_function
, c
);
3140 /* Restore the saved echoing state
3141 and this_command_keys state. */
3142 this_command_key_count
= key_count
;
3143 this_command_key_count_reset
= key_count_reset
;
3145 this_command_keys
= keys
;
3148 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3149 kset_echo_string (current_kboard
, saved_echo_string
);
3150 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3151 if (saved_immediate_echo
)
3156 /* The input method can return no events. */
3159 /* Bring back the previous message, if any. */
3160 if (! NILP (previous_echo_area_message
))
3161 message_with_string ("%s", previous_echo_area_message
, 0);
3164 /* It returned one event or more. */
3166 Vunread_post_input_method_events
3167 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3172 /* Display help if not echoing. */
3173 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3175 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3176 Lisp_Object help
, object
, position
, window
, htem
;
3178 htem
= Fcdr (XCDR (c
));
3181 window
= Fcar (htem
);
3183 object
= Fcar (htem
);
3185 position
= Fcar (htem
);
3187 show_help_echo (help
, window
, object
, position
);
3189 /* We stopped being idle for this event; undo that. */
3191 timer_resume_idle ();
3195 if ((! reread
|| this_command_key_count
== 0
3196 || this_command_key_count_reset
)
3200 /* Don't echo mouse motion events. */
3201 if (echo_keystrokes_p ()
3202 && ! (EVENT_HAS_PARAMETERS (c
)
3203 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3206 if (! NILP (also_record
))
3207 echo_char (also_record
);
3208 /* Once we reread a character, echoing can happen
3209 the next time we pause to read a new one. */
3210 ok_to_echo_at_next_pause
= current_kboard
;
3213 /* Record this character as part of the current key. */
3214 add_command_key (c
);
3215 if (! NILP (also_record
))
3216 add_command_key (also_record
);
3219 last_input_event
= c
;
3222 /* Process the help character specially if enabled. */
3223 if (!NILP (Vhelp_form
) && help_char_p (c
))
3227 help_form_saved_window_configs
3228 = Fcons (Fcurrent_window_configuration (Qnil
),
3229 help_form_saved_window_configs
);
3230 record_unwind_protect_void (read_char_help_form_unwind
);
3231 call0 (Qhelp_form_show
);
3236 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3237 if (EVENT_HAS_PARAMETERS (c
)
3238 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3239 XSETCAR (help_form_saved_window_configs
, Qnil
);
3241 while (BUFFERP (c
));
3242 /* Remove the help from the frame. */
3246 if (EQ (c
, make_number (040)))
3250 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3251 while (BUFFERP (c
));
3260 #undef used_mouse_menu
3264 #undef local_getcjmp
3266 #undef previous_echo_area_message
3269 #undef polling_stopped_here
3272 #undef restore_getcjmp
3274 /* {{coccinelle:skip_end}} */
3276 /* Record a key that came from a mouse menu.
3277 Record it for echoing, for this-command-keys, and so on. */
3280 record_menu_key (Lisp_Object c
)
3282 /* Wipe the echo area. */
3283 clear_message (1, 0);
3288 before_command_key_count
= this_command_key_count
;
3289 before_command_echo_length
= echo_length ();
3292 /* Don't echo mouse motion events. */
3293 if (echo_keystrokes_p ())
3297 /* Once we reread a character, echoing can happen
3298 the next time we pause to read a new one. */
3299 ok_to_echo_at_next_pause
= 0;
3302 /* Record this character as part of the current key. */
3303 add_command_key (c
);
3305 /* Re-reading in the middle of a command. */
3306 last_input_event
= c
;
3310 /* Return true if should recognize C as "the help character". */
3313 help_char_p (Lisp_Object c
)
3317 if (EQ (c
, Vhelp_char
))
3319 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3320 if (EQ (c
, XCAR (tail
)))
3325 /* Record the input event C in various ways. */
3328 record_char (Lisp_Object c
)
3332 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3334 /* To avoid filling recent_keys with help-echo and mouse-movement
3335 events, we filter out repeated help-echo events, only store the
3336 first and last in a series of mouse-movement events, and don't
3337 store repeated help-echo events which are only separated by
3338 mouse-movement events. */
3340 Lisp_Object ev1
, ev2
, ev3
;
3343 if ((ix1
= recent_keys_index
- 1) < 0)
3344 ix1
= NUM_RECENT_KEYS
- 1;
3345 ev1
= AREF (recent_keys
, ix1
);
3347 if ((ix2
= ix1
- 1) < 0)
3348 ix2
= NUM_RECENT_KEYS
- 1;
3349 ev2
= AREF (recent_keys
, ix2
);
3351 if ((ix3
= ix2
- 1) < 0)
3352 ix3
= NUM_RECENT_KEYS
- 1;
3353 ev3
= AREF (recent_keys
, ix3
);
3355 if (EQ (XCAR (c
), Qhelp_echo
))
3357 /* Don't record `help-echo' in recent_keys unless it shows some help
3358 message, and a different help than the previously recorded
3360 Lisp_Object help
, last_help
;
3362 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3363 if (!STRINGP (help
))
3365 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3366 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3368 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3369 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3370 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3372 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3373 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3374 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3375 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3378 else if (EQ (XCAR (c
), Qmouse_movement
))
3380 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3381 So additional mouse movement events replace the last element. */
3382 Lisp_Object last_window
, window
;
3384 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3385 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3386 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3387 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3388 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3390 ASET (recent_keys
, ix1
, c
);
3396 store_kbd_macro_char (c
);
3400 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3401 ASET (recent_keys
, recent_keys_index
, c
);
3402 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3403 recent_keys_index
= 0;
3405 else if (recorded
< 0)
3407 /* We need to remove one or two events from recent_keys.
3408 To do this, we simply put nil at those events and move the
3409 recent_keys_index backwards over those events. Usually,
3410 users will never see those nil events, as they will be
3411 overwritten by the command keys entered to see recent_keys
3414 while (recorded
++ < 0 && total_keys
> 0)
3416 if (total_keys
< NUM_RECENT_KEYS
)
3418 if (--recent_keys_index
< 0)
3419 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3420 ASET (recent_keys
, recent_keys_index
, Qnil
);
3424 num_nonmacro_input_events
++;
3426 /* Write c to the dribble file. If c is a lispy event, write
3427 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3428 If you, dear reader, have a better idea, you've got the source. :-) */
3434 if (XUINT (c
) < 0x100)
3435 putc (XUINT (c
), dribble
);
3437 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3441 Lisp_Object dribblee
;
3443 /* If it's a structured event, take the event header. */
3444 dribblee
= EVENT_HEAD (c
);
3446 if (SYMBOLP (dribblee
))
3448 putc ('<', dribble
);
3449 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3450 SBYTES (SYMBOL_NAME (dribblee
)),
3452 putc ('>', dribble
);
3461 /* Low level keyboard/mouse input.
3462 kbd_buffer_store_event places events in kbd_buffer, and
3463 kbd_buffer_get_event retrieves them. */
3465 /* Return true if there are any events in the queue that read-char
3466 would return. If this returns false, a read-char would block. */
3468 readable_events (int flags
)
3470 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3473 /* If the buffer contains only FOCUS_IN_EVENT events, and
3474 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3475 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3477 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3478 #ifdef USE_TOOLKIT_SCROLL_BARS
3479 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3483 struct input_event
*event
;
3485 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3492 #ifdef USE_TOOLKIT_SCROLL_BARS
3493 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3495 event
->kind
== FOCUS_IN_EVENT
)
3496 #ifdef USE_TOOLKIT_SCROLL_BARS
3497 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3498 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3499 && event
->part
== scroll_bar_handle
3500 && event
->modifiers
== 0)
3505 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3508 while (event
!= kbd_store_ptr
);
3514 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3515 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3519 if (current_kboard
->kbd_queue_has_data
)
3525 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3526 if (kb
->kbd_queue_has_data
)
3532 /* Set this for debugging, to have a way to get out */
3533 int stop_character EXTERNALLY_VISIBLE
;
3536 event_to_kboard (struct input_event
*event
)
3538 /* Not applicable for these special events. */
3539 if (event
->kind
== SELECTION_REQUEST_EVENT
3540 || event
->kind
== SELECTION_CLEAR_EVENT
)
3544 Lisp_Object obj
= event
->frame_or_window
;
3545 /* There are some events that set this field to nil or string. */
3547 obj
= WINDOW_FRAME (XWINDOW (obj
));
3548 /* Also ignore dead frames here. */
3549 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3550 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3555 /* Return the number of slots occupied in kbd_buffer. */
3558 kbd_buffer_nr_stored (void)
3560 return kbd_fetch_ptr
== kbd_store_ptr
3562 : (kbd_fetch_ptr
< kbd_store_ptr
3563 ? kbd_store_ptr
- kbd_fetch_ptr
3564 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3565 + (kbd_store_ptr
- kbd_buffer
)));
3567 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3570 kbd_buffer_store_event (register struct input_event
*event
)
3572 kbd_buffer_store_event_hold (event
, 0);
3575 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3577 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3578 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3579 Else, if EVENT is a quit event, store the quit event
3580 in HOLD_QUIT, and return (thus ignoring further events).
3582 This is used to postpone the processing of the quit event until all
3583 subsequent input events have been parsed (and discarded). */
3586 kbd_buffer_store_event_hold (register struct input_event
*event
,
3587 struct input_event
*hold_quit
)
3589 if (event
->kind
== NO_EVENT
)
3592 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3595 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3597 register int c
= event
->code
& 0377;
3599 if (event
->modifiers
& ctrl_modifier
)
3600 c
= make_ctrl_char (c
);
3602 c
|= (event
->modifiers
3603 & (meta_modifier
| alt_modifier
3604 | hyper_modifier
| super_modifier
));
3608 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3609 struct input_event
*sp
;
3611 if (single_kboard
&& kb
!= current_kboard
)
3614 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3616 kb
->kbd_queue_has_data
= 1;
3617 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3619 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3622 if (event_to_kboard (sp
) == kb
)
3624 sp
->kind
= NO_EVENT
;
3625 sp
->frame_or_window
= Qnil
;
3634 *hold_quit
= *event
;
3638 /* If this results in a quit_char being returned to Emacs as
3639 input, set Vlast_event_frame properly. If this doesn't
3640 get returned to Emacs as an event, the next event read
3641 will set Vlast_event_frame again, so this is safe to do. */
3645 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3647 focus
= event
->frame_or_window
;
3648 internal_last_event_frame
= focus
;
3649 Vlast_event_frame
= focus
;
3652 handle_interrupt (0);
3656 if (c
&& c
== stop_character
)
3662 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3663 Just ignore the second one. */
3664 else if (event
->kind
== BUFFER_SWITCH_EVENT
3665 && kbd_fetch_ptr
!= kbd_store_ptr
3666 && ((kbd_store_ptr
== kbd_buffer
3667 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3668 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3671 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3672 kbd_store_ptr
= kbd_buffer
;
3674 /* Don't let the very last slot in the buffer become full,
3675 since that would make the two pointers equal,
3676 and that is indistinguishable from an empty buffer.
3677 Discard the event if it would fill the last slot. */
3678 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3680 *kbd_store_ptr
= *event
;
3683 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3684 && ! kbd_on_hold_p ())
3686 /* Don't read keyboard input until we have processed kbd_buffer.
3687 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3688 hold_keyboard_input ();
3689 if (!noninteractive
)
3692 #endif /* subprocesses */
3695 /* If we're inside while-no-input, and this event qualifies
3696 as input, set quit-flag to cause an interrupt. */
3697 if (!NILP (Vthrow_on_input
)
3698 && event
->kind
!= FOCUS_IN_EVENT
3699 && event
->kind
!= HELP_EVENT
3700 && event
->kind
!= DEICONIFY_EVENT
)
3702 Vquit_flag
= Vthrow_on_input
;
3703 /* If we're inside a function that wants immediate quits,
3705 if (immediate_quit
&& NILP (Vinhibit_quit
))
3714 /* Put an input event back in the head of the event queue. */
3717 kbd_buffer_unget_event (register struct input_event
*event
)
3719 if (kbd_fetch_ptr
== kbd_buffer
)
3720 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3722 /* Don't let the very last slot in the buffer become full, */
3723 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3726 *kbd_fetch_ptr
= *event
;
3731 /* Generate a HELP_EVENT input_event and store it in the keyboard
3734 HELP is the help form.
3736 FRAME and WINDOW are the frame and window where the help is
3737 generated. OBJECT is the Lisp object where the help was found (a
3738 buffer, a string, an overlay, or nil if neither from a string nor
3739 from a buffer). POS is the position within OBJECT where the help
3743 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3744 Lisp_Object object
, ptrdiff_t pos
)
3746 struct input_event event
;
3750 event
.kind
= HELP_EVENT
;
3751 event
.frame_or_window
= frame
;
3753 event
.x
= WINDOWP (window
) ? window
: frame
;
3756 kbd_buffer_store_event (&event
);
3760 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3763 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3765 struct input_event event
;
3767 event
.kind
= HELP_EVENT
;
3768 event
.frame_or_window
= frame
;
3773 kbd_buffer_store_event (&event
);
3777 /* Discard any mouse events in the event buffer by setting them to
3780 discard_mouse_events (void)
3782 struct input_event
*sp
;
3783 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3785 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3788 if (sp
->kind
== MOUSE_CLICK_EVENT
3789 || sp
->kind
== WHEEL_EVENT
3790 || sp
->kind
== HORIZ_WHEEL_EVENT
3792 || sp
->kind
== GPM_CLICK_EVENT
3794 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3796 sp
->kind
= NO_EVENT
;
3802 /* Return true if there are any real events waiting in the event
3803 buffer, not counting `NO_EVENT's.
3805 Discard NO_EVENT events at the front of the input queue, possibly
3806 leaving the input queue empty if there are no real input events. */
3809 kbd_buffer_events_waiting (void)
3811 struct input_event
*sp
;
3813 for (sp
= kbd_fetch_ptr
;
3814 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3817 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3822 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3826 /* Clear input event EVENT. */
3829 clear_event (struct input_event
*event
)
3831 event
->kind
= NO_EVENT
;
3835 /* Read one event from the event buffer, waiting if necessary.
3836 The value is a Lisp object representing the event.
3837 The value is nil for an event that should be ignored,
3838 or that was handled here.
3839 We always read and discard one event. */
3842 kbd_buffer_get_event (KBOARD
**kbp
,
3843 bool *used_mouse_menu
,
3844 struct timespec
*end_time
)
3849 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3851 /* Start reading input again because we have processed enough to
3852 be able to accept new events again. */
3853 unhold_keyboard_input ();
3855 #endif /* subprocesses */
3857 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3859 /* In case we are running as a daemon, only do this before
3860 detaching from the terminal. */
3861 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3865 *kbp
= current_kboard
;
3868 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3870 /* Wait until there is input available. */
3873 /* Break loop if there's an unread command event. Needed in
3874 moused window autoselection which uses a timer to insert such
3876 if (CONSP (Vunread_command_events
))
3879 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3881 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3884 /* If the quit flag is set, then read_char will return
3885 quit_char, so that counts as "available input." */
3886 if (!NILP (Vquit_flag
))
3887 quit_throw_to_read_char (0);
3889 /* One way or another, wait until input is available; then, if
3890 interrupt handlers have not read it, read it now. */
3895 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3897 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3901 struct timespec now
= current_timespec ();
3902 if (timespec_cmp (*end_time
, now
) <= 0)
3903 return Qnil
; /* Finished waiting. */
3906 struct timespec duration
= timespec_sub (*end_time
, now
);
3907 wait_reading_process_output (min (duration
.tv_sec
,
3910 -1, 1, Qnil
, NULL
, 0);
3915 bool do_display
= true;
3917 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3919 struct tty_display_info
*tty
= CURTTY ();
3921 /* When this TTY is displaying a menu, we must prevent
3922 any redisplay, because we modify the frame's glyph
3923 matrix behind the back of the display engine. */
3924 if (tty
->showing_menu
)
3928 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3931 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3935 if (CONSP (Vunread_command_events
))
3938 first
= XCAR (Vunread_command_events
);
3939 Vunread_command_events
= XCDR (Vunread_command_events
);
3940 *kbp
= current_kboard
;
3944 /* At this point, we know that there is a readable event available
3945 somewhere. If the event queue is empty, then there must be a
3946 mouse movement enabled and available. */
3947 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3949 struct input_event
*event
;
3951 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3955 *kbp
= event_to_kboard (event
);
3957 *kbp
= current_kboard
; /* Better than returning null ptr? */
3961 /* These two kinds of events get special handling
3962 and don't actually appear to the command loop.
3963 We return nil for them. */
3964 if (event
->kind
== SELECTION_REQUEST_EVENT
3965 || event
->kind
== SELECTION_CLEAR_EVENT
)
3968 struct input_event copy
;
3970 /* Remove it from the buffer before processing it,
3971 since otherwise swallow_events will see it
3972 and process it again. */
3974 kbd_fetch_ptr
= event
+ 1;
3975 input_pending
= readable_events (0);
3976 x_handle_selection_event (©
);
3978 /* We're getting selection request events, but we don't have
3984 #if defined (HAVE_NS)
3985 else if (event
->kind
== NS_TEXT_EVENT
)
3987 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3988 obj
= list1 (intern ("ns-put-working-text"));
3990 obj
= list1 (intern ("ns-unput-working-text"));
3991 kbd_fetch_ptr
= event
+ 1;
3992 if (used_mouse_menu
)
3993 *used_mouse_menu
= 1;
3997 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3998 || defined (HAVE_NS)
3999 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4001 /* Make an event (delete-frame (FRAME)). */
4002 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4003 kbd_fetch_ptr
= event
+ 1;
4006 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4007 || defined (HAVE_NS)
4008 else if (event
->kind
== ICONIFY_EVENT
)
4010 /* Make an event (iconify-frame (FRAME)). */
4011 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4012 kbd_fetch_ptr
= event
+ 1;
4014 else if (event
->kind
== DEICONIFY_EVENT
)
4016 /* Make an event (make-frame-visible (FRAME)). */
4017 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4018 kbd_fetch_ptr
= event
+ 1;
4021 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4023 /* The value doesn't matter here; only the type is tested. */
4024 XSETBUFFER (obj
, current_buffer
);
4025 kbd_fetch_ptr
= event
+ 1;
4027 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4028 || defined (HAVE_NS) || defined (USE_GTK)
4029 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4031 kbd_fetch_ptr
= event
+ 1;
4032 input_pending
= readable_events (0);
4033 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4034 x_activate_menubar (XFRAME (event
->frame_or_window
));
4038 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4040 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4041 obj
= list4 (Qlanguage_change
,
4042 event
->frame_or_window
,
4043 make_number (event
->code
),
4044 make_number (event
->modifiers
));
4045 kbd_fetch_ptr
= event
+ 1;
4048 #ifdef USE_FILE_NOTIFY
4049 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4051 #ifdef HAVE_W32NOTIFY
4052 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4053 obj
= list3 (Qfile_notify
,
4054 list3 (make_number (event
->code
),
4057 event
->frame_or_window
);
4059 obj
= make_lispy_event (event
);
4061 kbd_fetch_ptr
= event
+ 1;
4063 #endif /* USE_FILE_NOTIFY */
4064 else if (event
->kind
== SAVE_SESSION_EVENT
)
4066 obj
= list2 (Qsave_session
, event
->arg
);
4067 kbd_fetch_ptr
= event
+ 1;
4069 /* Just discard these, by returning nil.
4070 With MULTI_KBOARD, these events are used as placeholders
4071 when we need to randomly delete events from the queue.
4072 (They shouldn't otherwise be found in the buffer,
4073 but on some machines it appears they do show up
4074 even without MULTI_KBOARD.) */
4075 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4076 mouse events during a popup-menu call. */
4077 else if (event
->kind
== NO_EVENT
)
4078 kbd_fetch_ptr
= event
+ 1;
4079 else if (event
->kind
== HELP_EVENT
)
4081 Lisp_Object object
, position
, help
, frame
, window
;
4083 frame
= event
->frame_or_window
;
4084 object
= event
->arg
;
4085 position
= make_number (event
->code
);
4088 clear_event (event
);
4090 kbd_fetch_ptr
= event
+ 1;
4091 if (!WINDOWP (window
))
4093 obj
= Fcons (Qhelp_echo
,
4094 list5 (frame
, help
, window
, object
, position
));
4096 else if (event
->kind
== FOCUS_IN_EVENT
)
4098 /* Notification of a FocusIn event. The frame receiving the
4099 focus is in event->frame_or_window. Generate a
4100 switch-frame event if necessary. */
4101 Lisp_Object frame
, focus
;
4103 frame
= event
->frame_or_window
;
4104 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4113 !EQ (frame
, internal_last_event_frame
)
4114 && !EQ (frame
, selected_frame
))
4115 obj
= make_lispy_switch_frame (frame
);
4117 obj
= make_lispy_focus_in (frame
);
4119 internal_last_event_frame
= frame
;
4120 kbd_fetch_ptr
= event
+ 1;
4122 else if (event
->kind
== FOCUS_OUT_EVENT
)
4124 #ifdef HAVE_WINDOW_SYSTEM
4127 Lisp_Object frame
= event
->frame_or_window
;
4128 bool focused
= false;
4130 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4131 focused
= di
->x_highlight_frame
!= 0;
4134 obj
= make_lispy_focus_out (frame
);
4136 #endif /* HAVE_WINDOW_SYSTEM */
4138 kbd_fetch_ptr
= event
+ 1;
4141 else if (event
->kind
== DBUS_EVENT
)
4143 obj
= make_lispy_event (event
);
4144 kbd_fetch_ptr
= event
+ 1;
4147 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4149 obj
= make_lispy_event (event
);
4150 kbd_fetch_ptr
= event
+ 1;
4154 /* If this event is on a different frame, return a switch-frame this
4155 time, and leave the event in the queue for next time. */
4159 frame
= event
->frame_or_window
;
4161 frame
= XCAR (frame
);
4162 else if (WINDOWP (frame
))
4163 frame
= WINDOW_FRAME (XWINDOW (frame
));
4165 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4169 if (! EQ (frame
, internal_last_event_frame
)
4170 && !EQ (frame
, selected_frame
))
4171 obj
= make_lispy_switch_frame (frame
);
4172 internal_last_event_frame
= frame
;
4174 /* If we didn't decide to make a switch-frame event, go ahead
4175 and build a real event from the queue entry. */
4179 obj
= make_lispy_event (event
);
4181 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4182 || defined (HAVE_NS) || defined (USE_GTK)
4183 /* If this was a menu selection, then set the flag to inhibit
4184 writing to last_nonmenu_event. Don't do this if the event
4185 we're returning is (menu-bar), though; that indicates the
4186 beginning of the menu sequence, and we might as well leave
4187 that as the `event with parameters' for this selection. */
4189 && !EQ (event
->frame_or_window
, event
->arg
)
4190 && (event
->kind
== MENU_BAR_EVENT
4191 || event
->kind
== TOOL_BAR_EVENT
))
4192 *used_mouse_menu
= 1;
4195 /* Certain system events are non-key events. */
4197 && event
->kind
== NS_NONKEY_EVENT
)
4198 *used_mouse_menu
= 1;
4201 /* Wipe out this event, to catch bugs. */
4202 clear_event (event
);
4203 kbd_fetch_ptr
= event
+ 1;
4207 /* Try generating a mouse motion event. */
4208 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4210 struct frame
*f
= some_mouse_moved ();
4211 Lisp_Object bar_window
;
4212 enum scroll_bar_part part
;
4216 *kbp
= current_kboard
;
4217 /* Note that this uses F to determine which terminal to look at.
4218 If there is no valid info, it does not store anything
4219 so x remains nil. */
4222 /* XXX Can f or mouse_position_hook be NULL here? */
4223 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4224 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4229 /* Decide if we should generate a switch-frame event. Don't
4230 generate switch-frame events for motion outside of all Emacs
4236 frame
= FRAME_FOCUS_FRAME (f
);
4238 XSETFRAME (frame
, f
);
4240 if (! EQ (frame
, internal_last_event_frame
)
4241 && !EQ (frame
, selected_frame
))
4242 obj
= make_lispy_switch_frame (frame
);
4243 internal_last_event_frame
= frame
;
4246 /* If we didn't decide to make a switch-frame event, go ahead and
4247 return a mouse-motion event. */
4248 if (!NILP (x
) && NILP (obj
))
4249 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4252 /* We were promised by the above while loop that there was
4253 something for us to read! */
4256 input_pending
= readable_events (0);
4258 Vlast_event_frame
= internal_last_event_frame
;
4263 /* Process any non-user-visible events (currently X selection events),
4264 without reading any user-visible events. */
4267 process_special_events (void)
4269 struct input_event
*event
;
4271 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4273 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4276 if (event
== kbd_store_ptr
)
4280 /* If we find a stored X selection request, handle it now. */
4281 if (event
->kind
== SELECTION_REQUEST_EVENT
4282 || event
->kind
== SELECTION_CLEAR_EVENT
)
4286 /* Remove the event from the fifo buffer before processing;
4287 otherwise swallow_events called recursively could see it
4288 and process it again. To do this, we move the events
4289 between kbd_fetch_ptr and EVENT one slot to the right,
4292 struct input_event copy
= *event
;
4293 struct input_event
*beg
4294 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4295 ? kbd_buffer
: kbd_fetch_ptr
;
4298 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4299 else if (event
< beg
)
4301 if (event
> kbd_buffer
)
4302 memmove (kbd_buffer
+ 1, kbd_buffer
,
4303 (event
- kbd_buffer
) * sizeof (struct input_event
));
4304 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4305 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4306 memmove (beg
+ 1, beg
,
4307 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4308 * sizeof (struct input_event
));
4311 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4312 kbd_fetch_ptr
= kbd_buffer
+ 1;
4316 input_pending
= readable_events (0);
4317 x_handle_selection_event (©
);
4319 /* We're getting selection request events, but we don't have
4327 /* Process any events that are not user-visible, run timer events that
4328 are ripe, and return, without reading any user-visible events. */
4331 swallow_events (bool do_display
)
4333 unsigned old_timers_run
;
4335 process_special_events ();
4337 old_timers_run
= timers_run
;
4338 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4340 if (timers_run
!= old_timers_run
&& do_display
)
4341 redisplay_preserve_echo_area (7);
4344 /* Record the start of when Emacs is idle,
4345 for the sake of running idle-time timers. */
4348 timer_start_idle (void)
4350 /* If we are already in the idle state, do nothing. */
4351 if (timespec_valid_p (timer_idleness_start_time
))
4354 timer_idleness_start_time
= current_timespec ();
4355 timer_last_idleness_start_time
= timer_idleness_start_time
;
4357 /* Mark all idle-time timers as once again candidates for running. */
4358 call0 (intern ("internal-timer-start-idle"));
4361 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4364 timer_stop_idle (void)
4366 timer_idleness_start_time
= invalid_timespec ();
4369 /* Resume idle timer from last idle start time. */
4372 timer_resume_idle (void)
4374 if (timespec_valid_p (timer_idleness_start_time
))
4377 timer_idleness_start_time
= timer_last_idleness_start_time
;
4380 /* This is only for debugging. */
4381 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4383 /* List of elisp functions to call, delayed because they were generated in
4384 a context where Elisp could not be safely run (e.g. redisplay, signal,
4385 ...). Each element has the form (FUN . ARGS). */
4386 Lisp_Object pending_funcalls
;
4388 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4390 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4392 Lisp_Object
*vector
;
4394 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4396 vector
= XVECTOR (timer
)->contents
;
4397 if (! NILP (vector
[0]))
4400 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4405 /* Check whether a timer has fired. To prevent larger problems we simply
4406 disregard elements that are not proper timers. Do not make a circular
4407 timer list for the time being.
4409 Returns the time to wait until the next timer fires. If a
4410 timer is triggering now, return zero.
4411 If no timer is active, return -1.
4413 If a timer is ripe, we run it, with quitting turned off.
4414 In that case we return 0 to indicate that a new timer_check_2 call
4417 static struct timespec
4418 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4420 struct timespec nexttime
;
4421 struct timespec now
;
4422 struct timespec idleness_now
;
4423 Lisp_Object chosen_timer
;
4424 struct gcpro gcpro1
;
4426 nexttime
= invalid_timespec ();
4428 chosen_timer
= Qnil
;
4429 GCPRO1 (chosen_timer
);
4431 /* First run the code that was delayed. */
4432 while (CONSP (pending_funcalls
))
4434 Lisp_Object funcall
= XCAR (pending_funcalls
);
4435 pending_funcalls
= XCDR (pending_funcalls
);
4436 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4439 if (CONSP (timers
) || CONSP (idle_timers
))
4441 now
= current_timespec ();
4442 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4443 ? timespec_sub (now
, timer_idleness_start_time
)
4444 : make_timespec (0, 0));
4447 while (CONSP (timers
) || CONSP (idle_timers
))
4449 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4450 struct timespec timer_time
, idle_timer_time
;
4451 struct timespec difference
;
4452 struct timespec timer_difference
= invalid_timespec ();
4453 struct timespec idle_timer_difference
= invalid_timespec ();
4454 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4456 /* Set TIMER and TIMER_DIFFERENCE
4457 based on the next ordinary timer.
4458 TIMER_DIFFERENCE is the distance in time from NOW to when
4459 this timer becomes ripe (negative if it's already ripe).
4460 Skip past invalid timers and timers already handled. */
4463 timer
= XCAR (timers
);
4464 if (! decode_timer (timer
, &timer_time
))
4466 timers
= XCDR (timers
);
4470 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4471 timer_difference
= (timer_ripe
4472 ? timespec_sub (now
, timer_time
)
4473 : timespec_sub (timer_time
, now
));
4476 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4477 based on the next idle timer. */
4478 if (CONSP (idle_timers
))
4480 idle_timer
= XCAR (idle_timers
);
4481 if (! decode_timer (idle_timer
, &idle_timer_time
))
4483 idle_timers
= XCDR (idle_timers
);
4487 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4488 idle_timer_difference
4490 ? timespec_sub (idleness_now
, idle_timer_time
)
4491 : timespec_sub (idle_timer_time
, idleness_now
));
4494 /* Decide which timer is the next timer,
4495 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4496 Also step down the list where we found that timer. */
4498 if (timespec_valid_p (timer_difference
)
4499 && (! timespec_valid_p (idle_timer_difference
)
4500 || idle_timer_ripe
< timer_ripe
4501 || (idle_timer_ripe
== timer_ripe
4503 ? timespec_cmp (idle_timer_difference
,
4505 : timespec_cmp (timer_difference
,
4506 idle_timer_difference
))
4509 chosen_timer
= timer
;
4510 timers
= XCDR (timers
);
4511 difference
= timer_difference
;
4516 chosen_timer
= idle_timer
;
4517 idle_timers
= XCDR (idle_timers
);
4518 difference
= idle_timer_difference
;
4519 ripe
= idle_timer_ripe
;
4522 /* If timer is ripe, run it if it hasn't been run. */
4525 if (NILP (AREF (chosen_timer
, 0)))
4528 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4530 /* Mark the timer as triggered to prevent problems if the lisp
4531 code fails to reschedule it right. */
4532 ASET (chosen_timer
, 0, Qt
);
4534 specbind (Qinhibit_quit
, Qt
);
4536 call1 (Qtimer_event_handler
, chosen_timer
);
4537 Vdeactivate_mark
= old_deactivate_mark
;
4541 /* Since we have handled the event,
4542 we don't need to tell the caller to wake up and do it. */
4543 /* But the caller must still wait for the next timer, so
4544 return 0 to indicate that. */
4547 nexttime
= make_timespec (0, 0);
4551 /* When we encounter a timer that is still waiting,
4552 return the amount of time to wait before it is ripe. */
4559 /* No timers are pending in the future. */
4560 /* Return 0 if we generated an event, and -1 if not. */
4566 /* Check whether a timer has fired. To prevent larger problems we simply
4567 disregard elements that are not proper timers. Do not make a circular
4568 timer list for the time being.
4570 Returns the time to wait until the next timer fires.
4571 If no timer is active, return an invalid value.
4573 As long as any timer is ripe, we run it. */
4578 struct timespec nexttime
;
4579 Lisp_Object timers
, idle_timers
;
4580 struct gcpro gcpro1
, gcpro2
;
4582 Lisp_Object tem
= Vinhibit_quit
;
4585 /* We use copies of the timers' lists to allow a timer to add itself
4586 again, without locking up Emacs if the newly added timer is
4587 already ripe when added. */
4589 /* Always consider the ordinary timers. */
4590 timers
= Fcopy_sequence (Vtimer_list
);
4591 /* Consider the idle timers only if Emacs is idle. */
4592 if (timespec_valid_p (timer_idleness_start_time
))
4593 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4597 Vinhibit_quit
= tem
;
4599 GCPRO2 (timers
, idle_timers
);
4603 nexttime
= timer_check_2 (timers
, idle_timers
);
4605 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4611 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4612 doc
: /* Return the current length of Emacs idleness, or nil.
4613 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4614 in the same style as (current-time).
4616 The value when Emacs is not idle is nil.
4618 PSEC is a multiple of the system clock resolution. */)
4621 if (timespec_valid_p (timer_idleness_start_time
))
4622 return make_lisp_time (timespec_sub (current_timespec (),
4623 timer_idleness_start_time
));
4628 /* Caches for modify_event_symbol. */
4629 static Lisp_Object accent_key_syms
;
4630 static Lisp_Object func_key_syms
;
4631 static Lisp_Object mouse_syms
;
4632 static Lisp_Object wheel_syms
;
4633 static Lisp_Object drag_n_drop_syms
;
4635 /* This is a list of keysym codes for special "accent" characters.
4636 It parallels lispy_accent_keys. */
4638 static const int lispy_accent_codes
[] =
4640 #ifdef XK_dead_circumflex
4645 #ifdef XK_dead_grave
4650 #ifdef XK_dead_tilde
4655 #ifdef XK_dead_diaeresis
4660 #ifdef XK_dead_macron
4665 #ifdef XK_dead_degree
4670 #ifdef XK_dead_acute
4675 #ifdef XK_dead_cedilla
4680 #ifdef XK_dead_breve
4685 #ifdef XK_dead_ogonek
4690 #ifdef XK_dead_caron
4695 #ifdef XK_dead_doubleacute
4696 XK_dead_doubleacute
,
4700 #ifdef XK_dead_abovedot
4705 #ifdef XK_dead_abovering
4715 #ifdef XK_dead_belowdot
4720 #ifdef XK_dead_voiced_sound
4721 XK_dead_voiced_sound
,
4725 #ifdef XK_dead_semivoiced_sound
4726 XK_dead_semivoiced_sound
,
4742 /* This is a list of Lisp names for special "accent" characters.
4743 It parallels lispy_accent_codes. */
4745 static const char *const lispy_accent_keys
[] =
4763 "dead-voiced-sound",
4764 "dead-semivoiced-sound",
4770 #define FUNCTION_KEY_OFFSET 0x0
4772 const char *const lispy_function_keys
[] =
4776 0, /* VK_LBUTTON 0x01 */
4777 0, /* VK_RBUTTON 0x02 */
4778 "cancel", /* VK_CANCEL 0x03 */
4779 0, /* VK_MBUTTON 0x04 */
4781 0, 0, 0, /* 0x05 .. 0x07 */
4783 "backspace", /* VK_BACK 0x08 */
4784 "tab", /* VK_TAB 0x09 */
4786 0, 0, /* 0x0A .. 0x0B */
4788 "clear", /* VK_CLEAR 0x0C */
4789 "return", /* VK_RETURN 0x0D */
4791 0, 0, /* 0x0E .. 0x0F */
4793 0, /* VK_SHIFT 0x10 */
4794 0, /* VK_CONTROL 0x11 */
4795 0, /* VK_MENU 0x12 */
4796 "pause", /* VK_PAUSE 0x13 */
4797 "capslock", /* VK_CAPITAL 0x14 */
4798 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4800 "junja", /* VK_JUNJA 0x17 */
4801 "final", /* VK_FINAL 0x18 */
4802 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4804 "escape", /* VK_ESCAPE 0x1B */
4805 "convert", /* VK_CONVERT 0x1C */
4806 "non-convert", /* VK_NONCONVERT 0x1D */
4807 "accept", /* VK_ACCEPT 0x1E */
4808 "mode-change", /* VK_MODECHANGE 0x1F */
4809 0, /* VK_SPACE 0x20 */
4810 "prior", /* VK_PRIOR 0x21 */
4811 "next", /* VK_NEXT 0x22 */
4812 "end", /* VK_END 0x23 */
4813 "home", /* VK_HOME 0x24 */
4814 "left", /* VK_LEFT 0x25 */
4815 "up", /* VK_UP 0x26 */
4816 "right", /* VK_RIGHT 0x27 */
4817 "down", /* VK_DOWN 0x28 */
4818 "select", /* VK_SELECT 0x29 */
4819 "print", /* VK_PRINT 0x2A */
4820 "execute", /* VK_EXECUTE 0x2B */
4821 "snapshot", /* VK_SNAPSHOT 0x2C */
4822 "insert", /* VK_INSERT 0x2D */
4823 "delete", /* VK_DELETE 0x2E */
4824 "help", /* VK_HELP 0x2F */
4826 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4828 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4832 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4834 0, 0, 0, 0, 0, 0, 0, 0, 0,
4835 0, 0, 0, 0, 0, 0, 0, 0, 0,
4836 0, 0, 0, 0, 0, 0, 0, 0,
4838 "lwindow", /* VK_LWIN 0x5B */
4839 "rwindow", /* VK_RWIN 0x5C */
4840 "apps", /* VK_APPS 0x5D */
4843 "kp-0", /* VK_NUMPAD0 0x60 */
4844 "kp-1", /* VK_NUMPAD1 0x61 */
4845 "kp-2", /* VK_NUMPAD2 0x62 */
4846 "kp-3", /* VK_NUMPAD3 0x63 */
4847 "kp-4", /* VK_NUMPAD4 0x64 */
4848 "kp-5", /* VK_NUMPAD5 0x65 */
4849 "kp-6", /* VK_NUMPAD6 0x66 */
4850 "kp-7", /* VK_NUMPAD7 0x67 */
4851 "kp-8", /* VK_NUMPAD8 0x68 */
4852 "kp-9", /* VK_NUMPAD9 0x69 */
4853 "kp-multiply", /* VK_MULTIPLY 0x6A */
4854 "kp-add", /* VK_ADD 0x6B */
4855 "kp-separator", /* VK_SEPARATOR 0x6C */
4856 "kp-subtract", /* VK_SUBTRACT 0x6D */
4857 "kp-decimal", /* VK_DECIMAL 0x6E */
4858 "kp-divide", /* VK_DIVIDE 0x6F */
4859 "f1", /* VK_F1 0x70 */
4860 "f2", /* VK_F2 0x71 */
4861 "f3", /* VK_F3 0x72 */
4862 "f4", /* VK_F4 0x73 */
4863 "f5", /* VK_F5 0x74 */
4864 "f6", /* VK_F6 0x75 */
4865 "f7", /* VK_F7 0x76 */
4866 "f8", /* VK_F8 0x77 */
4867 "f9", /* VK_F9 0x78 */
4868 "f10", /* VK_F10 0x79 */
4869 "f11", /* VK_F11 0x7A */
4870 "f12", /* VK_F12 0x7B */
4871 "f13", /* VK_F13 0x7C */
4872 "f14", /* VK_F14 0x7D */
4873 "f15", /* VK_F15 0x7E */
4874 "f16", /* VK_F16 0x7F */
4875 "f17", /* VK_F17 0x80 */
4876 "f18", /* VK_F18 0x81 */
4877 "f19", /* VK_F19 0x82 */
4878 "f20", /* VK_F20 0x83 */
4879 "f21", /* VK_F21 0x84 */
4880 "f22", /* VK_F22 0x85 */
4881 "f23", /* VK_F23 0x86 */
4882 "f24", /* VK_F24 0x87 */
4884 0, 0, 0, 0, /* 0x88 .. 0x8B */
4885 0, 0, 0, 0, /* 0x8C .. 0x8F */
4887 "kp-numlock", /* VK_NUMLOCK 0x90 */
4888 "scroll", /* VK_SCROLL 0x91 */
4889 /* Not sure where the following block comes from.
4890 Windows headers have NEC and Fujitsu specific keys in
4891 this block, but nothing generic. */
4892 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4893 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4894 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4895 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4896 "kp-end", /* VK_NUMPAD_END 0x96 */
4897 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4898 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4899 "kp-up", /* VK_NUMPAD_UP 0x99 */
4900 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4901 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4902 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4903 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4905 0, 0, /* 0x9E .. 0x9F */
4908 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4909 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4910 * No other API or message will distinguish left and right keys this way.
4915 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4916 to enable them selectively, and gives access to a few more functions.
4917 See lispy_multimedia_keys below. */
4918 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4919 0, 0, 0, /* 0xAD .. 0xAF Volume */
4920 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4921 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4923 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4924 0, 0, 0, 0, 0, 0, 0, 0, 0,
4926 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4927 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4928 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4931 "ax", /* VK_OEM_AX 0xE1 */
4932 0, /* VK_OEM_102 0xE2 */
4933 "ico-help", /* VK_ICO_HELP 0xE3 */
4934 "ico-00", /* VK_ICO_00 0xE4 */
4935 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4936 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4937 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4939 "reset", /* VK_OEM_RESET 0xE9 */
4940 "jump", /* VK_OEM_JUMP 0xEA */
4941 "oem-pa1", /* VK_OEM_PA1 0xEB */
4942 "oem-pa2", /* VK_OEM_PA2 0xEC */
4943 "oem-pa3", /* VK_OEM_PA3 0xED */
4944 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4945 "cusel", /* VK_OEM_CUSEL 0xEF */
4946 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4947 "finish", /* VK_OEM_FINISH 0xF1 */
4948 "copy", /* VK_OEM_COPY 0xF2 */
4949 "auto", /* VK_OEM_AUTO 0xF3 */
4950 "enlw", /* VK_OEM_ENLW 0xF4 */
4951 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4952 "attn", /* VK_ATTN 0xF6 */
4953 "crsel", /* VK_CRSEL 0xF7 */
4954 "exsel", /* VK_EXSEL 0xF8 */
4955 "ereof", /* VK_EREOF 0xF9 */
4956 "play", /* VK_PLAY 0xFA */
4957 "zoom", /* VK_ZOOM 0xFB */
4958 "noname", /* VK_NONAME 0xFC */
4959 "pa1", /* VK_PA1 0xFD */
4960 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4964 /* Some of these duplicate the "Media keys" on newer keyboards,
4965 but they are delivered to the application in a different way. */
4966 static const char *const lispy_multimedia_keys
[] =
4974 "browser-favorites",
5011 "toggle-dictate-command",
5017 "media-fast-forward",
5020 "media-channel-down"
5023 #else /* not HAVE_NTGUI */
5025 /* This should be dealt with in XTread_socket now, and that doesn't
5026 depend on the client system having the Kana syms defined. See also
5027 the XK_kana_A case below. */
5030 static const char *const lispy_kana_keys
[] =
5032 /* X Keysym value */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5034 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5035 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5037 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5038 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5039 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5042 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5043 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5044 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5045 "kana-i", "kana-u", "kana-e", "kana-o",
5046 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5047 "prolongedsound", "kana-A", "kana-I", "kana-U",
5048 "kana-E", "kana-O", "kana-KA", "kana-KI",
5049 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5050 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5051 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5052 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5053 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5054 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5055 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5056 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5057 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5058 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5059 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5060 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5062 #endif /* XK_kana_A */
5065 #define FUNCTION_KEY_OFFSET 0xff00
5067 /* You'll notice that this table is arranged to be conveniently
5068 indexed by X Windows keysym values. */
5069 static const char *const lispy_function_keys
[] =
5071 /* X Keysym value */
5073 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5074 "backspace", "tab", "linefeed", "clear",
5076 0, 0, 0, "pause", /* 0xff10...1f */
5077 0, 0, 0, 0, 0, 0, 0, "escape",
5079 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5080 "romaji", "hiragana", "katakana", "hiragana-katakana",
5081 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5082 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5083 "eisu-toggle", /* 0xff30...3f */
5084 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5085 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5087 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5088 "down", "prior", "next", "end",
5089 "begin", 0, 0, 0, 0, 0, 0, 0,
5090 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5101 "break", /* 0xff6b */
5104 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5105 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5106 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5107 0, 0, 0, 0, 0, 0, 0, 0,
5108 "kp-tab", /* 0xff89 */
5110 "kp-enter", /* 0xff8d */
5112 "kp-f1", /* 0xff91 */
5116 "kp-home", /* 0xff95 */
5121 "kp-prior", /* kp-page-up */
5122 "kp-next", /* kp-page-down */
5128 0, 0, 0, 0, 0, 0, 0, 0, 0,
5129 "kp-multiply", /* 0xffaa */
5134 "kp-divide", /* 0xffaf */
5135 "kp-0", /* 0xffb0 */
5136 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5139 "kp-equal", /* 0xffbd */
5140 "f1", /* 0xffbe */ /* IsFunctionKey */
5142 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5143 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5144 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5145 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5146 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5147 0, 0, 0, 0, 0, 0, 0, 0,
5148 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5149 0, 0, 0, 0, 0, 0, 0, "delete"
5152 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5153 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5155 static const char *const iso_lispy_function_keys
[] =
5157 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5158 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5159 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5160 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5161 "iso-lefttab", /* 0xfe20 */
5162 "iso-move-line-up", "iso-move-line-down",
5163 "iso-partial-line-up", "iso-partial-line-down",
5164 "iso-partial-space-left", "iso-partial-space-right",
5165 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5166 "iso-release-margin-left", "iso-release-margin-right",
5167 "iso-release-both-margins",
5168 "iso-fast-cursor-left", "iso-fast-cursor-right",
5169 "iso-fast-cursor-up", "iso-fast-cursor-down",
5170 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5171 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5174 #endif /* not HAVE_NTGUI */
5176 static Lisp_Object Vlispy_mouse_stem
;
5178 static const char *const lispy_wheel_names
[] =
5180 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5183 /* drag-n-drop events are generated when a set of selected files are
5184 dragged from another application and dropped onto an Emacs window. */
5185 static const char *const lispy_drag_n_drop_names
[] =
5190 /* Scroll bar parts. */
5191 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5192 Lisp_Object Qup
, Qdown
, Qbottom
;
5193 static Lisp_Object Qend_scroll
;
5195 static Lisp_Object Qratio
;
5197 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5198 static Lisp_Object
*const scroll_bar_parts
[] = {
5199 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5200 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5203 /* A vector, indexed by button number, giving the down-going location
5204 of currently depressed buttons, both scroll bar and non-scroll bar.
5206 The elements have the form
5207 (BUTTON-NUMBER MODIFIER-MASK . REST)
5208 where REST is the cdr of a position as it would be reported in the event.
5210 The make_lispy_event function stores positions here to tell the
5211 difference between click and drag events, and to store the starting
5212 location to be included in drag events. */
5214 static Lisp_Object button_down_location
;
5216 /* Information about the most recent up-going button event: Which
5217 button, what location, and what time. */
5219 static int last_mouse_button
;
5220 static int last_mouse_x
;
5221 static int last_mouse_y
;
5222 static Time button_down_time
;
5224 /* The number of clicks in this multiple-click. */
5226 static int double_click_count
;
5228 /* X and Y are frame-relative coordinates for a click or wheel event.
5229 Return a Lisp-style event list. */
5232 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5235 enum window_part part
;
5236 Lisp_Object posn
= Qnil
;
5237 Lisp_Object extra_info
= Qnil
;
5238 /* Coordinate pixel positions to return. */
5239 int xret
= 0, yret
= 0;
5240 /* The window under frame pixel coordinates (x,y) */
5241 Lisp_Object window
= f
5242 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5245 if (WINDOWP (window
))
5247 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5248 struct window
*w
= XWINDOW (window
);
5249 Lisp_Object string_info
= Qnil
;
5250 ptrdiff_t textpos
= 0;
5251 int col
= -1, row
= -1;
5252 int dx
= -1, dy
= -1;
5253 int width
= -1, height
= -1;
5254 Lisp_Object object
= Qnil
;
5256 /* Pixel coordinates relative to the window corner. */
5257 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5258 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5260 /* For text area clicks, return X, Y relative to the corner of
5261 this text area. Note that dX, dY etc are set below, by
5262 buffer_posn_from_coords. */
5263 if (part
== ON_TEXT
)
5265 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5266 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5268 /* For mode line and header line clicks, return X, Y relative to
5269 the left window edge. Use mode_line_string to look for a
5270 string on the click position. */
5271 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5276 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5277 /* Note that mode_line_string takes COL, ROW as pixels and
5278 converts them to characters. */
5281 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5282 &object
, &dx
, &dy
, &width
, &height
);
5283 if (STRINGP (string
))
5284 string_info
= Fcons (string
, make_number (charpos
));
5290 /* For fringes and margins, Y is relative to the area's (and the
5291 window's) top edge, while X is meaningless. */
5292 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5297 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5300 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5301 &object
, &dx
, &dy
, &width
, &height
);
5302 if (STRINGP (string
))
5303 string_info
= Fcons (string
, make_number (charpos
));
5304 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5306 else if (part
== ON_LEFT_FRINGE
)
5308 posn
= Qleft_fringe
;
5311 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5312 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5313 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5315 else if (part
== ON_RIGHT_FRINGE
)
5317 posn
= Qright_fringe
;
5320 - window_box_width (w
, LEFT_MARGIN_AREA
)
5321 - window_box_width (w
, TEXT_AREA
)
5322 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5323 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5325 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5327 else if (part
== ON_VERTICAL_BORDER
)
5329 posn
= Qvertical_line
;
5334 /* Nothing special for part == ON_SCROLL_BAR. */
5335 else if (part
== ON_RIGHT_DIVIDER
)
5337 posn
= Qright_divider
;
5338 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5342 else if (part
== ON_BOTTOM_DIVIDER
)
5344 posn
= Qbottom_divider
;
5345 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5350 /* For clicks in the text area, fringes, or margins, call
5351 buffer_posn_from_coords to extract TEXTPOS, the buffer
5352 position nearest to the click. */
5355 Lisp_Object string2
, object2
= Qnil
;
5356 struct display_pos p
;
5358 int width2
, height2
;
5359 /* The pixel X coordinate passed to buffer_posn_from_coords
5360 is the X coordinate relative to the text area for
5361 text-area and right-margin clicks, zero otherwise. */
5363 = (part
== ON_TEXT
) ? xret
5364 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5365 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5369 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5370 &object2
, &dx2
, &dy2
,
5372 textpos
= CHARPOS (p
.pos
);
5373 if (col
< 0) col
= x2
;
5374 if (row
< 0) row
= y2
;
5375 if (dx
< 0) dx
= dx2
;
5376 if (dy
< 0) dy
= dy2
;
5377 if (width
< 0) width
= width2
;
5378 if (height
< 0) height
= height2
;
5382 posn
= make_number (textpos
);
5383 if (STRINGP (string2
))
5384 string_info
= Fcons (string2
,
5385 make_number (CHARPOS (p
.string_pos
)));
5391 #ifdef HAVE_WINDOW_SYSTEM
5392 if (IMAGEP (object
))
5394 Lisp_Object image_map
, hotspot
;
5395 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5397 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5399 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5400 posn
= XCAR (hotspot
);
5407 Fcons (make_number (dx
), make_number (dy
)),
5408 Fcons (make_number (width
), make_number (height
)));
5411 extra_info
= Fcons (string_info
,
5412 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5413 Fcons (Fcons (make_number (col
),
5418 XSETFRAME (window
, f
);
5422 return Fcons (window
,
5424 Fcons (Fcons (make_number (xret
),
5425 make_number (yret
)),
5426 Fcons (make_number (t
),
5430 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5431 menu bar. This really means that Emacs draws and manages the menu
5432 bar as part of its normal display, and therefore can compute its
5435 toolkit_menubar_in_use (struct frame
*f
)
5437 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5438 return !(!FRAME_WINDOW_P (f
));
5444 /* Given a struct input_event, build the lisp event which represents
5445 it. If EVENT is 0, build a mouse movement event from the mouse
5446 movement buffer, which should have a movement event in it.
5448 Note that events must be passed to this function in the order they
5449 are received; this function stores the location of button presses
5450 in order to build drag events when the button is released. */
5453 make_lispy_event (struct input_event
*event
)
5457 switch (event
->kind
)
5459 /* A simple keystroke. */
5460 case ASCII_KEYSTROKE_EVENT
:
5461 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5463 Lisp_Object lispy_c
;
5464 EMACS_INT c
= event
->code
;
5465 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5468 eassert (c
== event
->code
);
5469 /* Turn ASCII characters into control characters
5471 if (event
->modifiers
& ctrl_modifier
)
5473 c
= make_ctrl_char (c
);
5474 event
->modifiers
&= ~ctrl_modifier
;
5478 /* Add in the other modifier bits. The shift key was taken care
5479 of by the X code. */
5480 c
|= (event
->modifiers
5481 & (meta_modifier
| alt_modifier
5482 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5483 /* Distinguish Shift-SPC from SPC. */
5484 if ((event
->code
) == 040
5485 && event
->modifiers
& shift_modifier
)
5486 c
|= shift_modifier
;
5487 button_down_time
= 0;
5488 XSETFASTINT (lispy_c
, c
);
5493 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5494 except that they are non-key events (last-nonmenu-event is nil). */
5495 case NS_NONKEY_EVENT
:
5498 /* A function key. The symbol may need to have modifier prefixes
5500 case NON_ASCII_KEYSTROKE_EVENT
:
5501 button_down_time
= 0;
5503 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5504 if (event
->code
== lispy_accent_codes
[i
])
5505 return modify_event_symbol (i
,
5507 Qfunction_key
, Qnil
,
5508 lispy_accent_keys
, &accent_key_syms
,
5509 ARRAYELTS (lispy_accent_keys
));
5513 if (event
->code
>= 0x400 && event
->code
< 0x500)
5514 return modify_event_symbol (event
->code
- 0x400,
5515 event
->modifiers
& ~shift_modifier
,
5516 Qfunction_key
, Qnil
,
5517 lispy_kana_keys
, &func_key_syms
,
5518 ARRAYELTS (lispy_kana_keys
));
5519 #endif /* XK_kana_A */
5522 #ifdef ISO_FUNCTION_KEY_OFFSET
5523 if (event
->code
< FUNCTION_KEY_OFFSET
5524 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5525 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5527 Qfunction_key
, Qnil
,
5528 iso_lispy_function_keys
, &func_key_syms
,
5529 ARRAYELTS (iso_lispy_function_keys
));
5532 /* Handle system-specific or unknown keysyms. */
5533 if (event
->code
& (1 << 28)
5534 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5535 || (event
->code
- FUNCTION_KEY_OFFSET
5536 >= ARRAYELTS (lispy_function_keys
))
5537 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5539 /* We need to use an alist rather than a vector as the cache
5540 since we can't make a vector long enough. */
5541 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5542 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5543 return modify_event_symbol (event
->code
,
5546 KVAR (current_kboard
, Vsystem_key_alist
),
5547 0, &KVAR (current_kboard
, system_key_syms
),
5551 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5553 Qfunction_key
, Qnil
,
5554 lispy_function_keys
, &func_key_syms
,
5555 ARRAYELTS (lispy_function_keys
));
5558 case MULTIMEDIA_KEY_EVENT
:
5559 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5560 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5562 return modify_event_symbol (event
->code
, event
->modifiers
,
5563 Qfunction_key
, Qnil
,
5564 lispy_multimedia_keys
, &func_key_syms
,
5565 ARRAYELTS (lispy_multimedia_keys
));
5570 /* A mouse click. Figure out where it is, decide whether it's
5571 a press, click or drag, and build the appropriate structure. */
5572 case MOUSE_CLICK_EVENT
:
5574 case GPM_CLICK_EVENT
:
5576 #ifndef USE_TOOLKIT_SCROLL_BARS
5577 case SCROLL_BAR_CLICK_EVENT
:
5580 int button
= event
->code
;
5582 Lisp_Object position
;
5583 Lisp_Object
*start_pos_ptr
;
5584 Lisp_Object start_pos
;
5588 /* Build the position as appropriate for this mouse click. */
5589 if (event
->kind
== MOUSE_CLICK_EVENT
5591 || event
->kind
== GPM_CLICK_EVENT
5595 struct frame
*f
= XFRAME (event
->frame_or_window
);
5598 /* Ignore mouse events that were made on frame that
5599 have been deleted. */
5600 if (! FRAME_LIVE_P (f
))
5603 /* EVENT->x and EVENT->y are frame-relative pixel
5604 coordinates at this place. Under old redisplay, COLUMN
5605 and ROW are set to frame relative glyph coordinates
5606 which are then used to determine whether this click is
5607 in a menu (non-toolkit version). */
5608 if (!toolkit_menubar_in_use (f
))
5610 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5611 &column
, &row
, NULL
, 1);
5613 /* In the non-toolkit version, clicks on the menu bar
5614 are ordinary button events in the event buffer.
5615 Distinguish them, and invoke the menu.
5617 (In the toolkit version, the toolkit handles the
5618 menu bar and Emacs doesn't know about it until
5619 after the user makes a selection.) */
5620 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5621 && (event
->modifiers
& down_modifier
))
5623 Lisp_Object items
, item
;
5625 /* Find the menu bar item under `column'. */
5627 items
= FRAME_MENU_BAR_ITEMS (f
);
5628 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5630 Lisp_Object pos
, string
;
5631 string
= AREF (items
, i
+ 1);
5632 pos
= AREF (items
, i
+ 3);
5635 if (column
>= XINT (pos
)
5636 && column
< XINT (pos
) + SCHARS (string
))
5638 item
= AREF (items
, i
);
5643 /* ELisp manual 2.4b says (x y) are window
5644 relative but code says they are
5646 position
= list4 (event
->frame_or_window
,
5648 Fcons (event
->x
, event
->y
),
5649 make_number (event
->timestamp
));
5651 return list2 (item
, position
);
5655 position
= make_lispy_position (f
, event
->x
, event
->y
,
5658 #ifndef USE_TOOLKIT_SCROLL_BARS
5661 /* It's a scrollbar click. */
5663 Lisp_Object portion_whole
;
5666 window
= event
->frame_or_window
;
5667 portion_whole
= Fcons (event
->x
, event
->y
);
5668 part
= *scroll_bar_parts
[(int) event
->part
];
5670 position
= list5 (window
, Qvertical_scroll_bar
,
5671 portion_whole
, make_number (event
->timestamp
),
5674 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5676 if (button
>= ASIZE (button_down_location
))
5678 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5679 button_down_location
= larger_vector (button_down_location
,
5681 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5684 start_pos_ptr
= aref_addr (button_down_location
, button
);
5685 start_pos
= *start_pos_ptr
;
5686 *start_pos_ptr
= Qnil
;
5689 /* On window-system frames, use the value of
5690 double-click-fuzz as is. On other frames, interpret it
5691 as a multiple of 1/8 characters. */
5695 if (WINDOWP (event
->frame_or_window
))
5696 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5697 else if (FRAMEP (event
->frame_or_window
))
5698 f
= XFRAME (event
->frame_or_window
);
5702 if (FRAME_WINDOW_P (f
))
5703 fuzz
= double_click_fuzz
;
5705 fuzz
= double_click_fuzz
/ 8;
5707 is_double
= (button
== last_mouse_button
5708 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5709 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5710 && button_down_time
!= 0
5711 && (EQ (Vdouble_click_time
, Qt
)
5712 || (NATNUMP (Vdouble_click_time
)
5713 && (event
->timestamp
- button_down_time
5714 < XFASTINT (Vdouble_click_time
)))));
5717 last_mouse_button
= button
;
5718 last_mouse_x
= XINT (event
->x
);
5719 last_mouse_y
= XINT (event
->y
);
5721 /* If this is a button press, squirrel away the location, so
5722 we can decide later whether it was a click or a drag. */
5723 if (event
->modifiers
& down_modifier
)
5727 double_click_count
++;
5728 event
->modifiers
|= ((double_click_count
> 2)
5733 double_click_count
= 1;
5734 button_down_time
= event
->timestamp
;
5735 *start_pos_ptr
= Fcopy_alist (position
);
5736 ignore_mouse_drag_p
= 0;
5739 /* Now we're releasing a button - check the co-ordinates to
5740 see if this was a click or a drag. */
5741 else if (event
->modifiers
& up_modifier
)
5743 /* If we did not see a down before this up, ignore the up.
5744 Probably this happened because the down event chose a
5745 menu item. It would be an annoyance to treat the
5746 release of the button that chose the menu item as a
5749 if (!CONSP (start_pos
))
5752 event
->modifiers
&= ~up_modifier
;
5755 Lisp_Object new_down
, down
;
5756 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5758 /* The third element of every position
5759 should be the (x,y) pair. */
5760 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5761 new_down
= Fcar (Fcdr (Fcdr (position
)));
5764 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5766 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5767 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5770 if (ignore_mouse_drag_p
)
5772 event
->modifiers
|= click_modifier
;
5773 ignore_mouse_drag_p
= 0;
5775 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5776 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5777 /* Maybe the mouse has moved a lot, caused scrolling, and
5778 eventually ended up at the same screen position (but
5779 not buffer position) in which case it is a drag, not
5781 /* FIXME: OTOH if the buffer position has changed
5782 because of a timer or process filter rather than
5783 because of mouse movement, it should be considered as
5784 a click. But mouse-drag-region completely ignores
5785 this case and it hasn't caused any real problem, so
5786 it's probably OK to ignore it as well. */
5787 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5788 /* Mouse hasn't moved (much). */
5789 event
->modifiers
|= click_modifier
;
5792 button_down_time
= 0;
5793 event
->modifiers
|= drag_modifier
;
5796 /* Don't check is_double; treat this as multiple
5797 if the down-event was multiple. */
5798 if (double_click_count
> 1)
5799 event
->modifiers
|= ((double_click_count
> 2)
5805 /* Every mouse event should either have the down_modifier or
5806 the up_modifier set. */
5810 /* Get the symbol we should use for the mouse click. */
5813 head
= modify_event_symbol (button
,
5815 Qmouse_click
, Vlispy_mouse_stem
,
5818 ASIZE (mouse_syms
));
5819 if (event
->modifiers
& drag_modifier
)
5820 return list3 (head
, start_pos
, position
);
5821 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5822 return list3 (head
, position
, make_number (double_click_count
));
5824 return list2 (head
, position
);
5829 case HORIZ_WHEEL_EVENT
:
5831 Lisp_Object position
;
5834 /* Build the position as appropriate for this mouse click. */
5835 struct frame
*f
= XFRAME (event
->frame_or_window
);
5837 /* Ignore wheel events that were made on frame that have been
5839 if (! FRAME_LIVE_P (f
))
5842 position
= make_lispy_position (f
, event
->x
, event
->y
,
5845 /* Set double or triple modifiers to indicate the wheel speed. */
5847 /* On window-system frames, use the value of
5848 double-click-fuzz as is. On other frames, interpret it
5849 as a multiple of 1/8 characters. */
5855 if (WINDOWP (event
->frame_or_window
))
5856 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5857 else if (FRAMEP (event
->frame_or_window
))
5858 fr
= XFRAME (event
->frame_or_window
);
5862 fuzz
= FRAME_WINDOW_P (fr
)
5863 ? double_click_fuzz
: double_click_fuzz
/ 8;
5865 if (event
->modifiers
& up_modifier
)
5867 /* Emit a wheel-up event. */
5868 event
->modifiers
&= ~up_modifier
;
5871 else if (event
->modifiers
& down_modifier
)
5873 /* Emit a wheel-down event. */
5874 event
->modifiers
&= ~down_modifier
;
5878 /* Every wheel event should either have the down_modifier or
5879 the up_modifier set. */
5882 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5885 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5886 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5887 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5888 && button_down_time
!= 0
5889 && (EQ (Vdouble_click_time
, Qt
)
5890 || (NATNUMP (Vdouble_click_time
)
5891 && (event
->timestamp
- button_down_time
5892 < XFASTINT (Vdouble_click_time
)))));
5895 double_click_count
++;
5896 event
->modifiers
|= ((double_click_count
> 2)
5902 double_click_count
= 1;
5903 event
->modifiers
|= click_modifier
;
5906 button_down_time
= event
->timestamp
;
5907 /* Use a negative value to distinguish wheel from mouse button. */
5908 last_mouse_button
= - (1 + symbol_num
);
5909 last_mouse_x
= XINT (event
->x
);
5910 last_mouse_y
= XINT (event
->y
);
5912 /* Get the symbol we should use for the wheel event. */
5913 head
= modify_event_symbol (symbol_num
,
5919 ASIZE (wheel_syms
));
5922 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5923 return list3 (head
, position
, make_number (double_click_count
));
5925 return list2 (head
, position
);
5929 #ifdef USE_TOOLKIT_SCROLL_BARS
5931 /* We don't have down and up events if using toolkit scroll bars,
5932 so make this always a click event. Store in the `part' of
5933 the Lisp event a symbol which maps to the following actions:
5935 `above_handle' page up
5936 `below_handle' page down
5940 `bottom' bottom of buffer
5941 `handle' thumb has been dragged.
5942 `end-scroll' end of interaction with scroll bar
5944 The incoming input_event contains in its `part' member an
5945 index of type `enum scroll_bar_part' which we can use as an
5946 index in scroll_bar_parts to get the appropriate symbol. */
5948 case SCROLL_BAR_CLICK_EVENT
:
5950 Lisp_Object position
, head
, window
, portion_whole
, part
;
5952 window
= event
->frame_or_window
;
5953 portion_whole
= Fcons (event
->x
, event
->y
);
5954 part
= *scroll_bar_parts
[(int) event
->part
];
5956 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5957 make_number (event
->timestamp
), part
);
5959 /* Always treat scroll bar events as clicks. */
5960 event
->modifiers
|= click_modifier
;
5961 event
->modifiers
&= ~up_modifier
;
5963 if (event
->code
>= ASIZE (mouse_syms
))
5964 mouse_syms
= larger_vector (mouse_syms
,
5965 event
->code
- ASIZE (mouse_syms
) + 1,
5968 /* Get the symbol we should use for the mouse click. */
5969 head
= modify_event_symbol (event
->code
,
5974 ASIZE (mouse_syms
));
5975 return list2 (head
, position
);
5978 #endif /* USE_TOOLKIT_SCROLL_BARS */
5980 case DRAG_N_DROP_EVENT
:
5983 Lisp_Object head
, position
;
5986 f
= XFRAME (event
->frame_or_window
);
5989 /* Ignore mouse events that were made on frames that
5990 have been deleted. */
5991 if (! FRAME_LIVE_P (f
))
5994 position
= make_lispy_position (f
, event
->x
, event
->y
,
5997 head
= modify_event_symbol (0, event
->modifiers
,
5999 lispy_drag_n_drop_names
,
6000 &drag_n_drop_syms
, 1);
6001 return list3 (head
, position
, files
);
6004 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6005 || defined (HAVE_NS) || defined (USE_GTK)
6006 case MENU_BAR_EVENT
:
6007 if (EQ (event
->arg
, event
->frame_or_window
))
6008 /* This is the prefix key. We translate this to
6009 `(menu_bar)' because the code in keyboard.c for menu
6010 events, which we use, relies on this. */
6011 return list1 (Qmenu_bar
);
6015 case SELECT_WINDOW_EVENT
:
6016 /* Make an event (select-window (WINDOW)). */
6017 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6019 case TOOL_BAR_EVENT
:
6020 if (EQ (event
->arg
, event
->frame_or_window
))
6021 /* This is the prefix key. We translate this to
6022 `(tool_bar)' because the code in keyboard.c for tool bar
6023 events, which we use, relies on this. */
6024 return list1 (Qtool_bar
);
6025 else if (SYMBOLP (event
->arg
))
6026 return apply_modifiers (event
->modifiers
, event
->arg
);
6029 case USER_SIGNAL_EVENT
:
6030 /* A user signal. */
6032 char *name
= find_user_signal_name (event
->code
);
6035 return intern (name
);
6038 case SAVE_SESSION_EVENT
:
6039 return Qsave_session
;
6044 return Fcons (Qdbus_event
, event
->arg
);
6046 #endif /* HAVE_DBUS */
6048 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6049 case FILE_NOTIFY_EVENT
:
6051 return Fcons (Qfile_notify
, event
->arg
);
6053 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6055 case CONFIG_CHANGED_EVENT
:
6056 return list3 (Qconfig_changed_event
,
6057 event
->arg
, event
->frame_or_window
);
6059 /* The 'kind' field of the event is something we don't recognize. */
6066 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6067 Lisp_Object x
, Lisp_Object y
, Time t
)
6069 /* Is it a scroll bar movement? */
6070 if (frame
&& ! NILP (bar_window
))
6072 Lisp_Object part_sym
;
6074 part_sym
= *scroll_bar_parts
[(int) part
];
6075 return list2 (Qscroll_bar_movement
,
6077 Qvertical_scroll_bar
,
6082 /* Or is it an ordinary mouse movement? */
6085 Lisp_Object position
;
6086 position
= make_lispy_position (frame
, x
, y
, t
);
6087 return list2 (Qmouse_movement
, position
);
6091 /* Construct a switch frame event. */
6093 make_lispy_switch_frame (Lisp_Object frame
)
6095 return list2 (Qswitch_frame
, frame
);
6099 make_lispy_focus_in (Lisp_Object frame
)
6101 return list2 (Qfocus_in
, frame
);
6104 #ifdef HAVE_WINDOW_SYSTEM
6107 make_lispy_focus_out (Lisp_Object frame
)
6109 return list2 (Qfocus_out
, frame
);
6112 #endif /* HAVE_WINDOW_SYSTEM */
6114 /* Manipulating modifiers. */
6116 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6118 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6119 SYMBOL's name of the end of the modifiers; the string from this
6120 position is the unmodified symbol name.
6122 This doesn't use any caches. */
6125 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6131 CHECK_SYMBOL (symbol
);
6134 name
= SYMBOL_NAME (symbol
);
6136 for (i
= 0; i
< SBYTES (name
) - 1; )
6138 ptrdiff_t this_mod_end
= 0;
6141 /* See if the name continues with a modifier word.
6142 Check that the word appears, but don't check what follows it.
6143 Set this_mod and this_mod_end to record what we find. */
6145 switch (SREF (name
, i
))
6147 #define SINGLE_LETTER_MOD(BIT) \
6148 (this_mod_end = i + 1, this_mod = BIT)
6151 SINGLE_LETTER_MOD (alt_modifier
);
6155 SINGLE_LETTER_MOD (ctrl_modifier
);
6159 SINGLE_LETTER_MOD (hyper_modifier
);
6163 SINGLE_LETTER_MOD (meta_modifier
);
6167 SINGLE_LETTER_MOD (shift_modifier
);
6171 SINGLE_LETTER_MOD (super_modifier
);
6174 #undef SINGLE_LETTER_MOD
6176 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6177 if (i + LEN + 1 <= SBYTES (name) \
6178 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6180 this_mod_end = i + LEN; \
6185 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6186 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6187 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6191 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6193 #undef MULTI_LETTER_MOD
6197 /* If we found no modifier, stop looking for them. */
6198 if (this_mod_end
== 0)
6201 /* Check there is a dash after the modifier, so that it
6202 really is a modifier. */
6203 if (this_mod_end
>= SBYTES (name
)
6204 || SREF (name
, this_mod_end
) != '-')
6207 /* This modifier is real; look for another. */
6208 modifiers
|= this_mod
;
6209 i
= this_mod_end
+ 1;
6212 /* Should we include the `click' modifier? */
6213 if (! (modifiers
& (down_modifier
| drag_modifier
6214 | double_modifier
| triple_modifier
))
6215 && i
+ 7 == SBYTES (name
)
6216 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6217 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6218 modifiers
|= click_modifier
;
6220 if (! (modifiers
& (double_modifier
| triple_modifier
))
6221 && i
+ 6 < SBYTES (name
)
6222 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6223 modifiers
|= click_modifier
;
6231 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6232 prepended to the string BASE[0..BASE_LEN-1].
6233 This doesn't use any caches. */
6235 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6237 /* Since BASE could contain nulls, we can't use intern here; we have
6238 to use Fintern, which expects a genuine Lisp_String, and keeps a
6240 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6246 /* Only the event queue may use the `up' modifier; it should always
6247 be turned into a click or drag event before presented to lisp code. */
6248 if (modifiers
& up_modifier
)
6251 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6252 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6253 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6254 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6255 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6256 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6257 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6258 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6259 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6260 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6261 /* The click modifier is denoted by the absence of other modifiers. */
6265 mod_len
= p
- new_mods
;
6269 Lisp_Object new_name
;
6271 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6272 mod_len
+ base_len_byte
);
6273 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6274 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6276 return Fintern (new_name
, Qnil
);
6281 static const char *const modifier_names
[] =
6283 "up", "down", "drag", "click", "double", "triple", 0, 0,
6284 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6285 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6287 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6289 static Lisp_Object modifier_symbols
;
6291 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6293 lispy_modifier_list (int modifiers
)
6295 Lisp_Object modifier_list
;
6298 modifier_list
= Qnil
;
6299 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6300 if (modifiers
& (1<<i
))
6301 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6304 return modifier_list
;
6308 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6309 where UNMODIFIED is the unmodified form of SYMBOL,
6310 MASK is the set of modifiers present in SYMBOL's name.
6311 This is similar to parse_modifiers_uncached, but uses the cache in
6312 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6313 Qevent_symbol_elements property. */
6315 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6318 parse_modifiers (Lisp_Object symbol
)
6320 Lisp_Object elements
;
6322 if (INTEGERP (symbol
))
6323 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6324 else if (!SYMBOLP (symbol
))
6327 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6328 if (CONSP (elements
))
6333 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6334 Lisp_Object unmodified
;
6337 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6338 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6341 if (modifiers
& ~INTMASK
)
6343 XSETFASTINT (mask
, modifiers
);
6344 elements
= list2 (unmodified
, mask
);
6346 /* Cache the parsing results on SYMBOL. */
6347 Fput (symbol
, Qevent_symbol_element_mask
,
6349 Fput (symbol
, Qevent_symbol_elements
,
6350 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6352 /* Since we know that SYMBOL is modifiers applied to unmodified,
6353 it would be nice to put that in unmodified's cache.
6354 But we can't, since we're not sure that parse_modifiers is
6361 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6362 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6363 doc
: /* Parse the event symbol. For internal use. */)
6364 (Lisp_Object symbol
)
6366 /* Fill the cache if needed. */
6367 parse_modifiers (symbol
);
6368 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6369 and use the Lispier representation stored on Qevent_symbol_elements
6371 return Fget (symbol
, Qevent_symbol_elements
);
6374 /* Apply the modifiers MODIFIERS to the symbol BASE.
6375 BASE must be unmodified.
6377 This is like apply_modifiers_uncached, but uses BASE's
6378 Qmodifier_cache property, if present. It also builds
6379 Qevent_symbol_elements properties, since it has that info anyway.
6381 apply_modifiers copies the value of BASE's Qevent_kind property to
6382 the modified symbol. */
6384 apply_modifiers (int modifiers
, Lisp_Object base
)
6386 Lisp_Object cache
, idx
, entry
, new_symbol
;
6388 /* Mask out upper bits. We don't know where this value's been. */
6389 modifiers
&= INTMASK
;
6391 if (INTEGERP (base
))
6392 return make_number (XINT (base
) | modifiers
);
6394 /* The click modifier never figures into cache indices. */
6395 cache
= Fget (base
, Qmodifier_cache
);
6396 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6397 entry
= assq_no_quit (idx
, cache
);
6400 new_symbol
= XCDR (entry
);
6403 /* We have to create the symbol ourselves. */
6404 new_symbol
= apply_modifiers_uncached (modifiers
,
6405 SSDATA (SYMBOL_NAME (base
)),
6406 SCHARS (SYMBOL_NAME (base
)),
6407 SBYTES (SYMBOL_NAME (base
)));
6409 /* Add the new symbol to the base's cache. */
6410 entry
= Fcons (idx
, new_symbol
);
6411 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6413 /* We have the parsing info now for free, so we could add it to
6415 XSETFASTINT (idx, modifiers);
6416 Fput (new_symbol, Qevent_symbol_element_mask,
6418 Fput (new_symbol, Qevent_symbol_elements,
6419 Fcons (base, lispy_modifier_list (modifiers)));
6420 Sadly, this is only correct if `base' is indeed a base event,
6421 which is not necessarily the case. -stef */
6424 /* Make sure this symbol is of the same kind as BASE.
6426 You'd think we could just set this once and for all when we
6427 intern the symbol above, but reorder_modifiers may call us when
6428 BASE's property isn't set right; we can't assume that just
6429 because it has a Qmodifier_cache property it must have its
6430 Qevent_kind set right as well. */
6431 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6435 kind
= Fget (base
, Qevent_kind
);
6437 Fput (new_symbol
, Qevent_kind
, kind
);
6444 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6445 return a symbol with the modifiers placed in the canonical order.
6446 Canonical order is alphabetical, except for down and drag, which
6447 always come last. The 'click' modifier is never written out.
6449 Fdefine_key calls this to make sure that (for example) C-M-foo
6450 and M-C-foo end up being equivalent in the keymap. */
6453 reorder_modifiers (Lisp_Object symbol
)
6455 /* It's hopefully okay to write the code this way, since everything
6456 will soon be in caches, and no consing will be done at all. */
6459 parsed
= parse_modifiers (symbol
);
6460 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6465 /* For handling events, we often want to produce a symbol whose name
6466 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6467 to some base, like the name of a function key or mouse button.
6468 modify_event_symbol produces symbols of this sort.
6470 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6471 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6474 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6475 into symbol names, or a string specifying a name stem used to
6476 construct a symbol name or the form `STEM-N', where N is the decimal
6477 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6478 non-nil; otherwise NAME_TABLE is used.
6480 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6481 persist between calls to modify_event_symbol that it can use to
6482 store a cache of the symbols it's generated for this NAME_TABLE
6483 before. The object stored there may be a vector or an alist.
6485 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6487 MODIFIERS is a set of modifier bits (as given in struct input_events)
6488 whose prefixes should be applied to the symbol name.
6490 SYMBOL_KIND is the value to be placed in the event_kind property of
6491 the returned symbol.
6493 The symbols we create are supposed to have an
6494 `event-symbol-elements' property, which lists the modifiers present
6495 in the symbol's name. */
6498 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6499 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6500 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6503 Lisp_Object symbol_int
;
6505 /* Get rid of the "vendor-specific" bit here. */
6506 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6508 /* Is this a request for a valid symbol? */
6509 if (symbol_num
< 0 || symbol_num
>= table_size
)
6512 if (CONSP (*symbol_table
))
6513 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6515 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6516 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6517 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6518 we've never used that symbol before. */
6521 if (! VECTORP (*symbol_table
)
6522 || ASIZE (*symbol_table
) != table_size
)
6526 XSETFASTINT (size
, table_size
);
6527 *symbol_table
= Fmake_vector (size
, Qnil
);
6530 value
= AREF (*symbol_table
, symbol_num
);
6533 /* Have we already used this symbol before? */
6536 /* No; let's create it. */
6537 if (CONSP (name_alist_or_stem
))
6538 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6539 else if (STRINGP (name_alist_or_stem
))
6542 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6543 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6545 buf
= SAFE_ALLOCA (len
);
6546 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6547 XINT (symbol_int
) + 1);
6548 value
= intern (buf
);
6551 else if (name_table
!= 0 && name_table
[symbol_num
])
6552 value
= intern (name_table
[symbol_num
]);
6554 #ifdef HAVE_WINDOW_SYSTEM
6557 char *name
= x_get_keysym_name (symbol_num
);
6559 value
= intern (name
);
6565 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6566 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6567 value
= intern (buf
);
6570 if (CONSP (*symbol_table
))
6571 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6573 ASET (*symbol_table
, symbol_num
, value
);
6575 /* Fill in the cache entries for this symbol; this also
6576 builds the Qevent_symbol_elements property, which the user
6578 apply_modifiers (modifiers
& click_modifier
, value
);
6579 Fput (value
, Qevent_kind
, symbol_kind
);
6582 /* Apply modifiers to that symbol. */
6583 return apply_modifiers (modifiers
, value
);
6586 /* Convert a list that represents an event type,
6587 such as (ctrl meta backspace), into the usual representation of that
6588 event type as a number or a symbol. */
6590 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6591 doc
: /* Convert the event description list EVENT-DESC to an event type.
6592 EVENT-DESC should contain one base event type (a character or symbol)
6593 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6594 drag, down, double or triple). The base must be last.
6595 The return value is an event type (a character or symbol) which
6596 has the same base event type and all the specified modifiers. */)
6597 (Lisp_Object event_desc
)
6605 while (CONSP (rest
))
6613 /* Given a symbol, see if it is a modifier name. */
6614 if (SYMBOLP (elt
) && CONSP (rest
))
6615 this = parse_solitary_modifier (elt
);
6619 else if (!NILP (base
))
6620 error ("Two bases given in one event");
6626 /* Let the symbol A refer to the character A. */
6627 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6628 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6630 if (INTEGERP (base
))
6632 /* Turn (shift a) into A. */
6633 if ((modifiers
& shift_modifier
) != 0
6634 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6636 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6637 modifiers
&= ~shift_modifier
;
6640 /* Turn (control a) into C-a. */
6641 if (modifiers
& ctrl_modifier
)
6642 return make_number ((modifiers
& ~ctrl_modifier
)
6643 | make_ctrl_char (XINT (base
)));
6645 return make_number (modifiers
| XINT (base
));
6647 else if (SYMBOLP (base
))
6648 return apply_modifiers (modifiers
, base
);
6650 error ("Invalid base event");
6653 /* Try to recognize SYMBOL as a modifier name.
6654 Return the modifier flag bit, or 0 if not recognized. */
6657 parse_solitary_modifier (Lisp_Object symbol
)
6659 Lisp_Object name
= SYMBOL_NAME (symbol
);
6661 switch (SREF (name
, 0))
6663 #define SINGLE_LETTER_MOD(BIT) \
6664 if (SBYTES (name) == 1) \
6667 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6668 if (LEN == SBYTES (name) \
6669 && ! memcmp (SDATA (name), NAME, LEN)) \
6673 SINGLE_LETTER_MOD (alt_modifier
);
6677 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6681 SINGLE_LETTER_MOD (ctrl_modifier
);
6685 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6686 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6690 SINGLE_LETTER_MOD (hyper_modifier
);
6694 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6698 SINGLE_LETTER_MOD (meta_modifier
);
6702 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6706 SINGLE_LETTER_MOD (shift_modifier
);
6710 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6711 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6712 SINGLE_LETTER_MOD (super_modifier
);
6716 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6717 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6718 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6722 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6725 #undef SINGLE_LETTER_MOD
6726 #undef MULTI_LETTER_MOD
6732 /* Return true if EVENT is a list whose elements are all integers or symbols.
6733 Such a list is not valid as an event,
6734 but it can be a Lucid-style event type list. */
6737 lucid_event_type_list_p (Lisp_Object object
)
6741 if (! CONSP (object
))
6744 if (EQ (XCAR (object
), Qhelp_echo
)
6745 || EQ (XCAR (object
), Qvertical_line
)
6746 || EQ (XCAR (object
), Qmode_line
)
6747 || EQ (XCAR (object
), Qheader_line
))
6750 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6754 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6761 /* Return true if terminal input chars are available.
6762 Also, store the return value into INPUT_PENDING.
6764 Serves the purpose of ioctl (0, FIONREAD, ...)
6765 but works even if FIONREAD does not exist.
6766 (In fact, this may actually read some input.)
6768 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6769 timer events that are ripe.
6770 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6771 events (FOCUS_IN_EVENT).
6772 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6773 movements and toolkit scroll bar thumb drags. */
6776 get_input_pending (int flags
)
6778 /* First of all, have we already counted some input? */
6779 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6781 /* If input is being read as it arrives, and we have none, there is none. */
6782 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6784 /* Try to read some input and see how much we get. */
6786 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6789 return input_pending
;
6792 /* Put a BUFFER_SWITCH_EVENT in the buffer
6793 so that read_key_sequence will notice the new current buffer. */
6796 record_asynch_buffer_change (void)
6798 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6799 The purpose of the event is to make read_key_sequence look up the
6800 keymaps again. If we aren't in read_key_sequence, we don't need one,
6801 and the event could cause trouble by messing up (input-pending-p).
6802 Note: Fwaiting_for_user_input_p always returns nil when async
6803 subprocesses aren't supported. */
6804 if (!NILP (Fwaiting_for_user_input_p ()))
6806 struct input_event event
;
6809 event
.kind
= BUFFER_SWITCH_EVENT
;
6810 event
.frame_or_window
= Qnil
;
6813 /* Make sure no interrupt happens while storing the event. */
6814 kbd_buffer_store_event (&event
);
6818 /* Read any terminal input already buffered up by the system
6819 into the kbd_buffer, but do not wait.
6821 Return the number of keyboard chars read, or -1 meaning
6822 this is a bad time to try to read input. */
6831 /* Store pending user signal events, if any. */
6832 store_user_signal_events ();
6834 /* Loop through the available terminals, and call their input hooks. */
6838 struct terminal
*next
= t
->next_terminal
;
6840 if (t
->read_socket_hook
)
6843 struct input_event hold_quit
;
6845 if (input_blocked_p ())
6847 pending_signals
= 1;
6851 EVENT_INIT (hold_quit
);
6852 hold_quit
.kind
= NO_EVENT
;
6854 /* No need for FIONREAD or fcntl; just say don't wait. */
6855 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6858 if (nr
== -1) /* Not OK to read input now. */
6862 else if (nr
== -2) /* Non-transient error. */
6864 /* The terminal device terminated; it should be closed. */
6866 /* Kill Emacs if this was our last terminal. */
6867 if (!terminal_list
->next_terminal
)
6868 /* Formerly simply reported no input, but that
6869 sometimes led to a failure of Emacs to terminate.
6870 SIGHUP seems appropriate if we can't reach the
6872 /* ??? Is it really right to send the signal just to
6873 this process rather than to the whole process
6874 group? Perhaps on systems with FIONREAD Emacs is
6875 alone in its group. */
6876 terminate_due_to_signal (SIGHUP
, 10);
6878 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6881 XSETTERMINAL (tmp
, t
);
6882 Fdelete_terminal (tmp
, Qnoelisp
);
6886 /* If there was no error, make sure the pointer
6887 is visible for all frames on this terminal. */
6890 Lisp_Object tail
, frame
;
6892 FOR_EACH_FRAME (tail
, frame
)
6894 struct frame
*f
= XFRAME (frame
);
6895 if (FRAME_TERMINAL (f
) == t
)
6896 frame_make_pointer_visible (f
);
6900 if (hold_quit
.kind
!= NO_EVENT
)
6901 kbd_buffer_store_event (&hold_quit
);
6913 /* This is the tty way of reading available input.
6915 Note that each terminal device has its own `struct terminal' object,
6916 and so this function is called once for each individual termcap
6917 terminal. The first parameter indicates which terminal to read from. */
6920 tty_read_avail_input (struct terminal
*terminal
,
6921 struct input_event
*hold_quit
)
6923 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6924 the kbd_buffer can really hold. That may prevent loss
6925 of characters on some systems when input is stuffed at us. */
6926 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6928 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6931 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6933 if (kbd_on_hold_p () || buffer_free
<= 0)
6935 #endif /* subprocesses */
6937 if (!terminal
->name
) /* Don't read from a dead terminal. */
6940 if (terminal
->type
!= output_termcap
6941 && terminal
->type
!= output_msdos_raw
)
6944 /* XXX I think the following code should be moved to separate hook
6945 functions in system-dependent files. */
6947 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6948 code sets read_socket_hook to w32_console_read_socket instead! */
6950 #else /* not WINDOWSNT */
6951 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6955 return 0; /* The terminal is suspended. */
6958 n_to_read
= dos_keysns ();
6962 cbuf
[0] = dos_keyread ();
6965 #else /* not MSDOS */
6970 struct input_event gpm_hold_quit
;
6971 int gpm
, fd
= gpm_fd
;
6973 EVENT_INIT (gpm_hold_quit
);
6974 gpm_hold_quit
.kind
= NO_EVENT
;
6976 /* gpm==1 if event received.
6977 gpm==0 if the GPM daemon has closed the connection, in which case
6978 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6979 we save it in `fd' so close_gpm can remove it from the
6981 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6982 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6983 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6986 /* Presumably the GPM daemon has closed the connection. */
6988 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6989 kbd_buffer_store_event (&gpm_hold_quit
);
6993 #endif /* HAVE_GPM */
6995 /* Determine how many characters we should *try* to read. */
6996 #ifdef USABLE_FIONREAD
6997 /* Find out how much input is available. */
6998 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7000 if (! noninteractive
)
7001 return -2; /* Close this terminal. */
7007 if (n_to_read
> sizeof cbuf
)
7008 n_to_read
= sizeof cbuf
;
7009 #elif defined USG || defined CYGWIN
7010 /* Read some input if available, but don't wait. */
7011 n_to_read
= sizeof cbuf
;
7012 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7014 # error "Cannot read without possibly delaying"
7018 /* Don't read more than we can store. */
7019 if (n_to_read
> buffer_free
)
7020 n_to_read
= buffer_free
;
7021 #endif /* subprocesses */
7023 /* Now read; for one reason or another, this will not block.
7024 NREAD is set to the number of chars read. */
7027 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7028 /* POSIX infers that processes which are not in the session leader's
7029 process group won't get SIGHUPs at logout time. BSDI adheres to
7030 this part standard and returns -1 from read (0) with errno==EIO
7031 when the control tty is taken away.
7032 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7033 if (nread
== -1 && errno
== EIO
)
7034 return -2; /* Close this terminal. */
7035 #if defined (AIX) && defined (_BSD)
7036 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7037 This looks incorrect, but it isn't, because _BSD causes
7038 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7039 and that causes a value other than 0 when there is no input. */
7041 return -2; /* Close this terminal. */
7045 /* We used to retry the read if it was interrupted.
7046 But this does the wrong thing when O_NONBLOCK causes
7047 an EAGAIN error. Does anybody know of a situation
7048 where a retry is actually needed? */
7050 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7060 #ifndef USABLE_FIONREAD
7061 #if defined (USG) || defined (CYGWIN)
7062 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7063 #endif /* USG or CYGWIN */
7064 #endif /* no FIONREAD */
7069 #endif /* not MSDOS */
7070 #endif /* not WINDOWSNT */
7072 for (i
= 0; i
< nread
; i
++)
7074 struct input_event buf
;
7076 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7078 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7079 buf
.modifiers
= meta_modifier
;
7080 if (tty
->meta_key
!= 2)
7084 /* Set the frame corresponding to the active tty. Note that the
7085 value of selected_frame is not reliable here, redisplay tends
7086 to temporarily change it. */
7087 buf
.frame_or_window
= tty
->top_frame
;
7090 kbd_buffer_store_event (&buf
);
7091 /* Don't look at input that follows a C-g too closely.
7092 This reduces lossage due to autorepeat on C-g. */
7093 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7094 && buf
.code
== quit_char
)
7102 handle_async_input (void)
7107 int nread
= gobble_input ();
7108 /* -1 means it's not ok to read the input now.
7109 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7110 0 means there was no keyboard input available. */
7118 process_pending_signals (void)
7120 pending_signals
= 0;
7121 handle_async_input ();
7122 do_pending_atimers ();
7125 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7126 and reinvoke any pending signal if the level is now 0 and
7127 a fatal error is not already in progress. */
7130 unblock_input_to (int level
)
7132 interrupt_input_blocked
= level
;
7135 if (pending_signals
&& !fatal_error_in_progress
)
7136 process_pending_signals ();
7142 /* End critical section.
7144 If doing signal-driven input, and a signal came in when input was
7145 blocked, reinvoke the signal handler now to deal with it.
7147 It will also process queued input, if it was not read before.
7148 When a longer code sequence does not use block/unblock input
7149 at all, the whole input gathered up to the next call to
7150 unblock_input will be processed inside that call. */
7153 unblock_input (void)
7155 unblock_input_to (interrupt_input_blocked
- 1);
7158 /* Undo any number of BLOCK_INPUT calls,
7159 and also reinvoke any pending signal. */
7162 totally_unblock_input (void)
7164 unblock_input_to (0);
7170 handle_input_available_signal (int sig
)
7172 pending_signals
= 1;
7174 if (input_available_clear_time
)
7175 *input_available_clear_time
= make_timespec (0, 0);
7179 deliver_input_available_signal (int sig
)
7181 deliver_process_signal (sig
, handle_input_available_signal
);
7183 #endif /* USABLE_SIGIO */
7186 /* User signal events. */
7188 struct user_signal_info
7190 /* Signal number. */
7193 /* Name of the signal. */
7196 /* Number of pending signals. */
7199 struct user_signal_info
*next
;
7202 /* List of user signals. */
7203 static struct user_signal_info
*user_signals
= NULL
;
7206 add_user_signal (int sig
, const char *name
)
7208 struct sigaction action
;
7209 struct user_signal_info
*p
;
7211 for (p
= user_signals
; p
; p
= p
->next
)
7213 /* Already added. */
7216 p
= xmalloc (sizeof *p
);
7218 p
->name
= xstrdup (name
);
7220 p
->next
= user_signals
;
7223 emacs_sigaction_init (&action
, deliver_user_signal
);
7224 sigaction (sig
, &action
, 0);
7228 handle_user_signal (int sig
)
7230 struct user_signal_info
*p
;
7231 const char *special_event_name
= NULL
;
7233 if (SYMBOLP (Vdebug_on_event
))
7234 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7236 for (p
= user_signals
; p
; p
= p
->next
)
7239 if (special_event_name
7240 && strcmp (special_event_name
, p
->name
) == 0)
7242 /* Enter the debugger in many ways. */
7243 debug_on_next_call
= 1;
7246 Vinhibit_quit
= Qnil
;
7248 /* Eat the event. */
7254 if (interrupt_input
)
7255 handle_input_available_signal (sig
);
7259 /* Tell wait_reading_process_output that it needs to wake
7260 up and look around. */
7261 if (input_available_clear_time
)
7262 *input_available_clear_time
= make_timespec (0, 0);
7269 deliver_user_signal (int sig
)
7271 deliver_process_signal (sig
, handle_user_signal
);
7275 find_user_signal_name (int sig
)
7277 struct user_signal_info
*p
;
7279 for (p
= user_signals
; p
; p
= p
->next
)
7287 store_user_signal_events (void)
7289 struct user_signal_info
*p
;
7290 struct input_event buf
;
7291 bool buf_initialized
= 0;
7293 for (p
= user_signals
; p
; p
= p
->next
)
7294 if (p
->npending
> 0)
7296 if (! buf_initialized
)
7298 memset (&buf
, 0, sizeof buf
);
7299 buf
.kind
= USER_SIGNAL_EVENT
;
7300 buf
.frame_or_window
= selected_frame
;
7301 buf_initialized
= 1;
7307 kbd_buffer_store_event (&buf
);
7310 while (p
->npending
> 0);
7315 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7316 static Lisp_Object menu_bar_one_keymap_changed_items
;
7318 /* These variables hold the vector under construction within
7319 menu_bar_items and its subroutines, and the current index
7320 for storing into that vector. */
7321 static Lisp_Object menu_bar_items_vector
;
7322 static int menu_bar_items_index
;
7325 static const char *separator_names
[] = {
7330 "single-dashed-line",
7331 "double-dashed-line",
7333 "shadow-etched-out",
7334 "shadow-etched-in-dash",
7335 "shadow-etched-out-dash",
7336 "shadow-double-etched-in",
7337 "shadow-double-etched-out",
7338 "shadow-double-etched-in-dash",
7339 "shadow-double-etched-out-dash",
7343 /* Return true if LABEL specifies a separator. */
7346 menu_separator_name_p (const char *label
)
7350 else if (strlen (label
) > 3
7351 && memcmp (label
, "--", 2) == 0
7356 for (i
= 0; separator_names
[i
]; ++i
)
7357 if (strcmp (label
, separator_names
[i
]) == 0)
7362 /* It's a separator if it contains only dashes. */
7363 while (*label
== '-')
7365 return (*label
== 0);
7372 /* Return a vector of menu items for a menu bar, appropriate
7373 to the current buffer. Each item has three elements in the vector:
7376 OLD is an old vector we can optionally reuse, or nil. */
7379 menu_bar_items (Lisp_Object old
)
7381 /* The number of keymaps we're scanning right now, and the number of
7382 keymaps we have allocated space for. */
7385 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7386 in the current keymaps, or nil where it is not a prefix. */
7389 Lisp_Object def
, tail
;
7394 /* In order to build the menus, we need to call the keymap
7395 accessors. They all call QUIT. But this function is called
7396 during redisplay, during which a quit is fatal. So inhibit
7397 quitting while building the menus.
7398 We do this instead of specbind because (1) errors will clear it anyway
7399 and (2) this avoids risk of specpdl overflow. */
7400 oquit
= Vinhibit_quit
;
7404 menu_bar_items_vector
= old
;
7406 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7407 menu_bar_items_index
= 0;
7409 /* Build our list of keymaps.
7410 If we recognize a function key and replace its escape sequence in
7411 keybuf with its symbol, or if the sequence starts with a mouse
7412 click and we need to switch buffers, we jump back here to rebuild
7413 the initial keymaps from the current buffer. */
7417 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7418 if (!NILP (Voverriding_local_map_menu_flag
)
7419 && !NILP (Voverriding_local_map
))
7421 /* Yes, use them (if non-nil) as well as the global map. */
7422 maps
= alloca (3 * sizeof (maps
[0]));
7424 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7425 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7426 if (!NILP (Voverriding_local_map
))
7427 maps
[nmaps
++] = Voverriding_local_map
;
7431 /* No, so use major and minor mode keymaps and keymap property.
7432 Note that menu-bar bindings in the local-map and keymap
7433 properties may not work reliable, as they are only
7434 recognized when the menu-bar (or mode-line) is updated,
7435 which does not normally happen after every command. */
7438 nminor
= current_minor_maps (NULL
, &tmaps
);
7439 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7441 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7442 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7443 maps
[nmaps
++] = tem
;
7444 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7445 maps
[nmaps
++] = tem
;
7446 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7448 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7450 maps
[nmaps
++] = current_global_map
;
7453 /* Look up in each map the dummy prefix key `menu-bar'. */
7455 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7456 if (!NILP (maps
[mapno
]))
7458 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7462 menu_bar_one_keymap_changed_items
= Qnil
;
7463 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7467 /* Move to the end those items that should be at the end. */
7469 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7472 int end
= menu_bar_items_index
;
7474 for (i
= 0; i
< end
; i
+= 4)
7475 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7477 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7478 /* Move the item at index I to the end,
7479 shifting all the others forward. */
7480 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7481 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7482 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7483 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7485 memmove (aref_addr (menu_bar_items_vector
, i
),
7486 aref_addr (menu_bar_items_vector
, i
+ 4),
7487 (end
- i
- 4) * word_size
);
7488 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7489 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7490 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7491 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7496 /* Add nil, nil, nil, nil at the end. */
7498 int i
= menu_bar_items_index
;
7499 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7500 menu_bar_items_vector
7501 = larger_vector (menu_bar_items_vector
, 4, -1);
7502 /* Add this item. */
7503 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7504 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7505 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7506 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7507 menu_bar_items_index
= i
;
7510 Vinhibit_quit
= oquit
;
7511 return menu_bar_items_vector
;
7514 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7515 If there's already an item for KEY, add this DEF to it. */
7517 Lisp_Object item_properties
;
7520 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7522 struct gcpro gcpro1
;
7527 if (EQ (item
, Qundefined
))
7529 /* If a map has an explicit `undefined' as definition,
7530 discard any previously made menu bar item. */
7532 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7533 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7535 if (menu_bar_items_index
> i
+ 4)
7536 memmove (aref_addr (menu_bar_items_vector
, i
),
7537 aref_addr (menu_bar_items_vector
, i
+ 4),
7538 (menu_bar_items_index
- i
- 4) * word_size
);
7539 menu_bar_items_index
-= 4;
7543 /* If this keymap has already contributed to this KEY,
7544 don't contribute to it a second time. */
7545 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7546 if (!NILP (tem
) || NILP (item
))
7549 menu_bar_one_keymap_changed_items
7550 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7552 /* We add to menu_bar_one_keymap_changed_items before doing the
7553 parse_menu_item, so that if it turns out it wasn't a menu item,
7554 it still correctly hides any further menu item. */
7556 parsed
= parse_menu_item (item
, 1);
7561 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7563 /* Find any existing item for this KEY. */
7564 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7565 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7568 /* If we did not find this KEY, add it at the end. */
7569 if (i
== menu_bar_items_index
)
7571 /* If vector is too small, get a bigger one. */
7572 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7573 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7574 /* Add this item. */
7575 ASET (menu_bar_items_vector
, i
, key
); i
++;
7576 ASET (menu_bar_items_vector
, i
,
7577 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7578 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7579 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7580 menu_bar_items_index
= i
;
7582 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7586 old
= AREF (menu_bar_items_vector
, i
+ 2);
7587 /* If the new and the old items are not both keymaps,
7588 the lookup will only find `item'. */
7589 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7590 ASET (menu_bar_items_vector
, i
+ 2, item
);
7594 /* This is used as the handler when calling menu_item_eval_property. */
7596 menu_item_eval_property_1 (Lisp_Object arg
)
7598 /* If we got a quit from within the menu computation,
7599 quit all the way out of it. This takes care of C-] in the debugger. */
7600 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7601 Fsignal (Qquit
, Qnil
);
7607 eval_dyn (Lisp_Object form
)
7609 return Feval (form
, Qnil
);
7612 /* Evaluate an expression and return the result (or nil if something
7613 went wrong). Used to evaluate dynamic parts of menu items. */
7615 menu_item_eval_property (Lisp_Object sexpr
)
7619 specbind (Qinhibit_redisplay
, Qt
);
7620 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7621 menu_item_eval_property_1
);
7626 /* This function parses a menu item and leaves the result in the
7627 vector item_properties.
7628 ITEM is a key binding, a possible menu item.
7629 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7631 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7632 parse_menu_item returns true if the item is a menu item and false
7636 parse_menu_item (Lisp_Object item
, int inmenubar
)
7638 Lisp_Object def
, tem
, item_string
, start
;
7640 Lisp_Object keyhint
;
7649 /* Create item_properties vector if necessary. */
7650 if (NILP (item_properties
))
7652 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7654 /* Initialize optional entries. */
7655 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7656 ASET (item_properties
, i
, Qnil
);
7657 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7659 /* Save the item here to protect it from GC. */
7660 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7662 item_string
= XCAR (item
);
7666 if (STRINGP (item_string
))
7668 /* Old format menu item. */
7669 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7671 /* Maybe help string. */
7672 if (CONSP (item
) && STRINGP (XCAR (item
)))
7674 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7679 /* Maybe an obsolete key binding cache. */
7680 if (CONSP (item
) && CONSP (XCAR (item
))
7681 && (NILP (XCAR (XCAR (item
)))
7682 || VECTORP (XCAR (XCAR (item
)))))
7685 /* This is the real definition--the function to run. */
7686 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7688 /* Get enable property, if any. */
7691 tem
= Fget (item
, Qmenu_enable
);
7692 if (!NILP (Venable_disabled_menus_and_buttons
))
7693 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7694 else if (!NILP (tem
))
7695 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7698 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7700 /* New format menu item. */
7701 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7702 start
= XCDR (item
);
7705 /* We have a real binding. */
7706 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7708 item
= XCDR (start
);
7709 /* Is there an obsolete cache list with key equivalences. */
7710 if (CONSP (item
) && CONSP (XCAR (item
)))
7713 /* Parse properties. */
7714 while (CONSP (item
) && CONSP (XCDR (item
)))
7719 if (EQ (tem
, QCenable
))
7721 if (!NILP (Venable_disabled_menus_and_buttons
))
7722 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7724 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7726 else if (EQ (tem
, QCvisible
))
7728 /* If got a visible property and that evaluates to nil
7729 then ignore this item. */
7730 tem
= menu_item_eval_property (XCAR (item
));
7734 else if (EQ (tem
, QChelp
))
7735 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7736 else if (EQ (tem
, QCfilter
))
7738 else if (EQ (tem
, QCkey_sequence
))
7741 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7742 /* Be GC protected. Set keyhint to item instead of tem. */
7745 else if (EQ (tem
, QCkeys
))
7748 if (CONSP (tem
) || STRINGP (tem
))
7749 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7751 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7756 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7758 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7760 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7766 else if (inmenubar
|| !NILP (start
))
7770 return 0; /* not a menu item */
7772 /* If item string is not a string, evaluate it to get string.
7773 If we don't get a string, skip this item. */
7774 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7775 if (!(STRINGP (item_string
)))
7777 item_string
= menu_item_eval_property (item_string
);
7778 if (!STRINGP (item_string
))
7780 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7783 /* If got a filter apply it on definition. */
7784 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7787 def
= menu_item_eval_property (list2 (XCAR (filter
),
7788 list2 (Qquote
, def
)));
7790 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7793 /* Enable or disable selection of item. */
7794 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7797 tem
= menu_item_eval_property (tem
);
7798 if (inmenubar
&& NILP (tem
))
7799 return 0; /* Ignore disabled items in menu bar. */
7800 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7803 /* If we got no definition, this item is just unselectable text which
7804 is OK in a submenu but not in the menubar. */
7806 return (!inmenubar
);
7808 /* See if this is a separate pane or a submenu. */
7809 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7810 tem
= get_keymap (def
, 0, 1);
7811 /* For a subkeymap, just record its details and exit. */
7814 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7815 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7819 /* At the top level in the menu bar, do likewise for commands also.
7820 The menu bar does not display equivalent key bindings anyway.
7821 ITEM_PROPERTY_DEF is already set up properly. */
7825 { /* This is a command. See if there is an equivalent key binding. */
7826 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7828 /* The previous code preferred :key-sequence to :keys, so we
7829 preserve this behavior. */
7830 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7831 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7834 Lisp_Object prefix
= keyeq
;
7835 Lisp_Object keys
= Qnil
;
7839 def
= XCAR (prefix
);
7840 prefix
= XCDR (prefix
);
7843 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7845 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7847 keys
= XCAR (keyhint
);
7848 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7850 /* We have a suggested key. Is it bound to the command? */
7853 /* If the command is an alias for another
7854 (such as lmenu.el set it up), check if the
7855 original command matches the cached command. */
7857 && EQ (tem
, SYMBOL_FUNCTION (def
)))))
7862 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7866 tem
= Fkey_description (keys
, Qnil
);
7869 if (STRINGP (XCAR (prefix
)))
7870 tem
= concat2 (XCAR (prefix
), tem
);
7871 if (STRINGP (XCDR (prefix
)))
7872 tem
= concat2 (tem
, XCDR (prefix
));
7874 keyeq
= concat2 (build_string (" "), tem
);
7875 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7881 /* If we have an equivalent key binding, use that. */
7882 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7885 /* Include this when menu help is implemented.
7886 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7887 if (!(NILP (tem) || STRINGP (tem)))
7889 tem = menu_item_eval_property (tem);
7892 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7896 /* Handle radio buttons or toggle boxes. */
7897 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7899 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7900 menu_item_eval_property (tem
));
7907 /***********************************************************************
7909 ***********************************************************************/
7911 /* A vector holding tool bar items while they are parsed in function
7912 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7915 static Lisp_Object tool_bar_items_vector
;
7917 /* A vector holding the result of parse_tool_bar_item. Layout is like
7918 the one for a single item in tool_bar_items_vector. */
7920 static Lisp_Object tool_bar_item_properties
;
7922 /* Next free index in tool_bar_items_vector. */
7924 static int ntool_bar_items
;
7926 /* The symbols `:image' and `:rtl'. */
7928 static Lisp_Object QCimage
;
7929 static Lisp_Object QCrtl
;
7931 /* Function prototypes. */
7933 static void init_tool_bar_items (Lisp_Object
);
7934 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7936 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7937 static void append_tool_bar_item (void);
7940 /* Return a vector of tool bar items for keymaps currently in effect.
7941 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7942 tool bar items found. */
7945 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7954 /* In order to build the menus, we need to call the keymap
7955 accessors. They all call QUIT. But this function is called
7956 during redisplay, during which a quit is fatal. So inhibit
7957 quitting while building the menus. We do this instead of
7958 specbind because (1) errors will clear it anyway and (2) this
7959 avoids risk of specpdl overflow. */
7960 oquit
= Vinhibit_quit
;
7963 /* Initialize tool_bar_items_vector and protect it from GC. */
7964 init_tool_bar_items (reuse
);
7966 /* Build list of keymaps in maps. Set nmaps to the number of maps
7969 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7970 if (!NILP (Voverriding_local_map_menu_flag
)
7971 && !NILP (Voverriding_local_map
))
7973 /* Yes, use them (if non-nil) as well as the global map. */
7974 maps
= alloca (3 * sizeof *maps
);
7976 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7977 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7978 if (!NILP (Voverriding_local_map
))
7979 maps
[nmaps
++] = Voverriding_local_map
;
7983 /* No, so use major and minor mode keymaps and keymap property.
7984 Note that tool-bar bindings in the local-map and keymap
7985 properties may not work reliable, as they are only
7986 recognized when the tool-bar (or mode-line) is updated,
7987 which does not normally happen after every command. */
7990 nminor
= current_minor_maps (NULL
, &tmaps
);
7991 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7993 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7994 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7995 maps
[nmaps
++] = tem
;
7996 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7997 maps
[nmaps
++] = tem
;
7998 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8000 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8003 /* Add global keymap at the end. */
8004 maps
[nmaps
++] = current_global_map
;
8006 /* Process maps in reverse order and look up in each map the prefix
8008 for (i
= nmaps
- 1; i
>= 0; --i
)
8009 if (!NILP (maps
[i
]))
8013 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8015 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8018 Vinhibit_quit
= oquit
;
8019 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8020 return tool_bar_items_vector
;
8024 /* Process the definition of KEY which is DEF. */
8027 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8030 struct gcpro gcpro1
, gcpro2
;
8032 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8036 if (EQ (def
, Qundefined
))
8038 /* If a map has an explicit `undefined' as definition,
8039 discard any previously made item. */
8040 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8042 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8044 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8046 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8047 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8048 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8050 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8055 else if (parse_tool_bar_item (key
, def
))
8056 /* Append a new tool bar item to tool_bar_items_vector. Accept
8057 more than one definition for the same key. */
8058 append_tool_bar_item ();
8063 /* Access slot with index IDX of vector tool_bar_item_properties. */
8064 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8066 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8068 ASET (tool_bar_item_properties
, idx
, val
);
8072 /* Parse a tool bar item specification ITEM for key KEY and return the
8073 result in tool_bar_item_properties. Value is false if ITEM is
8076 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8078 CAPTION is the caption of the item, If it's not a string, it is
8079 evaluated to get a string.
8081 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8082 as binding are currently ignored.
8084 The following properties are recognized:
8088 FORM is evaluated and specifies whether the tool bar item is
8089 enabled or disabled.
8093 FORM is evaluated and specifies whether the tool bar item is visible.
8095 - `:filter FUNCTION'
8097 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8098 result is stored as the new binding.
8100 - `:button (TYPE SELECTED)'
8102 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8103 and specifies whether the button is selected (pressed) or not.
8107 IMAGES is either a single image specification or a vector of four
8108 image specifications. See enum tool_bar_item_images.
8110 - `:help HELP-STRING'.
8112 Gives a help string to display for the tool bar item.
8114 - `:label LABEL-STRING'.
8116 A text label to show with the tool bar button if labels are enabled. */
8119 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8121 Lisp_Object filter
= Qnil
;
8122 Lisp_Object caption
;
8124 bool have_label
= 0;
8126 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8127 Rule out items that aren't lists, don't start with
8128 `menu-item' or whose rest following `tool-bar-item' is not a
8133 /* As an exception, allow old-style menu separators. */
8134 if (STRINGP (XCAR (item
)))
8135 item
= list1 (XCAR (item
));
8136 else if (!EQ (XCAR (item
), Qmenu_item
)
8137 || (item
= XCDR (item
), !CONSP (item
)))
8140 /* Create tool_bar_item_properties vector if necessary. Reset it to
8142 if (VECTORP (tool_bar_item_properties
))
8144 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8148 tool_bar_item_properties
8149 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8152 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8153 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8155 /* Get the caption of the item. If the caption is not a string,
8156 evaluate it to get a string. If we don't get a string, skip this
8158 caption
= XCAR (item
);
8159 if (!STRINGP (caption
))
8161 caption
= menu_item_eval_property (caption
);
8162 if (!STRINGP (caption
))
8165 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8167 /* If the rest following the caption is not a list, the menu item is
8168 either a separator, or invalid. */
8172 if (menu_separator_name_p (SSDATA (caption
)))
8174 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8175 #if !defined (USE_GTK) && !defined (HAVE_NS)
8176 /* If we use build_desired_tool_bar_string to render the
8177 tool bar, the separator is rendered as an image. */
8178 set_prop (TOOL_BAR_ITEM_IMAGES
,
8179 (menu_item_eval_property
8180 (Vtool_bar_separator_image_expression
)));
8181 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8182 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8183 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8190 /* Store the binding. */
8191 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8194 /* Ignore cached key binding, if any. */
8195 if (CONSP (item
) && CONSP (XCAR (item
)))
8198 /* Process the rest of the properties. */
8199 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8201 Lisp_Object ikey
, value
;
8204 value
= XCAR (XCDR (item
));
8206 if (EQ (ikey
, QCenable
))
8208 /* `:enable FORM'. */
8209 if (!NILP (Venable_disabled_menus_and_buttons
))
8210 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8212 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8214 else if (EQ (ikey
, QCvisible
))
8216 /* `:visible FORM'. If got a visible property and that
8217 evaluates to nil then ignore this item. */
8218 if (NILP (menu_item_eval_property (value
)))
8221 else if (EQ (ikey
, QChelp
))
8222 /* `:help HELP-STRING'. */
8223 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8224 else if (EQ (ikey
, QCvert_only
))
8225 /* `:vert-only t/nil'. */
8226 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8227 else if (EQ (ikey
, QClabel
))
8229 const char *bad_label
= "!!?GARBLED ITEM?!!";
8230 /* `:label LABEL-STRING'. */
8231 set_prop (TOOL_BAR_ITEM_LABEL
,
8232 STRINGP (value
) ? value
: build_string (bad_label
));
8235 else if (EQ (ikey
, QCfilter
))
8236 /* ':filter FORM'. */
8238 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8240 /* `:button (TYPE . SELECTED)'. */
8241 Lisp_Object type
, selected
;
8243 type
= XCAR (value
);
8244 selected
= XCDR (value
);
8245 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8247 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8248 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8251 else if (EQ (ikey
, QCimage
)
8253 || (VECTORP (value
) && ASIZE (value
) == 4)))
8254 /* Value is either a single image specification or a vector
8255 of 4 such specifications for the different button states. */
8256 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8257 else if (EQ (ikey
, QCrtl
))
8259 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8265 /* Try to make one from caption and key. */
8266 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8267 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8268 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8269 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8271 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8272 char *buf
= xmalloc_atomic (max_lbl
+ 1);
8273 Lisp_Object new_lbl
;
8274 ptrdiff_t caption_len
= strlen (capt
);
8276 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8279 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8281 buf
[caption_len
] = '\0';
8285 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8289 strcpy (buf
, label
);
8291 for (j
= 0; buf
[j
] != '\0'; ++j
)
8299 new_lbl
= Fupcase_initials (build_string (label
));
8300 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8301 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8303 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8307 /* If got a filter apply it on binding. */
8309 set_prop (TOOL_BAR_ITEM_BINDING
,
8310 (menu_item_eval_property
8313 PROP (TOOL_BAR_ITEM_BINDING
))))));
8315 /* See if the binding is a keymap. Give up if it is. */
8316 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8319 /* Enable or disable selection of item. */
8320 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8321 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8322 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8324 /* Handle radio buttons or toggle boxes. */
8325 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8326 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8327 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8335 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8336 that can be reused. */
8339 init_tool_bar_items (Lisp_Object reuse
)
8341 if (VECTORP (reuse
))
8342 tool_bar_items_vector
= reuse
;
8344 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8345 ntool_bar_items
= 0;
8349 /* Append parsed tool bar item properties from
8350 tool_bar_item_properties */
8353 append_tool_bar_item (void)
8357 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8359 /* Enlarge tool_bar_items_vector if necessary. */
8361 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8363 /* Append entries from tool_bar_item_properties to the end of
8364 tool_bar_items_vector. */
8365 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8366 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8367 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8374 /* Read a character using menus based on the keymap MAP.
8375 Return nil if there are no menus in the maps.
8376 Return t if we displayed a menu but the user rejected it.
8378 PREV_EVENT is the previous input event, or nil if we are reading
8379 the first event of a key sequence.
8381 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8382 if we used a mouse menu to read the input, or false otherwise. If
8383 USED_MOUSE_MENU is null, don't dereference it.
8385 The prompting is done based on the prompt-string of the map
8386 and the strings associated with various map elements.
8388 This can be done with X menus or with menus put in the minibuf.
8389 These are done in different ways, depending on how the input will be read.
8390 Menus using X are done after auto-saving in read-char, getting the input
8391 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8392 and do auto-saving in the inner call of read_char. */
8395 read_char_x_menu_prompt (Lisp_Object map
,
8396 Lisp_Object prev_event
, bool *used_mouse_menu
)
8398 if (used_mouse_menu
)
8399 *used_mouse_menu
= 0;
8401 /* Use local over global Menu maps. */
8403 if (! menu_prompting
)
8406 /* If we got to this point via a mouse click,
8407 use a real menu for mouse selection. */
8408 if (EVENT_HAS_PARAMETERS (prev_event
)
8409 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8410 && !EQ (XCAR (prev_event
), Qtool_bar
))
8412 /* Display the menu and get the selection. */
8415 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8420 record_menu_key (XCAR (value
));
8422 /* If we got multiple events, unread all but
8424 There is no way to prevent those unread events
8425 from showing up later in last_nonmenu_event.
8426 So turn symbol and integer events into lists,
8427 to indicate that they came from a mouse menu,
8428 so that when present in last_nonmenu_event
8429 they won't confuse things. */
8430 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8432 record_menu_key (XCAR (tem
));
8433 if (SYMBOLP (XCAR (tem
))
8434 || INTEGERP (XCAR (tem
)))
8435 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8438 /* If we got more than one event, put all but the first
8439 onto this list to be read later.
8440 Return just the first event now. */
8441 Vunread_command_events
8442 = nconc2 (XCDR (value
), Vunread_command_events
);
8443 value
= XCAR (value
);
8445 else if (NILP (value
))
8447 if (used_mouse_menu
)
8448 *used_mouse_menu
= 1;
8455 read_char_minibuf_menu_prompt (int commandflag
,
8458 register Lisp_Object name
;
8460 /* FIXME: Use the minibuffer's frame width. */
8461 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8463 bool nobindings
= 1;
8464 Lisp_Object rest
, vector
;
8465 Lisp_Object prompt_strings
= Qnil
;
8469 if (! menu_prompting
)
8472 map
= get_keymap (map
, 0, 1);
8473 name
= Fkeymap_prompt (map
);
8475 /* If we don't have any menus, just read a character normally. */
8476 if (!STRINGP (name
))
8479 #define PUSH_C_STR(str, listvar) \
8480 listvar = Fcons (build_unibyte_string (str), listvar)
8482 /* Prompt string always starts with map's prompt, and a space. */
8483 prompt_strings
= Fcons (name
, prompt_strings
);
8484 PUSH_C_STR (": ", prompt_strings
);
8485 nlength
= SCHARS (name
) + 2;
8489 /* Present the documented bindings, a line at a time. */
8493 Lisp_Object menu_strings
= prompt_strings
;
8494 ptrdiff_t i
= nlength
;
8496 Lisp_Object orig_defn_macro
;
8498 /* Loop over elements of map. */
8503 /* FIXME: Use map_keymap to handle new keymap formats. */
8505 /* At end of map, wrap around if just starting,
8506 or end this line if already have something on it. */
8509 if (notfirst
|| nobindings
)
8515 /* Look at the next element of the map. */
8517 elt
= AREF (vector
, idx
);
8519 elt
= Fcar_safe (rest
);
8521 if (idx
< 0 && VECTORP (elt
))
8523 /* If we found a dense table in the keymap,
8524 advanced past it, but start scanning its contents. */
8525 rest
= Fcdr_safe (rest
);
8531 /* An ordinary element. */
8532 Lisp_Object event
, tem
;
8536 event
= Fcar_safe (elt
); /* alist */
8537 elt
= Fcdr_safe (elt
);
8541 XSETINT (event
, idx
); /* vector */
8544 /* Ignore the element if it has no prompt string. */
8545 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8547 /* True if the char to type matches the string. */
8549 Lisp_Object upcased_event
, downcased_event
;
8550 Lisp_Object desc
= Qnil
;
8552 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8554 upcased_event
= Fupcase (event
);
8555 downcased_event
= Fdowncase (event
);
8556 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8557 || XINT (downcased_event
) == SREF (s
, 0));
8559 desc
= Fsingle_key_description (event
, Qnil
);
8561 #if 0 /* It is redundant to list the equivalent key bindings because
8562 the prefix is what the user has already typed. */
8564 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8566 /* Insert equivalent keybinding. */
8567 s
= concat2 (s
, tem
);
8570 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8571 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8573 /* Insert button prefix. */
8574 Lisp_Object selected
8575 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8576 if (EQ (tem
, QCradio
))
8577 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8579 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8580 s
= concat2 (tem
, s
);
8584 /* If we have room for the prompt string, add it to this line.
8585 If this is the first on the line, always add it. */
8586 if ((SCHARS (s
) + i
+ 2
8587 + (char_matches
? 0 : SCHARS (desc
) + 3))
8591 ptrdiff_t thiswidth
;
8593 /* Punctuate between strings. */
8596 PUSH_C_STR (", ", menu_strings
);
8602 /* If the char to type doesn't match the string's
8603 first char, explicitly show what char to type. */
8606 /* Add as much of string as fits. */
8607 thiswidth
= min (SCHARS (desc
), width
- i
);
8609 = Fcons (Fsubstring (desc
, make_number (0),
8610 make_number (thiswidth
)),
8613 PUSH_C_STR (" = ", menu_strings
);
8617 /* Add as much of string as fits. */
8618 thiswidth
= min (SCHARS (s
), width
- i
);
8620 = Fcons (Fsubstring (s
, make_number (0),
8621 make_number (thiswidth
)),
8627 /* If this element does not fit, end the line now,
8628 and save the element for the next line. */
8629 PUSH_C_STR ("...", menu_strings
);
8634 /* Move past this element. */
8635 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8636 /* Handle reaching end of dense table. */
8641 rest
= Fcdr_safe (rest
);
8645 /* Prompt with that and read response. */
8646 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8648 /* Make believe it's not a keyboard macro in case the help char
8649 is pressed. Help characters are not recorded because menu prompting
8650 is not used on replay. */
8651 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8652 kset_defining_kbd_macro (current_kboard
, Qnil
);
8654 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8655 while (BUFFERP (obj
));
8656 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8658 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8661 if (! EQ (obj
, menu_prompt_more_char
)
8662 && (!INTEGERP (menu_prompt_more_char
)
8663 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8665 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8666 store_kbd_macro_char (obj
);
8669 /* Help char - go round again. */
8673 /* Reading key sequences. */
8676 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8678 return access_keymap (get_keymap (keymap
, 0, 1),
8683 active_maps (Lisp_Object first_event
)
8685 Lisp_Object position
8686 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8687 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8690 /* Structure used to keep track of partial application of key remapping
8691 such as Vfunction_key_map and Vkey_translation_map. */
8692 typedef struct keyremap
8694 /* This is the map originally specified for this use. */
8696 /* This is a submap reached by looking up, in PARENT,
8697 the events from START to END. */
8699 /* Positions [START, END) in the key sequence buffer
8700 are the key that we have scanned so far.
8701 Those events are the ones that we will replace
8702 if PARENT maps them into a key sequence. */
8706 /* Lookup KEY in MAP.
8707 MAP is a keymap mapping keys to key vectors or functions.
8708 If the mapping is a function and DO_FUNCALL is true,
8709 the function is called with PROMPT as parameter and its return
8710 value is used as the return value of this function (after checking
8711 that it is indeed a vector). */
8714 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8719 next
= access_keymap (map
, key
, 1, 0, 1);
8721 /* Handle a symbol whose function definition is a keymap
8723 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8724 && (ARRAYP (SYMBOL_FUNCTION (next
))
8725 || KEYMAPP (SYMBOL_FUNCTION (next
))))
8726 next
= Fautoload_do_load (SYMBOL_FUNCTION (next
),
8729 /* If the keymap gives a function, not an
8730 array, then call the function with one arg and use
8731 its value instead. */
8732 if (do_funcall
&& FUNCTIONP (next
))
8737 next
= call1 (next
, prompt
);
8738 /* If the function returned something invalid,
8739 barf--don't ignore it.
8740 (To ignore it safely, we would need to gcpro a bunch of
8741 other variables.) */
8742 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8743 error ("Function %s returns invalid key sequence",
8744 SSDATA (SYMBOL_NAME (tem
)));
8749 /* Do one step of the key remapping used for function-key-map and
8750 key-translation-map:
8751 KEYBUF is the buffer holding the input events.
8752 BUFSIZE is its maximum size.
8753 FKEY is a pointer to the keyremap structure to use.
8754 INPUT is the index of the last element in KEYBUF.
8755 DOIT if true says that the remapping can actually take place.
8756 DIFF is used to return the number of keys added/removed by the remapping.
8757 PARENT is the root of the keymap.
8758 PROMPT is the prompt to use if the remapping happens through a function.
8759 Return true if the remapping actually took place. */
8762 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8763 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8765 Lisp_Object next
, key
;
8767 key
= keybuf
[fkey
->end
++];
8769 if (KEYMAPP (fkey
->parent
))
8770 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8774 /* If keybuf[fkey->start..fkey->end] is bound in the
8775 map and we're in a position to do the key remapping, replace it with
8776 the binding and restart with fkey->start at the end. */
8777 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8779 int len
= XFASTINT (Flength (next
));
8782 *diff
= len
- (fkey
->end
- fkey
->start
);
8784 if (bufsize
- input
<= *diff
)
8785 error ("Key sequence too long");
8787 /* Shift the keys that follow fkey->end. */
8789 for (i
= fkey
->end
; i
< input
; i
++)
8790 keybuf
[i
+ *diff
] = keybuf
[i
];
8792 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8793 keybuf
[i
+ *diff
] = keybuf
[i
];
8794 /* Overwrite the old keys with the new ones. */
8795 for (i
= 0; i
< len
; i
++)
8796 keybuf
[fkey
->start
+ i
]
8797 = Faref (next
, make_number (i
));
8799 fkey
->start
= fkey
->end
+= *diff
;
8800 fkey
->map
= fkey
->parent
;
8805 fkey
->map
= get_keymap (next
, 0, 1);
8807 /* If we no longer have a bound suffix, try a new position for
8809 if (!CONSP (fkey
->map
))
8811 fkey
->end
= ++fkey
->start
;
8812 fkey
->map
= fkey
->parent
;
8818 test_undefined (Lisp_Object binding
)
8820 return (NILP (binding
)
8821 || EQ (binding
, Qundefined
)
8822 || (SYMBOLP (binding
)
8823 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8826 /* Read a sequence of keys that ends with a non prefix character,
8827 storing it in KEYBUF, a buffer of size BUFSIZE.
8829 Return the length of the key sequence stored.
8830 Return -1 if the user rejected a command menu.
8832 Echo starting immediately unless `prompt' is 0.
8834 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8835 read_char with a suitable COMMANDFLAG argument.
8837 Where a key sequence ends depends on the currently active keymaps.
8838 These include any minor mode keymaps active in the current buffer,
8839 the current buffer's local map, and the global map.
8841 If a key sequence has no other bindings, we check Vfunction_key_map
8842 to see if some trailing subsequence might be the beginning of a
8843 function key's sequence. If so, we try to read the whole function
8844 key, and substitute its symbolic name into the key sequence.
8846 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8847 `double-' events into similar click events, if that would make them
8848 bound. We try to turn `triple-' events first into `double-' events,
8851 If we get a mouse click in a mode line, vertical divider, or other
8852 non-text area, we treat the click as if it were prefixed by the
8853 symbol denoting that area - `mode-line', `vertical-line', or
8856 If the sequence starts with a mouse click, we read the key sequence
8857 with respect to the buffer clicked on, not the current buffer.
8859 If the user switches frames in the midst of a key sequence, we put
8860 off the switch-frame event until later; the next call to
8861 read_char will return it.
8863 If FIX_CURRENT_BUFFER, we restore current_buffer
8864 from the selected window's buffer. */
8867 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8868 bool dont_downcase_last
, bool can_return_switch_frame
,
8869 bool fix_current_buffer
, bool prevent_redisplay
)
8871 /* How many keys there are in the current key sequence. */
8874 /* The length of the echo buffer when we started reading, and
8875 the length of this_command_keys when we started reading. */
8876 ptrdiff_t echo_start
IF_LINT (= 0);
8877 ptrdiff_t keys_start
;
8879 Lisp_Object current_binding
= Qnil
;
8880 Lisp_Object first_event
= Qnil
;
8882 /* Index of the first key that has no binding.
8883 It is useless to try fkey.start larger than that. */
8886 /* If t < mock_input, then KEYBUF[t] should be read as the next
8889 We use this to recover after recognizing a function key. Once we
8890 realize that a suffix of the current key sequence is actually a
8891 function key's escape sequence, we replace the suffix with the
8892 function key's binding from Vfunction_key_map. Now keybuf
8893 contains a new and different key sequence, so the echo area,
8894 this_command_keys, and the submaps and defs arrays are wrong. In
8895 this situation, we set mock_input to t, set t to 0, and jump to
8896 restart_sequence; the loop will read keys from keybuf up until
8897 mock_input, thus rebuilding the state; and then it will resume
8898 reading characters from the keyboard. */
8901 /* If the sequence is unbound in submaps[], then
8902 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8903 and fkey.map is its binding.
8905 These might be > t, indicating that all function key scanning
8906 should hold off until t reaches them. We do this when we've just
8907 recognized a function key, to avoid searching for the function
8908 key's again in Vfunction_key_map. */
8911 /* Likewise, for key_translation_map and input-decode-map. */
8912 keyremap keytran
, indec
;
8914 /* True if we are trying to map a key by changing an upper-case
8915 letter to lower case, or a shifted function key to an unshifted
8917 bool shift_translated
= 0;
8919 /* If we receive a `switch-frame' or `select-window' event in the middle of
8920 a key sequence, we put it off for later.
8921 While we're reading, we keep the event here. */
8922 Lisp_Object delayed_switch_frame
;
8924 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8925 int original_uppercase_position
= -1;
8927 /* Gets around Microsoft compiler limitations. */
8930 struct buffer
*starting_buffer
;
8932 /* List of events for which a fake prefix key has been generated. */
8933 Lisp_Object fake_prefixed_keys
= Qnil
;
8935 struct gcpro gcpro1
;
8939 GCPRO1 (fake_prefixed_keys
);
8940 raw_keybuf_count
= 0;
8942 last_nonmenu_event
= Qnil
;
8944 delayed_switch_frame
= Qnil
;
8950 /* Install the string PROMPT as the beginning of the string
8951 of echoing, so that it serves as a prompt for the next
8953 kset_echo_string (current_kboard
, prompt
);
8954 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8957 else if (cursor_in_echo_area
8958 && echo_keystrokes_p ())
8959 /* This doesn't put in a dash if the echo buffer is empty, so
8960 you don't always see a dash hanging out in the minibuffer. */
8964 /* Record the initial state of the echo area and this_command_keys;
8965 we will need to restore them if we replay a key sequence. */
8967 echo_start
= echo_length ();
8968 keys_start
= this_command_key_count
;
8969 this_single_command_key_start
= keys_start
;
8971 /* We jump here when we need to reinitialize fkey and keytran; this
8972 happens if we switch keyboards between rescans. */
8973 replay_entire_sequence
:
8975 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8976 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8977 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8978 indec
.start
= indec
.end
= 0;
8979 fkey
.start
= fkey
.end
= 0;
8980 keytran
.start
= keytran
.end
= 0;
8982 /* We jump here when the key sequence has been thoroughly changed, and
8983 we need to rescan it starting from the beginning. When we jump here,
8984 keybuf[0..mock_input] holds the sequence we should reread. */
8987 starting_buffer
= current_buffer
;
8988 first_unbound
= bufsize
+ 1;
8990 /* Build our list of keymaps.
8991 If we recognize a function key and replace its escape sequence in
8992 keybuf with its symbol, or if the sequence starts with a mouse
8993 click and we need to switch buffers, we jump back here to rebuild
8994 the initial keymaps from the current buffer. */
8995 current_binding
= active_maps (first_event
);
8997 /* Start from the beginning in keybuf. */
9000 /* These are no-ops the first time through, but if we restart, they
9001 revert the echo area and this_command_keys to their original state. */
9002 this_command_key_count
= keys_start
;
9003 if (INTERACTIVE
&& t
< mock_input
)
9004 echo_truncate (echo_start
);
9006 /* If the best binding for the current key sequence is a keymap, or
9007 we may be looking at a function key's escape sequence, keep on
9009 while (!NILP (current_binding
)
9010 /* Keep reading as long as there's a prefix binding. */
9011 ? KEYMAPP (current_binding
)
9012 /* Don't return in the middle of a possible function key sequence,
9013 if the only bindings we found were via case conversion.
9014 Thus, if ESC O a has a function-key-map translation
9015 and ESC o has a binding, don't return after ESC O,
9016 so that we can translate ESC O plus the next character. */
9017 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9020 bool used_mouse_menu
= 0;
9022 /* Where the last real key started. If we need to throw away a
9023 key that has expanded into more than one element of keybuf
9024 (say, a mouse click on the mode line which is being treated
9025 as [mode-line (mouse-...)], then we backtrack to this point
9027 int last_real_key_start
;
9029 /* These variables are analogous to echo_start and keys_start;
9030 while those allow us to restart the entire key sequence,
9031 echo_local_start and keys_local_start allow us to throw away
9033 ptrdiff_t echo_local_start
IF_LINT (= 0);
9034 int keys_local_start
;
9035 Lisp_Object new_binding
;
9037 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9038 eassert (indec
.start
<= indec
.end
);
9039 eassert (fkey
.start
<= fkey
.end
);
9040 eassert (keytran
.start
<= keytran
.end
);
9041 /* key-translation-map is applied *after* function-key-map
9042 which is itself applied *after* input-decode-map. */
9043 eassert (fkey
.end
<= indec
.start
);
9044 eassert (keytran
.end
<= fkey
.start
);
9046 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9047 first_unbound
< keytran
.start
)
9048 { /* The prefix upto first_unbound has no binding and has
9049 no translation left to do either, so we know it's unbound.
9050 If we don't stop now, we risk staying here indefinitely
9051 (if the user keeps entering fkey or keytran prefixes
9052 like C-c ESC ESC ESC ESC ...) */
9054 for (i
= first_unbound
+ 1; i
< t
; i
++)
9055 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9056 mock_input
= t
- first_unbound
- 1;
9057 indec
.end
= indec
.start
-= first_unbound
+ 1;
9058 indec
.map
= indec
.parent
;
9059 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9060 fkey
.map
= fkey
.parent
;
9061 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9062 keytran
.map
= keytran
.parent
;
9063 goto replay_sequence
;
9067 error ("Key sequence too long");
9070 echo_local_start
= echo_length ();
9071 keys_local_start
= this_command_key_count
;
9074 /* These are no-ops, unless we throw away a keystroke below and
9075 jumped back up to replay_key; in that case, these restore the
9076 variables to their original state, allowing us to replay the
9078 if (INTERACTIVE
&& t
< mock_input
)
9079 echo_truncate (echo_local_start
);
9080 this_command_key_count
= keys_local_start
;
9082 /* By default, assume each event is "real". */
9083 last_real_key_start
= t
;
9085 /* Does mock_input indicate that we are re-reading a key sequence? */
9089 add_command_key (key
);
9090 if (echo_keystrokes_p ()
9091 && current_kboard
->immediate_echo
)
9098 /* If not, we should actually read a character. */
9102 KBOARD
*interrupted_kboard
= current_kboard
;
9103 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9104 /* Calling read_char with COMMANDFLAG = -2 avoids
9105 redisplay in read_char and its subroutines. */
9106 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9107 current_binding
, last_nonmenu_event
,
9108 &used_mouse_menu
, NULL
);
9109 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9110 /* When switching to a new tty (with a new keyboard),
9111 read_char returns the new buffer, rather than -2
9112 (Bug#5095). This is because `terminal-init-xterm'
9113 calls read-char, which eats the wrong_kboard_jmpbuf
9114 return. Any better way to fix this? -- cyd */
9115 || (interrupted_kboard
!= current_kboard
))
9120 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9121 if (k
== interrupted_kboard
)
9126 /* Don't touch interrupted_kboard when it's been
9128 delayed_switch_frame
= Qnil
;
9129 goto replay_entire_sequence
;
9132 if (!NILP (delayed_switch_frame
))
9135 (interrupted_kboard
,
9136 Fcons (delayed_switch_frame
,
9137 KVAR (interrupted_kboard
, kbd_queue
)));
9138 delayed_switch_frame
= Qnil
;
9143 (interrupted_kboard
,
9144 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9146 /* If the side queue is non-empty, ensure it begins with a
9147 switch-frame, so we'll replay it in the right context. */
9148 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9149 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9150 !(EVENT_HAS_PARAMETERS (key
)
9151 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9155 XSETFRAME (frame
, interrupted_frame
);
9157 (interrupted_kboard
,
9158 Fcons (make_lispy_switch_frame (frame
),
9159 KVAR (interrupted_kboard
, kbd_queue
)));
9162 goto replay_entire_sequence
;
9166 /* read_char returns t when it shows a menu and the user rejects it.
9175 /* read_char returns -1 at the end of a macro.
9176 Emacs 18 handles this by returning immediately with a
9177 zero, so that's what we'll do. */
9178 if (INTEGERP (key
) && XINT (key
) == -1)
9181 /* The Microsoft C compiler can't handle the goto that
9187 /* If the current buffer has been changed from under us, the
9188 keymap may have changed, so replay the sequence. */
9191 timer_resume_idle ();
9194 /* Reset the current buffer from the selected window
9195 in case something changed the former and not the latter.
9196 This is to be more consistent with the behavior
9197 of the command_loop_1. */
9198 if (fix_current_buffer
)
9200 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9202 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9204 Fset_buffer (XWINDOW (selected_window
)->contents
);
9207 goto replay_sequence
;
9210 /* If we have a quit that was typed in another frame, and
9211 quit_throw_to_read_char switched buffers,
9212 replay to get the right keymap. */
9214 && XINT (key
) == quit_char
9215 && current_buffer
!= starting_buffer
)
9218 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9223 goto replay_sequence
;
9228 if (EVENT_HAS_PARAMETERS (key
)
9229 /* Either a `switch-frame' or a `select-window' event. */
9230 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9232 /* If we're at the beginning of a key sequence, and the caller
9233 says it's okay, go ahead and return this event. If we're
9234 in the midst of a key sequence, delay it until the end. */
9235 if (t
> 0 || !can_return_switch_frame
)
9237 delayed_switch_frame
= key
;
9242 if (NILP (first_event
))
9245 /* Even if first_event does not specify a particular
9246 window/position, it's important to recompute the maps here
9247 since a long time might have passed since we entered
9248 read_key_sequence, and a timer (or process-filter or
9249 special-event-map, ...) might have switched the current buffer
9250 or the selected window from under us in the mean time. */
9251 if (fix_current_buffer
9252 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9254 Fset_buffer (XWINDOW (selected_window
)->contents
);
9255 current_binding
= active_maps (first_event
);
9259 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9263 /* Clicks in non-text areas get prefixed by the symbol
9264 in their CHAR-ADDRESS field. For example, a click on
9265 the mode line is prefixed by the symbol `mode-line'.
9267 Furthermore, key sequences beginning with mouse clicks
9268 are read using the keymaps of the buffer clicked on, not
9269 the current buffer. So we may have to switch the buffer
9272 When we turn one event into two events, we must make sure
9273 that neither of the two looks like the original--so that,
9274 if we replay the events, they won't be expanded again.
9275 If not for this, such reexpansion could happen either here
9276 or when user programs play with this-command-keys. */
9277 if (EVENT_HAS_PARAMETERS (key
))
9279 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9280 if (EQ (kind
, Qmouse_click
))
9282 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9283 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9286 || (!NILP (fake_prefixed_keys
)
9287 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9289 /* We're looking a second time at an event for which
9290 we generated a fake prefix key. Set
9291 last_real_key_start appropriately. */
9293 last_real_key_start
= t
- 1;
9296 if (last_real_key_start
== 0)
9298 /* Key sequences beginning with mouse clicks are
9299 read using the keymaps in the buffer clicked on,
9300 not the current buffer. If we're at the
9301 beginning of a key sequence, switch buffers. */
9302 if (WINDOWP (window
)
9303 && BUFFERP (XWINDOW (window
)->contents
)
9304 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9306 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9311 /* Arrange to go back to the original buffer once we're
9312 done reading the key sequence. Note that we can't
9313 use save_excursion_{save,restore} here, because they
9314 save point as well as the current buffer; we don't
9315 want to save point, because redisplay may change it,
9316 to accommodate a Fset_window_start or something. We
9317 don't want to do this at the top of the function,
9318 because we may get input from a subprocess which
9319 wants to change the selected window and stuff (say,
9321 record_unwind_current_buffer ();
9323 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9325 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9326 goto replay_sequence
;
9330 /* Expand mode-line and scroll-bar events into two events:
9331 use posn as a fake prefix key. */
9333 && (NILP (fake_prefixed_keys
)
9334 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9336 if (bufsize
- t
<= 1)
9337 error ("Key sequence too long");
9340 keybuf
[t
+ 1] = key
;
9343 /* Record that a fake prefix key has been generated
9344 for KEY. Don't modify the event; this would
9345 prevent proper action when the event is pushed
9346 back into unread-command-events. */
9347 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9351 else if (CONSP (XCDR (key
))
9352 && CONSP (EVENT_START (key
))
9353 && CONSP (XCDR (EVENT_START (key
))))
9357 posn
= POSN_POSN (EVENT_START (key
));
9358 /* Handle menu-bar events:
9359 insert the dummy prefix event `menu-bar'. */
9360 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9362 if (bufsize
- t
<= 1)
9363 error ("Key sequence too long");
9365 keybuf
[t
+ 1] = key
;
9367 /* Zap the position in key, so we know that we've
9368 expanded it, and don't try to do so again. */
9369 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9372 goto replay_sequence
;
9374 else if (CONSP (posn
))
9376 /* We're looking at the second event of a
9377 sequence which we expanded before. Set
9378 last_real_key_start appropriately. */
9379 if (last_real_key_start
== t
&& t
> 0)
9380 last_real_key_start
= t
- 1;
9385 /* We have finally decided that KEY is something we might want
9387 new_binding
= follow_key (current_binding
, key
);
9389 /* If KEY wasn't bound, we'll try some fallbacks. */
9390 if (!NILP (new_binding
))
9391 /* This is needed for the following scenario:
9392 event 0: a down-event that gets dropped by calling replay_key.
9393 event 1: some normal prefix like C-h.
9394 After event 0, first_unbound is 0, after event 1 indec.start,
9395 fkey.start, and keytran.start are all 1, so when we see that
9396 C-h is bound, we need to update first_unbound. */
9397 first_unbound
= max (t
+ 1, first_unbound
);
9402 /* Remember the position to put an upper bound on indec.start. */
9403 first_unbound
= min (t
, first_unbound
);
9405 head
= EVENT_HEAD (key
);
9409 Lisp_Object breakdown
;
9412 breakdown
= parse_modifiers (head
);
9413 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9414 /* Attempt to reduce an unbound mouse event to a simpler
9415 event that is bound:
9416 Drags reduce to clicks.
9417 Double-clicks reduce to clicks.
9418 Triple-clicks reduce to double-clicks, then to clicks.
9419 Down-clicks are eliminated.
9420 Double-downs reduce to downs, then are eliminated.
9421 Triple-downs reduce to double-downs, then to downs,
9422 then are eliminated. */
9423 if (modifiers
& (down_modifier
| drag_modifier
9424 | double_modifier
| triple_modifier
))
9426 while (modifiers
& (down_modifier
| drag_modifier
9427 | double_modifier
| triple_modifier
))
9429 Lisp_Object new_head
, new_click
;
9430 if (modifiers
& triple_modifier
)
9431 modifiers
^= (double_modifier
| triple_modifier
);
9432 else if (modifiers
& double_modifier
)
9433 modifiers
&= ~double_modifier
;
9434 else if (modifiers
& drag_modifier
)
9435 modifiers
&= ~drag_modifier
;
9438 /* Dispose of this `down' event by simply jumping
9439 back to replay_key, to get another event.
9441 Note that if this event came from mock input,
9442 then just jumping back to replay_key will just
9443 hand it to us again. So we have to wipe out any
9446 We could delete keybuf[t] and shift everything
9447 after that to the left by one spot, but we'd also
9448 have to fix up any variable that points into
9449 keybuf, and shifting isn't really necessary
9452 Adding prefixes for non-textual mouse clicks
9453 creates two characters of mock input, and both
9454 must be thrown away. If we're only looking at
9455 the prefix now, we can just jump back to
9456 replay_key. On the other hand, if we've already
9457 processed the prefix, and now the actual click
9458 itself is giving us trouble, then we've lost the
9459 state of the keymaps we want to backtrack to, and
9460 we need to replay the whole sequence to rebuild
9463 Beyond that, only function key expansion could
9464 create more than two keys, but that should never
9465 generate mouse events, so it's okay to zero
9466 mock_input in that case too.
9468 FIXME: The above paragraph seems just plain
9469 wrong, if you consider things like
9470 xterm-mouse-mode. -stef
9472 Isn't this just the most wonderful code ever? */
9474 /* If mock_input > t + 1, the above simplification
9475 will actually end up dropping keys on the floor.
9476 This is probably OK for now, but even
9477 if mock_input <= t + 1, we need to adjust indec,
9479 Typical case [header-line down-mouse-N]:
9480 mock_input = 2, t = 1, fkey.end = 1,
9481 last_real_key_start = 0. */
9482 if (indec
.end
> last_real_key_start
)
9484 indec
.end
= indec
.start
9485 = min (last_real_key_start
, indec
.start
);
9486 indec
.map
= indec
.parent
;
9487 if (fkey
.end
> last_real_key_start
)
9489 fkey
.end
= fkey
.start
9490 = min (last_real_key_start
, fkey
.start
);
9491 fkey
.map
= fkey
.parent
;
9492 if (keytran
.end
> last_real_key_start
)
9494 keytran
.end
= keytran
.start
9495 = min (last_real_key_start
, keytran
.start
);
9496 keytran
.map
= keytran
.parent
;
9500 if (t
== last_real_key_start
)
9507 mock_input
= last_real_key_start
;
9508 goto replay_sequence
;
9513 = apply_modifiers (modifiers
, XCAR (breakdown
));
9514 new_click
= list2 (new_head
, EVENT_START (key
));
9516 /* Look for a binding for this new key. */
9517 new_binding
= follow_key (current_binding
, new_click
);
9519 /* If that click is bound, go for it. */
9520 if (!NILP (new_binding
))
9522 current_binding
= new_binding
;
9526 /* Otherwise, we'll leave key set to the drag event. */
9531 current_binding
= new_binding
;
9534 /* Normally, last_nonmenu_event gets the previous key we read.
9535 But when a mouse popup menu is being used,
9536 we don't update last_nonmenu_event; it continues to hold the mouse
9537 event that preceded the first level of menu. */
9538 if (!used_mouse_menu
)
9539 last_nonmenu_event
= key
;
9541 /* Record what part of this_command_keys is the current key sequence. */
9542 this_single_command_key_start
= this_command_key_count
- t
;
9544 /* Look for this sequence in input-decode-map.
9545 Scan from indec.end until we find a bound suffix. */
9546 while (indec
.end
< t
)
9548 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9552 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9553 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9558 mock_input
= diff
+ max (t
, mock_input
);
9559 goto replay_sequence
;
9563 if (!KEYMAPP (current_binding
)
9564 && !test_undefined (current_binding
)
9565 && indec
.start
>= t
)
9566 /* There is a binding and it's not a prefix.
9567 (and it doesn't have any input-decode-map translation pending).
9568 There is thus no function-key in this sequence.
9569 Moving fkey.start is important in this case to allow keytran.start
9570 to go over the sequence before we return (since we keep the
9571 invariant that keytran.end <= fkey.start). */
9574 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9577 /* If the sequence is unbound, see if we can hang a function key
9578 off the end of it. */
9579 /* Continue scan from fkey.end until we find a bound suffix. */
9580 while (fkey
.end
< indec
.start
)
9582 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9586 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9587 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9588 max (t
, mock_input
),
9589 /* If there's a binding (i.e.
9590 first_binding >= nmaps) we don't want
9591 to apply this function-key-mapping. */
9593 && (test_undefined (current_binding
)),
9598 mock_input
= diff
+ max (t
, mock_input
);
9599 /* Adjust the input-decode-map counters. */
9601 indec
.start
+= diff
;
9603 goto replay_sequence
;
9607 /* Look for this sequence in key-translation-map.
9608 Scan from keytran.end until we find a bound suffix. */
9609 while (keytran
.end
< fkey
.start
)
9611 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9615 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9616 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9621 mock_input
= diff
+ max (t
, mock_input
);
9622 /* Adjust the function-key-map and input-decode-map counters. */
9624 indec
.start
+= diff
;
9628 goto replay_sequence
;
9632 /* If KEY is not defined in any of the keymaps,
9633 and cannot be part of a function key or translation,
9634 and is an upper case letter
9635 use the corresponding lower-case letter instead. */
9636 if (NILP (current_binding
)
9637 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9639 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9640 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9641 || (XINT (key
) & shift_modifier
)))
9643 Lisp_Object new_key
;
9645 original_uppercase
= key
;
9646 original_uppercase_position
= t
- 1;
9648 if (XINT (key
) & shift_modifier
)
9649 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9651 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9652 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9654 /* We have to do this unconditionally, regardless of whether
9655 the lower-case char is defined in the keymaps, because they
9656 might get translated through function-key-map. */
9657 keybuf
[t
- 1] = new_key
;
9658 mock_input
= max (t
, mock_input
);
9659 shift_translated
= 1;
9661 goto replay_sequence
;
9664 if (NILP (current_binding
)
9665 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9667 read_key_sequence_cmd
= Vprefix_help_command
;
9668 /* The Microsoft C compiler can't handle the goto that
9674 /* If KEY is not defined in any of the keymaps,
9675 and cannot be part of a function key or translation,
9676 and is a shifted function key,
9677 use the corresponding unshifted function key instead. */
9678 if (NILP (current_binding
)
9679 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9681 Lisp_Object breakdown
= parse_modifiers (key
);
9683 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9685 if (modifiers
& shift_modifier
9686 /* Treat uppercase keys as shifted. */
9688 && (KEY_TO_CHAR (key
)
9689 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9690 && uppercasep (KEY_TO_CHAR (key
))))
9693 = (modifiers
& shift_modifier
9694 ? apply_modifiers (modifiers
& ~shift_modifier
,
9696 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9698 original_uppercase
= key
;
9699 original_uppercase_position
= t
- 1;
9701 /* We have to do this unconditionally, regardless of whether
9702 the lower-case char is defined in the keymaps, because they
9703 might get translated through function-key-map. */
9704 keybuf
[t
- 1] = new_key
;
9705 mock_input
= max (t
, mock_input
);
9706 /* Reset fkey (and consequently keytran) to apply
9707 function-key-map on the result, so that S-backspace is
9708 correctly mapped to DEL (via backspace). OTOH,
9709 input-decode-map doesn't need to go through it again. */
9710 fkey
.start
= fkey
.end
= 0;
9711 keytran
.start
= keytran
.end
= 0;
9712 shift_translated
= 1;
9714 goto replay_sequence
;
9719 read_key_sequence_cmd
= current_binding
;
9720 read_key_sequence_remapped
9721 /* Remap command through active keymaps.
9722 Do the remapping here, before the unbind_to so it uses the keymaps
9723 of the appropriate buffer. */
9724 = SYMBOLP (read_key_sequence_cmd
)
9725 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9728 unread_switch_frame
= delayed_switch_frame
;
9731 /* Don't downcase the last character if the caller says don't.
9732 Don't downcase it if the result is undefined, either. */
9733 if ((dont_downcase_last
|| NILP (current_binding
))
9735 && t
- 1 == original_uppercase_position
)
9737 keybuf
[t
- 1] = original_uppercase
;
9738 shift_translated
= 0;
9741 if (shift_translated
)
9742 Vthis_command_keys_shift_translated
= Qt
;
9744 /* Occasionally we fabricate events, perhaps by expanding something
9745 according to function-key-map, or by adding a prefix symbol to a
9746 mouse click in the scroll bar or modeline. In this cases, return
9747 the entire generated key sequence, even if we hit an unbound
9748 prefix or a definition before the end. This means that you will
9749 be able to push back the event properly, and also means that
9750 read-key-sequence will always return a logical unit.
9753 for (; t
< mock_input
; t
++)
9755 if (echo_keystrokes_p ())
9756 echo_char (keybuf
[t
]);
9757 add_command_key (keybuf
[t
]);
9765 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9766 Lisp_Object dont_downcase_last
,
9767 Lisp_Object can_return_switch_frame
,
9768 Lisp_Object cmd_loop
, bool allow_string
)
9770 Lisp_Object keybuf
[30];
9772 struct gcpro gcpro1
;
9776 CHECK_STRING (prompt
);
9779 specbind (Qinput_method_exit_on_first_char
,
9780 (NILP (cmd_loop
) ? Qt
: Qnil
));
9781 specbind (Qinput_method_use_echo_area
,
9782 (NILP (cmd_loop
) ? Qt
: Qnil
));
9784 memset (keybuf
, 0, sizeof keybuf
);
9786 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9788 if (NILP (continue_echo
))
9790 this_command_key_count
= 0;
9791 this_command_key_count_reset
= 0;
9792 this_single_command_key_start
= 0;
9795 #ifdef HAVE_WINDOW_SYSTEM
9796 if (display_hourglass_p
)
9797 cancel_hourglass ();
9800 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9801 prompt
, ! NILP (dont_downcase_last
),
9802 ! NILP (can_return_switch_frame
), 0, 0);
9804 #if 0 /* The following is fine for code reading a key sequence and
9805 then proceeding with a lengthy computation, but it's not good
9806 for code reading keys in a loop, like an input method. */
9807 #ifdef HAVE_WINDOW_SYSTEM
9808 if (display_hourglass_p
)
9819 Lisp_Object tem0
= ((allow_string
? make_event_array
: Fvector
) (i
, keybuf
));
9824 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9825 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9826 The sequence is sufficient to specify a non-prefix command in the
9827 current local and global maps.
9829 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9830 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9831 as a continuation of the previous key.
9833 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9834 convert the last event to lower case. (Normally any upper case event
9835 is converted to lower case if the original event is undefined and the lower
9836 case equivalent is defined.) A non-nil value is appropriate for reading
9837 a key sequence to be defined.
9839 A C-g typed while in this function is treated like any other character,
9840 and `quit-flag' is not set.
9842 If the key sequence starts with a mouse click, then the sequence is read
9843 using the keymaps of the buffer of the window clicked in, not the buffer
9844 of the selected window as normal.
9846 `read-key-sequence' drops unbound button-down events, since you normally
9847 only care about the click or drag events which follow them. If a drag
9848 or multi-click event is unbound, but the corresponding click event would
9849 be bound, `read-key-sequence' turns the event into a click event at the
9850 drag's starting position. This means that you don't have to distinguish
9851 between click and drag, double, or triple events unless you want to.
9853 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9854 lines separating windows, and scroll bars with imaginary keys
9855 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9857 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9858 function will process a switch-frame event if the user switches frames
9859 before typing anything. If the user switches frames in the middle of a
9860 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9861 is nil, then the event will be put off until after the current key sequence.
9863 `read-key-sequence' checks `function-key-map' for function key
9864 sequences, where they wouldn't conflict with ordinary bindings. See
9865 `function-key-map' for more details.
9867 The optional fifth argument CMD-LOOP, if non-nil, means
9868 that this key sequence is being read by something that will
9869 read commands one after another. It should be nil if the caller
9870 will read just one key sequence. */)
9871 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9873 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9874 can_return_switch_frame
, cmd_loop
, true);
9877 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9878 Sread_key_sequence_vector
, 1, 5, 0,
9879 doc
: /* Like `read-key-sequence' but always return a vector. */)
9880 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9882 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9883 can_return_switch_frame
, cmd_loop
, false);
9886 /* Return true if input events are pending. */
9889 detect_input_pending (void)
9891 return input_pending
|| get_input_pending (0);
9894 /* Return true if input events other than mouse movements are
9898 detect_input_pending_ignore_squeezables (void)
9900 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9903 /* Return true if input events are pending, and run any pending timers. */
9906 detect_input_pending_run_timers (bool do_display
)
9908 unsigned old_timers_run
= timers_run
;
9911 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9913 if (old_timers_run
!= timers_run
&& do_display
)
9914 redisplay_preserve_echo_area (8);
9916 return input_pending
;
9919 /* This is called in some cases before a possible quit.
9920 It cases the next call to detect_input_pending to recompute input_pending.
9921 So calling this function unnecessarily can't do any harm. */
9924 clear_input_pending (void)
9929 /* Return true if there are pending requeued events.
9930 This isn't used yet. The hope is to make wait_reading_process_output
9931 call it, and return if it runs Lisp code that unreads something.
9932 The problem is, kbd_buffer_get_event needs to be fixed to know what
9933 to do in that case. It isn't trivial. */
9936 requeued_events_pending_p (void)
9938 return (!NILP (Vunread_command_events
));
9941 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9942 doc
: /* Return t if command input is currently available with no wait.
9943 Actually, the value is nil only if we can be sure that no input is available;
9944 if there is a doubt, the value is t.
9946 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9947 (Lisp_Object check_timers
)
9949 if (!NILP (Vunread_command_events
)
9950 || !NILP (Vunread_post_input_method_events
)
9951 || !NILP (Vunread_input_method_events
))
9954 /* Process non-user-visible events (Bug#10195). */
9955 process_special_events ();
9957 return (get_input_pending ((NILP (check_timers
)
9958 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9959 | READABLE_EVENTS_FILTER_EVENTS
)
9963 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9964 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9967 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9970 if (total_keys
< NUM_RECENT_KEYS
)
9971 return Fvector (total_keys
, keys
);
9974 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9975 vcopy (val
, 0, keys
+ recent_keys_index
,
9976 NUM_RECENT_KEYS
- recent_keys_index
);
9977 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9978 keys
, recent_keys_index
);
9983 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9984 doc
: /* Return the key sequence that invoked this command.
9985 However, if the command has called `read-key-sequence', it returns
9986 the last key sequence that has been read.
9987 The value is a string or a vector.
9989 See also `this-command-keys-vector'. */)
9992 return make_event_array (this_command_key_count
,
9993 XVECTOR (this_command_keys
)->contents
);
9996 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9997 doc
: /* Return the key sequence that invoked this command, as a vector.
9998 However, if the command has called `read-key-sequence', it returns
9999 the last key sequence that has been read.
10001 See also `this-command-keys'. */)
10004 return Fvector (this_command_key_count
,
10005 XVECTOR (this_command_keys
)->contents
);
10008 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10009 Sthis_single_command_keys
, 0, 0, 0,
10010 doc
: /* Return the key sequence that invoked this command.
10011 More generally, it returns the last key sequence read, either by
10012 the command loop or by `read-key-sequence'.
10013 Unlike `this-command-keys', this function's value
10014 does not include prefix arguments.
10015 The value is always a vector. */)
10018 return Fvector (this_command_key_count
10019 - this_single_command_key_start
,
10020 (XVECTOR (this_command_keys
)->contents
10021 + this_single_command_key_start
));
10024 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10025 Sthis_single_command_raw_keys
, 0, 0, 0,
10026 doc
: /* Return the raw events that were read for this command.
10027 More generally, it returns the last key sequence read, either by
10028 the command loop or by `read-key-sequence'.
10029 Unlike `this-single-command-keys', this function's value
10030 shows the events before all translations (except for input methods).
10031 The value is always a vector. */)
10034 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10037 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10038 Sreset_this_command_lengths
, 0, 0, 0,
10039 doc
: /* Make the unread events replace the last command and echo.
10040 Used in `universal-argument-other-key'.
10042 `universal-argument-other-key' rereads the event just typed.
10043 It then gets translated through `function-key-map'.
10044 The translated event has to replace the real events,
10045 both in the value of (this-command-keys) and in echoing.
10046 To achieve this, `universal-argument-other-key' calls
10047 `reset-this-command-lengths', which discards the record of reading
10048 these events the first time. */)
10051 this_command_key_count
= before_command_key_count
;
10052 if (this_command_key_count
< this_single_command_key_start
)
10053 this_single_command_key_start
= this_command_key_count
;
10055 echo_truncate (before_command_echo_length
);
10057 /* Cause whatever we put into unread-command-events
10058 to echo as if it were being freshly read from the keyboard. */
10059 this_command_key_count_reset
= 1;
10064 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10065 Sclear_this_command_keys
, 0, 1, 0,
10066 doc
: /* Clear out the vector that `this-command-keys' returns.
10067 Also clear the record of the last 100 events, unless optional arg
10068 KEEP-RECORD is non-nil. */)
10069 (Lisp_Object keep_record
)
10073 this_command_key_count
= 0;
10074 this_command_key_count_reset
= 0;
10076 if (NILP (keep_record
))
10078 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10079 ASET (recent_keys
, i
, Qnil
);
10081 recent_keys_index
= 0;
10086 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10087 doc
: /* Return the current depth in recursive edits. */)
10091 /* Wrap around reliably on integer overflow. */
10092 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10093 XSETINT (temp
, sum
);
10097 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10098 "FOpen dribble file: ",
10099 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10100 If FILE is nil, close any open dribble file.
10101 The file will be closed when Emacs exits.
10103 Be aware that this records ALL characters you type!
10104 This may include sensitive information such as passwords. */)
10117 Lisp_Object encfile
;
10119 file
= Fexpand_file_name (file
, Qnil
);
10120 encfile
= ENCODE_FILE (file
);
10121 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10122 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10123 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10124 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10126 report_file_error ("Opening dribble", file
);
10131 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10132 doc
: /* Discard the contents of the terminal input buffer.
10133 Also end any kbd macro being defined. */)
10136 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10138 /* Discard the last command from the macro. */
10139 Fcancel_kbd_macro_events ();
10143 Vunread_command_events
= Qnil
;
10145 discard_tty_input ();
10147 kbd_fetch_ptr
= kbd_store_ptr
;
10153 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10154 doc
: /* Stop Emacs and return to superior process. You can resume later.
10155 If `cannot-suspend' is non-nil, or if the system doesn't support job
10156 control, run a subshell instead.
10158 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10159 to be read as terminal input by Emacs's parent, after suspension.
10161 Before suspending, run the normal hook `suspend-hook'.
10162 After resumption run the normal hook `suspend-resume-hook'.
10164 Some operating systems cannot stop the Emacs process and resume it later.
10165 On such systems, Emacs starts a subshell instead of suspending. */)
10166 (Lisp_Object stuffstring
)
10169 int old_height
, old_width
;
10171 struct gcpro gcpro1
;
10174 if (tty_list
&& tty_list
->next
)
10175 error ("There are other tty frames open; close them before suspending Emacs");
10177 if (!NILP (stuffstring
))
10178 CHECK_STRING (stuffstring
);
10180 /* Run the functions in suspend-hook. */
10181 hook
= intern ("suspend-hook");
10182 Frun_hooks (1, &hook
);
10184 GCPRO1 (stuffstring
);
10185 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10186 reset_all_sys_modes ();
10187 /* sys_suspend can get an error if it tries to fork a subshell
10188 and the system resources aren't available for that. */
10189 record_unwind_protect_void (init_all_sys_modes
);
10190 stuff_buffered_input (stuffstring
);
10191 if (cannot_suspend
)
10197 /* Check if terminal/window size has changed.
10198 Note that this is not useful when we are running directly
10199 with a window system; but suspend should be disabled in that case. */
10200 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10201 if (width
!= old_width
|| height
!= old_height
)
10202 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10204 /* Run suspend-resume-hook. */
10205 hook
= intern ("suspend-resume-hook");
10206 Frun_hooks (1, &hook
);
10212 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10213 Then in any case stuff anything Emacs has read ahead and not used. */
10216 stuff_buffered_input (Lisp_Object stuffstring
)
10218 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10219 register unsigned char *p
;
10221 if (STRINGP (stuffstring
))
10223 register ptrdiff_t count
;
10225 p
= SDATA (stuffstring
);
10226 count
= SBYTES (stuffstring
);
10227 while (count
-- > 0)
10232 /* Anything we have read ahead, put back for the shell to read. */
10233 /* ?? What should this do when we have multiple keyboards??
10234 Should we ignore anything that was typed in at the "wrong" kboard?
10236 rms: we should stuff everything back into the kboard
10238 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10241 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10242 kbd_fetch_ptr
= kbd_buffer
;
10243 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10244 stuff_char (kbd_fetch_ptr
->code
);
10246 clear_event (kbd_fetch_ptr
);
10250 #endif /* SIGTSTP */
10254 set_waiting_for_input (struct timespec
*time_to_clear
)
10256 input_available_clear_time
= time_to_clear
;
10258 /* Tell handle_interrupt to throw back to read_char, */
10259 waiting_for_input
= 1;
10261 /* If handle_interrupt was called before and buffered a C-g,
10262 make it run again now, to avoid timing error. */
10263 if (!NILP (Vquit_flag
))
10264 quit_throw_to_read_char (0);
10268 clear_waiting_for_input (void)
10270 /* Tell handle_interrupt not to throw back to read_char, */
10271 waiting_for_input
= 0;
10272 input_available_clear_time
= 0;
10275 /* The SIGINT handler.
10277 If we have a frame on the controlling tty, we assume that the
10278 SIGINT was generated by C-g, so we call handle_interrupt.
10279 Otherwise, tell QUIT to kill Emacs. */
10282 handle_interrupt_signal (int sig
)
10284 /* See if we have an active terminal on our controlling tty. */
10285 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10288 /* If there are no frames there, let's pretend that we are a
10289 well-behaving UN*X program and quit. We must not call Lisp
10290 in a signal handler, so tell QUIT to exit when it is
10292 Vquit_flag
= Qkill_emacs
;
10296 /* Otherwise, the SIGINT was probably generated by C-g. */
10298 /* Set internal_last_event_frame to the top frame of the
10299 controlling tty, if we have a frame there. We disable the
10300 interrupt key on secondary ttys, so the SIGINT must have come
10301 from the controlling tty. */
10302 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10304 handle_interrupt (1);
10309 deliver_interrupt_signal (int sig
)
10311 deliver_process_signal (sig
, handle_interrupt_signal
);
10315 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10316 of the number of times C-g has been requested. If C-g is pressed
10317 enough times, then quit anyway. See bug#6585. */
10318 static int volatile force_quit_count
;
10320 /* This routine is called at interrupt level in response to C-g.
10322 It is called from the SIGINT handler or kbd_buffer_store_event.
10324 If `waiting_for_input' is non zero, then unless `echoing' is
10325 nonzero, immediately throw back to read_char.
10327 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10328 eval to throw, when it gets a chance. If quit-flag is already
10329 non-nil, it stops the job right away. */
10332 handle_interrupt (bool in_signal_handler
)
10338 /* XXX This code needs to be revised for multi-tty support. */
10339 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10341 if (! in_signal_handler
)
10343 /* If SIGINT isn't blocked, don't let us be interrupted by
10344 a SIGINT. It might be harmful due to non-reentrancy
10345 in I/O functions. */
10347 sigemptyset (&blocked
);
10348 sigaddset (&blocked
, SIGINT
);
10349 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10353 reset_all_sys_modes ();
10357 * On systems which can suspend the current process and return to the original
10358 * shell, this command causes the user to end up back at the shell.
10359 * The "Auto-save" and "Abort" questions are not asked until
10360 * the user elects to return to emacs, at which point he can save the current
10361 * job and either dump core or continue.
10365 /* Perhaps should really fork an inferior shell?
10366 But that would not provide any way to get back
10367 to the original shell, ever. */
10368 printf ("No support for stopping a process on this operating system;\n");
10369 printf ("you can continue or abort.\n");
10370 #endif /* not SIGTSTP */
10372 /* We must remain inside the screen area when the internal terminal
10373 is used. Note that [Enter] is not echoed by dos. */
10374 cursor_to (SELECTED_FRAME (), 0, 0);
10376 printf ("Auto-save? (y or n) ");
10378 if (((c
= getchar ()) & ~040) == 'Y')
10380 Fdo_auto_save (Qt
, Qnil
);
10382 printf ("\r\nAuto-save done");
10383 #else /* not MSDOS */
10384 printf ("Auto-save done\n");
10385 #endif /* not MSDOS */
10387 while (c
!= '\n') c
= getchar ();
10390 printf ("\r\nAbort? (y or n) ");
10391 #else /* not MSDOS */
10392 printf ("Abort (and dump core)? (y or n) ");
10393 #endif /* not MSDOS */
10395 if (((c
= getchar ()) & ~040) == 'Y')
10397 while (c
!= '\n') c
= getchar ();
10399 printf ("\r\nContinuing...\r\n");
10400 #else /* not MSDOS */
10401 printf ("Continuing...\n");
10402 #endif /* not MSDOS */
10404 init_all_sys_modes ();
10408 /* If executing a function that wants to be interrupted out of
10409 and the user has not deferred quitting by binding `inhibit-quit'
10410 then quit right away. */
10411 if (immediate_quit
&& NILP (Vinhibit_quit
))
10413 struct gl_state_s saved
;
10414 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10416 immediate_quit
= 0;
10417 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10419 GCPRO4 (saved
.object
, saved
.global_code
,
10420 saved
.current_syntax_table
, saved
.old_prop
);
10421 Fsignal (Qquit
, Qnil
);
10426 { /* Else request quit when it's safe. */
10427 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10428 force_quit_count
= count
;
10431 immediate_quit
= 1;
10432 Vinhibit_quit
= Qnil
;
10438 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10440 /* TODO: The longjmp in this call throws the NS event loop integration off,
10441 and it seems to do fine without this. Probably some attention
10442 needs to be paid to the setting of waiting_for_input in
10443 wait_reading_process_output() under HAVE_NS because of the call
10444 to ns_select there (needed because otherwise events aren't picked up
10445 outside of polling since we don't get SIGIO like X and we don't have a
10446 separate event loop thread like W32. */
10448 if (waiting_for_input
&& !echoing
)
10449 quit_throw_to_read_char (in_signal_handler
);
10453 /* Handle a C-g by making read_char return C-g. */
10456 quit_throw_to_read_char (bool from_signal
)
10458 /* When not called from a signal handler it is safe to call
10460 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10461 Fkill_emacs (Qnil
);
10463 /* Prevent another signal from doing this before we finish. */
10464 clear_waiting_for_input ();
10467 Vunread_command_events
= Qnil
;
10469 if (FRAMEP (internal_last_event_frame
)
10470 && !EQ (internal_last_event_frame
, selected_frame
))
10471 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10474 abort_to_prompt (getctag
, SCM_EOL
);
10477 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10478 Sset_input_interrupt_mode
, 1, 1, 0,
10479 doc
: /* Set interrupt mode of reading keyboard input.
10480 If INTERRUPT is non-nil, Emacs will use input interrupts;
10481 otherwise Emacs uses CBREAK mode.
10483 See also `current-input-mode'. */)
10484 (Lisp_Object interrupt
)
10486 bool new_interrupt_input
;
10487 #ifdef USABLE_SIGIO
10488 #ifdef HAVE_X_WINDOWS
10489 if (x_display_list
!= NULL
)
10491 /* When using X, don't give the user a real choice,
10492 because we haven't implemented the mechanisms to support it. */
10493 new_interrupt_input
= 1;
10496 #endif /* HAVE_X_WINDOWS */
10497 new_interrupt_input
= !NILP (interrupt
);
10498 #else /* not USABLE_SIGIO */
10499 new_interrupt_input
= 0;
10500 #endif /* not USABLE_SIGIO */
10502 if (new_interrupt_input
!= interrupt_input
)
10505 /* this causes startup screen to be restored and messes with the mouse */
10506 reset_all_sys_modes ();
10507 interrupt_input
= new_interrupt_input
;
10508 init_all_sys_modes ();
10510 interrupt_input
= new_interrupt_input
;
10513 #ifdef POLL_FOR_INPUT
10520 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10521 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10522 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10523 C-q in key sequences.
10525 This setting only has an effect on tty terminals and only when
10526 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10528 See also `current-input-mode'. */)
10529 (Lisp_Object flow
, Lisp_Object terminal
)
10531 struct terminal
*t
= get_terminal (terminal
, 1);
10532 struct tty_display_info
*tty
;
10533 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10535 tty
= t
->display_info
.tty
;
10537 if (tty
->flow_control
!= !NILP (flow
))
10540 /* This causes startup screen to be restored and messes with the mouse. */
10541 reset_sys_modes (tty
);
10544 tty
->flow_control
= !NILP (flow
);
10547 init_sys_modes (tty
);
10553 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10554 doc
: /* Enable or disable 8-bit input on TERMINAL.
10555 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10556 bit as the Meta modifier.
10558 If META is nil, Emacs will ignore the top bit, on the assumption it is
10561 Otherwise, Emacs will accept and pass through 8-bit input without
10562 specially interpreting the top bit.
10564 This setting only has an effect on tty terminal devices.
10566 Optional parameter TERMINAL specifies the tty terminal device to use.
10567 It may be a terminal object, a frame, or nil for the terminal used by
10568 the currently selected frame.
10570 See also `current-input-mode'. */)
10571 (Lisp_Object meta
, Lisp_Object terminal
)
10573 struct terminal
*t
= get_terminal (terminal
, 1);
10574 struct tty_display_info
*tty
;
10577 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10579 tty
= t
->display_info
.tty
;
10583 else if (EQ (meta
, Qt
))
10588 if (tty
->meta_key
!= new_meta
)
10591 /* this causes startup screen to be restored and messes with the mouse */
10592 reset_sys_modes (tty
);
10595 tty
->meta_key
= new_meta
;
10598 init_sys_modes (tty
);
10604 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10605 doc
: /* Specify character used for quitting.
10606 QUIT must be an ASCII character.
10608 This function only has an effect on the controlling tty of the Emacs
10611 See also `current-input-mode'. */)
10614 struct terminal
*t
= get_named_tty ("/dev/tty");
10615 struct tty_display_info
*tty
;
10616 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10618 tty
= t
->display_info
.tty
;
10620 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10621 error ("QUIT must be an ASCII character");
10624 /* this causes startup screen to be restored and messes with the mouse */
10625 reset_sys_modes (tty
);
10628 /* Don't let this value be out of range. */
10629 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10632 init_sys_modes (tty
);
10638 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10639 doc
: /* Set mode of reading keyboard input.
10640 First arg INTERRUPT non-nil means use input interrupts;
10641 nil means use CBREAK mode.
10642 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10643 (no effect except in CBREAK mode).
10644 Third arg META t means accept 8-bit input (for a Meta key).
10645 META nil means ignore the top bit, on the assumption it is parity.
10646 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10647 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10648 See also `current-input-mode'. */)
10649 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10651 Fset_input_interrupt_mode (interrupt
);
10652 Fset_output_flow_control (flow
, Qnil
);
10653 Fset_input_meta_mode (meta
, Qnil
);
10655 Fset_quit_char (quit
);
10659 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10660 doc
: /* Return information about the way Emacs currently reads keyboard input.
10661 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10662 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10663 nil, Emacs is using CBREAK mode.
10664 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10665 terminal; this does not apply if Emacs uses interrupt-driven input.
10666 META is t if accepting 8-bit input with 8th bit as Meta flag.
10667 META nil means ignoring the top bit, on the assumption it is parity.
10668 META is neither t nor nil if accepting 8-bit input and using
10669 all 8 bits as the character code.
10670 QUIT is the character Emacs currently uses to quit.
10671 The elements of this list correspond to the arguments of
10672 `set-input-mode'. */)
10675 Lisp_Object val
[4];
10676 struct frame
*sf
= XFRAME (selected_frame
);
10678 val
[0] = interrupt_input
? Qt
: Qnil
;
10679 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10681 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10682 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10684 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10691 XSETFASTINT (val
[3], quit_char
);
10693 return Flist (ARRAYELTS (val
), val
);
10696 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10697 doc
: /* Return position information for pixel coordinates X and Y.
10698 By default, X and Y are relative to text area of the selected window.
10699 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10700 If optional fourth arg WHOLE is non-nil, X is relative to the left
10701 edge of the window.
10703 The return value is similar to a mouse click position:
10704 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10705 IMAGE (DX . DY) (WIDTH . HEIGHT))
10706 The `posn-' functions access elements of such lists. */)
10707 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10712 if (NILP (frame_or_window
))
10713 frame_or_window
= selected_window
;
10715 if (WINDOWP (frame_or_window
))
10717 struct window
*w
= decode_live_window (frame_or_window
);
10719 XSETINT (x
, (XINT (x
)
10720 + WINDOW_LEFT_EDGE_X (w
)
10722 ? window_box_left_offset (w
, TEXT_AREA
)
10724 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10725 frame_or_window
= w
->frame
;
10728 CHECK_LIVE_FRAME (frame_or_window
);
10730 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10733 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10734 doc
: /* Return position information for buffer POS in WINDOW.
10735 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10737 Return nil if position is not visible in window. Otherwise,
10738 the return value is similar to that returned by `event-start' for
10739 a mouse click at the upper left corner of the glyph corresponding
10740 to the given buffer position:
10741 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10742 IMAGE (DX . DY) (WIDTH . HEIGHT))
10743 The `posn-' functions access elements of such lists. */)
10744 (Lisp_Object pos
, Lisp_Object window
)
10749 window
= selected_window
;
10751 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10754 Lisp_Object x
= XCAR (tem
);
10755 Lisp_Object y
= XCAR (XCDR (tem
));
10757 /* Point invisible due to hscrolling? */
10760 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10766 /* Set up a new kboard object with reasonable initial values.
10767 TYPE is a window system for which this keyboard is used. */
10770 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10772 kset_overriding_terminal_local_map (kb
, Qnil
);
10773 kset_last_command (kb
, Qnil
);
10774 kset_real_last_command (kb
, Qnil
);
10775 kset_keyboard_translate_table (kb
, Qnil
);
10776 kset_last_repeatable_command (kb
, Qnil
);
10777 kset_prefix_arg (kb
, Qnil
);
10778 kset_last_prefix_arg (kb
, Qnil
);
10779 kset_kbd_queue (kb
, Qnil
);
10780 kb
->kbd_queue_has_data
= 0;
10781 kb
->immediate_echo
= 0;
10782 kset_echo_string (kb
, Qnil
);
10783 kb
->echo_after_prompt
= -1;
10784 kb
->kbd_macro_buffer
= 0;
10785 kb
->kbd_macro_bufsize
= 0;
10786 kset_defining_kbd_macro (kb
, Qnil
);
10787 kset_last_kbd_macro (kb
, Qnil
);
10788 kb
->reference_count
= 0;
10789 kset_system_key_alist (kb
, Qnil
);
10790 kset_system_key_syms (kb
, Qnil
);
10791 kset_window_system (kb
, type
);
10792 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10793 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10794 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10795 kset_default_minibuffer_frame (kb
, Qnil
);
10798 /* Allocate and basically initialize keyboard
10799 object to use with window system TYPE. */
10802 allocate_kboard (Lisp_Object type
)
10804 KBOARD
*kb
= xmalloc (sizeof *kb
);
10806 init_kboard (kb
, type
);
10807 kb
->next_kboard
= all_kboards
;
10813 * Destroy the contents of a kboard object, but not the object itself.
10814 * We use this just before deleting it, or if we're going to initialize
10815 * it a second time.
10818 wipe_kboard (KBOARD
*kb
)
10820 xfree (kb
->kbd_macro_buffer
);
10823 /* Free KB and memory referenced from it. */
10826 delete_kboard (KBOARD
*kb
)
10830 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10833 *kbp
= kb
->next_kboard
;
10835 /* Prevent a dangling reference to KB. */
10836 if (kb
== current_kboard
10837 && FRAMEP (selected_frame
)
10838 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10840 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10842 if (current_kboard
== kb
)
10851 init_keyboard (void)
10853 /* This is correct before outermost invocation of the editor loop. */
10854 command_loop_level
= -1;
10855 immediate_quit
= 0;
10856 quit_char
= Ctl ('g');
10857 Vunread_command_events
= Qnil
;
10858 timer_idleness_start_time
= invalid_timespec ();
10860 recent_keys_index
= 0;
10861 kbd_fetch_ptr
= kbd_buffer
;
10862 kbd_store_ptr
= kbd_buffer
;
10863 do_mouse_tracking
= Qnil
;
10865 interrupt_input_blocked
= 0;
10866 pending_signals
= 0;
10868 /* This means that command_loop_1 won't try to select anything the first
10870 internal_last_event_frame
= Qnil
;
10871 Vlast_event_frame
= internal_last_event_frame
;
10873 current_kboard
= initial_kboard
;
10874 /* Re-initialize the keyboard again. */
10875 wipe_kboard (current_kboard
);
10876 /* A value of nil for Vwindow_system normally means a tty, but we also use
10877 it for the initial terminal since there is no window system there. */
10878 init_kboard (current_kboard
, Qnil
);
10880 if (!noninteractive
)
10882 /* Before multi-tty support, these handlers used to be installed
10883 only if the current session was a tty session. Now an Emacs
10884 session may have multiple display types, so we always handle
10885 SIGINT. There is special code in handle_interrupt_signal to exit
10886 Emacs on SIGINT when there are no termcap frames on the
10887 controlling terminal. */
10888 struct sigaction action
;
10889 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10890 sigaction (SIGINT
, &action
, 0);
10892 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10893 SIGQUIT and we can't tell which one it will give us. */
10894 sigaction (SIGQUIT
, &action
, 0);
10895 #endif /* not DOS_NT */
10897 #ifdef USABLE_SIGIO
10898 if (!noninteractive
)
10900 struct sigaction action
;
10901 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10902 sigaction (SIGIO
, &action
, 0);
10906 /* Use interrupt input by default, if it works and noninterrupt input
10907 has deficiencies. */
10909 #ifdef INTERRUPT_INPUT
10910 interrupt_input
= 1;
10912 interrupt_input
= 0;
10915 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10918 if (keyboard_init_hook
)
10919 (*keyboard_init_hook
) ();
10921 #ifdef POLL_FOR_INPUT
10927 /* This type's only use is in syms_of_keyboard, to initialize the
10928 event header symbols and put properties on them. */
10929 struct event_head
{
10935 static const struct event_head head_table
[] = {
10936 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10937 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10938 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10939 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10940 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10941 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10942 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10943 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10944 /* `select-window' should be handled just like `switch-frame'
10945 in read_key_sequence. */
10946 {&Qselect_window
, "select-window", &Qswitch_frame
}
10950 syms_of_keyboard (void)
10952 #include "keyboard.x"
10954 pending_funcalls
= Qnil
;
10955 staticpro (&pending_funcalls
);
10957 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10958 staticpro (&Vlispy_mouse_stem
);
10961 DEFSYM (QCimage
, ":image");
10962 DEFSYM (Qhelp_echo
, "help-echo");
10963 DEFSYM (QCrtl
, ":rtl");
10965 staticpro (&item_properties
);
10966 item_properties
= Qnil
;
10968 staticpro (&tool_bar_item_properties
);
10969 tool_bar_item_properties
= Qnil
;
10970 staticpro (&tool_bar_items_vector
);
10971 tool_bar_items_vector
= Qnil
;
10973 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10974 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10975 DEFSYM (Qself_insert_command
, "self-insert-command");
10976 DEFSYM (Qforward_char
, "forward-char");
10977 DEFSYM (Qbackward_char
, "backward-char");
10978 DEFSYM (Qdisabled
, "disabled");
10979 DEFSYM (Qundefined
, "undefined");
10980 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10981 DEFSYM (Qpost_command_hook
, "post-command-hook");
10982 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10983 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10984 DEFSYM (Qfunction_key
, "function-key");
10985 DEFSYM (Qmouse_click
, "mouse-click");
10986 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10987 DEFSYM (Qsave_session
, "save-session");
10988 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10989 DEFSYM (Qmenu_enable
, "menu-enable");
10992 DEFSYM (Qlanguage_change
, "language-change");
10996 DEFSYM (Qdbus_event
, "dbus-event");
10999 #ifdef USE_FILE_NOTIFY
11000 DEFSYM (Qfile_notify
, "file-notify");
11001 #endif /* USE_FILE_NOTIFY */
11003 DEFSYM (QCenable
, ":enable");
11004 DEFSYM (QCvisible
, ":visible");
11005 DEFSYM (QChelp
, ":help");
11006 DEFSYM (QCfilter
, ":filter");
11007 DEFSYM (QCbutton
, ":button");
11008 DEFSYM (QCkeys
, ":keys");
11009 DEFSYM (QCkey_sequence
, ":key-sequence");
11010 DEFSYM (QCtoggle
, ":toggle");
11011 DEFSYM (QCradio
, ":radio");
11012 DEFSYM (QClabel
, ":label");
11013 DEFSYM (QCvert_only
, ":vert-only");
11015 DEFSYM (Qmode_line
, "mode-line");
11016 DEFSYM (Qvertical_line
, "vertical-line");
11017 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11018 DEFSYM (Qmenu_bar
, "menu-bar");
11019 DEFSYM (Qright_divider
, "right-divider");
11020 DEFSYM (Qbottom_divider
, "bottom-divider");
11022 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11024 DEFSYM (Qabove_handle
, "above-handle");
11025 DEFSYM (Qhandle
, "handle");
11026 DEFSYM (Qbelow_handle
, "below-handle");
11027 DEFSYM (Qup
, "up");
11028 DEFSYM (Qdown
, "down");
11029 DEFSYM (Qtop
, "top");
11030 DEFSYM (Qbottom
, "bottom");
11031 DEFSYM (Qend_scroll
, "end-scroll");
11032 DEFSYM (Qratio
, "ratio");
11034 DEFSYM (Qevent_kind
, "event-kind");
11035 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11036 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11037 DEFSYM (Qmodifier_cache
, "modifier-cache");
11039 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11040 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11042 DEFSYM (Qpolling_period
, "polling-period");
11044 DEFSYM (Qx_set_selection
, "x-set-selection");
11045 DEFSYM (QPRIMARY
, "PRIMARY");
11046 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11047 DEFSYM (Qhandle_select_window
, "handle-select-window");
11049 DEFSYM (Qinput_method_function
, "input-method-function");
11050 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11051 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11053 DEFSYM (Qhelp_form_show
, "help-form-show");
11055 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11057 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11058 Fset (Qinput_method_use_echo_area
, Qnil
);
11062 int len
= ARRAYELTS (head_table
);
11064 for (i
= 0; i
< len
; i
++)
11066 const struct event_head
*p
= &head_table
[i
];
11067 *p
->var
= intern_c_string (p
->name
);
11068 staticpro (p
->var
);
11069 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11070 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11074 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11075 staticpro (&button_down_location
);
11076 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11077 staticpro (&mouse_syms
);
11078 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11080 staticpro (&wheel_syms
);
11084 int len
= ARRAYELTS (modifier_names
);
11086 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11087 for (i
= 0; i
< len
; i
++)
11088 if (modifier_names
[i
])
11089 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11090 staticpro (&modifier_symbols
);
11093 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11094 staticpro (&recent_keys
);
11096 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11097 staticpro (&this_command_keys
);
11099 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11100 staticpro (&raw_keybuf
);
11102 DEFSYM (Qcommand_execute
, "command-execute");
11104 accent_key_syms
= Qnil
;
11105 staticpro (&accent_key_syms
);
11107 func_key_syms
= Qnil
;
11108 staticpro (&func_key_syms
);
11110 drag_n_drop_syms
= Qnil
;
11111 staticpro (&drag_n_drop_syms
);
11113 unread_switch_frame
= Qnil
;
11114 staticpro (&unread_switch_frame
);
11116 internal_last_event_frame
= Qnil
;
11117 staticpro (&internal_last_event_frame
);
11119 read_key_sequence_cmd
= Qnil
;
11120 staticpro (&read_key_sequence_cmd
);
11121 read_key_sequence_remapped
= Qnil
;
11122 staticpro (&read_key_sequence_remapped
);
11124 menu_bar_one_keymap_changed_items
= Qnil
;
11125 staticpro (&menu_bar_one_keymap_changed_items
);
11127 menu_bar_items_vector
= Qnil
;
11128 staticpro (&menu_bar_items_vector
);
11130 help_form_saved_window_configs
= Qnil
;
11131 staticpro (&help_form_saved_window_configs
);
11133 DEFVAR_LISP ("last-command-event", last_command_event
,
11134 doc
: /* Last input event that was part of a command. */);
11136 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11137 doc
: /* Last input event in a command, except for mouse menu events.
11138 Mouse menus give back keys that don't look like mouse events;
11139 this variable holds the actual mouse event that led to the menu,
11140 so that you can determine whether the command was run by mouse or not. */);
11142 DEFVAR_LISP ("last-input-event", last_input_event
,
11143 doc
: /* Last input event. */);
11145 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11146 doc
: /* List of events to be read as the command input.
11147 These events are processed first, before actual keyboard input.
11148 Events read from this list are not normally added to `this-command-keys',
11149 as they will already have been added once as they were read for the first time.
11150 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11151 Vunread_command_events
= Qnil
;
11153 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11154 doc
: /* List of events to be processed as input by input methods.
11155 These events are processed before `unread-command-events'
11156 and actual keyboard input, but are not given to `input-method-function'. */);
11157 Vunread_post_input_method_events
= Qnil
;
11159 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11160 doc
: /* List of events to be processed as input by input methods.
11161 These events are processed after `unread-command-events', but
11162 before actual keyboard input.
11163 If there's an active input method, the events are given to
11164 `input-method-function'. */);
11165 Vunread_input_method_events
= Qnil
;
11167 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11168 doc
: /* Meta-prefix character code.
11169 Meta-foo as command input turns into this character followed by foo. */);
11170 XSETINT (meta_prefix_char
, 033);
11172 DEFVAR_KBOARD ("last-command", Vlast_command
,
11173 doc
: /* The last command executed.
11174 Normally a symbol with a function definition, but can be whatever was found
11175 in the keymap, or whatever the variable `this-command' was set to by that
11178 The value `mode-exit' is special; it means that the previous command
11179 read an event that told it to exit, and it did so and unread that event.
11180 In other words, the present command is the event that made the previous
11183 The value `kill-region' is special; it means that the previous command
11184 was a kill command.
11186 `last-command' has a separate binding for each terminal device.
11187 See Info node `(elisp)Multiple Terminals'. */);
11189 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11190 doc
: /* Same as `last-command', but never altered by Lisp code.
11191 Taken from the previous value of `real-this-command'. */);
11193 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11194 doc
: /* Last command that may be repeated.
11195 The last command executed that was not bound to an input event.
11196 This is the command `repeat' will try to repeat.
11197 Taken from a previous value of `real-this-command'. */);
11199 DEFVAR_LISP ("this-command", Vthis_command
,
11200 doc
: /* The command now being executed.
11201 The command can set this variable; whatever is put here
11202 will be in `last-command' during the following command. */);
11203 Vthis_command
= Qnil
;
11205 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11206 doc
: /* This is like `this-command', except that commands should never modify it. */);
11207 Vreal_this_command
= Qnil
;
11209 DEFVAR_LISP ("this-command-keys-shift-translated",
11210 Vthis_command_keys_shift_translated
,
11211 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11212 Shift-translation occurs when there is no binding for the key sequence
11213 as entered, but a binding was found by changing an upper-case letter
11214 to lower-case, or a shifted function key to an unshifted one. */);
11215 Vthis_command_keys_shift_translated
= Qnil
;
11217 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11218 doc
: /* The command bound to the current key sequence before remapping.
11219 It equals `this-command' if the original command was not remapped through
11220 any of the active keymaps. Otherwise, the value of `this-command' is the
11221 result of looking up the original command in the active keymaps. */);
11222 Vthis_original_command
= Qnil
;
11224 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11225 doc
: /* Number of input events between auto-saves.
11226 Zero means disable autosaving due to number of characters typed. */);
11227 auto_save_interval
= 300;
11229 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11230 doc
: /* Number of seconds idle time before auto-save.
11231 Zero or nil means disable auto-saving due to idleness.
11232 After auto-saving due to this many seconds of idle time,
11233 Emacs also does a garbage collection if that seems to be warranted. */);
11234 XSETFASTINT (Vauto_save_timeout
, 30);
11236 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11237 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11238 The value may be integer or floating point.
11239 If the value is zero, don't echo at all. */);
11240 Vecho_keystrokes
= make_number (1);
11242 DEFVAR_INT ("polling-period", polling_period
,
11243 doc
: /* Interval between polling for input during Lisp execution.
11244 The reason for polling is to make C-g work to stop a running program.
11245 Polling is needed only when using X windows and SIGIO does not work.
11246 Polling is automatically disabled in all other cases. */);
11247 polling_period
= 2;
11249 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11250 doc
: /* Maximum time between mouse clicks to make a double-click.
11251 Measured in milliseconds. The value nil means disable double-click
11252 recognition; t means double-clicks have no time limit and are detected
11253 by position only. */);
11254 Vdouble_click_time
= make_number (500);
11256 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11257 doc
: /* Maximum mouse movement between clicks to make a double-click.
11258 On window-system frames, value is the number of pixels the mouse may have
11259 moved horizontally or vertically between two clicks to make a double-click.
11260 On non window-system frames, value is interpreted in units of 1/8 characters
11263 This variable is also the threshold for motion of the mouse
11264 to count as a drag. */);
11265 double_click_fuzz
= 3;
11267 DEFVAR_INT ("num-input-keys", num_input_keys
,
11268 doc
: /* Number of complete key sequences read as input so far.
11269 This includes key sequences read from keyboard macros.
11270 The number is effectively the number of interactive command invocations. */);
11271 num_input_keys
= 0;
11273 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11274 doc
: /* Number of input events read from the keyboard so far.
11275 This does not include events generated by keyboard macros. */);
11276 num_nonmacro_input_events
= 0;
11278 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11279 doc
: /* The frame in which the most recently read event occurred.
11280 If the last event came from a keyboard macro, this is set to `macro'. */);
11281 Vlast_event_frame
= Qnil
;
11283 /* This variable is set up in sysdep.c. */
11284 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11285 doc
: /* The ERASE character as set by the user with stty. */);
11287 DEFVAR_LISP ("help-char", Vhelp_char
,
11288 doc
: /* Character to recognize as meaning Help.
11289 When it is read, do `(eval help-form)', and display result if it's a string.
11290 If the value of `help-form' is nil, this char can be read normally. */);
11291 XSETINT (Vhelp_char
, Ctl ('H'));
11293 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11294 doc
: /* List of input events to recognize as meaning Help.
11295 These work just like the value of `help-char' (see that). */);
11296 Vhelp_event_list
= Qnil
;
11298 DEFVAR_LISP ("help-form", Vhelp_form
,
11299 doc
: /* Form to execute when character `help-char' is read.
11300 If the form returns a string, that string is displayed.
11301 If `help-form' is nil, the help char is not recognized. */);
11304 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11305 doc
: /* Command to run when `help-char' character follows a prefix key.
11306 This command is used only when there is no actual binding
11307 for that character after that prefix key. */);
11308 Vprefix_help_command
= Qnil
;
11310 DEFVAR_LISP ("top-level", Vtop_level
,
11311 doc
: /* Form to evaluate when Emacs starts up.
11312 Useful to set before you dump a modified Emacs. */);
11315 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11316 doc
: /* Translate table for local keyboard input, or nil.
11317 If non-nil, the value should be a char-table. Each character read
11318 from the keyboard is looked up in this char-table. If the value found
11319 there is non-nil, then it is used instead of the actual input character.
11321 The value can also be a string or vector, but this is considered obsolete.
11322 If it is a string or vector of length N, character codes N and up are left
11323 untranslated. In a vector, an element which is nil means "no translation".
11325 This is applied to the characters supplied to input methods, not their
11326 output. See also `translation-table-for-input'.
11328 This variable has a separate binding for each terminal.
11329 See Info node `(elisp)Multiple Terminals'. */);
11331 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11332 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11333 \(Even if the operating system has support for stopping a process.\) */);
11334 cannot_suspend
= 0;
11336 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11337 doc
: /* Non-nil means prompt with menus when appropriate.
11338 This is done when reading from a keymap that has a prompt string,
11339 for elements that have prompt strings.
11340 The menu is displayed on the screen
11341 if X menus were enabled at configuration
11342 time and the previous event was a mouse click prefix key.
11343 Otherwise, menu prompting uses the echo area. */);
11344 menu_prompting
= 1;
11346 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11347 doc
: /* Character to see next line of menu prompt.
11348 Type this character while in a menu prompt to rotate around the lines of it. */);
11349 XSETINT (menu_prompt_more_char
, ' ');
11351 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11352 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11353 Emacs applies the modifiers of the character stored here to each keyboard
11354 character it reads. For example, after evaluating the expression
11355 (setq extra-keyboard-modifiers ?\\C-x)
11356 all input characters will have the control modifier applied to them.
11358 Note that the character ?\\C-@, equivalent to the integer zero, does
11359 not count as a control character; rather, it counts as a character
11360 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11361 cancels any modification. */);
11362 extra_keyboard_modifiers
= 0;
11364 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11365 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11366 The command loop sets this to nil before each command,
11367 and tests the value when the command returns.
11368 Buffer modification stores t in this variable. */);
11369 Vdeactivate_mark
= Qnil
;
11370 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11371 Fmake_variable_buffer_local (Qdeactivate_mark
);
11373 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11374 doc
: /* Normal hook run before each command is executed.
11375 If an unhandled error happens in running this hook,
11376 the function in which the error occurred is unconditionally removed, since
11377 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11378 Vpre_command_hook
= Qnil
;
11380 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11381 doc
: /* Normal hook run after each command is executed.
11382 If an unhandled error happens in running this hook,
11383 the function in which the error occurred is unconditionally removed, since
11384 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11385 Vpost_command_hook
= Qnil
;
11388 DEFVAR_LISP ("echo-area-clear-hook", ...,
11389 doc
: /* Normal hook run when clearing the echo area. */);
11391 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11392 Fset (Qecho_area_clear_hook
, Qnil
);
11394 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11395 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11396 Vlucid_menu_bar_dirty_flag
= Qnil
;
11398 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11399 doc
: /* List of menu bar items to move to the end of the menu bar.
11400 The elements of the list are event types that may have menu bar bindings. */);
11401 Vmenu_bar_final_items
= Qnil
;
11403 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11404 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11405 This is used internally by graphical displays that do not render
11406 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11407 Vtool_bar_separator_image_expression
= Qnil
;
11409 DEFVAR_KBOARD ("overriding-terminal-local-map",
11410 Voverriding_terminal_local_map
,
11411 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11412 This variable is intended to let commands such as `universal-argument'
11413 set up a different keymap for reading the next command.
11415 `overriding-terminal-local-map' has a separate binding for each
11416 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11418 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11419 doc
: /* Keymap that replaces (overrides) local keymaps.
11420 If this variable is non-nil, Emacs looks up key bindings in this
11421 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11422 buffer's local map. Hence, the only active keymaps would be
11423 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11424 order of precedence. */);
11425 Voverriding_local_map
= Qnil
;
11427 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11428 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11429 Otherwise, the menu bar continues to reflect the buffer's local map
11430 and the minor mode maps regardless of `overriding-local-map'. */);
11431 Voverriding_local_map_menu_flag
= Qnil
;
11433 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11434 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11435 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11437 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11438 doc
: /* Non-nil means generate motion events for mouse motion. */);
11440 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11441 doc
: /* Alist of system-specific X windows key symbols.
11442 Each element should have the form (N . SYMBOL) where N is the
11443 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11444 and SYMBOL is its name.
11446 `system-key-alist' has a separate binding for each terminal device.
11447 See Info node `(elisp)Multiple Terminals'. */);
11449 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11450 doc
: /* Keymap that translates key sequences to key sequences during input.
11451 This is used mainly for mapping key sequences into some preferred
11452 key events (symbols).
11454 The `read-key-sequence' function replaces any subsequence bound by
11455 `local-function-key-map' with its binding. More precisely, when the
11456 active keymaps have no binding for the current key sequence but
11457 `local-function-key-map' binds a suffix of the sequence to a vector or
11458 string, `read-key-sequence' replaces the matching suffix with its
11459 binding, and continues with the new sequence.
11461 If the binding is a function, it is called with one argument (the prompt)
11462 and its return value (a key sequence) is used.
11464 The events that come from bindings in `local-function-key-map' are not
11465 themselves looked up in `local-function-key-map'.
11467 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11468 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11469 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11470 typing `ESC O P x' would return [f1 x].
11472 `local-function-key-map' has a separate binding for each terminal
11473 device. See Info node `(elisp)Multiple Terminals'. If you need to
11474 define a binding on all terminals, change `function-key-map'
11475 instead. Initially, `local-function-key-map' is an empty keymap that
11476 has `function-key-map' as its parent on all terminal devices. */);
11478 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11479 doc
: /* Keymap that decodes input escape sequences.
11480 This is used mainly for mapping ASCII function key sequences into
11481 real Emacs function key events (symbols).
11483 The `read-key-sequence' function replaces any subsequence bound by
11484 `input-decode-map' with its binding. Contrary to `function-key-map',
11485 this map applies its rebinding regardless of the presence of an ordinary
11486 binding. So it is more like `key-translation-map' except that it applies
11487 before `function-key-map' rather than after.
11489 If the binding is a function, it is called with one argument (the prompt)
11490 and its return value (a key sequence) is used.
11492 The events that come from bindings in `input-decode-map' are not
11493 themselves looked up in `input-decode-map'. */);
11495 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11496 doc
: /* The parent keymap of all `local-function-key-map' instances.
11497 Function key definitions that apply to all terminal devices should go
11498 here. If a mapping is defined in both the current
11499 `local-function-key-map' binding and this variable, then the local
11500 definition will take precedence. */);
11501 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11503 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11504 doc
: /* Keymap of key translations that can override keymaps.
11505 This keymap works like `input-decode-map', but comes after `function-key-map'.
11506 Another difference is that it is global rather than terminal-local. */);
11507 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11509 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11510 doc
: /* List of deferred actions to be performed at a later time.
11511 The precise format isn't relevant here; we just check whether it is nil. */);
11512 Vdeferred_action_list
= Qnil
;
11514 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11515 doc
: /* Function to call to handle deferred actions, after each command.
11516 This function is called with no arguments after each command
11517 whenever `deferred-action-list' is non-nil. */);
11518 Vdeferred_action_function
= Qnil
;
11520 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11521 doc
: /* List of warnings to be displayed after this command.
11522 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11523 as per the args of `display-warning' (which see).
11524 If this variable is non-nil, `delayed-warnings-hook' will be run
11525 immediately after running `post-command-hook'. */);
11526 Vdelayed_warnings_list
= Qnil
;
11528 DEFVAR_LISP ("timer-list", Vtimer_list
,
11529 doc
: /* List of active absolute time timers in order of increasing time. */);
11530 Vtimer_list
= Qnil
;
11532 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11533 doc
: /* List of active idle-time timers in order of increasing time. */);
11534 Vtimer_idle_list
= Qnil
;
11536 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11537 doc
: /* If non-nil, the function that implements the current input method.
11538 It's called with one argument, a printing character that was just read.
11539 \(That means a character with code 040...0176.)
11540 Typically this function uses `read-event' to read additional events.
11541 When it does so, it should first bind `input-method-function' to nil
11542 so it will not be called recursively.
11544 The function should return a list of zero or more events
11545 to be used as input. If it wants to put back some events
11546 to be reconsidered, separately, by the input method,
11547 it can add them to the beginning of `unread-command-events'.
11549 The input method function can find in `input-method-previous-message'
11550 the previous echo area message.
11552 The input method function should refer to the variables
11553 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11554 for guidance on what to do. */);
11555 Vinput_method_function
= Qnil
;
11557 DEFVAR_LISP ("input-method-previous-message",
11558 Vinput_method_previous_message
,
11559 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11560 This variable exists because `read-event' clears the echo area
11561 before running the input method. It is nil if there was no message. */);
11562 Vinput_method_previous_message
= Qnil
;
11564 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11565 doc
: /* If non-nil, the function that implements the display of help.
11566 It's called with one argument, the help string to display. */);
11567 Vshow_help_function
= Qnil
;
11569 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11570 doc
: /* If non-nil, suppress point adjustment after executing a command.
11572 After a command is executed, if point is moved into a region that has
11573 special properties (e.g. composition, display), we adjust point to
11574 the boundary of the region. But, when a command sets this variable to
11575 non-nil, we suppress the point adjustment.
11577 This variable is set to nil before reading a command, and is checked
11578 just after executing the command. */);
11579 Vdisable_point_adjustment
= Qnil
;
11581 DEFVAR_LISP ("global-disable-point-adjustment",
11582 Vglobal_disable_point_adjustment
,
11583 doc
: /* If non-nil, always suppress point adjustment.
11585 The default value is nil, in which case, point adjustment are
11586 suppressed only after special commands that set
11587 `disable-point-adjustment' (which see) to non-nil. */);
11588 Vglobal_disable_point_adjustment
= Qnil
;
11590 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11591 doc
: /* How long to display an echo-area message when the minibuffer is active.
11592 If the value is not a number, such messages don't time out. */);
11593 Vminibuffer_message_timeout
= make_number (2);
11595 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11596 doc
: /* If non-nil, any keyboard input throws to this symbol.
11597 The value of that variable is passed to `quit-flag' and later causes a
11598 peculiar kind of quitting. */);
11599 Vthrow_on_input
= Qnil
;
11601 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11602 doc
: /* Function to output error messages.
11603 Called with three arguments:
11604 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11605 such as what `condition-case' would bind its variable to,
11606 - the context (a string which normally goes at the start of the message),
11607 - the Lisp function within which the error was signaled. */);
11608 Vcommand_error_function
= intern ("command-error-default-function");
11610 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11611 Venable_disabled_menus_and_buttons
,
11612 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11614 Help functions bind this to allow help on disabled menu items
11615 and tool-bar buttons. */);
11616 Venable_disabled_menus_and_buttons
= Qnil
;
11618 DEFVAR_LISP ("select-active-regions",
11619 Vselect_active_regions
,
11620 doc
: /* If non-nil, an active region automatically sets the primary selection.
11621 If the value is `only', only temporarily active regions (usually made
11622 by mouse-dragging or shift-selection) set the window selection.
11624 This takes effect only when Transient Mark mode is enabled. */);
11625 Vselect_active_regions
= Qt
;
11627 DEFVAR_LISP ("saved-region-selection",
11628 Vsaved_region_selection
,
11629 doc
: /* Contents of active region prior to buffer modification.
11630 If `select-active-regions' is non-nil, Emacs sets this to the
11631 text in the region before modifying the buffer. The next call to
11632 the function `deactivate-mark' uses this to set the window selection. */);
11633 Vsaved_region_selection
= Qnil
;
11635 DEFVAR_LISP ("selection-inhibit-update-commands",
11636 Vselection_inhibit_update_commands
,
11637 doc
: /* List of commands which should not update the selection.
11638 Normally, if `select-active-regions' is non-nil and the mark remains
11639 active after a command (i.e. the mark was not deactivated), the Emacs
11640 command loop sets the selection to the text in the region. However,
11641 if the command is in this list, the selection is not updated. */);
11642 Vselection_inhibit_update_commands
11643 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11645 DEFVAR_LISP ("debug-on-event",
11647 doc
: /* Enter debugger on this event. When Emacs
11648 receives the special event specified by this variable, it will try to
11649 break into the debugger as soon as possible instead of processing the
11650 event normally through `special-event-map'.
11652 Currently, the only supported values for this
11653 variable are `sigusr1' and `sigusr2'. */);
11654 Vdebug_on_event
= intern_c_string ("sigusr2");
11656 /* Create the initial keyboard. Qt means 'unset'. */
11657 initial_kboard
= allocate_kboard (Qt
);
11661 keys_of_keyboard (void)
11663 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11664 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11665 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11666 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11667 initial_define_key (meta_map
, 'x', "execute-extended-command");
11669 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11670 "handle-delete-frame");
11671 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11672 "ns-put-working-text");
11673 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11674 "ns-unput-working-text");
11675 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11676 current-prefix-arg, as is done in `handle-switch-frame'.
11677 But `handle-switch-frame is not run from the special-map.
11678 Commands from that map are run in a special way that automatically
11679 preserves the prefix-arg. Restoring the prefix arg here is not just
11680 redundant but harmful:
11682 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11683 - after the first prompt, the exit-minibuffer-hook is run which may
11684 iconify a frame and thus push a `iconify-frame' event.
11685 - after running exit-minibuffer-hook, current-prefix-arg is
11686 restored to the non-nil value it had before the prompt.
11687 - we enter the second prompt.
11688 current-prefix-arg is non-nil, prefix-arg is nil.
11689 - before running the first real event, we run the special iconify-frame
11690 event, but we pass the `special' arg to execute-command so
11691 current-prefix-arg and prefix-arg are left untouched.
11692 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11693 - the next key event will have a spuriously non-nil current-prefix-arg. */
11694 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11696 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11698 /* Handling it at such a low-level causes read_key_sequence to get
11699 * confused because it doesn't realize that the current_buffer was
11700 * changed by read_char.
11702 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11703 * "handle-select-window"); */
11704 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11705 "handle-save-session");
11708 /* Define a special event which is raised for dbus callback
11710 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11711 "dbus-handle-event");
11714 #ifdef USE_FILE_NOTIFY
11715 /* Define a special event which is raised for notification callback
11717 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11718 "file-notify-handle-event");
11719 #endif /* USE_FILE_NOTIFY */
11721 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11723 #if defined (WINDOWSNT)
11724 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11727 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11728 "handle-focus-in");
11729 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11730 "handle-focus-out");