1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 #include <gc.h> /* for GC_collect_a_little */
74 /* Variables for blockinput.h: */
76 /* Positive if interrupt input is blocked right now. */
77 volatile int interrupt_input_blocked
;
79 /* True means an input interrupt or alarm signal has arrived.
80 The QUIT macro checks this. */
81 volatile bool pending_signals
;
83 #define KBD_BUFFER_SIZE 4096
85 KBOARD
*initial_kboard
;
86 KBOARD
*current_kboard
;
87 static KBOARD
*all_kboards
;
89 /* True in the single-kboard state, false in the any-kboard state. */
90 static bool single_kboard
;
92 /* Non-nil disable property on a command means
93 do not execute it; call disabled-command-function's value instead. */
94 Lisp_Object Qdisabled
;
95 static Lisp_Object Qdisabled_command_function
;
97 #define NUM_RECENT_KEYS (300)
99 /* Index for storing next element into recent_keys. */
100 static int recent_keys_index
;
102 /* Total number of elements stored into recent_keys. */
103 static int total_keys
;
105 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
106 static Lisp_Object recent_keys
;
108 /* Vector holding the key sequence that invoked the current command.
109 It is reused for each command, and it may be longer than the current
110 sequence; this_command_key_count indicates how many elements
111 actually mean something.
112 It's easier to staticpro a single Lisp_Object than an array. */
113 Lisp_Object this_command_keys
;
114 ptrdiff_t this_command_key_count
;
116 /* True after calling Freset_this_command_lengths.
117 Usually it is false. */
118 static bool this_command_key_count_reset
;
120 /* This vector is used as a buffer to record the events that were actually read
121 by read_key_sequence. */
122 static Lisp_Object raw_keybuf
;
123 static int raw_keybuf_count
;
125 #define GROW_RAW_KEYBUF \
126 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
127 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
129 /* Number of elements of this_command_keys
130 that precede this key sequence. */
131 static ptrdiff_t this_single_command_key_start
;
133 /* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135 static ptrdiff_t before_command_key_count
;
136 static ptrdiff_t before_command_echo_length
;
138 /* For longjmp to where kbd input is being done. */
140 static sys_jmp_buf getcjmp
;
142 /* True while doing kbd input. */
143 bool waiting_for_input
;
145 /* True while displaying for echoing. Delays C-g throwing. */
149 /* Non-null means we can start echoing at the next input pause even
150 though there is something in the echo area. */
152 static struct kboard
*ok_to_echo_at_next_pause
;
154 /* The kboard last echoing, or null for none. Reset to 0 in
155 cancel_echoing. If non-null, and a current echo area message
156 exists, and echo_message_buffer is eq to the current message
157 buffer, we know that the message comes from echo_kboard. */
159 struct kboard
*echo_kboard
;
161 /* The buffer used for echoing. Set in echo_now, reset in
164 Lisp_Object echo_message_buffer
;
166 /* True means C-g should cause immediate error-signal. */
169 /* Character that causes a quit. Normally C-g.
171 If we are running on an ordinary terminal, this must be an ordinary
172 ASCII char, since we want to make it our interrupt character.
174 If we are not running on an ordinary terminal, it still needs to be
175 an ordinary ASCII char. This character needs to be recognized in
176 the input interrupt handler. At this point, the keystroke is
177 represented as a struct input_event, while the desired quit
178 character is specified as a lispy event. The mapping from struct
179 input_events to lispy events cannot run in an interrupt handler,
180 and the reverse mapping is difficult for anything but ASCII
183 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
187 /* Current depth in recursive edits. */
188 EMACS_INT command_loop_level
;
190 /* If not Qnil, this is a switch-frame event which we decided to put
191 off until the end of a key sequence. This should be read as the
192 next command input, after any unread_command_events.
194 read_key_sequence uses this to delay switch-frame events until the
195 end of the key sequence; Fread_char uses it to put off switch-frame
196 events until a non-ASCII event is acceptable as input. */
197 Lisp_Object unread_switch_frame
;
199 /* Last size recorded for a current buffer which is not a minibuffer. */
200 static ptrdiff_t last_non_minibuf_size
;
202 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
203 uintmax_t num_input_events
;
205 /* Value of num_nonmacro_input_events as of last auto save. */
207 static EMACS_INT last_auto_save
;
209 /* The value of point when the last command was started. */
210 static ptrdiff_t last_point_position
;
212 /* The frame in which the last input event occurred, or Qmacro if the
213 last event came from a macro. We use this to determine when to
214 generate switch-frame events. This may be cleared by functions
215 like Fselect_frame, to make sure that a switch-frame event is
216 generated by the next character.
218 FIXME: This is modified by a signal handler so it should be volatile.
219 It's exported to Lisp, though, so it can't simply be marked
221 Lisp_Object internal_last_event_frame
;
223 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
224 static Lisp_Object Qhandle_select_window
;
225 Lisp_Object QPRIMARY
;
227 static Lisp_Object Qself_insert_command
;
228 static Lisp_Object Qforward_char
;
229 static Lisp_Object Qbackward_char
;
230 Lisp_Object Qundefined
;
231 static Lisp_Object Qtimer_event_handler
;
233 /* `read_key_sequence' stores here the command definition of the
234 key sequence that it reads. */
235 static Lisp_Object read_key_sequence_cmd
;
236 static Lisp_Object read_key_sequence_remapped
;
238 static Lisp_Object Qinput_method_function
;
240 static Lisp_Object Qdeactivate_mark
;
242 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
244 static Lisp_Object Qecho_area_clear_hook
;
246 /* Hooks to run before and after each command. */
247 static Lisp_Object Qpre_command_hook
;
248 static Lisp_Object Qpost_command_hook
;
250 static Lisp_Object Qdeferred_action_function
;
252 static Lisp_Object Qdelayed_warnings_hook
;
254 static Lisp_Object Qinput_method_exit_on_first_char
;
255 static Lisp_Object Qinput_method_use_echo_area
;
257 static Lisp_Object Qhelp_form_show
;
259 /* File in which we write all commands we read. */
260 static FILE *dribble
;
262 /* Nonzero if input is available. */
265 /* Circular buffer for pre-read keyboard input. */
267 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
269 /* Pointer to next available character in kbd_buffer.
270 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
271 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
272 next available char is in kbd_buffer[0]. */
273 static struct input_event
*kbd_fetch_ptr
;
275 /* Pointer to next place to store character in kbd_buffer. This
276 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
277 character should go in kbd_buffer[0]. */
278 static struct input_event
* volatile kbd_store_ptr
;
280 /* The above pair of variables forms a "queue empty" flag. When we
281 enqueue a non-hook event, we increment kbd_store_ptr. When we
282 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
283 there is input available if the two pointers are not equal.
285 Why not just have a flag set and cleared by the enqueuing and
286 dequeuing functions? Such a flag could be screwed up by interrupts
287 at inopportune times. */
289 /* Symbols to head events. */
290 static Lisp_Object Qmouse_movement
;
291 static Lisp_Object Qscroll_bar_movement
;
292 Lisp_Object Qswitch_frame
;
293 static Lisp_Object Qfocus_in
, Qfocus_out
;
294 static Lisp_Object Qdelete_frame
;
295 static Lisp_Object Qiconify_frame
;
296 static Lisp_Object Qmake_frame_visible
;
297 static Lisp_Object Qselect_window
;
298 Lisp_Object Qhelp_echo
;
300 static Lisp_Object Qmouse_fixup_help_message
;
302 /* Symbols to denote kinds of events. */
303 static Lisp_Object Qfunction_key
;
304 Lisp_Object Qmouse_click
;
306 Lisp_Object Qlanguage_change
;
308 static Lisp_Object Qdrag_n_drop
;
309 static Lisp_Object Qsave_session
;
311 static Lisp_Object Qdbus_event
;
313 #ifdef USE_FILE_NOTIFY
314 static Lisp_Object Qfile_notify
;
315 #endif /* USE_FILE_NOTIFY */
316 static Lisp_Object Qconfig_changed_event
;
318 /* Lisp_Object Qmouse_movement; - also an event header */
320 /* Properties of event headers. */
321 Lisp_Object Qevent_kind
;
322 static Lisp_Object Qevent_symbol_elements
;
324 /* Menu and tool bar item parts. */
325 static Lisp_Object Qmenu_enable
;
326 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
327 Lisp_Object QCfilter
;
329 /* Non-nil disable property on a command means
330 do not execute it; call disabled-command-function's value instead. */
331 Lisp_Object QCtoggle
, QCradio
;
332 static Lisp_Object QCbutton
, QClabel
;
334 static Lisp_Object QCvert_only
;
336 /* An event header symbol HEAD may have a property named
337 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
338 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
339 mask of modifiers applied to it. If present, this is used to help
340 speed up parse_modifiers. */
341 Lisp_Object Qevent_symbol_element_mask
;
343 /* An unmodified event header BASE may have a property named
344 Qmodifier_cache, which is an alist mapping modifier masks onto
345 modified versions of BASE. If present, this helps speed up
347 static Lisp_Object Qmodifier_cache
;
349 /* Symbols to use for parts of windows. */
350 Lisp_Object Qmode_line
;
351 Lisp_Object Qvertical_line
;
352 Lisp_Object Qright_divider
, Qbottom_divider
;
353 static Lisp_Object Qvertical_scroll_bar
;
354 Lisp_Object Qmenu_bar
;
356 static Lisp_Object Qecho_keystrokes
;
358 static void recursive_edit_unwind (Lisp_Object buffer
);
359 static Lisp_Object
command_loop (void);
360 static Lisp_Object Qcommand_execute
;
362 static void echo_now (void);
363 static ptrdiff_t echo_length (void);
365 static Lisp_Object Qpolling_period
;
367 /* Incremented whenever a timer is run. */
370 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
372 struct timespec
*input_available_clear_time
;
374 /* True means use SIGIO interrupts; false means use CBREAK mode.
375 Default is true if INTERRUPT_INPUT is defined. */
376 bool interrupt_input
;
378 /* Nonzero while interrupts are temporarily deferred during redisplay. */
379 bool interrupts_deferred
;
381 /* The time when Emacs started being idle. */
383 static struct timespec timer_idleness_start_time
;
385 /* After Emacs stops being idle, this saves the last value
386 of timer_idleness_start_time from when it was idle. */
388 static struct timespec timer_last_idleness_start_time
;
391 /* Global variable declarations. */
393 /* Flags for readable_events. */
394 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
395 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
396 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
398 /* Function for init_keyboard to call with no args (if nonzero). */
399 static void (*keyboard_init_hook
) (void);
401 static bool get_input_pending (int);
402 static bool readable_events (int);
403 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
404 Lisp_Object
, bool *);
405 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
406 static Lisp_Object
make_lispy_event (struct input_event
*);
407 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
408 enum scroll_bar_part
,
409 Lisp_Object
, Lisp_Object
,
411 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
412 Lisp_Object
, const char *const *,
413 Lisp_Object
*, ptrdiff_t);
414 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
415 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
416 #ifdef HAVE_WINDOW_SYSTEM
417 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
418 #endif /* HAVE_WINDOW_SYSTEM */
419 static bool help_char_p (Lisp_Object
);
420 static void save_getcjmp (sys_jmp_buf
*);
421 static void restore_getcjmp (sys_jmp_buf
*);
422 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
423 static void clear_event (struct input_event
*);
424 static void restore_kboard_configuration (int);
426 static void deliver_input_available_signal (int signo
);
428 static void handle_interrupt (bool);
429 static _Noreturn
void quit_throw_to_read_char (bool);
430 static void process_special_events (void);
431 static void timer_start_idle (void);
432 static void timer_stop_idle (void);
433 static void timer_resume_idle (void);
434 static void deliver_user_signal (int);
435 static char *find_user_signal_name (int);
436 static void store_user_signal_events (void);
438 /* These setters are used only in this file, so they can be private. */
440 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
442 kb
->INTERNAL_FIELD (echo_string
) = val
;
445 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
447 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
450 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
455 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
460 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
465 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
470 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
475 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
480 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
486 /* Add C to the echo string, without echoing it immediately. C can be
487 a character, which is pretty-printed, or a symbol, whose name is
491 echo_add_key (Lisp_Object c
)
493 int size
= KEY_DESCRIPTION_SIZE
+ 100;
494 char *buffer
= alloca (size
);
496 Lisp_Object echo_string
;
498 echo_string
= KVAR (current_kboard
, echo_string
);
500 /* If someone has passed us a composite event, use its head symbol. */
504 ptr
= push_key_description (XINT (c
), ptr
);
505 else if (SYMBOLP (c
))
507 Lisp_Object name
= SYMBOL_NAME (c
);
508 int nbytes
= SBYTES (name
);
510 if (size
- (ptr
- buffer
) < nbytes
)
512 int offset
= ptr
- buffer
;
513 size
= max (2 * size
, size
+ nbytes
);
514 buffer
= alloca (size
);
515 ptr
= buffer
+ offset
;
518 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
519 STRING_MULTIBYTE (name
), 1);
522 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
525 const char *text
= " (Type ? for further options)";
526 int len
= strlen (text
);
528 if (size
- (ptr
- buffer
) < len
)
530 int offset
= ptr
- buffer
;
532 buffer
= alloca (size
);
533 ptr
= buffer
+ offset
;
536 memcpy (ptr
, text
, len
);
540 /* Replace a dash from echo_dash with a space, otherwise add a space
541 at the end as a separator between keys. */
542 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
544 Lisp_Object last_char
, prev_char
, idx
;
546 idx
= make_number (SCHARS (echo_string
) - 2);
547 prev_char
= Faref (echo_string
, idx
);
549 idx
= make_number (SCHARS (echo_string
) - 1);
550 last_char
= Faref (echo_string
, idx
);
552 /* We test PREV_CHAR to make sure this isn't the echoing of a
554 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
555 Faset (echo_string
, idx
, make_number (' '));
557 echo_string
= concat2 (echo_string
, build_string (" "));
559 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
560 echo_string
= concat2 (echo_string
, build_string (" "));
564 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
567 /* Add C to the echo string, if echoing is going on. C can be a
568 character or a symbol. */
571 echo_char (Lisp_Object c
)
573 if (current_kboard
->immediate_echo
)
580 /* Temporarily add a dash to the end of the echo string if it's not
581 empty, so that it serves as a mini-prompt for the very next
587 /* Do nothing if not echoing at all. */
588 if (NILP (KVAR (current_kboard
, echo_string
)))
591 if (this_command_key_count
== 0)
594 if (!current_kboard
->immediate_echo
595 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
598 /* Do nothing if we just printed a prompt. */
599 if (current_kboard
->echo_after_prompt
600 == SCHARS (KVAR (current_kboard
, echo_string
)))
603 /* Do nothing if we have already put a dash at the end. */
604 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
606 Lisp_Object last_char
, prev_char
, idx
;
608 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
609 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
611 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
612 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
614 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
618 /* Put a dash at the end of the buffer temporarily,
619 but make it go away when the next character is added. */
622 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
626 /* Display the current echo string, and begin echoing if not already
632 if (!current_kboard
->immediate_echo
)
635 current_kboard
->immediate_echo
= 1;
637 for (i
= 0; i
< this_command_key_count
; i
++)
641 /* Set before_command_echo_length to the value that would
642 have been saved before the start of this subcommand in
643 command_loop_1, if we had already been echoing then. */
644 if (i
== this_single_command_key_start
)
645 before_command_echo_length
= echo_length ();
647 c
= AREF (this_command_keys
, i
);
648 if (! (EVENT_HAS_PARAMETERS (c
)
649 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
653 /* Set before_command_echo_length to the value that would
654 have been saved before the start of this subcommand in
655 command_loop_1, if we had already been echoing then. */
656 if (this_command_key_count
== this_single_command_key_start
)
657 before_command_echo_length
= echo_length ();
659 /* Put a dash at the end to invite the user to type more. */
664 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
665 message3_nolog (KVAR (current_kboard
, echo_string
));
668 /* Record in what buffer we echoed, and from which kboard. */
669 echo_message_buffer
= echo_area_buffer
[0];
670 echo_kboard
= current_kboard
;
672 if (waiting_for_input
&& !NILP (Vquit_flag
))
673 quit_throw_to_read_char (0);
676 /* Turn off echoing, for the start of a new command. */
679 cancel_echoing (void)
681 current_kboard
->immediate_echo
= 0;
682 current_kboard
->echo_after_prompt
= -1;
683 kset_echo_string (current_kboard
, Qnil
);
684 ok_to_echo_at_next_pause
= NULL
;
686 echo_message_buffer
= Qnil
;
689 /* Return the length of the current echo string. */
694 return (STRINGP (KVAR (current_kboard
, echo_string
))
695 ? SCHARS (KVAR (current_kboard
, echo_string
))
699 /* Truncate the current echo message to its first LEN chars.
700 This and echo_char get used by read_key_sequence when the user
701 switches frames while entering a key sequence. */
704 echo_truncate (ptrdiff_t nchars
)
706 if (STRINGP (KVAR (current_kboard
, echo_string
)))
707 kset_echo_string (current_kboard
,
708 Fsubstring (KVAR (current_kboard
, echo_string
),
709 make_number (0), make_number (nchars
)));
710 truncate_echo_area (nchars
);
714 /* Functions for manipulating this_command_keys. */
716 add_command_key (Lisp_Object key
)
718 #if 0 /* Not needed after we made Freset_this_command_lengths
719 do the job immediately. */
720 /* If reset-this-command-length was called recently, obey it now.
721 See the doc string of that function for an explanation of why. */
722 if (before_command_restore_flag
)
724 this_command_key_count
= before_command_key_count_1
;
725 if (this_command_key_count
< this_single_command_key_start
)
726 this_single_command_key_start
= this_command_key_count
;
727 echo_truncate (before_command_echo_length_1
);
728 before_command_restore_flag
= 0;
732 if (this_command_key_count
>= ASIZE (this_command_keys
))
733 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
735 ASET (this_command_keys
, this_command_key_count
, key
);
736 ++this_command_key_count
;
741 recursive_edit_1 (void)
743 ptrdiff_t count
= SPECPDL_INDEX ();
746 if (command_loop_level
> 0)
748 specbind (Qstandard_output
, Qt
);
749 specbind (Qstandard_input
, Qt
);
752 #ifdef HAVE_WINDOW_SYSTEM
753 /* The command loop has started an hourglass timer, so we have to
754 cancel it here, otherwise it will fire because the recursive edit
755 can take some time. Do not check for display_hourglass_p here,
756 because it could already be nil. */
760 /* This function may have been called from a debugger called from
761 within redisplay, for instance by Edebugging a function called
762 from fontification-functions. We want to allow redisplay in
763 the debugging session.
765 The recursive edit is left with a `(throw exit ...)'. The `exit'
766 tag is not caught anywhere in redisplay, i.e. when we leave the
767 recursive edit, the original redisplay leading to the recursive
768 edit will be unwound. The outcome should therefore be safe. */
769 specbind (Qinhibit_redisplay
, Qnil
);
772 val
= command_loop ();
774 Fsignal (Qquit
, Qnil
);
775 /* Handle throw from read_minibuf when using minibuffer
776 while it's active but we're in another window. */
778 xsignal1 (Qerror
, val
);
780 return unbind_to (count
, Qnil
);
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. */)
815 ptrdiff_t count
= SPECPDL_INDEX ();
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 ())
823 if (command_loop_level
>= 0
824 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
825 buffer
= Fcurrent_buffer ();
829 /* Don't do anything interesting between the increment and the
830 record_unwind_protect! Otherwise, we could get distracted and
831 never decrement the counter again. */
832 command_loop_level
++;
833 update_mode_lines
= 17;
834 record_unwind_protect (recursive_edit_unwind
, buffer
);
836 /* If we leave recursive_edit_1 below with a `throw' for instance,
837 like it is done in the splash screen display, we have to
838 make sure that we restore single_kboard as command_loop_1
839 would have done if it were left normally. */
840 if (command_loop_level
> 0)
841 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
844 return unbind_to (count
, Qnil
);
848 recursive_edit_unwind (Lisp_Object buffer
)
850 if (BUFFERP (buffer
))
851 Fset_buffer (buffer
);
853 command_loop_level
--;
854 update_mode_lines
= 18;
858 #if 0 /* These two functions are now replaced with
859 temporarily_switch_to_single_kboard. */
863 #if 0 /* Theory: if there's anything in Vunread_command_events,
864 it will right away be read by read_key_sequence,
865 and then if we do switch KBOARDS, it will go into the side
866 queue then. So we don't need to do anything special here -- rms. */
867 if (CONSP (Vunread_command_events
))
869 current_kboard
->kbd_queue
870 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
871 current_kboard
->kbd_queue_has_data
= 1;
873 Vunread_command_events
= Qnil
;
878 /* Switch to the single-kboard state, making current_kboard
879 the only KBOARD from which further input is accepted. */
882 single_kboard_state ()
888 /* If we're in single_kboard state for kboard KBOARD,
892 not_single_kboard_state (KBOARD
*kboard
)
894 if (kboard
== current_kboard
)
898 /* Maintain a stack of kboards, so other parts of Emacs
899 can switch temporarily to the kboard of a given frame
900 and then revert to the previous status. */
905 struct kboard_stack
*next
;
908 static struct kboard_stack
*kboard_stack
;
911 push_kboard (struct kboard
*k
)
913 struct kboard_stack
*p
= xmalloc (sizeof *p
);
915 p
->next
= kboard_stack
;
916 p
->kboard
= current_kboard
;
926 struct kboard_stack
*p
= kboard_stack
;
928 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
930 if (t
->kboard
== p
->kboard
)
932 current_kboard
= p
->kboard
;
939 /* The terminal we remembered has been deleted. */
940 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
943 kboard_stack
= p
->next
;
947 /* Switch to single_kboard mode, making current_kboard the only KBOARD
948 from which further input is accepted. If F is non-nil, set its
949 KBOARD as the current keyboard.
951 This function uses record_unwind_protect_int to return to the previous
954 If Emacs is already in single_kboard mode, and F's keyboard is
955 locked, then this function will throw an error. */
958 temporarily_switch_to_single_kboard (struct frame
*f
)
960 bool was_locked
= single_kboard
;
963 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
964 /* We can not switch keyboards while in single_kboard mode.
965 In rare cases, Lisp code may call `recursive-edit' (or
966 `read-minibuffer' or `y-or-n-p') after it switched to a
967 locked frame. For example, this is likely to happen
968 when server.el connects to a new terminal while Emacs is in
969 single_kboard mode. It is best to throw an error instead
970 of presenting the user with a frozen screen. */
971 error ("Terminal %d is locked, cannot read from it",
972 FRAME_TERMINAL (f
)->id
);
974 /* This call is unnecessary, but helps
975 `restore_kboard_configuration' discover if somebody changed
976 `current_kboard' behind our back. */
977 push_kboard (current_kboard
);
980 current_kboard
= FRAME_KBOARD (f
);
982 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
985 #if 0 /* This function is not needed anymore. */
987 record_single_kboard_state ()
990 push_kboard (current_kboard
);
991 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
996 restore_kboard_configuration (int was_locked
)
998 single_kboard
= was_locked
;
1001 struct kboard
*prev
= current_kboard
;
1003 /* The pop should not change the kboard. */
1004 if (single_kboard
&& current_kboard
!= prev
)
1010 /* Handle errors that are not handled at inner levels
1011 by printing an error message and returning to the editor command loop. */
1014 cmd_error (Lisp_Object data
)
1016 Lisp_Object old_level
, old_length
;
1017 char macroerror
[sizeof "After..kbd macro iterations: "
1018 + INT_STRLEN_BOUND (EMACS_INT
)];
1020 #ifdef HAVE_WINDOW_SYSTEM
1021 if (display_hourglass_p
)
1022 cancel_hourglass ();
1025 if (!NILP (executing_kbd_macro
))
1027 if (executing_kbd_macro_iterations
== 1)
1028 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1030 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1031 executing_kbd_macro_iterations
);
1036 Vstandard_output
= Qt
;
1037 Vstandard_input
= Qt
;
1038 Vexecuting_kbd_macro
= Qnil
;
1039 executing_kbd_macro
= Qnil
;
1040 kset_prefix_arg (current_kboard
, Qnil
);
1041 kset_last_prefix_arg (current_kboard
, Qnil
);
1044 /* Avoid unquittable loop if data contains a circular list. */
1045 old_level
= Vprint_level
;
1046 old_length
= Vprint_length
;
1047 XSETFASTINT (Vprint_level
, 10);
1048 XSETFASTINT (Vprint_length
, 10);
1049 cmd_error_internal (data
, macroerror
);
1050 Vprint_level
= old_level
;
1051 Vprint_length
= old_length
;
1054 Vinhibit_quit
= Qnil
;
1056 return make_number (0);
1059 /* Take actions on handling an error. DATA is the data that describes
1062 CONTEXT is a C-string containing ASCII characters only which
1063 describes the context in which the error happened. If we need to
1064 generalize CONTEXT to allow multibyte characters, make it a Lisp
1068 cmd_error_internal (Lisp_Object data
, const char *context
)
1070 /* The immediate context is not interesting for Quits,
1071 since they are asynchronous. */
1072 if (EQ (XCAR (data
), Qquit
))
1073 Vsignaling_function
= Qnil
;
1078 /* Use user's specified output function if any. */
1079 if (!NILP (Vcommand_error_function
))
1080 call3 (Vcommand_error_function
, data
,
1081 context
? build_string (context
) : empty_unibyte_string
,
1082 Vsignaling_function
);
1084 Vsignaling_function
= Qnil
;
1087 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1088 Scommand_error_default_function
, 3, 3, 0,
1089 doc
: /* Produce default output for unhandled error message.
1090 Default value of `command-error-function'. */)
1091 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1093 struct frame
*sf
= SELECTED_FRAME ();
1095 CHECK_STRING (context
);
1097 /* If the window system or terminal frame hasn't been initialized
1098 yet, or we're not interactive, write the message to stderr and exit. */
1099 if (!sf
->glyphs_initialized_p
1100 /* The initial frame is a special non-displaying frame. It
1101 will be current in daemon mode when there are no frames
1102 to display, and in non-daemon mode before the real frame
1103 has finished initializing. If an error is thrown in the
1104 latter case while creating the frame, then the frame
1105 will never be displayed, so the safest thing to do is
1106 write to stderr and quit. In daemon mode, there are
1107 many other potential errors that do not prevent frames
1108 from being created, so continuing as normal is better in
1110 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1113 print_error_message (data
, Qexternal_debugging_output
,
1114 SSDATA (context
), signal
);
1115 Fterpri (Qexternal_debugging_output
);
1116 Fkill_emacs (make_number (-1));
1120 clear_message (1, 0);
1122 message_log_maybe_newline ();
1125 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1130 static Lisp_Object
command_loop_2 (Lisp_Object
);
1131 static Lisp_Object
top_level_1 (Lisp_Object
);
1133 /* Entry to editor-command-loop.
1134 This level has the catches for exiting/returning to editor command loop.
1135 It returns nil to exit recursive edit, t to abort it. */
1140 if (command_loop_level
> 0 || minibuf_level
> 0)
1143 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1144 executing_kbd_macro
= Qnil
;
1150 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1151 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1152 executing_kbd_macro
= Qnil
;
1154 /* End of file in -batch run causes exit here. */
1160 /* Here we catch errors in execution of commands within the
1161 editing loop, and reenter the editing loop.
1162 When there is an error, cmd_error runs and returns a non-nil
1163 value to us. A value of nil means that command_loop_1 itself
1164 returned due to end of file (or end of kbd macro). */
1167 command_loop_2 (Lisp_Object ignore
)
1169 register Lisp_Object val
;
1172 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1173 while (!NILP (val
));
1181 return Feval (Vtop_level
, Qnil
);
1185 top_level_1 (Lisp_Object ignore
)
1187 /* On entry to the outer level, run the startup file. */
1188 if (!NILP (Vtop_level
))
1189 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1190 else if (!NILP (Vpurify_flag
))
1191 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1193 message1 ("Bare Emacs (standard Lisp code not loaded)");
1197 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1198 doc
: /* Exit all recursive editing levels.
1199 This also exits all active minibuffers. */)
1202 #ifdef HAVE_WINDOW_SYSTEM
1203 if (display_hourglass_p
)
1204 cancel_hourglass ();
1207 /* Unblock input if we enter with input blocked. This may happen if
1208 redisplay traps e.g. during tool-bar update with input blocked. */
1209 totally_unblock_input ();
1211 Fthrow (Qtop_level
, Qnil
);
1214 static _Noreturn
void
1215 user_error (const char *msg
)
1217 xsignal1 (Quser_error
, build_string (msg
));
1220 /* _Noreturn will be added to prototype by make-docfile. */
1221 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1222 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1225 if (command_loop_level
> 0 || minibuf_level
> 0)
1226 Fthrow (Qexit
, Qnil
);
1228 user_error ("No recursive edit is in progress");
1231 /* _Noreturn will be added to prototype by make-docfile. */
1232 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1233 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1236 if (command_loop_level
> 0 || minibuf_level
> 0)
1239 user_error ("No recursive edit is in progress");
1242 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1243 of this function. */
1246 tracking_off (Lisp_Object old_value
)
1248 do_mouse_tracking
= old_value
;
1249 if (NILP (old_value
))
1251 /* Redisplay may have been preempted because there was input
1252 available, and it assumes it will be called again after the
1253 input has been processed. If the only input available was
1254 the sort that we have just disabled, then we need to call
1256 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1258 redisplay_preserve_echo_area (6);
1259 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1264 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1265 doc
: /* Evaluate BODY with mouse movement events enabled.
1266 Within a `track-mouse' form, mouse motion generates input events that
1267 you can read with `read-event'.
1268 Normally, mouse motion is ignored.
1269 usage: (track-mouse BODY...) */)
1272 ptrdiff_t count
= SPECPDL_INDEX ();
1275 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1277 do_mouse_tracking
= Qt
;
1279 val
= Fprogn (args
);
1280 return unbind_to (count
, val
);
1283 /* If mouse has moved on some frame, return one of those frames.
1287 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1288 after resizing the tool-bar window. */
1290 bool ignore_mouse_drag_p
;
1292 static struct frame
*
1293 some_mouse_moved (void)
1295 Lisp_Object tail
, frame
;
1297 if (ignore_mouse_drag_p
)
1299 /* ignore_mouse_drag_p = 0; */
1303 FOR_EACH_FRAME (tail
, frame
)
1305 if (XFRAME (frame
)->mouse_moved
)
1306 return XFRAME (frame
);
1313 /* This is the actual command reading loop,
1314 sans error-handling encapsulation. */
1316 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1317 bool, bool, bool, bool);
1318 static void adjust_point_for_property (ptrdiff_t, bool);
1320 /* The last boundary auto-added to buffer-undo-list. */
1321 Lisp_Object last_undo_boundary
;
1323 /* FIXME: This is wrong rather than test window-system, we should call
1324 a new set-selection, which will then dispatch to x-set-selection, or
1325 tty-set-selection, or w32-set-selection, ... */
1328 command_loop_1 (void)
1331 Lisp_Object keybuf
[30];
1333 EMACS_INT prev_modiff
= 0;
1334 struct buffer
*prev_buffer
= NULL
;
1335 bool already_adjusted
= 0;
1337 kset_prefix_arg (current_kboard
, Qnil
);
1338 kset_last_prefix_arg (current_kboard
, Qnil
);
1339 Vdeactivate_mark
= Qnil
;
1340 waiting_for_input
= 0;
1343 this_command_key_count
= 0;
1344 this_command_key_count_reset
= 0;
1345 this_single_command_key_start
= 0;
1347 if (NILP (Vmemory_full
))
1349 /* Make sure this hook runs after commands that get errors and
1350 throw to top level. */
1351 /* Note that the value cell will never directly contain nil
1352 if the symbol is a local variable. */
1353 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1354 safe_run_hooks (Qpost_command_hook
);
1356 /* If displaying a message, resize the echo area window to fit
1357 that message's size exactly. */
1358 if (!NILP (echo_area_buffer
[0]))
1359 resize_echo_area_exactly ();
1361 /* If there are warnings waiting, process them. */
1362 if (!NILP (Vdelayed_warnings_list
))
1363 safe_run_hooks (Qdelayed_warnings_hook
);
1365 if (!NILP (Vdeferred_action_list
))
1366 safe_run_hooks (Qdeferred_action_function
);
1369 /* Do this after running Vpost_command_hook, for consistency. */
1370 kset_last_command (current_kboard
, Vthis_command
);
1371 kset_real_last_command (current_kboard
, Vreal_this_command
);
1372 if (!CONSP (last_command_event
))
1373 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1377 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1380 /* Make sure the current window's buffer is selected. */
1381 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1383 /* Display any malloc warning that just came out. Use while because
1384 displaying one warning can cause another. */
1386 while (pending_malloc_warning
)
1387 display_malloc_warning ();
1389 Vdeactivate_mark
= Qnil
;
1391 /* Don't ignore mouse movements for more than a single command
1392 loop. (This flag is set in xdisp.c whenever the tool bar is
1393 resized, because the resize moves text up or down, and would
1394 generate false mouse drag events if we don't ignore them.) */
1395 ignore_mouse_drag_p
= 0;
1397 /* If minibuffer on and echo area in use,
1398 wait a short time and redraw minibuffer. */
1401 && !NILP (echo_area_buffer
[0])
1402 && EQ (minibuf_window
, echo_area_window
)
1403 && NUMBERP (Vminibuffer_message_timeout
))
1405 /* Bind inhibit-quit to t so that C-g gets read in
1406 rather than quitting back to the minibuffer. */
1408 specbind (Qinhibit_quit
, Qt
);
1410 sit_for (Vminibuffer_message_timeout
, 0, 2);
1412 /* Clear the echo area. */
1414 safe_run_hooks (Qecho_area_clear_hook
);
1418 /* If a C-g came in before, treat it as input now. */
1419 if (!NILP (Vquit_flag
))
1422 Vunread_command_events
= list1 (make_number (quit_char
));
1426 /* If it has changed current-menubar from previous value,
1427 really recompute the menubar from the value. */
1428 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1429 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1430 call0 (Qrecompute_lucid_menubar
);
1432 before_command_key_count
= this_command_key_count
;
1433 before_command_echo_length
= echo_length ();
1435 Vthis_command
= Qnil
;
1436 Vreal_this_command
= Qnil
;
1437 Vthis_original_command
= Qnil
;
1438 Vthis_command_keys_shift_translated
= Qnil
;
1440 /* Read next key sequence; i gets its length. */
1441 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1444 /* A filter may have run while we were reading the input. */
1445 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1447 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1451 /* Now we have read a key sequence of length I,
1452 or else I is 0 and we found end of file. */
1454 if (i
== 0) /* End of file -- happens only in */
1455 return Qnil
; /* a kbd macro, at the end. */
1456 /* -1 means read_key_sequence got a menu that was rejected.
1457 Just loop around and read another command. */
1461 this_command_key_count
= 0;
1462 this_command_key_count_reset
= 0;
1463 this_single_command_key_start
= 0;
1467 last_command_event
= keybuf
[i
- 1];
1469 /* If the previous command tried to force a specific window-start,
1470 forget about that, in case this command moves point far away
1471 from that position. But also throw away beg_unchanged and
1472 end_unchanged information in that case, so that redisplay will
1473 update the whole window properly. */
1474 if (XWINDOW (selected_window
)->force_start
)
1477 XWINDOW (selected_window
)->force_start
= 0;
1478 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1479 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1482 cmd
= read_key_sequence_cmd
;
1483 if (!NILP (Vexecuting_kbd_macro
))
1485 if (!NILP (Vquit_flag
))
1487 Vexecuting_kbd_macro
= Qt
;
1488 QUIT
; /* Make some noise. */
1489 /* Will return since macro now empty. */
1493 /* Do redisplay processing after this command except in special
1494 cases identified below. */
1495 prev_buffer
= current_buffer
;
1496 prev_modiff
= MODIFF
;
1497 last_point_position
= PT
;
1499 /* By default, we adjust point to a boundary of a region that
1500 has such a property that should be treated intangible
1501 (e.g. composition, display). But, some commands will set
1502 this variable differently. */
1503 Vdisable_point_adjustment
= Qnil
;
1505 /* Process filters and timers may have messed with deactivate-mark.
1506 reset it before we execute the command. */
1507 Vdeactivate_mark
= Qnil
;
1509 /* Remap command through active keymaps. */
1510 Vthis_original_command
= cmd
;
1511 if (!NILP (read_key_sequence_remapped
))
1512 cmd
= read_key_sequence_remapped
;
1514 /* Execute the command. */
1516 Vthis_command
= cmd
;
1517 Vreal_this_command
= cmd
;
1518 safe_run_hooks (Qpre_command_hook
);
1520 already_adjusted
= 0;
1522 if (NILP (Vthis_command
))
1523 /* nil means key is undefined. */
1527 /* Here for a command that isn't executed directly. */
1529 #ifdef HAVE_WINDOW_SYSTEM
1532 if (display_hourglass_p
1533 && NILP (Vexecuting_kbd_macro
))
1535 record_unwind_protect_void (cancel_hourglass
);
1540 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1542 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1545 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1546 ? Qnil
: BVAR (current_buffer
, undo_list
));
1548 call1 (Qcommand_execute
, Vthis_command
);
1550 #ifdef HAVE_WINDOW_SYSTEM
1551 /* Do not check display_hourglass_p here, because
1552 `command-execute' could change it, but we should cancel
1553 hourglass cursor anyway.
1554 But don't cancel the hourglass within a macro
1555 just because a command in the macro finishes. */
1559 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1561 safe_run_hooks (Qpost_command_hook
);
1563 /* If displaying a message, resize the echo area window to fit
1564 that message's size exactly. */
1565 if (!NILP (echo_area_buffer
[0]))
1566 resize_echo_area_exactly ();
1568 /* If there are warnings waiting, process them. */
1569 if (!NILP (Vdelayed_warnings_list
))
1570 safe_run_hooks (Qdelayed_warnings_hook
);
1572 safe_run_hooks (Qdeferred_action_function
);
1574 /* If there is a prefix argument,
1575 1) We don't want Vlast_command to be ``universal-argument''
1576 (that would be dumb), so don't set Vlast_command,
1577 2) we want to leave echoing on so that the prefix will be
1578 echoed as part of this key sequence, so don't call
1580 3) we want to leave this_command_key_count non-zero, so that
1581 read_char will realize that it is re-reading a character, and
1582 not echo it a second time.
1584 If the command didn't actually create a prefix arg,
1585 but is merely a frame event that is transparent to prefix args,
1586 then the above doesn't apply. */
1587 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1588 || CONSP (last_command_event
))
1590 kset_last_command (current_kboard
, Vthis_command
);
1591 kset_real_last_command (current_kboard
, Vreal_this_command
);
1592 if (!CONSP (last_command_event
))
1593 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1595 this_command_key_count
= 0;
1596 this_command_key_count_reset
= 0;
1597 this_single_command_key_start
= 0;
1600 if (!NILP (BVAR (current_buffer
, mark_active
))
1601 && !NILP (Vrun_hooks
))
1603 /* In Emacs 22, setting transient-mark-mode to `only' was a
1604 way of turning it on for just one command. This usage is
1605 obsolete, but support it anyway. */
1606 if (EQ (Vtransient_mark_mode
, Qidentity
))
1607 Vtransient_mark_mode
= Qnil
;
1608 else if (EQ (Vtransient_mark_mode
, Qonly
))
1609 Vtransient_mark_mode
= Qidentity
;
1611 if (!NILP (Vdeactivate_mark
))
1612 /* If `select-active-regions' is non-nil, this call to
1613 `deactivate-mark' also sets the PRIMARY selection. */
1614 call0 (Qdeactivate_mark
);
1617 /* Even if not deactivating the mark, set PRIMARY if
1618 `select-active-regions' is non-nil. */
1619 if (!NILP (Fwindow_system (Qnil
))
1620 /* Even if mark_active is non-nil, the actual buffer
1621 marker may not have been set yet (Bug#7044). */
1622 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1623 && (EQ (Vselect_active_regions
, Qonly
)
1624 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1625 : (!NILP (Vselect_active_regions
)
1626 && !NILP (Vtransient_mark_mode
)))
1627 && NILP (Fmemq (Vthis_command
,
1628 Vselection_inhibit_update_commands
)))
1631 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1632 if (XINT (Flength (txt
)) > 0)
1633 /* Don't set empty selections. */
1634 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1637 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1639 Lisp_Object hook
= intern ("activate-mark-hook");
1640 Frun_hooks (1, &hook
);
1644 Vsaved_region_selection
= Qnil
;
1649 if (current_buffer
== prev_buffer
1650 && last_point_position
!= PT
1651 && NILP (Vdisable_point_adjustment
)
1652 && NILP (Vglobal_disable_point_adjustment
))
1654 if (last_point_position
> BEGV
1655 && last_point_position
< ZV
1656 && (composition_adjust_point (last_point_position
,
1657 last_point_position
)
1658 != last_point_position
))
1659 /* The last point was temporarily set within a grapheme
1660 cluster to prevent automatic composition. To recover
1661 the automatic composition, we must update the
1663 windows_or_buffers_changed
= 21;
1664 if (!already_adjusted
)
1665 adjust_point_for_property (last_point_position
,
1666 MODIFF
!= prev_modiff
);
1669 /* Install chars successfully executed in kbd macro. */
1671 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1672 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1673 finalize_kbd_macro_chars ();
1678 read_menu_command (void)
1680 Lisp_Object keybuf
[30];
1681 ptrdiff_t count
= SPECPDL_INDEX ();
1684 /* We don't want to echo the keystrokes while navigating the
1686 specbind (Qecho_keystrokes
, make_number (0));
1688 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1691 unbind_to (count
, Qnil
);
1693 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1695 if (i
== 0 || i
== -1)
1698 return read_key_sequence_cmd
;
1701 /* Adjust point to a boundary of a region that has such a property
1702 that should be treated intangible. For the moment, we check
1703 `composition', `display' and `invisible' properties.
1704 LAST_PT is the last position of point. */
1707 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1710 Lisp_Object val
, overlay
, tmp
;
1711 /* When called after buffer modification, we should temporarily
1712 suppress the point adjustment for automatic composition so that a
1713 user can keep inserting another character at point or keep
1714 deleting characters around point. */
1715 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1716 ptrdiff_t orig_pt
= PT
;
1718 /* FIXME: cycling is probably not necessary because these properties
1719 can't be usefully combined anyway. */
1720 while (check_composition
|| check_display
|| check_invisible
)
1722 /* FIXME: check `intangible'. */
1723 if (check_composition
1724 && PT
> BEGV
&& PT
< ZV
1725 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1728 check_display
= check_invisible
= 1;
1730 check_composition
= 0;
1732 && PT
> BEGV
&& PT
< ZV
1733 && !NILP (val
= get_char_property_and_overlay
1734 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1735 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1736 && (!OVERLAYP (overlay
)
1737 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1738 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1739 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1740 && (beg
< PT
/* && end > PT <- It's always the case. */
1741 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1744 SET_PT (PT
< last_pt
1745 ? (STRINGP (val
) && SCHARS (val
) == 0
1746 ? max (beg
- 1, BEGV
)
1749 check_composition
= check_invisible
= 1;
1752 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1758 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1761 /* FIXME: We should stop if we find a spot between
1762 two runs of `invisible' where inserted text would
1763 be visible. This is important when we have two
1764 invisible boundaries that enclose an area: if the
1765 area is empty, we need this test in order to make
1766 it possible to place point in the middle rather
1767 than skip both boundaries. However, this code
1768 also stops anywhere in a non-sticky text-property,
1769 which breaks (e.g.) Org mode. */
1770 && (val
= Fget_pos_property (make_number (end
),
1772 TEXT_PROP_MEANS_INVISIBLE (val
))
1774 && !NILP (val
= get_char_property_and_overlay
1775 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1776 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1778 ellipsis
= ellipsis
|| inv
> 1
1779 || (OVERLAYP (overlay
)
1780 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1781 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1782 tmp
= Fnext_single_char_property_change
1783 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1784 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1788 && (val
= Fget_pos_property (make_number (beg
),
1790 TEXT_PROP_MEANS_INVISIBLE (val
))
1792 && !NILP (val
= get_char_property_and_overlay
1793 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1794 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1796 ellipsis
= ellipsis
|| inv
> 1
1797 || (OVERLAYP (overlay
)
1798 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1799 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1800 tmp
= Fprevious_single_char_property_change
1801 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1802 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1805 /* Move away from the inside area. */
1806 if (beg
< PT
&& end
> PT
)
1808 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1809 /* We haven't moved yet (so we don't need to fear
1810 infinite-looping) and we were outside the range
1811 before (so either end of the range still corresponds
1812 to a move in the right direction): pretend we moved
1813 less than we actually did, so that we still have
1814 more freedom below in choosing which end of the range
1816 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1817 /* We either have moved already or the last point
1818 was already in the range: we don't get to choose
1819 which end of the range we have to go to. */
1820 : (PT
< last_pt
? beg
: end
));
1821 check_composition
= check_display
= 1;
1823 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1824 the point to something other than its argument, due to
1825 point-motion hooks, intangibility, etc. */
1826 eassert (PT
== beg
|| PT
== end
);
1829 /* Pretend the area doesn't exist if the buffer is not
1831 if (!modified
&& !ellipsis
&& beg
< end
)
1833 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1834 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1835 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1836 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1837 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1838 /* We've already moved as far as we can. Trying to go
1839 to the other end would mean moving backwards and thus
1840 could lead to an infinite loop. */
1842 else if (val
= Fget_pos_property (make_number (PT
),
1844 TEXT_PROP_MEANS_INVISIBLE (val
)
1845 && (val
= (Fget_pos_property
1846 (make_number (PT
== beg
? end
: beg
),
1848 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1849 (check_composition
= check_display
= 1,
1850 SET_PT (PT
== beg
? end
: beg
));
1853 check_invisible
= 0;
1857 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1860 safe_run_hooks_1 (void)
1862 eassert (CONSP (Vinhibit_quit
));
1863 return call0 (XCDR (Vinhibit_quit
));
1866 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1870 safe_run_hooks_error (Lisp_Object error_data
)
1873 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1874 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1875 Lisp_Object args
[4];
1876 args
[0] = build_string ("Error in %s (%S): %S");
1879 args
[3] = error_data
;
1885 Lisp_Object newval
= Qnil
;
1886 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1887 if (EQ (fun
, XCAR (val
)))
1890 newval
= Fcons (XCAR (val
), newval
);
1892 return Fset (hook
, Fnreverse (newval
));
1893 /* Not found in the local part of the hook. Let's look at the global
1896 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1897 : Fdefault_value (hook
));
1898 CONSP (val
); val
= XCDR (val
))
1899 if (EQ (fun
, XCAR (val
)))
1902 newval
= Fcons (XCAR (val
), newval
);
1904 return Fset_default (hook
, Fnreverse (newval
));
1910 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1912 eassert (nargs
== 1);
1913 if (CONSP (Vinhibit_quit
))
1914 XSETCDR (Vinhibit_quit
, args
[0]);
1916 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1918 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1922 /* If we get an error while running the hook, cause the hook variable
1923 to be nil. Also inhibit quits, so that C-g won't cause the hook
1924 to mysteriously evaporate. */
1927 safe_run_hooks (Lisp_Object hook
)
1929 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1930 to its body or to its handlers other than via globals such as
1931 dynamically-bound variables ;-) */
1932 ptrdiff_t count
= SPECPDL_INDEX ();
1933 specbind (Qinhibit_quit
, hook
);
1935 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1937 unbind_to (count
, Qnil
);
1941 /* Nonzero means polling for input is temporarily suppressed. */
1943 int poll_suppress_count
;
1946 #ifdef POLL_FOR_INPUT
1948 /* Asynchronous timer for polling. */
1950 static struct atimer
*poll_timer
;
1952 /* Poll for input, so that we catch a C-g if it comes in. */
1954 poll_for_input_1 (void)
1956 if (! input_blocked_p ()
1957 && !waiting_for_input
)
1961 /* Timer callback function for poll_timer. TIMER is equal to
1965 poll_for_input (struct atimer
*timer
)
1967 if (poll_suppress_count
== 0)
1968 pending_signals
= 1;
1971 #endif /* POLL_FOR_INPUT */
1973 /* Begin signals to poll for input, if they are appropriate.
1974 This function is called unconditionally from various places. */
1977 start_polling (void)
1979 #ifdef POLL_FOR_INPUT
1980 /* XXX This condition was (read_socket_hook && !interrupt_input),
1981 but read_socket_hook is not global anymore. Let's pretend that
1983 if (!interrupt_input
)
1985 /* Turn alarm handling on unconditionally. It might have
1986 been turned off in process.c. */
1987 turn_on_atimers (1);
1989 /* If poll timer doesn't exist, or we need one with
1990 a different interval, start a new one. */
1991 if (poll_timer
== NULL
1992 || poll_timer
->interval
.tv_sec
!= polling_period
)
1994 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1995 struct timespec interval
= make_timespec (period
, 0);
1998 cancel_atimer (poll_timer
);
2000 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2001 poll_for_input
, NULL
);
2004 /* Let the timer's callback function poll for input
2005 if this becomes zero. */
2006 --poll_suppress_count
;
2011 /* True if we are using polling to handle input asynchronously. */
2014 input_polling_used (void)
2016 #ifdef POLL_FOR_INPUT
2017 /* XXX This condition was (read_socket_hook && !interrupt_input),
2018 but read_socket_hook is not global anymore. Let's pretend that
2020 return !interrupt_input
;
2026 /* Turn off polling. */
2031 #ifdef POLL_FOR_INPUT
2032 /* XXX This condition was (read_socket_hook && !interrupt_input),
2033 but read_socket_hook is not global anymore. Let's pretend that
2035 if (!interrupt_input
)
2036 ++poll_suppress_count
;
2040 /* Set the value of poll_suppress_count to COUNT
2041 and start or stop polling accordingly. */
2044 set_poll_suppress_count (int count
)
2046 #ifdef POLL_FOR_INPUT
2047 if (count
== 0 && poll_suppress_count
!= 0)
2049 poll_suppress_count
= 1;
2052 else if (count
!= 0 && poll_suppress_count
== 0)
2056 poll_suppress_count
= count
;
2060 /* Bind polling_period to a value at least N.
2061 But don't decrease it. */
2064 bind_polling_period (int n
)
2066 #ifdef POLL_FOR_INPUT
2067 EMACS_INT
new = polling_period
;
2072 stop_other_atimers (poll_timer
);
2074 specbind (Qpolling_period
, make_number (new));
2075 /* Start a new alarm with the new period. */
2080 /* Apply the control modifier to CHARACTER. */
2083 make_ctrl_char (int c
)
2085 /* Save the upper bits here. */
2086 int upper
= c
& ~0177;
2088 if (! ASCII_CHAR_P (c
))
2089 return c
|= ctrl_modifier
;
2093 /* Everything in the columns containing the upper-case letters
2094 denotes a control character. */
2095 if (c
>= 0100 && c
< 0140)
2099 /* Set the shift modifier for a control char
2100 made from a shifted letter. But only for letters! */
2101 if (oc
>= 'A' && oc
<= 'Z')
2102 c
|= shift_modifier
;
2105 /* The lower-case letters denote control characters too. */
2106 else if (c
>= 'a' && c
<= 'z')
2109 /* Include the bits for control and shift
2110 only if the basic ASCII code can't indicate them. */
2114 /* Replace the high bits. */
2115 c
|= (upper
& ~ctrl_modifier
);
2120 /* Display the help-echo property of the character after the mouse pointer.
2121 Either show it in the echo area, or call show-help-function to display
2122 it by other means (maybe in a tooltip).
2124 If HELP is nil, that means clear the previous help echo.
2126 If HELP is a string, display that string. If HELP is a function,
2127 call it with OBJECT and POS as arguments; the function should
2128 return a help string or nil for none. For all other types of HELP,
2129 evaluate it to obtain a string.
2131 WINDOW is the window in which the help was generated, if any.
2132 It is nil if not in a window.
2134 If OBJECT is a buffer, POS is the position in the buffer where the
2135 `help-echo' text property was found.
2137 If OBJECT is an overlay, that overlay has a `help-echo' property,
2138 and POS is the position in the overlay's buffer under the mouse.
2140 If OBJECT is a string (an overlay string or a string displayed with
2141 the `display' property). POS is the position in that string under
2144 Note: this function may only be called with HELP nil or a string
2145 from X code running asynchronously. */
2148 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2151 if (!NILP (help
) && !STRINGP (help
))
2153 if (FUNCTIONP (help
))
2154 help
= safe_call (4, help
, window
, object
, pos
);
2156 help
= safe_eval (help
);
2158 if (!STRINGP (help
))
2162 if (!noninteractive
&& STRINGP (help
))
2164 /* The mouse-fixup-help-message Lisp function can call
2165 mouse_position_hook, which resets the mouse_moved flags.
2166 This causes trouble if we are trying to read a mouse motion
2167 event (i.e., if we are inside a `track-mouse' form), so we
2168 restore the mouse_moved flag. */
2169 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2170 help
= call1 (Qmouse_fixup_help_message
, help
);
2175 if (STRINGP (help
) || NILP (help
))
2177 if (!NILP (Vshow_help_function
))
2178 call1 (Vshow_help_function
, help
);
2179 help_echo_showing_p
= STRINGP (help
);
2185 /* Input of single characters from keyboard. */
2187 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2188 struct timespec
*end_time
);
2189 static void record_char (Lisp_Object c
);
2191 static Lisp_Object help_form_saved_window_configs
;
2193 read_char_help_form_unwind (void)
2195 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2196 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2197 if (!NILP (window_config
))
2198 Fset_window_configuration (window_config
);
2201 #define STOP_POLLING \
2202 do { if (! polling_stopped_here) stop_polling (); \
2203 polling_stopped_here = 1; } while (0)
2205 #define RESUME_POLLING \
2206 do { if (polling_stopped_here) start_polling (); \
2207 polling_stopped_here = 0; } while (0)
2210 read_event_from_main_queue (struct timespec
*end_time
,
2211 sys_jmp_buf
*local_getcjmp
,
2212 bool *used_mouse_menu
)
2214 Lisp_Object c
= Qnil
;
2215 sys_jmp_buf
*save_jump
= xmalloc (sizeof *save_jump
);
2216 KBOARD
*kb
IF_LINT (= NULL
);
2220 /* Read from the main queue, and if that gives us something we can't use yet,
2221 we put it on the appropriate side queue and try again. */
2223 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2226 /* Actually read a character, waiting if necessary. */
2227 save_getcjmp (save_jump
);
2228 restore_getcjmp (local_getcjmp
);
2230 timer_start_idle ();
2231 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2232 restore_getcjmp (save_jump
);
2234 if (! NILP (c
) && (kb
!= current_kboard
))
2236 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2239 while (CONSP (XCDR (last
)))
2241 if (!NILP (XCDR (last
)))
2245 kset_kbd_queue (kb
, list1 (c
));
2247 XSETCDR (last
, list1 (c
));
2248 kb
->kbd_queue_has_data
= 1;
2252 current_kboard
= kb
;
2253 /* This is going to exit from read_char
2254 so we had better get rid of this frame's stuff. */
2255 return make_number (-2);
2258 /* Terminate Emacs in batch mode if at eof. */
2259 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2260 Fkill_emacs (make_number (1));
2264 /* Add in any extra modifiers, where appropriate. */
2265 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2266 || ((extra_keyboard_modifiers
& 0177) < ' '
2267 && (extra_keyboard_modifiers
& 0177) != 0))
2268 XSETINT (c
, make_ctrl_char (XINT (c
)));
2270 /* Transfer any other modifier bits directly from
2271 extra_keyboard_modifiers to c. Ignore the actual character code
2272 in the low 16 bits of extra_keyboard_modifiers. */
2273 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2281 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2284 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2285 sys_jmp_buf
*local_getcjmp
,
2286 Lisp_Object prev_event
,
2287 bool *used_mouse_menu
)
2289 #define MAX_ENCODED_BYTES 16
2291 Lisp_Object events
[MAX_ENCODED_BYTES
];
2297 = read_event_from_main_queue (end_time
, local_getcjmp
,
2300 /* w32_console already returns decoded events. It either reads
2301 Unicode characters from the Windows keyboard input, or
2302 converts characters encoded in the current codepage into
2303 Unicode. See w32inevt.c:key_event, near its end. */
2306 struct frame
*frame
= XFRAME (selected_frame
);
2307 struct terminal
*terminal
= frame
->terminal
;
2308 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2309 /* Don't apply decoding if we're just reading a raw event
2310 (e.g. reading bytes sent by the xterm to specify the position
2311 of a mouse click). */
2312 && (!EQ (prev_event
, Qt
))
2313 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2314 & CODING_REQUIRE_DECODING_MASK
)))
2315 return nextevt
; /* No decoding needed. */
2318 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2319 eassert (n
< MAX_ENCODED_BYTES
);
2320 events
[n
++] = nextevt
;
2321 if (NATNUMP (nextevt
)
2322 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2323 { /* An encoded byte sequence, let's try to decode it. */
2324 struct coding_system
*coding
2325 = TERMINAL_KEYBOARD_CODING (terminal
);
2326 unsigned char *src
= alloca (n
);
2328 for (i
= 0; i
< n
; i
++)
2329 src
[i
] = XINT (events
[i
]);
2331 for (i
= 0; i
< n
; i
++)
2333 coding
->destination
= alloca (n
* 4);
2334 coding
->dst_bytes
= n
* 4;
2335 decode_coding_c_string (coding
, src
, n
, Qnil
);
2336 eassert (coding
->produced_char
<= n
);
2337 if (coding
->produced_char
== 0)
2338 { /* The encoded sequence is incomplete. */
2339 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2340 continue; /* Read on! */
2344 const unsigned char *p
= coding
->destination
;
2345 eassert (coding
->carryover_bytes
== 0);
2347 while (n
< coding
->produced_char
)
2348 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2351 /* Now `events' should hold decoded events.
2352 Normally, n should be equal to 1, but better not rely on it.
2353 We can only return one event here, so return the first we
2354 had and keep the others (if any) for later. */
2356 Vunread_command_events
2357 = Fcons (events
[--n
], Vunread_command_events
);
2365 echo_keystrokes_p (void)
2367 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2368 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2371 /* Read a character from the keyboard; call the redisplay if needed. */
2372 /* commandflag 0 means do not autosave, but do redisplay.
2373 -1 means do not redisplay, but do autosave.
2374 -2 means do neither.
2377 /* The argument MAP is a keymap for menu prompting.
2379 PREV_EVENT is the previous input event, or nil if we are reading
2380 the first event of a key sequence (or not reading a key sequence).
2381 If PREV_EVENT is t, that is a "magic" value that says
2382 not to run input methods, but in other respects to act as if
2383 not reading a key sequence.
2385 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2386 if we used a mouse menu to read the input, or false otherwise. If
2387 USED_MOUSE_MENU is null, don't dereference it.
2389 Value is -2 when we find input on another keyboard. A second call
2390 to read_char will read it.
2392 If END_TIME is non-null, it is a pointer to a struct timespec
2393 specifying the maximum time to wait until. If no input arrives by
2394 that time, stop waiting and return nil.
2396 Value is t if we showed a menu and the user rejected it. */
2398 struct read_char_state
2402 Lisp_Object prev_event
;
2403 bool *used_mouse_menu
;
2404 struct timespec
*end_time
;
2407 sys_jmp_buf
*local_getcjmp
;
2408 sys_jmp_buf
*save_jump
;
2409 Lisp_Object previous_echo_area_message
;
2410 Lisp_Object also_record
;
2412 bool polling_stopped_here
;
2413 struct kboard
*orig_kboard
;
2416 static Lisp_Object
read_char_1 (bool, volatile struct read_char_state
*);
2419 read_char (int commandflag
, Lisp_Object map
,
2420 Lisp_Object prev_event
,
2421 bool *used_mouse_menu
, struct timespec
*end_time
)
2423 volatile struct read_char_state
*state
= xmalloc (sizeof *state
);
2425 state
->commandflag
= commandflag
;
2427 state
->prev_event
= prev_event
;
2428 state
->used_mouse_menu
= used_mouse_menu
;
2429 state
->end_time
= end_time
;
2431 state
->local_getcjmp
= xmalloc (sizeof (*state
->local_getcjmp
));
2432 state
->save_jump
= xmalloc (sizeof (*state
->save_jump
));
2433 state
->previous_echo_area_message
= Qnil
;
2434 state
->also_record
= Qnil
;
2435 state
->reread
= false;
2436 state
->polling_stopped_here
= false;
2437 state
->orig_kboard
= current_kboard
;
2439 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2440 We will do that below, temporarily for short sections of code,
2441 when appropriate. local_getcjmp must be in effect
2442 around any call to sit_for or kbd_buffer_get_event;
2443 it *must not* be in effect when we call redisplay. */
2445 state
->jmpcount
= SPECPDL_INDEX ();
2446 if (sys_setjmp (*state
->local_getcjmp
))
2448 /* Handle quits while reading the keyboard. */
2449 /* We must have saved the outer value of getcjmp here,
2450 so restore it now. */
2451 restore_getcjmp (state
->save_jump
);
2452 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2453 unbind_to (state
->jmpcount
, Qnil
);
2454 XSETINT (state
->c
, quit_char
);
2455 internal_last_event_frame
= selected_frame
;
2456 Vlast_event_frame
= internal_last_event_frame
;
2457 /* If we report the quit char as an event,
2458 don't do so more than once. */
2459 if (!NILP (Vinhibit_quit
))
2463 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2464 if (kb
!= current_kboard
)
2466 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2467 /* We shouldn't get here if we were in single-kboard mode! */
2472 while (CONSP (XCDR (last
)))
2474 if (!NILP (XCDR (last
)))
2478 kset_kbd_queue (kb
, list1 (state
->c
));
2480 XSETCDR (last
, list1 (state
->c
));
2481 kb
->kbd_queue_has_data
= 1;
2482 current_kboard
= kb
;
2483 /* This is going to exit from read_char
2484 so we had better get rid of this frame's stuff. */
2486 return make_number (-2); /* wrong_kboard_jmpbuf */
2489 return read_char_1 (true, state
);
2492 return read_char_1 (false, state
);
2496 read_char_1 (bool jump
, volatile struct read_char_state
*state
)
2498 #define commandflag state->commandflag
2499 #define map state->map
2500 #define prev_event state->prev_event
2501 #define used_mouse_menu state->used_mouse_menu
2502 #define end_time state->end_time
2504 #define jmpcount state->jmpcount
2505 #define local_getcjmp state->local_getcjmp
2506 #define save_jump state->save_jump
2507 #define previous_echo_area_message state->previous_echo_area_message
2508 #define also_record state->also_record
2509 #define reread state->reread
2510 #define polling_stopped_here state->polling_stopped_here
2511 #define orig_kboard state->orig_kboard
2512 Lisp_Object tem
, save
;
2519 if (CONSP (Vunread_post_input_method_events
))
2521 c
= XCAR (Vunread_post_input_method_events
);
2522 Vunread_post_input_method_events
2523 = XCDR (Vunread_post_input_method_events
);
2525 /* Undo what read_char_x_menu_prompt did when it unread
2526 additional keys returned by Fx_popup_menu. */
2528 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2539 if (CONSP (Vunread_command_events
))
2541 bool was_disabled
= 0;
2543 c
= XCAR (Vunread_command_events
);
2544 Vunread_command_events
= XCDR (Vunread_command_events
);
2546 /* Undo what sit-for did when it unread additional keys
2547 inside universal-argument. */
2549 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2554 /* Undo what read_char_x_menu_prompt did when it unread
2555 additional keys returned by Fx_popup_menu. */
2557 && EQ (XCDR (c
), Qdisabled
)
2558 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2564 /* If the queued event is something that used the mouse,
2565 set used_mouse_menu accordingly. */
2567 /* Also check was_disabled so last-nonmenu-event won't return
2568 a bad value when submenus are involved. (Bug#447) */
2569 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2570 *used_mouse_menu
= 1;
2572 goto reread_for_input_method
;
2575 if (CONSP (Vunread_input_method_events
))
2577 c
= XCAR (Vunread_input_method_events
);
2578 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2580 /* Undo what read_char_x_menu_prompt did when it unread
2581 additional keys returned by Fx_popup_menu. */
2583 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2587 goto reread_for_input_method
;
2590 this_command_key_count_reset
= 0;
2592 if (!NILP (Vexecuting_kbd_macro
))
2594 /* We set this to Qmacro; since that's not a frame, nobody will
2595 try to switch frames on us, and the selected window will
2598 Since this event came from a macro, it would be misleading to
2599 leave internal_last_event_frame set to wherever the last
2600 real event came from. Normally, a switch-frame event selects
2601 internal_last_event_frame after each command is read, but
2602 events read from a macro should never cause a new frame to be
2604 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2606 /* Exit the macro if we are at the end.
2607 Also, some things replace the macro with t
2608 to force an early exit. */
2609 if (EQ (Vexecuting_kbd_macro
, Qt
)
2610 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2616 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2617 if (STRINGP (Vexecuting_kbd_macro
)
2618 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2619 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2621 executing_kbd_macro_index
++;
2626 if (!NILP (unread_switch_frame
))
2628 c
= unread_switch_frame
;
2629 unread_switch_frame
= Qnil
;
2631 /* This event should make it into this_command_keys, and get echoed
2632 again, so we do not set `reread'. */
2636 /* If redisplay was requested. */
2637 if (commandflag
>= 0)
2639 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2641 /* If there is pending input, process any events which are not
2642 user-visible, such as X selection_request events. */
2644 || detect_input_pending_run_timers (0))
2645 swallow_events (0); /* May clear input_pending. */
2647 /* Redisplay if no pending input. */
2648 while (!input_pending
)
2650 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2651 redisplay_preserve_echo_area (5);
2656 /* Normal case: no input arrived during redisplay. */
2659 /* Input arrived and pre-empted redisplay.
2660 Process any events which are not user-visible. */
2662 /* If that cleared input_pending, try again to redisplay. */
2665 /* Prevent the redisplay we just did
2666 from messing up echoing of the input after the prompt. */
2667 if (commandflag
== 0 && echo_current
)
2668 echo_message_buffer
= echo_area_buffer
[0];
2672 /* Message turns off echoing unless more keystrokes turn it on again.
2674 The code in 20.x for the condition was
2676 1. echo_area_glyphs && *echo_area_glyphs
2677 2. && echo_area_glyphs != current_kboard->echobuf
2678 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2680 (1) means there's a current message displayed
2682 (2) means it's not the message from echoing from the current
2685 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2686 is set to a non-null value. This is done in read_char and it is
2687 set to echo_area_glyphs after a call to echo_char. That means
2688 ok_to_echo_at_next_pause is either null or
2689 current_kboard->echobuf with the appropriate current_kboard at
2692 So, condition (3) means in clear text ok_to_echo_at_next_pause
2693 must be either null, or the current message isn't from echoing at
2694 all, or it's from echoing from a different kboard than the
2697 if (/* There currently is something in the echo area. */
2698 !NILP (echo_area_buffer
[0])
2699 && (/* It's an echo from a different kboard. */
2700 echo_kboard
!= current_kboard
2701 /* Or we explicitly allow overwriting whatever there is. */
2702 || ok_to_echo_at_next_pause
== NULL
))
2707 /* Try reading a character via menu prompting in the minibuf.
2708 Try this before the sit-for, because the sit-for
2709 would do the wrong thing if we are supposed to do
2710 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2711 after a mouse event so don't try a minibuf menu. */
2713 if (KEYMAPP (map
) && INTERACTIVE
2714 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2715 /* Don't bring up a menu if we already have another event. */
2716 && NILP (Vunread_command_events
)
2717 && !detect_input_pending_run_timers (0))
2719 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2721 if (INTEGERP (c
) && XINT (c
) == -2)
2722 return c
; /* wrong_kboard_jmpbuf */
2728 /* Start idle timers if no time limit is supplied. We don't do it
2729 if a time limit is supplied to avoid an infinite recursion in the
2730 situation where an idle timer calls `sit-for'. */
2733 timer_start_idle ();
2735 /* If in middle of key sequence and minibuffer not active,
2736 start echoing if enough time elapses. */
2738 if (minibuf_level
== 0
2740 && !current_kboard
->immediate_echo
2741 && this_command_key_count
> 0
2743 && echo_keystrokes_p ()
2744 && (/* No message. */
2745 NILP (echo_area_buffer
[0])
2746 /* Or empty message. */
2747 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2748 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2749 /* Or already echoing from same kboard. */
2750 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2751 /* Or not echoing before and echoing allowed. */
2752 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2754 /* After a mouse event, start echoing right away.
2755 This is because we are probably about to display a menu,
2756 and we don't want to delay before doing so. */
2757 if (EVENT_HAS_PARAMETERS (prev_event
))
2763 save_getcjmp (save_jump
);
2764 restore_getcjmp (local_getcjmp
);
2765 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2766 restore_getcjmp (save_jump
);
2768 && ! CONSP (Vunread_command_events
))
2773 /* Maybe auto save due to number of keystrokes. */
2775 if (commandflag
!= 0 && commandflag
!= -2
2776 && auto_save_interval
> 0
2777 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2778 && !detect_input_pending_run_timers (0))
2780 Fdo_auto_save (Qnil
, Qnil
);
2781 /* Hooks can actually change some buffers in auto save. */
2785 /* Try reading using an X menu.
2786 This is never confused with reading using the minibuf
2787 because the recursive call of read_char in read_char_minibuf_menu_prompt
2788 does not pass on any keymaps. */
2790 if (KEYMAPP (map
) && INTERACTIVE
2791 && !NILP (prev_event
)
2792 && EVENT_HAS_PARAMETERS (prev_event
)
2793 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2794 && !EQ (XCAR (prev_event
), Qtool_bar
)
2795 /* Don't bring up a menu if we already have another event. */
2796 && NILP (Vunread_command_events
))
2798 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2800 /* Now that we have read an event, Emacs is not idle. */
2807 /* Maybe autosave and/or garbage collect due to idleness. */
2809 if (INTERACTIVE
&& NILP (c
))
2812 ptrdiff_t buffer_size
;
2814 /* Slow down auto saves logarithmically in size of current buffer,
2815 and garbage collect while we're at it. */
2816 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2817 last_non_minibuf_size
= Z
- BEG
;
2818 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2820 while (buffer_size
> 64)
2821 delay_level
++, buffer_size
-= buffer_size
>> 2;
2822 if (delay_level
< 4) delay_level
= 4;
2823 /* delay_level is 4 for files under around 50k, 7 at 100k,
2824 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2826 /* Auto save if enough time goes by without input. */
2827 if (commandflag
!= 0 && commandflag
!= -2
2828 && num_nonmacro_input_events
> last_auto_save
2829 && INTEGERP (Vauto_save_timeout
)
2830 && XINT (Vauto_save_timeout
) > 0)
2833 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2835 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2836 timeout
= delay_level
* timeout
/ 4;
2837 save_getcjmp (save_jump
);
2838 restore_getcjmp (local_getcjmp
);
2839 tem0
= sit_for (make_number (timeout
), 1, 1);
2840 restore_getcjmp (save_jump
);
2843 && ! CONSP (Vunread_command_events
))
2845 Fdo_auto_save (Qnil
, Qnil
);
2850 /* If there is still no input available, ask for GC. */
2851 if (!detect_input_pending_run_timers (0))
2852 GC_collect_a_little ();
2855 /* Notify the caller if an autosave hook, or a timer, sentinel or
2856 filter in the sit_for calls above have changed the current
2857 kboard. This could happen if they use the minibuffer or start a
2858 recursive edit, like the fancy splash screen in server.el's
2859 filter. If this longjmp wasn't here, read_key_sequence would
2860 interpret the next key sequence using the wrong translation
2861 tables and function keymaps. */
2862 if (NILP (c
) && current_kboard
!= orig_kboard
)
2865 return make_number (-2); /* wrong_kboard_jmpbuf */
2868 /* If this has become non-nil here, it has been set by a timer
2869 or sentinel or filter. */
2870 if (CONSP (Vunread_command_events
))
2872 c
= XCAR (Vunread_command_events
);
2873 Vunread_command_events
= XCDR (Vunread_command_events
);
2875 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2881 /* Read something from current KBOARD's side queue, if possible. */
2885 if (current_kboard
->kbd_queue_has_data
)
2887 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2889 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2890 kset_kbd_queue (current_kboard
,
2891 XCDR (KVAR (current_kboard
, kbd_queue
)));
2892 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2893 current_kboard
->kbd_queue_has_data
= 0;
2894 input_pending
= readable_events (0);
2895 if (EVENT_HAS_PARAMETERS (c
)
2896 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2897 internal_last_event_frame
= XCAR (XCDR (c
));
2898 Vlast_event_frame
= internal_last_event_frame
;
2902 /* If current_kboard's side queue is empty check the other kboards.
2903 If one of them has data that we have not yet seen here,
2904 switch to it and process the data waiting for it.
2906 Note: if the events queued up for another kboard
2907 have already been seen here, and therefore are not a complete command,
2908 the kbd_queue_has_data field is 0, so we skip that kboard here.
2909 That's to avoid an infinite loop switching between kboards here. */
2910 if (NILP (c
) && !single_kboard
)
2913 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2914 if (kb
->kbd_queue_has_data
)
2916 current_kboard
= kb
;
2917 /* This is going to exit from read_char
2918 so we had better get rid of this frame's stuff. */
2920 return make_number (-2); /* wrong_kboard_jmpbuf */
2930 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2931 prev_event
, used_mouse_menu
);
2932 if (NILP (c
) && end_time
2933 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2938 if (EQ (c
, make_number (-2)))
2940 /* This is going to exit from read_char
2941 so we had better get rid of this frame's stuff. */
2955 if (commandflag
>= 0
2956 && !input_pending
&& !detect_input_pending_run_timers (0))
2962 /* Buffer switch events are only for internal wakeups
2963 so don't show them to the user.
2964 Also, don't record a key if we already did. */
2968 /* Process special events within read_char
2969 and loop around to read another event. */
2972 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2977 struct buffer
*prev_buffer
= current_buffer
;
2978 last_input_event
= c
;
2979 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2981 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2982 /* We stopped being idle for this event; undo that. This
2983 prevents automatic window selection (under
2984 mouse_autoselect_window from acting as a real input event, for
2985 example banishing the mouse under mouse-avoidance-mode. */
2986 timer_resume_idle ();
2988 if (current_buffer
!= prev_buffer
)
2990 /* The command may have changed the keymaps. Pretend there
2991 is input in another keyboard and return. This will
2992 recalculate keymaps. */
2993 c
= make_number (-2);
3000 /* Handle things that only apply to characters. */
3003 /* If kbd_buffer_get_event gave us an EOF, return that. */
3007 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3008 && UNSIGNED_CMP (XFASTINT (c
), <,
3009 SCHARS (KVAR (current_kboard
,
3010 Vkeyboard_translate_table
))))
3011 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3012 && UNSIGNED_CMP (XFASTINT (c
), <,
3013 ASIZE (KVAR (current_kboard
,
3014 Vkeyboard_translate_table
))))
3015 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3019 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3020 /* nil in keyboard-translate-table means no translation. */
3026 /* If this event is a mouse click in the menu bar,
3027 return just menu-bar for now. Modify the mouse click event
3028 so we won't do this twice, then queue it up. */
3029 if (EVENT_HAS_PARAMETERS (c
)
3031 && CONSP (EVENT_START (c
))
3032 && CONSP (XCDR (EVENT_START (c
))))
3036 posn
= POSN_POSN (EVENT_START (c
));
3037 /* Handle menu-bar events:
3038 insert the dummy prefix event `menu-bar'. */
3039 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3041 /* Change menu-bar to (menu-bar) as the event "position". */
3042 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3045 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3050 /* Store these characters into recent_keys, the dribble file if any,
3051 and the keyboard macro being defined, if any. */
3053 if (! NILP (also_record
))
3054 record_char (also_record
);
3056 /* Wipe the echo area.
3057 But first, if we are about to use an input method,
3058 save the echo area contents for it to refer to. */
3060 && ! NILP (Vinput_method_function
)
3061 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3063 previous_echo_area_message
= Fcurrent_message ();
3064 Vinput_method_previous_message
= previous_echo_area_message
;
3067 /* Now wipe the echo area, except for help events which do their
3068 own stuff with the echo area. */
3070 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3071 && !(EQ (Qswitch_frame
, XCAR (c
)))
3072 /* Don't wipe echo area for select window events: These might
3073 get delayed via `mouse-autoselect-window' (Bug#11304). */
3074 && !(EQ (Qselect_window
, XCAR (c
)))))
3076 if (!NILP (echo_area_buffer
[0]))
3078 safe_run_hooks (Qecho_area_clear_hook
);
3079 clear_message (1, 0);
3083 reread_for_input_method
:
3085 /* Pass this to the input method, if appropriate. */
3087 && ! NILP (Vinput_method_function
)
3088 /* Don't run the input method within a key sequence,
3089 after the first event of the key sequence. */
3090 && NILP (prev_event
)
3091 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3094 ptrdiff_t key_count
;
3095 bool key_count_reset
;
3096 struct gcpro gcpro1
;
3098 /* Save the echo status. */
3099 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3100 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3101 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3102 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3107 if (before_command_restore_flag
)
3109 this_command_key_count
= before_command_key_count_1
;
3110 if (this_command_key_count
< this_single_command_key_start
)
3111 this_single_command_key_start
= this_command_key_count
;
3112 echo_truncate (before_command_echo_length_1
);
3113 before_command_restore_flag
= 0;
3117 /* Save the this_command_keys status. */
3118 key_count
= this_command_key_count
;
3119 key_count_reset
= this_command_key_count_reset
;
3122 keys
= Fcopy_sequence (this_command_keys
);
3127 /* Clear out this_command_keys. */
3128 this_command_key_count
= 0;
3129 this_command_key_count_reset
= 0;
3131 /* Now wipe the echo area. */
3132 if (!NILP (echo_area_buffer
[0]))
3133 safe_run_hooks (Qecho_area_clear_hook
);
3134 clear_message (1, 0);
3137 /* If we are not reading a key sequence,
3138 never use the echo area. */
3141 specbind (Qinput_method_use_echo_area
, Qt
);
3144 /* Call the input method. */
3145 tem
= call1 (Vinput_method_function
, c
);
3149 /* Restore the saved echoing state
3150 and this_command_keys state. */
3151 this_command_key_count
= key_count
;
3152 this_command_key_count_reset
= key_count_reset
;
3154 this_command_keys
= keys
;
3157 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3158 kset_echo_string (current_kboard
, saved_echo_string
);
3159 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3160 if (saved_immediate_echo
)
3165 /* The input method can return no events. */
3168 /* Bring back the previous message, if any. */
3169 if (! NILP (previous_echo_area_message
))
3170 message_with_string ("%s", previous_echo_area_message
, 0);
3173 /* It returned one event or more. */
3175 Vunread_post_input_method_events
3176 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3181 /* Display help if not echoing. */
3182 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3184 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3185 Lisp_Object help
, object
, position
, window
, htem
;
3187 htem
= Fcdr (XCDR (c
));
3190 window
= Fcar (htem
);
3192 object
= Fcar (htem
);
3194 position
= Fcar (htem
);
3196 show_help_echo (help
, window
, object
, position
);
3198 /* We stopped being idle for this event; undo that. */
3200 timer_resume_idle ();
3204 if ((! reread
|| this_command_key_count
== 0
3205 || this_command_key_count_reset
)
3209 /* Don't echo mouse motion events. */
3210 if (echo_keystrokes_p ()
3211 && ! (EVENT_HAS_PARAMETERS (c
)
3212 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3215 if (! NILP (also_record
))
3216 echo_char (also_record
);
3217 /* Once we reread a character, echoing can happen
3218 the next time we pause to read a new one. */
3219 ok_to_echo_at_next_pause
= current_kboard
;
3222 /* Record this character as part of the current key. */
3223 add_command_key (c
);
3224 if (! NILP (also_record
))
3225 add_command_key (also_record
);
3228 last_input_event
= c
;
3231 /* Process the help character specially if enabled. */
3232 if (!NILP (Vhelp_form
) && help_char_p (c
))
3236 help_form_saved_window_configs
3237 = Fcons (Fcurrent_window_configuration (Qnil
),
3238 help_form_saved_window_configs
);
3239 record_unwind_protect_void (read_char_help_form_unwind
);
3240 call0 (Qhelp_form_show
);
3245 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3246 if (EVENT_HAS_PARAMETERS (c
)
3247 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3248 XSETCAR (help_form_saved_window_configs
, Qnil
);
3250 while (BUFFERP (c
));
3251 /* Remove the help from the frame. */
3255 if (EQ (c
, make_number (040)))
3259 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3260 while (BUFFERP (c
));
3270 #undef used_mouse_menu
3274 #undef local_getcjmp
3276 #undef previous_echo_area_message
3279 #undef polling_stopped_here
3283 /* Record a key that came from a mouse menu.
3284 Record it for echoing, for this-command-keys, and so on. */
3287 record_menu_key (Lisp_Object c
)
3289 /* Wipe the echo area. */
3290 clear_message (1, 0);
3295 before_command_key_count
= this_command_key_count
;
3296 before_command_echo_length
= echo_length ();
3299 /* Don't echo mouse motion events. */
3300 if (echo_keystrokes_p ())
3304 /* Once we reread a character, echoing can happen
3305 the next time we pause to read a new one. */
3306 ok_to_echo_at_next_pause
= 0;
3309 /* Record this character as part of the current key. */
3310 add_command_key (c
);
3312 /* Re-reading in the middle of a command. */
3313 last_input_event
= c
;
3317 /* Return true if should recognize C as "the help character". */
3320 help_char_p (Lisp_Object c
)
3324 if (EQ (c
, Vhelp_char
))
3326 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3327 if (EQ (c
, XCAR (tail
)))
3332 /* Record the input event C in various ways. */
3335 record_char (Lisp_Object c
)
3339 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3341 /* To avoid filling recent_keys with help-echo and mouse-movement
3342 events, we filter out repeated help-echo events, only store the
3343 first and last in a series of mouse-movement events, and don't
3344 store repeated help-echo events which are only separated by
3345 mouse-movement events. */
3347 Lisp_Object ev1
, ev2
, ev3
;
3350 if ((ix1
= recent_keys_index
- 1) < 0)
3351 ix1
= NUM_RECENT_KEYS
- 1;
3352 ev1
= AREF (recent_keys
, ix1
);
3354 if ((ix2
= ix1
- 1) < 0)
3355 ix2
= NUM_RECENT_KEYS
- 1;
3356 ev2
= AREF (recent_keys
, ix2
);
3358 if ((ix3
= ix2
- 1) < 0)
3359 ix3
= NUM_RECENT_KEYS
- 1;
3360 ev3
= AREF (recent_keys
, ix3
);
3362 if (EQ (XCAR (c
), Qhelp_echo
))
3364 /* Don't record `help-echo' in recent_keys unless it shows some help
3365 message, and a different help than the previously recorded
3367 Lisp_Object help
, last_help
;
3369 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3370 if (!STRINGP (help
))
3372 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3373 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3375 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3376 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3377 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3379 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3380 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3381 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3382 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3385 else if (EQ (XCAR (c
), Qmouse_movement
))
3387 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3388 So additional mouse movement events replace the last element. */
3389 Lisp_Object last_window
, window
;
3391 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3392 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3393 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3394 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3395 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3397 ASET (recent_keys
, ix1
, c
);
3403 store_kbd_macro_char (c
);
3407 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3408 ASET (recent_keys
, recent_keys_index
, c
);
3409 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3410 recent_keys_index
= 0;
3412 else if (recorded
< 0)
3414 /* We need to remove one or two events from recent_keys.
3415 To do this, we simply put nil at those events and move the
3416 recent_keys_index backwards over those events. Usually,
3417 users will never see those nil events, as they will be
3418 overwritten by the command keys entered to see recent_keys
3421 while (recorded
++ < 0 && total_keys
> 0)
3423 if (total_keys
< NUM_RECENT_KEYS
)
3425 if (--recent_keys_index
< 0)
3426 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3427 ASET (recent_keys
, recent_keys_index
, Qnil
);
3431 num_nonmacro_input_events
++;
3433 /* Write c to the dribble file. If c is a lispy event, write
3434 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3435 If you, dear reader, have a better idea, you've got the source. :-) */
3441 if (XUINT (c
) < 0x100)
3442 putc (XUINT (c
), dribble
);
3444 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3448 Lisp_Object dribblee
;
3450 /* If it's a structured event, take the event header. */
3451 dribblee
= EVENT_HEAD (c
);
3453 if (SYMBOLP (dribblee
))
3455 putc ('<', dribble
);
3456 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3457 SBYTES (SYMBOL_NAME (dribblee
)),
3459 putc ('>', dribble
);
3468 /* Copy out or in the info on where C-g should throw to.
3469 This is used when running Lisp code from within get_char,
3470 in case get_char is called recursively.
3471 See read_process_output. */
3474 save_getcjmp (sys_jmp_buf
*temp
)
3476 memcpy (*temp
, getcjmp
, sizeof getcjmp
);
3480 restore_getcjmp (sys_jmp_buf
*temp
)
3482 memcpy (getcjmp
, *temp
, sizeof getcjmp
);
3485 /* Low level keyboard/mouse input.
3486 kbd_buffer_store_event places events in kbd_buffer, and
3487 kbd_buffer_get_event retrieves them. */
3489 /* Return true if there are any events in the queue that read-char
3490 would return. If this returns false, a read-char would block. */
3492 readable_events (int flags
)
3494 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3497 /* If the buffer contains only FOCUS_IN_EVENT events, and
3498 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3499 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3501 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3502 #ifdef USE_TOOLKIT_SCROLL_BARS
3503 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3507 struct input_event
*event
;
3509 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3516 #ifdef USE_TOOLKIT_SCROLL_BARS
3517 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3519 event
->kind
== FOCUS_IN_EVENT
)
3520 #ifdef USE_TOOLKIT_SCROLL_BARS
3521 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3522 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3523 && event
->part
== scroll_bar_handle
3524 && event
->modifiers
== 0)
3529 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3532 while (event
!= kbd_store_ptr
);
3538 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3539 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3543 if (current_kboard
->kbd_queue_has_data
)
3549 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3550 if (kb
->kbd_queue_has_data
)
3556 /* Set this for debugging, to have a way to get out */
3557 int stop_character EXTERNALLY_VISIBLE
;
3560 event_to_kboard (struct input_event
*event
)
3562 /* Not applicable for these special events. */
3563 if (event
->kind
== SELECTION_REQUEST_EVENT
3564 || event
->kind
== SELECTION_CLEAR_EVENT
)
3568 Lisp_Object obj
= event
->frame_or_window
;
3569 /* There are some events that set this field to nil or string. */
3571 obj
= WINDOW_FRAME (XWINDOW (obj
));
3572 /* Also ignore dead frames here. */
3573 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3574 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3579 /* Return the number of slots occupied in kbd_buffer. */
3582 kbd_buffer_nr_stored (void)
3584 return kbd_fetch_ptr
== kbd_store_ptr
3586 : (kbd_fetch_ptr
< kbd_store_ptr
3587 ? kbd_store_ptr
- kbd_fetch_ptr
3588 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3589 + (kbd_store_ptr
- kbd_buffer
)));
3591 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3594 kbd_buffer_store_event (register struct input_event
*event
)
3596 kbd_buffer_store_event_hold (event
, 0);
3599 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3601 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3602 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3603 Else, if EVENT is a quit event, store the quit event
3604 in HOLD_QUIT, and return (thus ignoring further events).
3606 This is used to postpone the processing of the quit event until all
3607 subsequent input events have been parsed (and discarded). */
3610 kbd_buffer_store_event_hold (register struct input_event
*event
,
3611 struct input_event
*hold_quit
)
3613 if (event
->kind
== NO_EVENT
)
3616 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3619 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3621 register int c
= event
->code
& 0377;
3623 if (event
->modifiers
& ctrl_modifier
)
3624 c
= make_ctrl_char (c
);
3626 c
|= (event
->modifiers
3627 & (meta_modifier
| alt_modifier
3628 | hyper_modifier
| super_modifier
));
3632 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3633 struct input_event
*sp
;
3635 if (single_kboard
&& kb
!= current_kboard
)
3638 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3640 kb
->kbd_queue_has_data
= 1;
3641 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3643 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3646 if (event_to_kboard (sp
) == kb
)
3648 sp
->kind
= NO_EVENT
;
3649 sp
->frame_or_window
= Qnil
;
3658 *hold_quit
= *event
;
3662 /* If this results in a quit_char being returned to Emacs as
3663 input, set Vlast_event_frame properly. If this doesn't
3664 get returned to Emacs as an event, the next event read
3665 will set Vlast_event_frame again, so this is safe to do. */
3669 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3671 focus
= event
->frame_or_window
;
3672 internal_last_event_frame
= focus
;
3673 Vlast_event_frame
= focus
;
3676 handle_interrupt (0);
3680 if (c
&& c
== stop_character
)
3686 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3687 Just ignore the second one. */
3688 else if (event
->kind
== BUFFER_SWITCH_EVENT
3689 && kbd_fetch_ptr
!= kbd_store_ptr
3690 && ((kbd_store_ptr
== kbd_buffer
3691 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3692 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3695 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3696 kbd_store_ptr
= kbd_buffer
;
3698 /* Don't let the very last slot in the buffer become full,
3699 since that would make the two pointers equal,
3700 and that is indistinguishable from an empty buffer.
3701 Discard the event if it would fill the last slot. */
3702 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3704 *kbd_store_ptr
= *event
;
3707 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3708 && ! kbd_on_hold_p ())
3710 /* Don't read keyboard input until we have processed kbd_buffer.
3711 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3712 hold_keyboard_input ();
3713 if (!noninteractive
)
3717 #endif /* subprocesses */
3720 /* If we're inside while-no-input, and this event qualifies
3721 as input, set quit-flag to cause an interrupt. */
3722 if (!NILP (Vthrow_on_input
)
3723 && event
->kind
!= FOCUS_IN_EVENT
3724 && event
->kind
!= HELP_EVENT
3725 && event
->kind
!= DEICONIFY_EVENT
)
3727 Vquit_flag
= Vthrow_on_input
;
3728 /* If we're inside a function that wants immediate quits,
3730 if (immediate_quit
&& NILP (Vinhibit_quit
))
3739 /* Put an input event back in the head of the event queue. */
3742 kbd_buffer_unget_event (register struct input_event
*event
)
3744 if (kbd_fetch_ptr
== kbd_buffer
)
3745 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3747 /* Don't let the very last slot in the buffer become full, */
3748 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3751 *kbd_fetch_ptr
= *event
;
3756 /* Generate a HELP_EVENT input_event and store it in the keyboard
3759 HELP is the help form.
3761 FRAME and WINDOW are the frame and window where the help is
3762 generated. OBJECT is the Lisp object where the help was found (a
3763 buffer, a string, an overlay, or nil if neither from a string nor
3764 from a buffer). POS is the position within OBJECT where the help
3768 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3769 Lisp_Object object
, ptrdiff_t pos
)
3771 struct input_event event
;
3775 event
.kind
= HELP_EVENT
;
3776 event
.frame_or_window
= frame
;
3778 event
.x
= WINDOWP (window
) ? window
: frame
;
3781 kbd_buffer_store_event (&event
);
3785 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3788 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3790 struct input_event event
;
3792 event
.kind
= HELP_EVENT
;
3793 event
.frame_or_window
= frame
;
3798 kbd_buffer_store_event (&event
);
3802 /* Discard any mouse events in the event buffer by setting them to
3805 discard_mouse_events (void)
3807 struct input_event
*sp
;
3808 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3810 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3813 if (sp
->kind
== MOUSE_CLICK_EVENT
3814 || sp
->kind
== WHEEL_EVENT
3815 || sp
->kind
== HORIZ_WHEEL_EVENT
3817 || sp
->kind
== GPM_CLICK_EVENT
3819 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3821 sp
->kind
= NO_EVENT
;
3827 /* Return true if there are any real events waiting in the event
3828 buffer, not counting `NO_EVENT's.
3830 Discard NO_EVENT events at the front of the input queue, possibly
3831 leaving the input queue empty if there are no real input events. */
3834 kbd_buffer_events_waiting (void)
3836 struct input_event
*sp
;
3838 for (sp
= kbd_fetch_ptr
;
3839 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3842 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3847 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3851 /* Clear input event EVENT. */
3854 clear_event (struct input_event
*event
)
3856 event
->kind
= NO_EVENT
;
3860 /* Read one event from the event buffer, waiting if necessary.
3861 The value is a Lisp object representing the event.
3862 The value is nil for an event that should be ignored,
3863 or that was handled here.
3864 We always read and discard one event. */
3867 kbd_buffer_get_event (KBOARD
**kbp
,
3868 bool *used_mouse_menu
,
3869 struct timespec
*end_time
)
3874 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3876 /* Start reading input again because we have processed enough to
3877 be able to accept new events again. */
3878 unhold_keyboard_input ();
3881 #endif /* subprocesses */
3883 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3885 /* In case we are running as a daemon, only do this before
3886 detaching from the terminal. */
3887 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3891 *kbp
= current_kboard
;
3894 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3896 /* Wait until there is input available. */
3899 /* Break loop if there's an unread command event. Needed in
3900 moused window autoselection which uses a timer to insert such
3902 if (CONSP (Vunread_command_events
))
3905 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3907 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3910 /* If the quit flag is set, then read_char will return
3911 quit_char, so that counts as "available input." */
3912 if (!NILP (Vquit_flag
))
3913 quit_throw_to_read_char (0);
3915 /* One way or another, wait until input is available; then, if
3916 interrupt handlers have not read it, read it now. */
3921 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3923 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3927 struct timespec now
= current_timespec ();
3928 if (timespec_cmp (*end_time
, now
) <= 0)
3929 return Qnil
; /* Finished waiting. */
3932 struct timespec duration
= timespec_sub (*end_time
, now
);
3933 wait_reading_process_output (min (duration
.tv_sec
,
3936 -1, 1, Qnil
, NULL
, 0);
3941 bool do_display
= true;
3943 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3945 struct tty_display_info
*tty
= CURTTY ();
3947 /* When this TTY is displaying a menu, we must prevent
3948 any redisplay, because we modify the frame's glyph
3949 matrix behind the back of the display engine. */
3950 if (tty
->showing_menu
)
3954 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3957 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3961 if (CONSP (Vunread_command_events
))
3964 first
= XCAR (Vunread_command_events
);
3965 Vunread_command_events
= XCDR (Vunread_command_events
);
3966 *kbp
= current_kboard
;
3970 /* At this point, we know that there is a readable event available
3971 somewhere. If the event queue is empty, then there must be a
3972 mouse movement enabled and available. */
3973 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3975 struct input_event
*event
;
3977 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3981 *kbp
= event_to_kboard (event
);
3983 *kbp
= current_kboard
; /* Better than returning null ptr? */
3987 /* These two kinds of events get special handling
3988 and don't actually appear to the command loop.
3989 We return nil for them. */
3990 if (event
->kind
== SELECTION_REQUEST_EVENT
3991 || event
->kind
== SELECTION_CLEAR_EVENT
)
3994 struct input_event copy
;
3996 /* Remove it from the buffer before processing it,
3997 since otherwise swallow_events will see it
3998 and process it again. */
4000 kbd_fetch_ptr
= event
+ 1;
4001 input_pending
= readable_events (0);
4002 x_handle_selection_event (©
);
4004 /* We're getting selection request events, but we don't have
4010 #if defined (HAVE_NS)
4011 else if (event
->kind
== NS_TEXT_EVENT
)
4013 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4014 obj
= list1 (intern ("ns-put-working-text"));
4016 obj
= list1 (intern ("ns-unput-working-text"));
4017 kbd_fetch_ptr
= event
+ 1;
4018 if (used_mouse_menu
)
4019 *used_mouse_menu
= 1;
4023 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4024 || defined (HAVE_NS)
4025 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4027 /* Make an event (delete-frame (FRAME)). */
4028 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4029 kbd_fetch_ptr
= event
+ 1;
4032 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4033 || defined (HAVE_NS)
4034 else if (event
->kind
== ICONIFY_EVENT
)
4036 /* Make an event (iconify-frame (FRAME)). */
4037 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4038 kbd_fetch_ptr
= event
+ 1;
4040 else if (event
->kind
== DEICONIFY_EVENT
)
4042 /* Make an event (make-frame-visible (FRAME)). */
4043 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4044 kbd_fetch_ptr
= event
+ 1;
4047 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4049 /* The value doesn't matter here; only the type is tested. */
4050 XSETBUFFER (obj
, current_buffer
);
4051 kbd_fetch_ptr
= event
+ 1;
4053 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4054 || defined (HAVE_NS) || defined (USE_GTK)
4055 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4057 kbd_fetch_ptr
= event
+ 1;
4058 input_pending
= readable_events (0);
4059 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4060 x_activate_menubar (XFRAME (event
->frame_or_window
));
4064 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4066 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4067 obj
= list4 (Qlanguage_change
,
4068 event
->frame_or_window
,
4069 make_number (event
->code
),
4070 make_number (event
->modifiers
));
4071 kbd_fetch_ptr
= event
+ 1;
4074 #ifdef USE_FILE_NOTIFY
4075 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4077 #ifdef HAVE_W32NOTIFY
4078 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4079 obj
= list3 (Qfile_notify
,
4080 list3 (make_number (event
->code
),
4083 event
->frame_or_window
);
4085 obj
= make_lispy_event (event
);
4087 kbd_fetch_ptr
= event
+ 1;
4089 #endif /* USE_FILE_NOTIFY */
4090 else if (event
->kind
== SAVE_SESSION_EVENT
)
4092 obj
= list2 (Qsave_session
, event
->arg
);
4093 kbd_fetch_ptr
= event
+ 1;
4095 /* Just discard these, by returning nil.
4096 With MULTI_KBOARD, these events are used as placeholders
4097 when we need to randomly delete events from the queue.
4098 (They shouldn't otherwise be found in the buffer,
4099 but on some machines it appears they do show up
4100 even without MULTI_KBOARD.) */
4101 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4102 mouse events during a popup-menu call. */
4103 else if (event
->kind
== NO_EVENT
)
4104 kbd_fetch_ptr
= event
+ 1;
4105 else if (event
->kind
== HELP_EVENT
)
4107 Lisp_Object object
, position
, help
, frame
, window
;
4109 frame
= event
->frame_or_window
;
4110 object
= event
->arg
;
4111 position
= make_number (event
->code
);
4114 clear_event (event
);
4116 kbd_fetch_ptr
= event
+ 1;
4117 if (!WINDOWP (window
))
4119 obj
= Fcons (Qhelp_echo
,
4120 list5 (frame
, help
, window
, object
, position
));
4122 else if (event
->kind
== FOCUS_IN_EVENT
)
4124 /* Notification of a FocusIn event. The frame receiving the
4125 focus is in event->frame_or_window. Generate a
4126 switch-frame event if necessary. */
4127 Lisp_Object frame
, focus
;
4129 frame
= event
->frame_or_window
;
4130 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4139 !EQ (frame
, internal_last_event_frame
)
4140 && !EQ (frame
, selected_frame
))
4141 obj
= make_lispy_switch_frame (frame
);
4143 obj
= make_lispy_focus_in (frame
);
4145 internal_last_event_frame
= frame
;
4146 kbd_fetch_ptr
= event
+ 1;
4148 else if (event
->kind
== FOCUS_OUT_EVENT
)
4150 #ifdef HAVE_WINDOW_SYSTEM
4153 Lisp_Object frame
= event
->frame_or_window
;
4154 bool focused
= false;
4156 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4157 focused
= di
->x_highlight_frame
!= 0;
4160 obj
= make_lispy_focus_out (frame
);
4162 #endif /* HAVE_WINDOW_SYSTEM */
4164 kbd_fetch_ptr
= event
+ 1;
4167 else if (event
->kind
== DBUS_EVENT
)
4169 obj
= make_lispy_event (event
);
4170 kbd_fetch_ptr
= event
+ 1;
4173 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4175 obj
= make_lispy_event (event
);
4176 kbd_fetch_ptr
= event
+ 1;
4180 /* If this event is on a different frame, return a switch-frame this
4181 time, and leave the event in the queue for next time. */
4185 frame
= event
->frame_or_window
;
4187 frame
= XCAR (frame
);
4188 else if (WINDOWP (frame
))
4189 frame
= WINDOW_FRAME (XWINDOW (frame
));
4191 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4195 if (! EQ (frame
, internal_last_event_frame
)
4196 && !EQ (frame
, selected_frame
))
4197 obj
= make_lispy_switch_frame (frame
);
4198 internal_last_event_frame
= frame
;
4200 /* If we didn't decide to make a switch-frame event, go ahead
4201 and build a real event from the queue entry. */
4205 obj
= make_lispy_event (event
);
4207 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4208 || defined (HAVE_NS) || defined (USE_GTK)
4209 /* If this was a menu selection, then set the flag to inhibit
4210 writing to last_nonmenu_event. Don't do this if the event
4211 we're returning is (menu-bar), though; that indicates the
4212 beginning of the menu sequence, and we might as well leave
4213 that as the `event with parameters' for this selection. */
4215 && !EQ (event
->frame_or_window
, event
->arg
)
4216 && (event
->kind
== MENU_BAR_EVENT
4217 || event
->kind
== TOOL_BAR_EVENT
))
4218 *used_mouse_menu
= 1;
4221 /* Certain system events are non-key events. */
4223 && event
->kind
== NS_NONKEY_EVENT
)
4224 *used_mouse_menu
= 1;
4227 /* Wipe out this event, to catch bugs. */
4228 clear_event (event
);
4229 kbd_fetch_ptr
= event
+ 1;
4233 /* Try generating a mouse motion event. */
4234 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4236 struct frame
*f
= some_mouse_moved ();
4237 Lisp_Object bar_window
;
4238 enum scroll_bar_part part
;
4242 *kbp
= current_kboard
;
4243 /* Note that this uses F to determine which terminal to look at.
4244 If there is no valid info, it does not store anything
4245 so x remains nil. */
4248 /* XXX Can f or mouse_position_hook be NULL here? */
4249 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4250 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4255 /* Decide if we should generate a switch-frame event. Don't
4256 generate switch-frame events for motion outside of all Emacs
4262 frame
= FRAME_FOCUS_FRAME (f
);
4264 XSETFRAME (frame
, f
);
4266 if (! EQ (frame
, internal_last_event_frame
)
4267 && !EQ (frame
, selected_frame
))
4268 obj
= make_lispy_switch_frame (frame
);
4269 internal_last_event_frame
= frame
;
4272 /* If we didn't decide to make a switch-frame event, go ahead and
4273 return a mouse-motion event. */
4274 if (!NILP (x
) && NILP (obj
))
4275 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4278 /* We were promised by the above while loop that there was
4279 something for us to read! */
4282 input_pending
= readable_events (0);
4284 Vlast_event_frame
= internal_last_event_frame
;
4289 /* Process any non-user-visible events (currently X selection events),
4290 without reading any user-visible events. */
4293 process_special_events (void)
4295 struct input_event
*event
;
4297 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4299 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4302 if (event
== kbd_store_ptr
)
4306 /* If we find a stored X selection request, handle it now. */
4307 if (event
->kind
== SELECTION_REQUEST_EVENT
4308 || event
->kind
== SELECTION_CLEAR_EVENT
)
4312 /* Remove the event from the fifo buffer before processing;
4313 otherwise swallow_events called recursively could see it
4314 and process it again. To do this, we move the events
4315 between kbd_fetch_ptr and EVENT one slot to the right,
4318 struct input_event copy
= *event
;
4319 struct input_event
*beg
4320 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4321 ? kbd_buffer
: kbd_fetch_ptr
;
4324 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4325 else if (event
< beg
)
4327 if (event
> kbd_buffer
)
4328 memmove (kbd_buffer
+ 1, kbd_buffer
,
4329 (event
- kbd_buffer
) * sizeof (struct input_event
));
4330 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4331 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4332 memmove (beg
+ 1, beg
,
4333 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4334 * sizeof (struct input_event
));
4337 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4338 kbd_fetch_ptr
= kbd_buffer
+ 1;
4342 input_pending
= readable_events (0);
4343 x_handle_selection_event (©
);
4345 /* We're getting selection request events, but we don't have
4353 /* Process any events that are not user-visible, run timer events that
4354 are ripe, and return, without reading any user-visible events. */
4357 swallow_events (bool do_display
)
4359 unsigned old_timers_run
;
4361 process_special_events ();
4363 old_timers_run
= timers_run
;
4364 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4366 if (timers_run
!= old_timers_run
&& do_display
)
4367 redisplay_preserve_echo_area (7);
4370 /* Record the start of when Emacs is idle,
4371 for the sake of running idle-time timers. */
4374 timer_start_idle (void)
4376 /* If we are already in the idle state, do nothing. */
4377 if (timespec_valid_p (timer_idleness_start_time
))
4380 timer_idleness_start_time
= current_timespec ();
4381 timer_last_idleness_start_time
= timer_idleness_start_time
;
4383 /* Mark all idle-time timers as once again candidates for running. */
4384 call0 (intern ("internal-timer-start-idle"));
4387 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4390 timer_stop_idle (void)
4392 timer_idleness_start_time
= invalid_timespec ();
4395 /* Resume idle timer from last idle start time. */
4398 timer_resume_idle (void)
4400 if (timespec_valid_p (timer_idleness_start_time
))
4403 timer_idleness_start_time
= timer_last_idleness_start_time
;
4406 /* This is only for debugging. */
4407 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4409 /* List of elisp functions to call, delayed because they were generated in
4410 a context where Elisp could not be safely run (e.g. redisplay, signal,
4411 ...). Each element has the form (FUN . ARGS). */
4412 Lisp_Object pending_funcalls
;
4414 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4416 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4418 Lisp_Object
*vector
;
4420 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4422 vector
= XVECTOR (timer
)->contents
;
4423 if (! NILP (vector
[0]))
4426 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4431 /* Check whether a timer has fired. To prevent larger problems we simply
4432 disregard elements that are not proper timers. Do not make a circular
4433 timer list for the time being.
4435 Returns the time to wait until the next timer fires. If a
4436 timer is triggering now, return zero.
4437 If no timer is active, return -1.
4439 If a timer is ripe, we run it, with quitting turned off.
4440 In that case we return 0 to indicate that a new timer_check_2 call
4443 static struct timespec
4444 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4446 struct timespec nexttime
;
4447 struct timespec now
;
4448 struct timespec idleness_now
;
4449 Lisp_Object chosen_timer
;
4450 struct gcpro gcpro1
;
4452 nexttime
= invalid_timespec ();
4454 chosen_timer
= Qnil
;
4455 GCPRO1 (chosen_timer
);
4457 /* First run the code that was delayed. */
4458 while (CONSP (pending_funcalls
))
4460 Lisp_Object funcall
= XCAR (pending_funcalls
);
4461 pending_funcalls
= XCDR (pending_funcalls
);
4462 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4465 if (CONSP (timers
) || CONSP (idle_timers
))
4467 now
= current_timespec ();
4468 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4469 ? timespec_sub (now
, timer_idleness_start_time
)
4470 : make_timespec (0, 0));
4473 while (CONSP (timers
) || CONSP (idle_timers
))
4475 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4476 struct timespec timer_time
, idle_timer_time
;
4477 struct timespec difference
;
4478 struct timespec timer_difference
= invalid_timespec ();
4479 struct timespec idle_timer_difference
= invalid_timespec ();
4480 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4482 /* Set TIMER and TIMER_DIFFERENCE
4483 based on the next ordinary timer.
4484 TIMER_DIFFERENCE is the distance in time from NOW to when
4485 this timer becomes ripe (negative if it's already ripe).
4486 Skip past invalid timers and timers already handled. */
4489 timer
= XCAR (timers
);
4490 if (! decode_timer (timer
, &timer_time
))
4492 timers
= XCDR (timers
);
4496 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4497 timer_difference
= (timer_ripe
4498 ? timespec_sub (now
, timer_time
)
4499 : timespec_sub (timer_time
, now
));
4502 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4503 based on the next idle timer. */
4504 if (CONSP (idle_timers
))
4506 idle_timer
= XCAR (idle_timers
);
4507 if (! decode_timer (idle_timer
, &idle_timer_time
))
4509 idle_timers
= XCDR (idle_timers
);
4513 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4514 idle_timer_difference
4516 ? timespec_sub (idleness_now
, idle_timer_time
)
4517 : timespec_sub (idle_timer_time
, idleness_now
));
4520 /* Decide which timer is the next timer,
4521 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4522 Also step down the list where we found that timer. */
4524 if (timespec_valid_p (timer_difference
)
4525 && (! timespec_valid_p (idle_timer_difference
)
4526 || idle_timer_ripe
< timer_ripe
4527 || (idle_timer_ripe
== timer_ripe
4529 ? timespec_cmp (idle_timer_difference
,
4531 : timespec_cmp (timer_difference
,
4532 idle_timer_difference
))
4535 chosen_timer
= timer
;
4536 timers
= XCDR (timers
);
4537 difference
= timer_difference
;
4542 chosen_timer
= idle_timer
;
4543 idle_timers
= XCDR (idle_timers
);
4544 difference
= idle_timer_difference
;
4545 ripe
= idle_timer_ripe
;
4548 /* If timer is ripe, run it if it hasn't been run. */
4551 if (NILP (AREF (chosen_timer
, 0)))
4553 ptrdiff_t count
= SPECPDL_INDEX ();
4554 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4556 /* Mark the timer as triggered to prevent problems if the lisp
4557 code fails to reschedule it right. */
4558 ASET (chosen_timer
, 0, Qt
);
4560 specbind (Qinhibit_quit
, Qt
);
4562 call1 (Qtimer_event_handler
, chosen_timer
);
4563 Vdeactivate_mark
= old_deactivate_mark
;
4565 unbind_to (count
, Qnil
);
4567 /* Since we have handled the event,
4568 we don't need to tell the caller to wake up and do it. */
4569 /* But the caller must still wait for the next timer, so
4570 return 0 to indicate that. */
4573 nexttime
= make_timespec (0, 0);
4577 /* When we encounter a timer that is still waiting,
4578 return the amount of time to wait before it is ripe. */
4585 /* No timers are pending in the future. */
4586 /* Return 0 if we generated an event, and -1 if not. */
4592 /* Check whether a timer has fired. To prevent larger problems we simply
4593 disregard elements that are not proper timers. Do not make a circular
4594 timer list for the time being.
4596 Returns the time to wait until the next timer fires.
4597 If no timer is active, return an invalid value.
4599 As long as any timer is ripe, we run it. */
4604 struct timespec nexttime
;
4605 Lisp_Object timers
, idle_timers
;
4606 struct gcpro gcpro1
, gcpro2
;
4608 Lisp_Object tem
= Vinhibit_quit
;
4611 /* We use copies of the timers' lists to allow a timer to add itself
4612 again, without locking up Emacs if the newly added timer is
4613 already ripe when added. */
4615 /* Always consider the ordinary timers. */
4616 timers
= Fcopy_sequence (Vtimer_list
);
4617 /* Consider the idle timers only if Emacs is idle. */
4618 if (timespec_valid_p (timer_idleness_start_time
))
4619 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4623 Vinhibit_quit
= tem
;
4625 GCPRO2 (timers
, idle_timers
);
4629 nexttime
= timer_check_2 (timers
, idle_timers
);
4631 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4637 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4638 doc
: /* Return the current length of Emacs idleness, or nil.
4639 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4640 in the same style as (current-time).
4642 The value when Emacs is not idle is nil.
4644 PSEC is a multiple of the system clock resolution. */)
4647 if (timespec_valid_p (timer_idleness_start_time
))
4648 return make_lisp_time (timespec_sub (current_timespec (),
4649 timer_idleness_start_time
));
4654 /* Caches for modify_event_symbol. */
4655 static Lisp_Object accent_key_syms
;
4656 static Lisp_Object func_key_syms
;
4657 static Lisp_Object mouse_syms
;
4658 static Lisp_Object wheel_syms
;
4659 static Lisp_Object drag_n_drop_syms
;
4661 /* This is a list of keysym codes for special "accent" characters.
4662 It parallels lispy_accent_keys. */
4664 static const int lispy_accent_codes
[] =
4666 #ifdef XK_dead_circumflex
4671 #ifdef XK_dead_grave
4676 #ifdef XK_dead_tilde
4681 #ifdef XK_dead_diaeresis
4686 #ifdef XK_dead_macron
4691 #ifdef XK_dead_degree
4696 #ifdef XK_dead_acute
4701 #ifdef XK_dead_cedilla
4706 #ifdef XK_dead_breve
4711 #ifdef XK_dead_ogonek
4716 #ifdef XK_dead_caron
4721 #ifdef XK_dead_doubleacute
4722 XK_dead_doubleacute
,
4726 #ifdef XK_dead_abovedot
4731 #ifdef XK_dead_abovering
4741 #ifdef XK_dead_belowdot
4746 #ifdef XK_dead_voiced_sound
4747 XK_dead_voiced_sound
,
4751 #ifdef XK_dead_semivoiced_sound
4752 XK_dead_semivoiced_sound
,
4768 /* This is a list of Lisp names for special "accent" characters.
4769 It parallels lispy_accent_codes. */
4771 static const char *const lispy_accent_keys
[] =
4789 "dead-voiced-sound",
4790 "dead-semivoiced-sound",
4796 #define FUNCTION_KEY_OFFSET 0x0
4798 const char *const lispy_function_keys
[] =
4802 0, /* VK_LBUTTON 0x01 */
4803 0, /* VK_RBUTTON 0x02 */
4804 "cancel", /* VK_CANCEL 0x03 */
4805 0, /* VK_MBUTTON 0x04 */
4807 0, 0, 0, /* 0x05 .. 0x07 */
4809 "backspace", /* VK_BACK 0x08 */
4810 "tab", /* VK_TAB 0x09 */
4812 0, 0, /* 0x0A .. 0x0B */
4814 "clear", /* VK_CLEAR 0x0C */
4815 "return", /* VK_RETURN 0x0D */
4817 0, 0, /* 0x0E .. 0x0F */
4819 0, /* VK_SHIFT 0x10 */
4820 0, /* VK_CONTROL 0x11 */
4821 0, /* VK_MENU 0x12 */
4822 "pause", /* VK_PAUSE 0x13 */
4823 "capslock", /* VK_CAPITAL 0x14 */
4824 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4826 "junja", /* VK_JUNJA 0x17 */
4827 "final", /* VK_FINAL 0x18 */
4828 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4830 "escape", /* VK_ESCAPE 0x1B */
4831 "convert", /* VK_CONVERT 0x1C */
4832 "non-convert", /* VK_NONCONVERT 0x1D */
4833 "accept", /* VK_ACCEPT 0x1E */
4834 "mode-change", /* VK_MODECHANGE 0x1F */
4835 0, /* VK_SPACE 0x20 */
4836 "prior", /* VK_PRIOR 0x21 */
4837 "next", /* VK_NEXT 0x22 */
4838 "end", /* VK_END 0x23 */
4839 "home", /* VK_HOME 0x24 */
4840 "left", /* VK_LEFT 0x25 */
4841 "up", /* VK_UP 0x26 */
4842 "right", /* VK_RIGHT 0x27 */
4843 "down", /* VK_DOWN 0x28 */
4844 "select", /* VK_SELECT 0x29 */
4845 "print", /* VK_PRINT 0x2A */
4846 "execute", /* VK_EXECUTE 0x2B */
4847 "snapshot", /* VK_SNAPSHOT 0x2C */
4848 "insert", /* VK_INSERT 0x2D */
4849 "delete", /* VK_DELETE 0x2E */
4850 "help", /* VK_HELP 0x2F */
4852 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4854 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4856 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4858 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4860 0, 0, 0, 0, 0, 0, 0, 0, 0,
4861 0, 0, 0, 0, 0, 0, 0, 0, 0,
4862 0, 0, 0, 0, 0, 0, 0, 0,
4864 "lwindow", /* VK_LWIN 0x5B */
4865 "rwindow", /* VK_RWIN 0x5C */
4866 "apps", /* VK_APPS 0x5D */
4869 "kp-0", /* VK_NUMPAD0 0x60 */
4870 "kp-1", /* VK_NUMPAD1 0x61 */
4871 "kp-2", /* VK_NUMPAD2 0x62 */
4872 "kp-3", /* VK_NUMPAD3 0x63 */
4873 "kp-4", /* VK_NUMPAD4 0x64 */
4874 "kp-5", /* VK_NUMPAD5 0x65 */
4875 "kp-6", /* VK_NUMPAD6 0x66 */
4876 "kp-7", /* VK_NUMPAD7 0x67 */
4877 "kp-8", /* VK_NUMPAD8 0x68 */
4878 "kp-9", /* VK_NUMPAD9 0x69 */
4879 "kp-multiply", /* VK_MULTIPLY 0x6A */
4880 "kp-add", /* VK_ADD 0x6B */
4881 "kp-separator", /* VK_SEPARATOR 0x6C */
4882 "kp-subtract", /* VK_SUBTRACT 0x6D */
4883 "kp-decimal", /* VK_DECIMAL 0x6E */
4884 "kp-divide", /* VK_DIVIDE 0x6F */
4885 "f1", /* VK_F1 0x70 */
4886 "f2", /* VK_F2 0x71 */
4887 "f3", /* VK_F3 0x72 */
4888 "f4", /* VK_F4 0x73 */
4889 "f5", /* VK_F5 0x74 */
4890 "f6", /* VK_F6 0x75 */
4891 "f7", /* VK_F7 0x76 */
4892 "f8", /* VK_F8 0x77 */
4893 "f9", /* VK_F9 0x78 */
4894 "f10", /* VK_F10 0x79 */
4895 "f11", /* VK_F11 0x7A */
4896 "f12", /* VK_F12 0x7B */
4897 "f13", /* VK_F13 0x7C */
4898 "f14", /* VK_F14 0x7D */
4899 "f15", /* VK_F15 0x7E */
4900 "f16", /* VK_F16 0x7F */
4901 "f17", /* VK_F17 0x80 */
4902 "f18", /* VK_F18 0x81 */
4903 "f19", /* VK_F19 0x82 */
4904 "f20", /* VK_F20 0x83 */
4905 "f21", /* VK_F21 0x84 */
4906 "f22", /* VK_F22 0x85 */
4907 "f23", /* VK_F23 0x86 */
4908 "f24", /* VK_F24 0x87 */
4910 0, 0, 0, 0, /* 0x88 .. 0x8B */
4911 0, 0, 0, 0, /* 0x8C .. 0x8F */
4913 "kp-numlock", /* VK_NUMLOCK 0x90 */
4914 "scroll", /* VK_SCROLL 0x91 */
4915 /* Not sure where the following block comes from.
4916 Windows headers have NEC and Fujitsu specific keys in
4917 this block, but nothing generic. */
4918 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4919 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4920 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4921 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4922 "kp-end", /* VK_NUMPAD_END 0x96 */
4923 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4924 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4925 "kp-up", /* VK_NUMPAD_UP 0x99 */
4926 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4927 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4928 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4929 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4931 0, 0, /* 0x9E .. 0x9F */
4934 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4935 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4936 * No other API or message will distinguish left and right keys this way.
4941 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4942 to enable them selectively, and gives access to a few more functions.
4943 See lispy_multimedia_keys below. */
4944 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4945 0, 0, 0, /* 0xAD .. 0xAF Volume */
4946 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4947 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4949 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4950 0, 0, 0, 0, 0, 0, 0, 0, 0,
4952 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4953 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4954 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4957 "ax", /* VK_OEM_AX 0xE1 */
4958 0, /* VK_OEM_102 0xE2 */
4959 "ico-help", /* VK_ICO_HELP 0xE3 */
4960 "ico-00", /* VK_ICO_00 0xE4 */
4961 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4962 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4963 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4965 "reset", /* VK_OEM_RESET 0xE9 */
4966 "jump", /* VK_OEM_JUMP 0xEA */
4967 "oem-pa1", /* VK_OEM_PA1 0xEB */
4968 "oem-pa2", /* VK_OEM_PA2 0xEC */
4969 "oem-pa3", /* VK_OEM_PA3 0xED */
4970 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4971 "cusel", /* VK_OEM_CUSEL 0xEF */
4972 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4973 "finish", /* VK_OEM_FINISH 0xF1 */
4974 "copy", /* VK_OEM_COPY 0xF2 */
4975 "auto", /* VK_OEM_AUTO 0xF3 */
4976 "enlw", /* VK_OEM_ENLW 0xF4 */
4977 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4978 "attn", /* VK_ATTN 0xF6 */
4979 "crsel", /* VK_CRSEL 0xF7 */
4980 "exsel", /* VK_EXSEL 0xF8 */
4981 "ereof", /* VK_EREOF 0xF9 */
4982 "play", /* VK_PLAY 0xFA */
4983 "zoom", /* VK_ZOOM 0xFB */
4984 "noname", /* VK_NONAME 0xFC */
4985 "pa1", /* VK_PA1 0xFD */
4986 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4990 /* Some of these duplicate the "Media keys" on newer keyboards,
4991 but they are delivered to the application in a different way. */
4992 static const char *const lispy_multimedia_keys
[] =
5000 "browser-favorites",
5037 "toggle-dictate-command",
5043 "media-fast-forward",
5046 "media-channel-down"
5049 #else /* not HAVE_NTGUI */
5051 /* This should be dealt with in XTread_socket now, and that doesn't
5052 depend on the client system having the Kana syms defined. See also
5053 the XK_kana_A case below. */
5056 static const char *const lispy_kana_keys
[] =
5058 /* X Keysym value */
5059 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5060 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5061 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5062 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5063 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5064 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5065 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5066 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5069 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5070 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5071 "kana-i", "kana-u", "kana-e", "kana-o",
5072 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5073 "prolongedsound", "kana-A", "kana-I", "kana-U",
5074 "kana-E", "kana-O", "kana-KA", "kana-KI",
5075 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5076 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5077 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5078 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5079 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5080 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5081 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5082 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5083 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5084 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5085 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5086 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5088 #endif /* XK_kana_A */
5091 #define FUNCTION_KEY_OFFSET 0xff00
5093 /* You'll notice that this table is arranged to be conveniently
5094 indexed by X Windows keysym values. */
5095 static const char *const lispy_function_keys
[] =
5097 /* X Keysym value */
5099 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5100 "backspace", "tab", "linefeed", "clear",
5102 0, 0, 0, "pause", /* 0xff10...1f */
5103 0, 0, 0, 0, 0, 0, 0, "escape",
5105 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5106 "romaji", "hiragana", "katakana", "hiragana-katakana",
5107 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5108 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5109 "eisu-toggle", /* 0xff30...3f */
5110 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5111 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5113 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5114 "down", "prior", "next", "end",
5115 "begin", 0, 0, 0, 0, 0, 0, 0,
5116 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5127 "break", /* 0xff6b */
5130 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5131 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5132 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5133 0, 0, 0, 0, 0, 0, 0, 0,
5134 "kp-tab", /* 0xff89 */
5136 "kp-enter", /* 0xff8d */
5138 "kp-f1", /* 0xff91 */
5142 "kp-home", /* 0xff95 */
5147 "kp-prior", /* kp-page-up */
5148 "kp-next", /* kp-page-down */
5154 0, 0, 0, 0, 0, 0, 0, 0, 0,
5155 "kp-multiply", /* 0xffaa */
5160 "kp-divide", /* 0xffaf */
5161 "kp-0", /* 0xffb0 */
5162 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5165 "kp-equal", /* 0xffbd */
5166 "f1", /* 0xffbe */ /* IsFunctionKey */
5168 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5169 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5170 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5171 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5172 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5173 0, 0, 0, 0, 0, 0, 0, 0,
5174 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5175 0, 0, 0, 0, 0, 0, 0, "delete"
5178 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5179 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5181 static const char *const iso_lispy_function_keys
[] =
5183 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5184 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5185 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5186 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5187 "iso-lefttab", /* 0xfe20 */
5188 "iso-move-line-up", "iso-move-line-down",
5189 "iso-partial-line-up", "iso-partial-line-down",
5190 "iso-partial-space-left", "iso-partial-space-right",
5191 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5192 "iso-release-margin-left", "iso-release-margin-right",
5193 "iso-release-both-margins",
5194 "iso-fast-cursor-left", "iso-fast-cursor-right",
5195 "iso-fast-cursor-up", "iso-fast-cursor-down",
5196 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5197 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5200 #endif /* not HAVE_NTGUI */
5202 static Lisp_Object Vlispy_mouse_stem
;
5204 static const char *const lispy_wheel_names
[] =
5206 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5209 /* drag-n-drop events are generated when a set of selected files are
5210 dragged from another application and dropped onto an Emacs window. */
5211 static const char *const lispy_drag_n_drop_names
[] =
5216 /* Scroll bar parts. */
5217 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5218 Lisp_Object Qup
, Qdown
, Qbottom
;
5219 static Lisp_Object Qend_scroll
;
5221 static Lisp_Object Qratio
;
5223 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5224 static Lisp_Object
*const scroll_bar_parts
[] = {
5225 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5226 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5229 /* A vector, indexed by button number, giving the down-going location
5230 of currently depressed buttons, both scroll bar and non-scroll bar.
5232 The elements have the form
5233 (BUTTON-NUMBER MODIFIER-MASK . REST)
5234 where REST is the cdr of a position as it would be reported in the event.
5236 The make_lispy_event function stores positions here to tell the
5237 difference between click and drag events, and to store the starting
5238 location to be included in drag events. */
5240 static Lisp_Object button_down_location
;
5242 /* Information about the most recent up-going button event: Which
5243 button, what location, and what time. */
5245 static int last_mouse_button
;
5246 static int last_mouse_x
;
5247 static int last_mouse_y
;
5248 static Time button_down_time
;
5250 /* The number of clicks in this multiple-click. */
5252 static int double_click_count
;
5254 /* X and Y are frame-relative coordinates for a click or wheel event.
5255 Return a Lisp-style event list. */
5258 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5261 enum window_part part
;
5262 Lisp_Object posn
= Qnil
;
5263 Lisp_Object extra_info
= Qnil
;
5264 /* Coordinate pixel positions to return. */
5265 int xret
= 0, yret
= 0;
5266 /* The window under frame pixel coordinates (x,y) */
5267 Lisp_Object window
= f
5268 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5271 if (WINDOWP (window
))
5273 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5274 struct window
*w
= XWINDOW (window
);
5275 Lisp_Object string_info
= Qnil
;
5276 ptrdiff_t textpos
= 0;
5277 int col
= -1, row
= -1;
5278 int dx
= -1, dy
= -1;
5279 int width
= -1, height
= -1;
5280 Lisp_Object object
= Qnil
;
5282 /* Pixel coordinates relative to the window corner. */
5283 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5284 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5286 /* For text area clicks, return X, Y relative to the corner of
5287 this text area. Note that dX, dY etc are set below, by
5288 buffer_posn_from_coords. */
5289 if (part
== ON_TEXT
)
5291 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5292 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5294 /* For mode line and header line clicks, return X, Y relative to
5295 the left window edge. Use mode_line_string to look for a
5296 string on the click position. */
5297 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5302 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5303 /* Note that mode_line_string takes COL, ROW as pixels and
5304 converts them to characters. */
5307 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5308 &object
, &dx
, &dy
, &width
, &height
);
5309 if (STRINGP (string
))
5310 string_info
= Fcons (string
, make_number (charpos
));
5316 /* For fringes and margins, Y is relative to the area's (and the
5317 window's) top edge, while X is meaningless. */
5318 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5323 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5326 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5327 &object
, &dx
, &dy
, &width
, &height
);
5328 if (STRINGP (string
))
5329 string_info
= Fcons (string
, make_number (charpos
));
5330 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5332 else if (part
== ON_LEFT_FRINGE
)
5334 posn
= Qleft_fringe
;
5337 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5338 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5339 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5341 else if (part
== ON_RIGHT_FRINGE
)
5343 posn
= Qright_fringe
;
5346 - window_box_width (w
, LEFT_MARGIN_AREA
)
5347 - window_box_width (w
, TEXT_AREA
)
5348 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5349 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5351 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5353 else if (part
== ON_VERTICAL_BORDER
)
5355 posn
= Qvertical_line
;
5360 /* Nothing special for part == ON_SCROLL_BAR. */
5361 else if (part
== ON_RIGHT_DIVIDER
)
5363 posn
= Qright_divider
;
5364 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5368 else if (part
== ON_BOTTOM_DIVIDER
)
5370 posn
= Qbottom_divider
;
5371 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5376 /* For clicks in the text area, fringes, or margins, call
5377 buffer_posn_from_coords to extract TEXTPOS, the buffer
5378 position nearest to the click. */
5381 Lisp_Object string2
, object2
= Qnil
;
5382 struct display_pos p
;
5384 int width2
, height2
;
5385 /* The pixel X coordinate passed to buffer_posn_from_coords
5386 is the X coordinate relative to the text area for
5387 text-area and right-margin clicks, zero otherwise. */
5389 = (part
== ON_TEXT
) ? xret
5390 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5391 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5395 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5396 &object2
, &dx2
, &dy2
,
5398 textpos
= CHARPOS (p
.pos
);
5399 if (col
< 0) col
= x2
;
5400 if (row
< 0) row
= y2
;
5401 if (dx
< 0) dx
= dx2
;
5402 if (dy
< 0) dy
= dy2
;
5403 if (width
< 0) width
= width2
;
5404 if (height
< 0) height
= height2
;
5408 posn
= make_number (textpos
);
5409 if (STRINGP (string2
))
5410 string_info
= Fcons (string2
,
5411 make_number (CHARPOS (p
.string_pos
)));
5417 #ifdef HAVE_WINDOW_SYSTEM
5418 if (IMAGEP (object
))
5420 Lisp_Object image_map
, hotspot
;
5421 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5423 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5425 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5426 posn
= XCAR (hotspot
);
5433 Fcons (make_number (dx
), make_number (dy
)),
5434 Fcons (make_number (width
), make_number (height
)));
5437 extra_info
= Fcons (string_info
,
5438 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5439 Fcons (Fcons (make_number (col
),
5444 XSETFRAME (window
, f
);
5448 return Fcons (window
,
5450 Fcons (Fcons (make_number (xret
),
5451 make_number (yret
)),
5452 Fcons (make_number (t
),
5456 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5457 menu bar. This really means that Emacs draws and manages the menu
5458 bar as part of its normal display, and therefore can compute its
5461 toolkit_menubar_in_use (struct frame
*f
)
5463 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5464 return !(!FRAME_WINDOW_P (f
));
5470 /* Given a struct input_event, build the lisp event which represents
5471 it. If EVENT is 0, build a mouse movement event from the mouse
5472 movement buffer, which should have a movement event in it.
5474 Note that events must be passed to this function in the order they
5475 are received; this function stores the location of button presses
5476 in order to build drag events when the button is released. */
5479 make_lispy_event (struct input_event
*event
)
5483 switch (event
->kind
)
5485 /* A simple keystroke. */
5486 case ASCII_KEYSTROKE_EVENT
:
5487 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5489 Lisp_Object lispy_c
;
5490 EMACS_INT c
= event
->code
;
5491 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5494 eassert (c
== event
->code
);
5495 /* Turn ASCII characters into control characters
5497 if (event
->modifiers
& ctrl_modifier
)
5499 c
= make_ctrl_char (c
);
5500 event
->modifiers
&= ~ctrl_modifier
;
5504 /* Add in the other modifier bits. The shift key was taken care
5505 of by the X code. */
5506 c
|= (event
->modifiers
5507 & (meta_modifier
| alt_modifier
5508 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5509 /* Distinguish Shift-SPC from SPC. */
5510 if ((event
->code
) == 040
5511 && event
->modifiers
& shift_modifier
)
5512 c
|= shift_modifier
;
5513 button_down_time
= 0;
5514 XSETFASTINT (lispy_c
, c
);
5519 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5520 except that they are non-key events (last-nonmenu-event is nil). */
5521 case NS_NONKEY_EVENT
:
5524 /* A function key. The symbol may need to have modifier prefixes
5526 case NON_ASCII_KEYSTROKE_EVENT
:
5527 button_down_time
= 0;
5529 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5530 if (event
->code
== lispy_accent_codes
[i
])
5531 return modify_event_symbol (i
,
5533 Qfunction_key
, Qnil
,
5534 lispy_accent_keys
, &accent_key_syms
,
5535 ARRAYELTS (lispy_accent_keys
));
5539 if (event
->code
>= 0x400 && event
->code
< 0x500)
5540 return modify_event_symbol (event
->code
- 0x400,
5541 event
->modifiers
& ~shift_modifier
,
5542 Qfunction_key
, Qnil
,
5543 lispy_kana_keys
, &func_key_syms
,
5544 ARRAYELTS (lispy_kana_keys
));
5545 #endif /* XK_kana_A */
5548 #ifdef ISO_FUNCTION_KEY_OFFSET
5549 if (event
->code
< FUNCTION_KEY_OFFSET
5550 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5551 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5553 Qfunction_key
, Qnil
,
5554 iso_lispy_function_keys
, &func_key_syms
,
5555 ARRAYELTS (iso_lispy_function_keys
));
5558 /* Handle system-specific or unknown keysyms. */
5559 if (event
->code
& (1 << 28)
5560 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5561 || (event
->code
- FUNCTION_KEY_OFFSET
5562 >= ARRAYELTS (lispy_function_keys
))
5563 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5565 /* We need to use an alist rather than a vector as the cache
5566 since we can't make a vector long enough. */
5567 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5568 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5569 return modify_event_symbol (event
->code
,
5572 KVAR (current_kboard
, Vsystem_key_alist
),
5573 0, &KVAR (current_kboard
, system_key_syms
),
5577 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5579 Qfunction_key
, Qnil
,
5580 lispy_function_keys
, &func_key_syms
,
5581 ARRAYELTS (lispy_function_keys
));
5584 case MULTIMEDIA_KEY_EVENT
:
5585 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5586 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5588 return modify_event_symbol (event
->code
, event
->modifiers
,
5589 Qfunction_key
, Qnil
,
5590 lispy_multimedia_keys
, &func_key_syms
,
5591 ARRAYELTS (lispy_multimedia_keys
));
5596 /* A mouse click. Figure out where it is, decide whether it's
5597 a press, click or drag, and build the appropriate structure. */
5598 case MOUSE_CLICK_EVENT
:
5600 case GPM_CLICK_EVENT
:
5602 #ifndef USE_TOOLKIT_SCROLL_BARS
5603 case SCROLL_BAR_CLICK_EVENT
:
5606 int button
= event
->code
;
5608 Lisp_Object position
;
5609 Lisp_Object
*start_pos_ptr
;
5610 Lisp_Object start_pos
;
5614 /* Build the position as appropriate for this mouse click. */
5615 if (event
->kind
== MOUSE_CLICK_EVENT
5617 || event
->kind
== GPM_CLICK_EVENT
5621 struct frame
*f
= XFRAME (event
->frame_or_window
);
5624 /* Ignore mouse events that were made on frame that
5625 have been deleted. */
5626 if (! FRAME_LIVE_P (f
))
5629 /* EVENT->x and EVENT->y are frame-relative pixel
5630 coordinates at this place. Under old redisplay, COLUMN
5631 and ROW are set to frame relative glyph coordinates
5632 which are then used to determine whether this click is
5633 in a menu (non-toolkit version). */
5634 if (!toolkit_menubar_in_use (f
))
5636 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5637 &column
, &row
, NULL
, 1);
5639 /* In the non-toolkit version, clicks on the menu bar
5640 are ordinary button events in the event buffer.
5641 Distinguish them, and invoke the menu.
5643 (In the toolkit version, the toolkit handles the
5644 menu bar and Emacs doesn't know about it until
5645 after the user makes a selection.) */
5646 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5647 && (event
->modifiers
& down_modifier
))
5649 Lisp_Object items
, item
;
5651 /* Find the menu bar item under `column'. */
5653 items
= FRAME_MENU_BAR_ITEMS (f
);
5654 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5656 Lisp_Object pos
, string
;
5657 string
= AREF (items
, i
+ 1);
5658 pos
= AREF (items
, i
+ 3);
5661 if (column
>= XINT (pos
)
5662 && column
< XINT (pos
) + SCHARS (string
))
5664 item
= AREF (items
, i
);
5669 /* ELisp manual 2.4b says (x y) are window
5670 relative but code says they are
5672 position
= list4 (event
->frame_or_window
,
5674 Fcons (event
->x
, event
->y
),
5675 make_number (event
->timestamp
));
5677 return list2 (item
, position
);
5681 position
= make_lispy_position (f
, event
->x
, event
->y
,
5684 #ifndef USE_TOOLKIT_SCROLL_BARS
5687 /* It's a scrollbar click. */
5689 Lisp_Object portion_whole
;
5692 window
= event
->frame_or_window
;
5693 portion_whole
= Fcons (event
->x
, event
->y
);
5694 part
= *scroll_bar_parts
[(int) event
->part
];
5696 position
= list5 (window
, Qvertical_scroll_bar
,
5697 portion_whole
, make_number (event
->timestamp
),
5700 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5702 if (button
>= ASIZE (button_down_location
))
5704 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5705 button_down_location
= larger_vector (button_down_location
,
5707 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5710 start_pos_ptr
= aref_addr (button_down_location
, button
);
5711 start_pos
= *start_pos_ptr
;
5712 *start_pos_ptr
= Qnil
;
5715 /* On window-system frames, use the value of
5716 double-click-fuzz as is. On other frames, interpret it
5717 as a multiple of 1/8 characters. */
5721 if (WINDOWP (event
->frame_or_window
))
5722 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5723 else if (FRAMEP (event
->frame_or_window
))
5724 f
= XFRAME (event
->frame_or_window
);
5728 if (FRAME_WINDOW_P (f
))
5729 fuzz
= double_click_fuzz
;
5731 fuzz
= double_click_fuzz
/ 8;
5733 is_double
= (button
== last_mouse_button
5734 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5735 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5736 && button_down_time
!= 0
5737 && (EQ (Vdouble_click_time
, Qt
)
5738 || (NATNUMP (Vdouble_click_time
)
5739 && (event
->timestamp
- button_down_time
5740 < XFASTINT (Vdouble_click_time
)))));
5743 last_mouse_button
= button
;
5744 last_mouse_x
= XINT (event
->x
);
5745 last_mouse_y
= XINT (event
->y
);
5747 /* If this is a button press, squirrel away the location, so
5748 we can decide later whether it was a click or a drag. */
5749 if (event
->modifiers
& down_modifier
)
5753 double_click_count
++;
5754 event
->modifiers
|= ((double_click_count
> 2)
5759 double_click_count
= 1;
5760 button_down_time
= event
->timestamp
;
5761 *start_pos_ptr
= Fcopy_alist (position
);
5762 ignore_mouse_drag_p
= 0;
5765 /* Now we're releasing a button - check the co-ordinates to
5766 see if this was a click or a drag. */
5767 else if (event
->modifiers
& up_modifier
)
5769 /* If we did not see a down before this up, ignore the up.
5770 Probably this happened because the down event chose a
5771 menu item. It would be an annoyance to treat the
5772 release of the button that chose the menu item as a
5775 if (!CONSP (start_pos
))
5778 event
->modifiers
&= ~up_modifier
;
5781 Lisp_Object new_down
, down
;
5782 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5784 /* The third element of every position
5785 should be the (x,y) pair. */
5786 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5787 new_down
= Fcar (Fcdr (Fcdr (position
)));
5790 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5792 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5793 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5796 if (ignore_mouse_drag_p
)
5798 event
->modifiers
|= click_modifier
;
5799 ignore_mouse_drag_p
= 0;
5801 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5802 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5803 /* Maybe the mouse has moved a lot, caused scrolling, and
5804 eventually ended up at the same screen position (but
5805 not buffer position) in which case it is a drag, not
5807 /* FIXME: OTOH if the buffer position has changed
5808 because of a timer or process filter rather than
5809 because of mouse movement, it should be considered as
5810 a click. But mouse-drag-region completely ignores
5811 this case and it hasn't caused any real problem, so
5812 it's probably OK to ignore it as well. */
5813 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5814 /* Mouse hasn't moved (much). */
5815 event
->modifiers
|= click_modifier
;
5818 button_down_time
= 0;
5819 event
->modifiers
|= drag_modifier
;
5822 /* Don't check is_double; treat this as multiple
5823 if the down-event was multiple. */
5824 if (double_click_count
> 1)
5825 event
->modifiers
|= ((double_click_count
> 2)
5831 /* Every mouse event should either have the down_modifier or
5832 the up_modifier set. */
5836 /* Get the symbol we should use for the mouse click. */
5839 head
= modify_event_symbol (button
,
5841 Qmouse_click
, Vlispy_mouse_stem
,
5844 ASIZE (mouse_syms
));
5845 if (event
->modifiers
& drag_modifier
)
5846 return list3 (head
, start_pos
, position
);
5847 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5848 return list3 (head
, position
, make_number (double_click_count
));
5850 return list2 (head
, position
);
5855 case HORIZ_WHEEL_EVENT
:
5857 Lisp_Object position
;
5860 /* Build the position as appropriate for this mouse click. */
5861 struct frame
*f
= XFRAME (event
->frame_or_window
);
5863 /* Ignore wheel events that were made on frame that have been
5865 if (! FRAME_LIVE_P (f
))
5868 position
= make_lispy_position (f
, event
->x
, event
->y
,
5871 /* Set double or triple modifiers to indicate the wheel speed. */
5873 /* On window-system frames, use the value of
5874 double-click-fuzz as is. On other frames, interpret it
5875 as a multiple of 1/8 characters. */
5881 if (WINDOWP (event
->frame_or_window
))
5882 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5883 else if (FRAMEP (event
->frame_or_window
))
5884 fr
= XFRAME (event
->frame_or_window
);
5888 fuzz
= FRAME_WINDOW_P (fr
)
5889 ? double_click_fuzz
: double_click_fuzz
/ 8;
5891 if (event
->modifiers
& up_modifier
)
5893 /* Emit a wheel-up event. */
5894 event
->modifiers
&= ~up_modifier
;
5897 else if (event
->modifiers
& down_modifier
)
5899 /* Emit a wheel-down event. */
5900 event
->modifiers
&= ~down_modifier
;
5904 /* Every wheel event should either have the down_modifier or
5905 the up_modifier set. */
5908 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5911 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5912 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5913 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5914 && button_down_time
!= 0
5915 && (EQ (Vdouble_click_time
, Qt
)
5916 || (NATNUMP (Vdouble_click_time
)
5917 && (event
->timestamp
- button_down_time
5918 < XFASTINT (Vdouble_click_time
)))));
5921 double_click_count
++;
5922 event
->modifiers
|= ((double_click_count
> 2)
5928 double_click_count
= 1;
5929 event
->modifiers
|= click_modifier
;
5932 button_down_time
= event
->timestamp
;
5933 /* Use a negative value to distinguish wheel from mouse button. */
5934 last_mouse_button
= - (1 + symbol_num
);
5935 last_mouse_x
= XINT (event
->x
);
5936 last_mouse_y
= XINT (event
->y
);
5938 /* Get the symbol we should use for the wheel event. */
5939 head
= modify_event_symbol (symbol_num
,
5945 ASIZE (wheel_syms
));
5948 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5949 return list3 (head
, position
, make_number (double_click_count
));
5951 return list2 (head
, position
);
5955 #ifdef USE_TOOLKIT_SCROLL_BARS
5957 /* We don't have down and up events if using toolkit scroll bars,
5958 so make this always a click event. Store in the `part' of
5959 the Lisp event a symbol which maps to the following actions:
5961 `above_handle' page up
5962 `below_handle' page down
5966 `bottom' bottom of buffer
5967 `handle' thumb has been dragged.
5968 `end-scroll' end of interaction with scroll bar
5970 The incoming input_event contains in its `part' member an
5971 index of type `enum scroll_bar_part' which we can use as an
5972 index in scroll_bar_parts to get the appropriate symbol. */
5974 case SCROLL_BAR_CLICK_EVENT
:
5976 Lisp_Object position
, head
, window
, portion_whole
, part
;
5978 window
= event
->frame_or_window
;
5979 portion_whole
= Fcons (event
->x
, event
->y
);
5980 part
= *scroll_bar_parts
[(int) event
->part
];
5982 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5983 make_number (event
->timestamp
), part
);
5985 /* Always treat scroll bar events as clicks. */
5986 event
->modifiers
|= click_modifier
;
5987 event
->modifiers
&= ~up_modifier
;
5989 if (event
->code
>= ASIZE (mouse_syms
))
5990 mouse_syms
= larger_vector (mouse_syms
,
5991 event
->code
- ASIZE (mouse_syms
) + 1,
5994 /* Get the symbol we should use for the mouse click. */
5995 head
= modify_event_symbol (event
->code
,
6000 ASIZE (mouse_syms
));
6001 return list2 (head
, position
);
6004 #endif /* USE_TOOLKIT_SCROLL_BARS */
6006 case DRAG_N_DROP_EVENT
:
6009 Lisp_Object head
, position
;
6012 f
= XFRAME (event
->frame_or_window
);
6015 /* Ignore mouse events that were made on frames that
6016 have been deleted. */
6017 if (! FRAME_LIVE_P (f
))
6020 position
= make_lispy_position (f
, event
->x
, event
->y
,
6023 head
= modify_event_symbol (0, event
->modifiers
,
6025 lispy_drag_n_drop_names
,
6026 &drag_n_drop_syms
, 1);
6027 return list3 (head
, position
, files
);
6030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6031 || defined (HAVE_NS) || defined (USE_GTK)
6032 case MENU_BAR_EVENT
:
6033 if (EQ (event
->arg
, event
->frame_or_window
))
6034 /* This is the prefix key. We translate this to
6035 `(menu_bar)' because the code in keyboard.c for menu
6036 events, which we use, relies on this. */
6037 return list1 (Qmenu_bar
);
6041 case SELECT_WINDOW_EVENT
:
6042 /* Make an event (select-window (WINDOW)). */
6043 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6045 case TOOL_BAR_EVENT
:
6046 if (EQ (event
->arg
, event
->frame_or_window
))
6047 /* This is the prefix key. We translate this to
6048 `(tool_bar)' because the code in keyboard.c for tool bar
6049 events, which we use, relies on this. */
6050 return list1 (Qtool_bar
);
6051 else if (SYMBOLP (event
->arg
))
6052 return apply_modifiers (event
->modifiers
, event
->arg
);
6055 case USER_SIGNAL_EVENT
:
6056 /* A user signal. */
6058 char *name
= find_user_signal_name (event
->code
);
6061 return intern (name
);
6064 case SAVE_SESSION_EVENT
:
6065 return Qsave_session
;
6070 return Fcons (Qdbus_event
, event
->arg
);
6072 #endif /* HAVE_DBUS */
6074 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6075 case FILE_NOTIFY_EVENT
:
6077 return Fcons (Qfile_notify
, event
->arg
);
6079 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6081 case CONFIG_CHANGED_EVENT
:
6082 return list3 (Qconfig_changed_event
,
6083 event
->arg
, event
->frame_or_window
);
6085 /* The 'kind' field of the event is something we don't recognize. */
6092 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6093 Lisp_Object x
, Lisp_Object y
, Time t
)
6095 /* Is it a scroll bar movement? */
6096 if (frame
&& ! NILP (bar_window
))
6098 Lisp_Object part_sym
;
6100 part_sym
= *scroll_bar_parts
[(int) part
];
6101 return list2 (Qscroll_bar_movement
,
6103 Qvertical_scroll_bar
,
6108 /* Or is it an ordinary mouse movement? */
6111 Lisp_Object position
;
6112 position
= make_lispy_position (frame
, x
, y
, t
);
6113 return list2 (Qmouse_movement
, position
);
6117 /* Construct a switch frame event. */
6119 make_lispy_switch_frame (Lisp_Object frame
)
6121 return list2 (Qswitch_frame
, frame
);
6125 make_lispy_focus_in (Lisp_Object frame
)
6127 return list2 (Qfocus_in
, frame
);
6130 #ifdef HAVE_WINDOW_SYSTEM
6133 make_lispy_focus_out (Lisp_Object frame
)
6135 return list2 (Qfocus_out
, frame
);
6138 #endif /* HAVE_WINDOW_SYSTEM */
6140 /* Manipulating modifiers. */
6142 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6144 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6145 SYMBOL's name of the end of the modifiers; the string from this
6146 position is the unmodified symbol name.
6148 This doesn't use any caches. */
6151 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6157 CHECK_SYMBOL (symbol
);
6160 name
= SYMBOL_NAME (symbol
);
6162 for (i
= 0; i
< SBYTES (name
) - 1; )
6164 ptrdiff_t this_mod_end
= 0;
6167 /* See if the name continues with a modifier word.
6168 Check that the word appears, but don't check what follows it.
6169 Set this_mod and this_mod_end to record what we find. */
6171 switch (SREF (name
, i
))
6173 #define SINGLE_LETTER_MOD(BIT) \
6174 (this_mod_end = i + 1, this_mod = BIT)
6177 SINGLE_LETTER_MOD (alt_modifier
);
6181 SINGLE_LETTER_MOD (ctrl_modifier
);
6185 SINGLE_LETTER_MOD (hyper_modifier
);
6189 SINGLE_LETTER_MOD (meta_modifier
);
6193 SINGLE_LETTER_MOD (shift_modifier
);
6197 SINGLE_LETTER_MOD (super_modifier
);
6200 #undef SINGLE_LETTER_MOD
6202 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6203 if (i + LEN + 1 <= SBYTES (name) \
6204 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6206 this_mod_end = i + LEN; \
6211 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6212 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6213 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6217 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6219 #undef MULTI_LETTER_MOD
6223 /* If we found no modifier, stop looking for them. */
6224 if (this_mod_end
== 0)
6227 /* Check there is a dash after the modifier, so that it
6228 really is a modifier. */
6229 if (this_mod_end
>= SBYTES (name
)
6230 || SREF (name
, this_mod_end
) != '-')
6233 /* This modifier is real; look for another. */
6234 modifiers
|= this_mod
;
6235 i
= this_mod_end
+ 1;
6238 /* Should we include the `click' modifier? */
6239 if (! (modifiers
& (down_modifier
| drag_modifier
6240 | double_modifier
| triple_modifier
))
6241 && i
+ 7 == SBYTES (name
)
6242 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6243 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6244 modifiers
|= click_modifier
;
6246 if (! (modifiers
& (double_modifier
| triple_modifier
))
6247 && i
+ 6 < SBYTES (name
)
6248 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6249 modifiers
|= click_modifier
;
6257 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6258 prepended to the string BASE[0..BASE_LEN-1].
6259 This doesn't use any caches. */
6261 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6263 /* Since BASE could contain nulls, we can't use intern here; we have
6264 to use Fintern, which expects a genuine Lisp_String, and keeps a
6266 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6272 /* Only the event queue may use the `up' modifier; it should always
6273 be turned into a click or drag event before presented to lisp code. */
6274 if (modifiers
& up_modifier
)
6277 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6278 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6279 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6280 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6281 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6282 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6283 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6284 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6285 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6286 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6287 /* The click modifier is denoted by the absence of other modifiers. */
6291 mod_len
= p
- new_mods
;
6295 Lisp_Object new_name
;
6297 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6298 mod_len
+ base_len_byte
);
6299 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6300 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6302 return Fintern (new_name
, Qnil
);
6307 static const char *const modifier_names
[] =
6309 "up", "down", "drag", "click", "double", "triple", 0, 0,
6310 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6311 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6313 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6315 static Lisp_Object modifier_symbols
;
6317 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6319 lispy_modifier_list (int modifiers
)
6321 Lisp_Object modifier_list
;
6324 modifier_list
= Qnil
;
6325 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6326 if (modifiers
& (1<<i
))
6327 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6330 return modifier_list
;
6334 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6335 where UNMODIFIED is the unmodified form of SYMBOL,
6336 MASK is the set of modifiers present in SYMBOL's name.
6337 This is similar to parse_modifiers_uncached, but uses the cache in
6338 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6339 Qevent_symbol_elements property. */
6341 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6344 parse_modifiers (Lisp_Object symbol
)
6346 Lisp_Object elements
;
6348 if (INTEGERP (symbol
))
6349 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6350 else if (!SYMBOLP (symbol
))
6353 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6354 if (CONSP (elements
))
6359 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6360 Lisp_Object unmodified
;
6363 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6364 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6367 if (modifiers
& ~INTMASK
)
6369 XSETFASTINT (mask
, modifiers
);
6370 elements
= list2 (unmodified
, mask
);
6372 /* Cache the parsing results on SYMBOL. */
6373 Fput (symbol
, Qevent_symbol_element_mask
,
6375 Fput (symbol
, Qevent_symbol_elements
,
6376 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6378 /* Since we know that SYMBOL is modifiers applied to unmodified,
6379 it would be nice to put that in unmodified's cache.
6380 But we can't, since we're not sure that parse_modifiers is
6387 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6388 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6389 doc
: /* Parse the event symbol. For internal use. */)
6390 (Lisp_Object symbol
)
6392 /* Fill the cache if needed. */
6393 parse_modifiers (symbol
);
6394 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6395 and use the Lispier representation stored on Qevent_symbol_elements
6397 return Fget (symbol
, Qevent_symbol_elements
);
6400 /* Apply the modifiers MODIFIERS to the symbol BASE.
6401 BASE must be unmodified.
6403 This is like apply_modifiers_uncached, but uses BASE's
6404 Qmodifier_cache property, if present. It also builds
6405 Qevent_symbol_elements properties, since it has that info anyway.
6407 apply_modifiers copies the value of BASE's Qevent_kind property to
6408 the modified symbol. */
6410 apply_modifiers (int modifiers
, Lisp_Object base
)
6412 Lisp_Object cache
, idx
, entry
, new_symbol
;
6414 /* Mask out upper bits. We don't know where this value's been. */
6415 modifiers
&= INTMASK
;
6417 if (INTEGERP (base
))
6418 return make_number (XINT (base
) | modifiers
);
6420 /* The click modifier never figures into cache indices. */
6421 cache
= Fget (base
, Qmodifier_cache
);
6422 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6423 entry
= assq_no_quit (idx
, cache
);
6426 new_symbol
= XCDR (entry
);
6429 /* We have to create the symbol ourselves. */
6430 new_symbol
= apply_modifiers_uncached (modifiers
,
6431 SSDATA (SYMBOL_NAME (base
)),
6432 SCHARS (SYMBOL_NAME (base
)),
6433 SBYTES (SYMBOL_NAME (base
)));
6435 /* Add the new symbol to the base's cache. */
6436 entry
= Fcons (idx
, new_symbol
);
6437 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6439 /* We have the parsing info now for free, so we could add it to
6441 XSETFASTINT (idx, modifiers);
6442 Fput (new_symbol, Qevent_symbol_element_mask,
6444 Fput (new_symbol, Qevent_symbol_elements,
6445 Fcons (base, lispy_modifier_list (modifiers)));
6446 Sadly, this is only correct if `base' is indeed a base event,
6447 which is not necessarily the case. -stef */
6450 /* Make sure this symbol is of the same kind as BASE.
6452 You'd think we could just set this once and for all when we
6453 intern the symbol above, but reorder_modifiers may call us when
6454 BASE's property isn't set right; we can't assume that just
6455 because it has a Qmodifier_cache property it must have its
6456 Qevent_kind set right as well. */
6457 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6461 kind
= Fget (base
, Qevent_kind
);
6463 Fput (new_symbol
, Qevent_kind
, kind
);
6470 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6471 return a symbol with the modifiers placed in the canonical order.
6472 Canonical order is alphabetical, except for down and drag, which
6473 always come last. The 'click' modifier is never written out.
6475 Fdefine_key calls this to make sure that (for example) C-M-foo
6476 and M-C-foo end up being equivalent in the keymap. */
6479 reorder_modifiers (Lisp_Object symbol
)
6481 /* It's hopefully okay to write the code this way, since everything
6482 will soon be in caches, and no consing will be done at all. */
6485 parsed
= parse_modifiers (symbol
);
6486 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6491 /* For handling events, we often want to produce a symbol whose name
6492 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6493 to some base, like the name of a function key or mouse button.
6494 modify_event_symbol produces symbols of this sort.
6496 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6497 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6500 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6501 into symbol names, or a string specifying a name stem used to
6502 construct a symbol name or the form `STEM-N', where N is the decimal
6503 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6504 non-nil; otherwise NAME_TABLE is used.
6506 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6507 persist between calls to modify_event_symbol that it can use to
6508 store a cache of the symbols it's generated for this NAME_TABLE
6509 before. The object stored there may be a vector or an alist.
6511 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6513 MODIFIERS is a set of modifier bits (as given in struct input_events)
6514 whose prefixes should be applied to the symbol name.
6516 SYMBOL_KIND is the value to be placed in the event_kind property of
6517 the returned symbol.
6519 The symbols we create are supposed to have an
6520 `event-symbol-elements' property, which lists the modifiers present
6521 in the symbol's name. */
6524 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6525 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6526 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6529 Lisp_Object symbol_int
;
6531 /* Get rid of the "vendor-specific" bit here. */
6532 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6534 /* Is this a request for a valid symbol? */
6535 if (symbol_num
< 0 || symbol_num
>= table_size
)
6538 if (CONSP (*symbol_table
))
6539 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6541 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6542 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6543 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6544 we've never used that symbol before. */
6547 if (! VECTORP (*symbol_table
)
6548 || ASIZE (*symbol_table
) != table_size
)
6552 XSETFASTINT (size
, table_size
);
6553 *symbol_table
= Fmake_vector (size
, Qnil
);
6556 value
= AREF (*symbol_table
, symbol_num
);
6559 /* Have we already used this symbol before? */
6562 /* No; let's create it. */
6563 if (CONSP (name_alist_or_stem
))
6564 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6565 else if (STRINGP (name_alist_or_stem
))
6568 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6569 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6571 buf
= SAFE_ALLOCA (len
);
6572 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6573 XINT (symbol_int
) + 1);
6574 value
= intern (buf
);
6577 else if (name_table
!= 0 && name_table
[symbol_num
])
6578 value
= intern (name_table
[symbol_num
]);
6580 #ifdef HAVE_WINDOW_SYSTEM
6583 char *name
= x_get_keysym_name (symbol_num
);
6585 value
= intern (name
);
6591 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6592 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6593 value
= intern (buf
);
6596 if (CONSP (*symbol_table
))
6597 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6599 ASET (*symbol_table
, symbol_num
, value
);
6601 /* Fill in the cache entries for this symbol; this also
6602 builds the Qevent_symbol_elements property, which the user
6604 apply_modifiers (modifiers
& click_modifier
, value
);
6605 Fput (value
, Qevent_kind
, symbol_kind
);
6608 /* Apply modifiers to that symbol. */
6609 return apply_modifiers (modifiers
, value
);
6612 /* Convert a list that represents an event type,
6613 such as (ctrl meta backspace), into the usual representation of that
6614 event type as a number or a symbol. */
6616 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6617 doc
: /* Convert the event description list EVENT-DESC to an event type.
6618 EVENT-DESC should contain one base event type (a character or symbol)
6619 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6620 drag, down, double or triple). The base must be last.
6621 The return value is an event type (a character or symbol) which
6622 has the same base event type and all the specified modifiers. */)
6623 (Lisp_Object event_desc
)
6631 while (CONSP (rest
))
6639 /* Given a symbol, see if it is a modifier name. */
6640 if (SYMBOLP (elt
) && CONSP (rest
))
6641 this = parse_solitary_modifier (elt
);
6645 else if (!NILP (base
))
6646 error ("Two bases given in one event");
6652 /* Let the symbol A refer to the character A. */
6653 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6654 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6656 if (INTEGERP (base
))
6658 /* Turn (shift a) into A. */
6659 if ((modifiers
& shift_modifier
) != 0
6660 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6662 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6663 modifiers
&= ~shift_modifier
;
6666 /* Turn (control a) into C-a. */
6667 if (modifiers
& ctrl_modifier
)
6668 return make_number ((modifiers
& ~ctrl_modifier
)
6669 | make_ctrl_char (XINT (base
)));
6671 return make_number (modifiers
| XINT (base
));
6673 else if (SYMBOLP (base
))
6674 return apply_modifiers (modifiers
, base
);
6676 error ("Invalid base event");
6679 /* Try to recognize SYMBOL as a modifier name.
6680 Return the modifier flag bit, or 0 if not recognized. */
6683 parse_solitary_modifier (Lisp_Object symbol
)
6685 Lisp_Object name
= SYMBOL_NAME (symbol
);
6687 switch (SREF (name
, 0))
6689 #define SINGLE_LETTER_MOD(BIT) \
6690 if (SBYTES (name) == 1) \
6693 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6694 if (LEN == SBYTES (name) \
6695 && ! memcmp (SDATA (name), NAME, LEN)) \
6699 SINGLE_LETTER_MOD (alt_modifier
);
6703 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6707 SINGLE_LETTER_MOD (ctrl_modifier
);
6711 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6712 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6716 SINGLE_LETTER_MOD (hyper_modifier
);
6720 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6724 SINGLE_LETTER_MOD (meta_modifier
);
6728 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6732 SINGLE_LETTER_MOD (shift_modifier
);
6736 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6737 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6738 SINGLE_LETTER_MOD (super_modifier
);
6742 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6743 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6744 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6748 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6751 #undef SINGLE_LETTER_MOD
6752 #undef MULTI_LETTER_MOD
6758 /* Return true if EVENT is a list whose elements are all integers or symbols.
6759 Such a list is not valid as an event,
6760 but it can be a Lucid-style event type list. */
6763 lucid_event_type_list_p (Lisp_Object object
)
6767 if (! CONSP (object
))
6770 if (EQ (XCAR (object
), Qhelp_echo
)
6771 || EQ (XCAR (object
), Qvertical_line
)
6772 || EQ (XCAR (object
), Qmode_line
)
6773 || EQ (XCAR (object
), Qheader_line
))
6776 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6780 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6787 /* Return true if terminal input chars are available.
6788 Also, store the return value into INPUT_PENDING.
6790 Serves the purpose of ioctl (0, FIONREAD, ...)
6791 but works even if FIONREAD does not exist.
6792 (In fact, this may actually read some input.)
6794 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6795 timer events that are ripe.
6796 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6797 events (FOCUS_IN_EVENT).
6798 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6799 movements and toolkit scroll bar thumb drags. */
6802 get_input_pending (int flags
)
6804 /* First of all, have we already counted some input? */
6805 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6807 /* If input is being read as it arrives, and we have none, there is none. */
6808 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6810 /* Try to read some input and see how much we get. */
6812 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6815 return input_pending
;
6818 /* Put a BUFFER_SWITCH_EVENT in the buffer
6819 so that read_key_sequence will notice the new current buffer. */
6822 record_asynch_buffer_change (void)
6824 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6825 The purpose of the event is to make read_key_sequence look up the
6826 keymaps again. If we aren't in read_key_sequence, we don't need one,
6827 and the event could cause trouble by messing up (input-pending-p).
6828 Note: Fwaiting_for_user_input_p always returns nil when async
6829 subprocesses aren't supported. */
6830 if (!NILP (Fwaiting_for_user_input_p ()))
6832 struct input_event event
;
6835 event
.kind
= BUFFER_SWITCH_EVENT
;
6836 event
.frame_or_window
= Qnil
;
6839 /* Make sure no interrupt happens while storing the event. */
6841 if (interrupt_input
)
6842 kbd_buffer_store_event (&event
);
6847 kbd_buffer_store_event (&event
);
6853 /* Read any terminal input already buffered up by the system
6854 into the kbd_buffer, but do not wait.
6856 Return the number of keyboard chars read, or -1 meaning
6857 this is a bad time to try to read input. */
6866 /* Store pending user signal events, if any. */
6867 store_user_signal_events ();
6869 /* Loop through the available terminals, and call their input hooks. */
6873 struct terminal
*next
= t
->next_terminal
;
6875 if (t
->read_socket_hook
)
6878 struct input_event hold_quit
;
6880 if (input_blocked_p ())
6882 pending_signals
= 1;
6886 EVENT_INIT (hold_quit
);
6887 hold_quit
.kind
= NO_EVENT
;
6889 /* No need for FIONREAD or fcntl; just say don't wait. */
6890 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6893 if (nr
== -1) /* Not OK to read input now. */
6897 else if (nr
== -2) /* Non-transient error. */
6899 /* The terminal device terminated; it should be closed. */
6901 /* Kill Emacs if this was our last terminal. */
6902 if (!terminal_list
->next_terminal
)
6903 /* Formerly simply reported no input, but that
6904 sometimes led to a failure of Emacs to terminate.
6905 SIGHUP seems appropriate if we can't reach the
6907 /* ??? Is it really right to send the signal just to
6908 this process rather than to the whole process
6909 group? Perhaps on systems with FIONREAD Emacs is
6910 alone in its group. */
6911 terminate_due_to_signal (SIGHUP
, 10);
6913 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6916 XSETTERMINAL (tmp
, t
);
6917 Fdelete_terminal (tmp
, Qnoelisp
);
6921 /* If there was no error, make sure the pointer
6922 is visible for all frames on this terminal. */
6925 Lisp_Object tail
, frame
;
6927 FOR_EACH_FRAME (tail
, frame
)
6929 struct frame
*f
= XFRAME (frame
);
6930 if (FRAME_TERMINAL (f
) == t
)
6931 frame_make_pointer_visible (f
);
6935 if (hold_quit
.kind
!= NO_EVENT
)
6936 kbd_buffer_store_event (&hold_quit
);
6948 /* This is the tty way of reading available input.
6950 Note that each terminal device has its own `struct terminal' object,
6951 and so this function is called once for each individual termcap
6952 terminal. The first parameter indicates which terminal to read from. */
6955 tty_read_avail_input (struct terminal
*terminal
,
6956 struct input_event
*hold_quit
)
6958 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6959 the kbd_buffer can really hold. That may prevent loss
6960 of characters on some systems when input is stuffed at us. */
6961 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6963 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6966 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6968 if (kbd_on_hold_p () || buffer_free
<= 0)
6970 #endif /* subprocesses */
6972 if (!terminal
->name
) /* Don't read from a dead terminal. */
6975 if (terminal
->type
!= output_termcap
6976 && terminal
->type
!= output_msdos_raw
)
6979 /* XXX I think the following code should be moved to separate hook
6980 functions in system-dependent files. */
6982 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6983 code sets read_socket_hook to w32_console_read_socket instead! */
6985 #else /* not WINDOWSNT */
6986 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6990 return 0; /* The terminal is suspended. */
6993 n_to_read
= dos_keysns ();
6997 cbuf
[0] = dos_keyread ();
7000 #else /* not MSDOS */
7005 struct input_event gpm_hold_quit
;
7006 int gpm
, fd
= gpm_fd
;
7008 EVENT_INIT (gpm_hold_quit
);
7009 gpm_hold_quit
.kind
= NO_EVENT
;
7011 /* gpm==1 if event received.
7012 gpm==0 if the GPM daemon has closed the connection, in which case
7013 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7014 we save it in `fd' so close_gpm can remove it from the
7016 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7017 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7018 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7021 /* Presumably the GPM daemon has closed the connection. */
7023 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7024 kbd_buffer_store_event (&gpm_hold_quit
);
7028 #endif /* HAVE_GPM */
7030 /* Determine how many characters we should *try* to read. */
7031 #ifdef USABLE_FIONREAD
7032 /* Find out how much input is available. */
7033 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7035 if (! noninteractive
)
7036 return -2; /* Close this terminal. */
7042 if (n_to_read
> sizeof cbuf
)
7043 n_to_read
= sizeof cbuf
;
7044 #elif defined USG || defined CYGWIN
7045 /* Read some input if available, but don't wait. */
7046 n_to_read
= sizeof cbuf
;
7047 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7049 # error "Cannot read without possibly delaying"
7053 /* Don't read more than we can store. */
7054 if (n_to_read
> buffer_free
)
7055 n_to_read
= buffer_free
;
7056 #endif /* subprocesses */
7058 /* Now read; for one reason or another, this will not block.
7059 NREAD is set to the number of chars read. */
7062 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7063 /* POSIX infers that processes which are not in the session leader's
7064 process group won't get SIGHUPs at logout time. BSDI adheres to
7065 this part standard and returns -1 from read (0) with errno==EIO
7066 when the control tty is taken away.
7067 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7068 if (nread
== -1 && errno
== EIO
)
7069 return -2; /* Close this terminal. */
7070 #if defined (AIX) && defined (_BSD)
7071 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7072 This looks incorrect, but it isn't, because _BSD causes
7073 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7074 and that causes a value other than 0 when there is no input. */
7076 return -2; /* Close this terminal. */
7080 /* We used to retry the read if it was interrupted.
7081 But this does the wrong thing when O_NONBLOCK causes
7082 an EAGAIN error. Does anybody know of a situation
7083 where a retry is actually needed? */
7085 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7095 #ifndef USABLE_FIONREAD
7096 #if defined (USG) || defined (CYGWIN)
7097 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7098 #endif /* USG or CYGWIN */
7099 #endif /* no FIONREAD */
7104 #endif /* not MSDOS */
7105 #endif /* not WINDOWSNT */
7107 for (i
= 0; i
< nread
; i
++)
7109 struct input_event buf
;
7111 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7113 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7114 buf
.modifiers
= meta_modifier
;
7115 if (tty
->meta_key
!= 2)
7119 /* Set the frame corresponding to the active tty. Note that the
7120 value of selected_frame is not reliable here, redisplay tends
7121 to temporarily change it. */
7122 buf
.frame_or_window
= tty
->top_frame
;
7125 kbd_buffer_store_event (&buf
);
7126 /* Don't look at input that follows a C-g too closely.
7127 This reduces lossage due to autorepeat on C-g. */
7128 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7129 && buf
.code
== quit_char
)
7137 handle_async_input (void)
7142 int nread
= gobble_input ();
7143 /* -1 means it's not ok to read the input now.
7144 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7145 0 means there was no keyboard input available. */
7153 process_pending_signals (void)
7155 pending_signals
= 0;
7156 handle_async_input ();
7157 do_pending_atimers ();
7160 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7161 and reinvoke any pending signal if the level is now 0 and
7162 a fatal error is not already in progress. */
7165 unblock_input_to (int level
)
7167 interrupt_input_blocked
= level
;
7170 if (pending_signals
&& !fatal_error_in_progress
)
7171 process_pending_signals ();
7177 /* End critical section.
7179 If doing signal-driven input, and a signal came in when input was
7180 blocked, reinvoke the signal handler now to deal with it.
7182 It will also process queued input, if it was not read before.
7183 When a longer code sequence does not use block/unblock input
7184 at all, the whole input gathered up to the next call to
7185 unblock_input will be processed inside that call. */
7188 unblock_input (void)
7190 unblock_input_to (interrupt_input_blocked
- 1);
7193 /* Undo any number of BLOCK_INPUT calls,
7194 and also reinvoke any pending signal. */
7197 totally_unblock_input (void)
7199 unblock_input_to (0);
7205 handle_input_available_signal (int sig
)
7207 pending_signals
= 1;
7209 if (input_available_clear_time
)
7210 *input_available_clear_time
= make_timespec (0, 0);
7214 deliver_input_available_signal (int sig
)
7216 deliver_process_signal (sig
, handle_input_available_signal
);
7218 #endif /* USABLE_SIGIO */
7221 /* User signal events. */
7223 struct user_signal_info
7225 /* Signal number. */
7228 /* Name of the signal. */
7231 /* Number of pending signals. */
7234 struct user_signal_info
*next
;
7237 /* List of user signals. */
7238 static struct user_signal_info
*user_signals
= NULL
;
7241 add_user_signal (int sig
, const char *name
)
7243 struct sigaction action
;
7244 struct user_signal_info
*p
;
7246 for (p
= user_signals
; p
; p
= p
->next
)
7248 /* Already added. */
7251 p
= xmalloc (sizeof *p
);
7253 p
->name
= xstrdup (name
);
7255 p
->next
= user_signals
;
7258 emacs_sigaction_init (&action
, deliver_user_signal
);
7259 sigaction (sig
, &action
, 0);
7263 handle_user_signal (int sig
)
7265 struct user_signal_info
*p
;
7266 const char *special_event_name
= NULL
;
7268 if (SYMBOLP (Vdebug_on_event
))
7269 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7271 for (p
= user_signals
; p
; p
= p
->next
)
7274 if (special_event_name
7275 && strcmp (special_event_name
, p
->name
) == 0)
7277 /* Enter the debugger in many ways. */
7278 debug_on_next_call
= 1;
7281 Vinhibit_quit
= Qnil
;
7283 /* Eat the event. */
7289 if (interrupt_input
)
7290 handle_input_available_signal (sig
);
7294 /* Tell wait_reading_process_output that it needs to wake
7295 up and look around. */
7296 if (input_available_clear_time
)
7297 *input_available_clear_time
= make_timespec (0, 0);
7304 deliver_user_signal (int sig
)
7306 deliver_process_signal (sig
, handle_user_signal
);
7310 find_user_signal_name (int sig
)
7312 struct user_signal_info
*p
;
7314 for (p
= user_signals
; p
; p
= p
->next
)
7322 store_user_signal_events (void)
7324 struct user_signal_info
*p
;
7325 struct input_event buf
;
7326 bool buf_initialized
= 0;
7328 for (p
= user_signals
; p
; p
= p
->next
)
7329 if (p
->npending
> 0)
7331 if (! buf_initialized
)
7333 memset (&buf
, 0, sizeof buf
);
7334 buf
.kind
= USER_SIGNAL_EVENT
;
7335 buf
.frame_or_window
= selected_frame
;
7336 buf_initialized
= 1;
7342 kbd_buffer_store_event (&buf
);
7345 while (p
->npending
> 0);
7350 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7351 static Lisp_Object menu_bar_one_keymap_changed_items
;
7353 /* These variables hold the vector under construction within
7354 menu_bar_items and its subroutines, and the current index
7355 for storing into that vector. */
7356 static Lisp_Object menu_bar_items_vector
;
7357 static int menu_bar_items_index
;
7360 static const char *separator_names
[] = {
7365 "single-dashed-line",
7366 "double-dashed-line",
7368 "shadow-etched-out",
7369 "shadow-etched-in-dash",
7370 "shadow-etched-out-dash",
7371 "shadow-double-etched-in",
7372 "shadow-double-etched-out",
7373 "shadow-double-etched-in-dash",
7374 "shadow-double-etched-out-dash",
7378 /* Return true if LABEL specifies a separator. */
7381 menu_separator_name_p (const char *label
)
7385 else if (strlen (label
) > 3
7386 && memcmp (label
, "--", 2) == 0
7391 for (i
= 0; separator_names
[i
]; ++i
)
7392 if (strcmp (label
, separator_names
[i
]) == 0)
7397 /* It's a separator if it contains only dashes. */
7398 while (*label
== '-')
7400 return (*label
== 0);
7407 /* Return a vector of menu items for a menu bar, appropriate
7408 to the current buffer. Each item has three elements in the vector:
7411 OLD is an old vector we can optionally reuse, or nil. */
7414 menu_bar_items (Lisp_Object old
)
7416 /* The number of keymaps we're scanning right now, and the number of
7417 keymaps we have allocated space for. */
7420 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7421 in the current keymaps, or nil where it is not a prefix. */
7424 Lisp_Object def
, tail
;
7429 /* In order to build the menus, we need to call the keymap
7430 accessors. They all call QUIT. But this function is called
7431 during redisplay, during which a quit is fatal. So inhibit
7432 quitting while building the menus.
7433 We do this instead of specbind because (1) errors will clear it anyway
7434 and (2) this avoids risk of specpdl overflow. */
7435 oquit
= Vinhibit_quit
;
7439 menu_bar_items_vector
= old
;
7441 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7442 menu_bar_items_index
= 0;
7444 /* Build our list of keymaps.
7445 If we recognize a function key and replace its escape sequence in
7446 keybuf with its symbol, or if the sequence starts with a mouse
7447 click and we need to switch buffers, we jump back here to rebuild
7448 the initial keymaps from the current buffer. */
7452 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7453 if (!NILP (Voverriding_local_map_menu_flag
)
7454 && !NILP (Voverriding_local_map
))
7456 /* Yes, use them (if non-nil) as well as the global map. */
7457 maps
= alloca (3 * sizeof (maps
[0]));
7459 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7460 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7461 if (!NILP (Voverriding_local_map
))
7462 maps
[nmaps
++] = Voverriding_local_map
;
7466 /* No, so use major and minor mode keymaps and keymap property.
7467 Note that menu-bar bindings in the local-map and keymap
7468 properties may not work reliable, as they are only
7469 recognized when the menu-bar (or mode-line) is updated,
7470 which does not normally happen after every command. */
7473 nminor
= current_minor_maps (NULL
, &tmaps
);
7474 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7476 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7477 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7478 maps
[nmaps
++] = tem
;
7479 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7480 maps
[nmaps
++] = tem
;
7481 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7483 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7485 maps
[nmaps
++] = current_global_map
;
7488 /* Look up in each map the dummy prefix key `menu-bar'. */
7490 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7491 if (!NILP (maps
[mapno
]))
7493 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7497 menu_bar_one_keymap_changed_items
= Qnil
;
7498 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7502 /* Move to the end those items that should be at the end. */
7504 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7507 int end
= menu_bar_items_index
;
7509 for (i
= 0; i
< end
; i
+= 4)
7510 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7512 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7513 /* Move the item at index I to the end,
7514 shifting all the others forward. */
7515 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7516 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7517 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7518 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7520 memmove (aref_addr (menu_bar_items_vector
, i
),
7521 aref_addr (menu_bar_items_vector
, i
+ 4),
7522 (end
- i
- 4) * word_size
);
7523 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7524 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7525 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7526 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7531 /* Add nil, nil, nil, nil at the end. */
7533 int i
= menu_bar_items_index
;
7534 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7535 menu_bar_items_vector
7536 = larger_vector (menu_bar_items_vector
, 4, -1);
7537 /* Add this item. */
7538 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7539 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7540 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7541 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7542 menu_bar_items_index
= i
;
7545 Vinhibit_quit
= oquit
;
7546 return menu_bar_items_vector
;
7549 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7550 If there's already an item for KEY, add this DEF to it. */
7552 Lisp_Object item_properties
;
7555 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7557 struct gcpro gcpro1
;
7562 if (EQ (item
, Qundefined
))
7564 /* If a map has an explicit `undefined' as definition,
7565 discard any previously made menu bar item. */
7567 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7568 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7570 if (menu_bar_items_index
> i
+ 4)
7571 memmove (aref_addr (menu_bar_items_vector
, i
),
7572 aref_addr (menu_bar_items_vector
, i
+ 4),
7573 (menu_bar_items_index
- i
- 4) * word_size
);
7574 menu_bar_items_index
-= 4;
7578 /* If this keymap has already contributed to this KEY,
7579 don't contribute to it a second time. */
7580 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7581 if (!NILP (tem
) || NILP (item
))
7584 menu_bar_one_keymap_changed_items
7585 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7587 /* We add to menu_bar_one_keymap_changed_items before doing the
7588 parse_menu_item, so that if it turns out it wasn't a menu item,
7589 it still correctly hides any further menu item. */
7591 parsed
= parse_menu_item (item
, 1);
7596 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7598 /* Find any existing item for this KEY. */
7599 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7600 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7603 /* If we did not find this KEY, add it at the end. */
7604 if (i
== menu_bar_items_index
)
7606 /* If vector is too small, get a bigger one. */
7607 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7608 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7609 /* Add this item. */
7610 ASET (menu_bar_items_vector
, i
, key
); i
++;
7611 ASET (menu_bar_items_vector
, i
,
7612 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7613 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7614 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7615 menu_bar_items_index
= i
;
7617 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7621 old
= AREF (menu_bar_items_vector
, i
+ 2);
7622 /* If the new and the old items are not both keymaps,
7623 the lookup will only find `item'. */
7624 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7625 ASET (menu_bar_items_vector
, i
+ 2, item
);
7629 /* This is used as the handler when calling menu_item_eval_property. */
7631 menu_item_eval_property_1 (Lisp_Object arg
)
7633 /* If we got a quit from within the menu computation,
7634 quit all the way out of it. This takes care of C-] in the debugger. */
7635 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7636 Fsignal (Qquit
, Qnil
);
7642 eval_dyn (Lisp_Object form
)
7644 return Feval (form
, Qnil
);
7647 /* Evaluate an expression and return the result (or nil if something
7648 went wrong). Used to evaluate dynamic parts of menu items. */
7650 menu_item_eval_property (Lisp_Object sexpr
)
7652 ptrdiff_t count
= SPECPDL_INDEX ();
7654 specbind (Qinhibit_redisplay
, Qt
);
7655 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7656 menu_item_eval_property_1
);
7657 return unbind_to (count
, val
);
7660 /* This function parses a menu item and leaves the result in the
7661 vector item_properties.
7662 ITEM is a key binding, a possible menu item.
7663 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7665 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7666 parse_menu_item returns true if the item is a menu item and false
7670 parse_menu_item (Lisp_Object item
, int inmenubar
)
7672 Lisp_Object def
, tem
, item_string
, start
;
7674 Lisp_Object keyhint
;
7683 /* Create item_properties vector if necessary. */
7684 if (NILP (item_properties
))
7686 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7688 /* Initialize optional entries. */
7689 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7690 ASET (item_properties
, i
, Qnil
);
7691 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7693 /* Save the item here to protect it from GC. */
7694 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7696 item_string
= XCAR (item
);
7700 if (STRINGP (item_string
))
7702 /* Old format menu item. */
7703 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7705 /* Maybe help string. */
7706 if (CONSP (item
) && STRINGP (XCAR (item
)))
7708 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7713 /* Maybe an obsolete key binding cache. */
7714 if (CONSP (item
) && CONSP (XCAR (item
))
7715 && (NILP (XCAR (XCAR (item
)))
7716 || VECTORP (XCAR (XCAR (item
)))))
7719 /* This is the real definition--the function to run. */
7720 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7722 /* Get enable property, if any. */
7725 tem
= Fget (item
, Qmenu_enable
);
7726 if (!NILP (Venable_disabled_menus_and_buttons
))
7727 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7728 else if (!NILP (tem
))
7729 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7732 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7734 /* New format menu item. */
7735 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7736 start
= XCDR (item
);
7739 /* We have a real binding. */
7740 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7742 item
= XCDR (start
);
7743 /* Is there an obsolete cache list with key equivalences. */
7744 if (CONSP (item
) && CONSP (XCAR (item
)))
7747 /* Parse properties. */
7748 while (CONSP (item
) && CONSP (XCDR (item
)))
7753 if (EQ (tem
, QCenable
))
7755 if (!NILP (Venable_disabled_menus_and_buttons
))
7756 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7758 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7760 else if (EQ (tem
, QCvisible
))
7762 /* If got a visible property and that evaluates to nil
7763 then ignore this item. */
7764 tem
= menu_item_eval_property (XCAR (item
));
7768 else if (EQ (tem
, QChelp
))
7769 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7770 else if (EQ (tem
, QCfilter
))
7772 else if (EQ (tem
, QCkey_sequence
))
7775 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7776 /* Be GC protected. Set keyhint to item instead of tem. */
7779 else if (EQ (tem
, QCkeys
))
7782 if (CONSP (tem
) || STRINGP (tem
))
7783 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7785 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7790 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7792 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7794 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7800 else if (inmenubar
|| !NILP (start
))
7804 return 0; /* not a menu item */
7806 /* If item string is not a string, evaluate it to get string.
7807 If we don't get a string, skip this item. */
7808 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7809 if (!(STRINGP (item_string
)))
7811 item_string
= menu_item_eval_property (item_string
);
7812 if (!STRINGP (item_string
))
7814 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7817 /* If got a filter apply it on definition. */
7818 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7821 def
= menu_item_eval_property (list2 (XCAR (filter
),
7822 list2 (Qquote
, def
)));
7824 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7827 /* Enable or disable selection of item. */
7828 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7831 tem
= menu_item_eval_property (tem
);
7832 if (inmenubar
&& NILP (tem
))
7833 return 0; /* Ignore disabled items in menu bar. */
7834 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7837 /* If we got no definition, this item is just unselectable text which
7838 is OK in a submenu but not in the menubar. */
7840 return (!inmenubar
);
7842 /* See if this is a separate pane or a submenu. */
7843 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7844 tem
= get_keymap (def
, 0, 1);
7845 /* For a subkeymap, just record its details and exit. */
7848 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7849 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7853 /* At the top level in the menu bar, do likewise for commands also.
7854 The menu bar does not display equivalent key bindings anyway.
7855 ITEM_PROPERTY_DEF is already set up properly. */
7859 { /* This is a command. See if there is an equivalent key binding. */
7860 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7862 /* The previous code preferred :key-sequence to :keys, so we
7863 preserve this behavior. */
7864 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7865 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7868 Lisp_Object prefix
= keyeq
;
7869 Lisp_Object keys
= Qnil
;
7873 def
= XCAR (prefix
);
7874 prefix
= XCDR (prefix
);
7877 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7879 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7881 keys
= XCAR (keyhint
);
7882 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7884 /* We have a suggested key. Is it bound to the command? */
7887 /* If the command is an alias for another
7888 (such as lmenu.el set it up), check if the
7889 original command matches the cached command. */
7891 && EQ (tem
, XSYMBOL (def
)->function
))))
7896 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7900 tem
= Fkey_description (keys
, Qnil
);
7903 if (STRINGP (XCAR (prefix
)))
7904 tem
= concat2 (XCAR (prefix
), tem
);
7905 if (STRINGP (XCDR (prefix
)))
7906 tem
= concat2 (tem
, XCDR (prefix
));
7908 keyeq
= concat2 (build_string (" "), tem
);
7909 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7915 /* If we have an equivalent key binding, use that. */
7916 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7919 /* Include this when menu help is implemented.
7920 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7921 if (!(NILP (tem) || STRINGP (tem)))
7923 tem = menu_item_eval_property (tem);
7926 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7930 /* Handle radio buttons or toggle boxes. */
7931 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7933 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7934 menu_item_eval_property (tem
));
7941 /***********************************************************************
7943 ***********************************************************************/
7945 /* A vector holding tool bar items while they are parsed in function
7946 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7949 static Lisp_Object tool_bar_items_vector
;
7951 /* A vector holding the result of parse_tool_bar_item. Layout is like
7952 the one for a single item in tool_bar_items_vector. */
7954 static Lisp_Object tool_bar_item_properties
;
7956 /* Next free index in tool_bar_items_vector. */
7958 static int ntool_bar_items
;
7960 /* The symbols `:image' and `:rtl'. */
7962 static Lisp_Object QCimage
;
7963 static Lisp_Object QCrtl
;
7965 /* Function prototypes. */
7967 static void init_tool_bar_items (Lisp_Object
);
7968 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7970 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7971 static void append_tool_bar_item (void);
7974 /* Return a vector of tool bar items for keymaps currently in effect.
7975 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7976 tool bar items found. */
7979 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7988 /* In order to build the menus, we need to call the keymap
7989 accessors. They all call QUIT. But this function is called
7990 during redisplay, during which a quit is fatal. So inhibit
7991 quitting while building the menus. We do this instead of
7992 specbind because (1) errors will clear it anyway and (2) this
7993 avoids risk of specpdl overflow. */
7994 oquit
= Vinhibit_quit
;
7997 /* Initialize tool_bar_items_vector and protect it from GC. */
7998 init_tool_bar_items (reuse
);
8000 /* Build list of keymaps in maps. Set nmaps to the number of maps
8003 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8004 if (!NILP (Voverriding_local_map_menu_flag
)
8005 && !NILP (Voverriding_local_map
))
8007 /* Yes, use them (if non-nil) as well as the global map. */
8008 maps
= alloca (3 * sizeof *maps
);
8010 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8011 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8012 if (!NILP (Voverriding_local_map
))
8013 maps
[nmaps
++] = Voverriding_local_map
;
8017 /* No, so use major and minor mode keymaps and keymap property.
8018 Note that tool-bar bindings in the local-map and keymap
8019 properties may not work reliable, as they are only
8020 recognized when the tool-bar (or mode-line) is updated,
8021 which does not normally happen after every command. */
8024 nminor
= current_minor_maps (NULL
, &tmaps
);
8025 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8027 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8028 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8029 maps
[nmaps
++] = tem
;
8030 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8031 maps
[nmaps
++] = tem
;
8032 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8034 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8037 /* Add global keymap at the end. */
8038 maps
[nmaps
++] = current_global_map
;
8040 /* Process maps in reverse order and look up in each map the prefix
8042 for (i
= nmaps
- 1; i
>= 0; --i
)
8043 if (!NILP (maps
[i
]))
8047 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8049 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8052 Vinhibit_quit
= oquit
;
8053 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8054 return tool_bar_items_vector
;
8058 /* Process the definition of KEY which is DEF. */
8061 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8064 struct gcpro gcpro1
, gcpro2
;
8066 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8070 if (EQ (def
, Qundefined
))
8072 /* If a map has an explicit `undefined' as definition,
8073 discard any previously made item. */
8074 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8076 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8078 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8080 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8081 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8082 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8084 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8089 else if (parse_tool_bar_item (key
, def
))
8090 /* Append a new tool bar item to tool_bar_items_vector. Accept
8091 more than one definition for the same key. */
8092 append_tool_bar_item ();
8097 /* Access slot with index IDX of vector tool_bar_item_properties. */
8098 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8100 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8102 ASET (tool_bar_item_properties
, idx
, val
);
8106 /* Parse a tool bar item specification ITEM for key KEY and return the
8107 result in tool_bar_item_properties. Value is false if ITEM is
8110 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8112 CAPTION is the caption of the item, If it's not a string, it is
8113 evaluated to get a string.
8115 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8116 as binding are currently ignored.
8118 The following properties are recognized:
8122 FORM is evaluated and specifies whether the tool bar item is
8123 enabled or disabled.
8127 FORM is evaluated and specifies whether the tool bar item is visible.
8129 - `:filter FUNCTION'
8131 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8132 result is stored as the new binding.
8134 - `:button (TYPE SELECTED)'
8136 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8137 and specifies whether the button is selected (pressed) or not.
8141 IMAGES is either a single image specification or a vector of four
8142 image specifications. See enum tool_bar_item_images.
8144 - `:help HELP-STRING'.
8146 Gives a help string to display for the tool bar item.
8148 - `:label LABEL-STRING'.
8150 A text label to show with the tool bar button if labels are enabled. */
8153 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8155 Lisp_Object filter
= Qnil
;
8156 Lisp_Object caption
;
8158 bool have_label
= 0;
8160 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8161 Rule out items that aren't lists, don't start with
8162 `menu-item' or whose rest following `tool-bar-item' is not a
8167 /* As an exception, allow old-style menu separators. */
8168 if (STRINGP (XCAR (item
)))
8169 item
= list1 (XCAR (item
));
8170 else if (!EQ (XCAR (item
), Qmenu_item
)
8171 || (item
= XCDR (item
), !CONSP (item
)))
8174 /* Create tool_bar_item_properties vector if necessary. Reset it to
8176 if (VECTORP (tool_bar_item_properties
))
8178 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8182 tool_bar_item_properties
8183 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8186 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8187 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8189 /* Get the caption of the item. If the caption is not a string,
8190 evaluate it to get a string. If we don't get a string, skip this
8192 caption
= XCAR (item
);
8193 if (!STRINGP (caption
))
8195 caption
= menu_item_eval_property (caption
);
8196 if (!STRINGP (caption
))
8199 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8201 /* If the rest following the caption is not a list, the menu item is
8202 either a separator, or invalid. */
8206 if (menu_separator_name_p (SSDATA (caption
)))
8208 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8209 #if !defined (USE_GTK) && !defined (HAVE_NS)
8210 /* If we use build_desired_tool_bar_string to render the
8211 tool bar, the separator is rendered as an image. */
8212 set_prop (TOOL_BAR_ITEM_IMAGES
,
8213 (menu_item_eval_property
8214 (Vtool_bar_separator_image_expression
)));
8215 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8216 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8217 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8224 /* Store the binding. */
8225 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8228 /* Ignore cached key binding, if any. */
8229 if (CONSP (item
) && CONSP (XCAR (item
)))
8232 /* Process the rest of the properties. */
8233 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8235 Lisp_Object ikey
, value
;
8238 value
= XCAR (XCDR (item
));
8240 if (EQ (ikey
, QCenable
))
8242 /* `:enable FORM'. */
8243 if (!NILP (Venable_disabled_menus_and_buttons
))
8244 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8246 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8248 else if (EQ (ikey
, QCvisible
))
8250 /* `:visible FORM'. If got a visible property and that
8251 evaluates to nil then ignore this item. */
8252 if (NILP (menu_item_eval_property (value
)))
8255 else if (EQ (ikey
, QChelp
))
8256 /* `:help HELP-STRING'. */
8257 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8258 else if (EQ (ikey
, QCvert_only
))
8259 /* `:vert-only t/nil'. */
8260 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8261 else if (EQ (ikey
, QClabel
))
8263 const char *bad_label
= "!!?GARBLED ITEM?!!";
8264 /* `:label LABEL-STRING'. */
8265 set_prop (TOOL_BAR_ITEM_LABEL
,
8266 STRINGP (value
) ? value
: build_string (bad_label
));
8269 else if (EQ (ikey
, QCfilter
))
8270 /* ':filter FORM'. */
8272 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8274 /* `:button (TYPE . SELECTED)'. */
8275 Lisp_Object type
, selected
;
8277 type
= XCAR (value
);
8278 selected
= XCDR (value
);
8279 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8281 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8282 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8285 else if (EQ (ikey
, QCimage
)
8287 || (VECTORP (value
) && ASIZE (value
) == 4)))
8288 /* Value is either a single image specification or a vector
8289 of 4 such specifications for the different button states. */
8290 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8291 else if (EQ (ikey
, QCrtl
))
8293 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8299 /* Try to make one from caption and key. */
8300 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8301 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8302 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8303 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8305 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8306 char *buf
= xmalloc_atomic (max_lbl
+ 1);
8307 Lisp_Object new_lbl
;
8308 ptrdiff_t caption_len
= strlen (capt
);
8310 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8313 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8315 buf
[caption_len
] = '\0';
8319 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8323 strcpy (buf
, label
);
8325 for (j
= 0; buf
[j
] != '\0'; ++j
)
8333 new_lbl
= Fupcase_initials (build_string (label
));
8334 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8335 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8337 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8341 /* If got a filter apply it on binding. */
8343 set_prop (TOOL_BAR_ITEM_BINDING
,
8344 (menu_item_eval_property
8347 PROP (TOOL_BAR_ITEM_BINDING
))))));
8349 /* See if the binding is a keymap. Give up if it is. */
8350 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8353 /* Enable or disable selection of item. */
8354 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8355 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8356 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8358 /* Handle radio buttons or toggle boxes. */
8359 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8360 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8361 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8369 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8370 that can be reused. */
8373 init_tool_bar_items (Lisp_Object reuse
)
8375 if (VECTORP (reuse
))
8376 tool_bar_items_vector
= reuse
;
8378 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8379 ntool_bar_items
= 0;
8383 /* Append parsed tool bar item properties from
8384 tool_bar_item_properties */
8387 append_tool_bar_item (void)
8391 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8393 /* Enlarge tool_bar_items_vector if necessary. */
8395 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8397 /* Append entries from tool_bar_item_properties to the end of
8398 tool_bar_items_vector. */
8399 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8400 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8401 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8408 /* Read a character using menus based on the keymap MAP.
8409 Return nil if there are no menus in the maps.
8410 Return t if we displayed a menu but the user rejected it.
8412 PREV_EVENT is the previous input event, or nil if we are reading
8413 the first event of a key sequence.
8415 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8416 if we used a mouse menu to read the input, or false otherwise. If
8417 USED_MOUSE_MENU is null, don't dereference it.
8419 The prompting is done based on the prompt-string of the map
8420 and the strings associated with various map elements.
8422 This can be done with X menus or with menus put in the minibuf.
8423 These are done in different ways, depending on how the input will be read.
8424 Menus using X are done after auto-saving in read-char, getting the input
8425 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8426 and do auto-saving in the inner call of read_char. */
8429 read_char_x_menu_prompt (Lisp_Object map
,
8430 Lisp_Object prev_event
, bool *used_mouse_menu
)
8432 if (used_mouse_menu
)
8433 *used_mouse_menu
= 0;
8435 /* Use local over global Menu maps. */
8437 if (! menu_prompting
)
8440 /* If we got to this point via a mouse click,
8441 use a real menu for mouse selection. */
8442 if (EVENT_HAS_PARAMETERS (prev_event
)
8443 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8444 && !EQ (XCAR (prev_event
), Qtool_bar
))
8446 /* Display the menu and get the selection. */
8449 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8454 record_menu_key (XCAR (value
));
8456 /* If we got multiple events, unread all but
8458 There is no way to prevent those unread events
8459 from showing up later in last_nonmenu_event.
8460 So turn symbol and integer events into lists,
8461 to indicate that they came from a mouse menu,
8462 so that when present in last_nonmenu_event
8463 they won't confuse things. */
8464 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8466 record_menu_key (XCAR (tem
));
8467 if (SYMBOLP (XCAR (tem
))
8468 || INTEGERP (XCAR (tem
)))
8469 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8472 /* If we got more than one event, put all but the first
8473 onto this list to be read later.
8474 Return just the first event now. */
8475 Vunread_command_events
8476 = nconc2 (XCDR (value
), Vunread_command_events
);
8477 value
= XCAR (value
);
8479 else if (NILP (value
))
8481 if (used_mouse_menu
)
8482 *used_mouse_menu
= 1;
8489 read_char_minibuf_menu_prompt (int commandflag
,
8492 register Lisp_Object name
;
8494 /* FIXME: Use the minibuffer's frame width. */
8495 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8497 bool nobindings
= 1;
8498 Lisp_Object rest
, vector
;
8499 Lisp_Object prompt_strings
= Qnil
;
8503 if (! menu_prompting
)
8506 map
= get_keymap (map
, 0, 1);
8507 name
= Fkeymap_prompt (map
);
8509 /* If we don't have any menus, just read a character normally. */
8510 if (!STRINGP (name
))
8513 #define PUSH_C_STR(str, listvar) \
8514 listvar = Fcons (build_unibyte_string (str), listvar)
8516 /* Prompt string always starts with map's prompt, and a space. */
8517 prompt_strings
= Fcons (name
, prompt_strings
);
8518 PUSH_C_STR (": ", prompt_strings
);
8519 nlength
= SCHARS (name
) + 2;
8523 /* Present the documented bindings, a line at a time. */
8527 Lisp_Object menu_strings
= prompt_strings
;
8528 ptrdiff_t i
= nlength
;
8530 Lisp_Object orig_defn_macro
;
8532 /* Loop over elements of map. */
8537 /* FIXME: Use map_keymap to handle new keymap formats. */
8539 /* At end of map, wrap around if just starting,
8540 or end this line if already have something on it. */
8543 if (notfirst
|| nobindings
)
8549 /* Look at the next element of the map. */
8551 elt
= AREF (vector
, idx
);
8553 elt
= Fcar_safe (rest
);
8555 if (idx
< 0 && VECTORP (elt
))
8557 /* If we found a dense table in the keymap,
8558 advanced past it, but start scanning its contents. */
8559 rest
= Fcdr_safe (rest
);
8565 /* An ordinary element. */
8566 Lisp_Object event
, tem
;
8570 event
= Fcar_safe (elt
); /* alist */
8571 elt
= Fcdr_safe (elt
);
8575 XSETINT (event
, idx
); /* vector */
8578 /* Ignore the element if it has no prompt string. */
8579 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8581 /* True if the char to type matches the string. */
8583 Lisp_Object upcased_event
, downcased_event
;
8584 Lisp_Object desc
= Qnil
;
8586 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8588 upcased_event
= Fupcase (event
);
8589 downcased_event
= Fdowncase (event
);
8590 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8591 || XINT (downcased_event
) == SREF (s
, 0));
8593 desc
= Fsingle_key_description (event
, Qnil
);
8595 #if 0 /* It is redundant to list the equivalent key bindings because
8596 the prefix is what the user has already typed. */
8598 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8600 /* Insert equivalent keybinding. */
8601 s
= concat2 (s
, tem
);
8604 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8605 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8607 /* Insert button prefix. */
8608 Lisp_Object selected
8609 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8610 if (EQ (tem
, QCradio
))
8611 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8613 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8614 s
= concat2 (tem
, s
);
8618 /* If we have room for the prompt string, add it to this line.
8619 If this is the first on the line, always add it. */
8620 if ((SCHARS (s
) + i
+ 2
8621 + (char_matches
? 0 : SCHARS (desc
) + 3))
8625 ptrdiff_t thiswidth
;
8627 /* Punctuate between strings. */
8630 PUSH_C_STR (", ", menu_strings
);
8636 /* If the char to type doesn't match the string's
8637 first char, explicitly show what char to type. */
8640 /* Add as much of string as fits. */
8641 thiswidth
= min (SCHARS (desc
), width
- i
);
8643 = Fcons (Fsubstring (desc
, make_number (0),
8644 make_number (thiswidth
)),
8647 PUSH_C_STR (" = ", menu_strings
);
8651 /* Add as much of string as fits. */
8652 thiswidth
= min (SCHARS (s
), width
- i
);
8654 = Fcons (Fsubstring (s
, make_number (0),
8655 make_number (thiswidth
)),
8661 /* If this element does not fit, end the line now,
8662 and save the element for the next line. */
8663 PUSH_C_STR ("...", menu_strings
);
8668 /* Move past this element. */
8669 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8670 /* Handle reaching end of dense table. */
8675 rest
= Fcdr_safe (rest
);
8679 /* Prompt with that and read response. */
8680 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8682 /* Make believe it's not a keyboard macro in case the help char
8683 is pressed. Help characters are not recorded because menu prompting
8684 is not used on replay. */
8685 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8686 kset_defining_kbd_macro (current_kboard
, Qnil
);
8688 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8689 while (BUFFERP (obj
));
8690 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8692 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8695 if (! EQ (obj
, menu_prompt_more_char
)
8696 && (!INTEGERP (menu_prompt_more_char
)
8697 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8699 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8700 store_kbd_macro_char (obj
);
8703 /* Help char - go round again. */
8707 /* Reading key sequences. */
8710 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8712 return access_keymap (get_keymap (keymap
, 0, 1),
8717 active_maps (Lisp_Object first_event
)
8719 Lisp_Object position
8720 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8721 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8724 /* Structure used to keep track of partial application of key remapping
8725 such as Vfunction_key_map and Vkey_translation_map. */
8726 typedef struct keyremap
8728 /* This is the map originally specified for this use. */
8730 /* This is a submap reached by looking up, in PARENT,
8731 the events from START to END. */
8733 /* Positions [START, END) in the key sequence buffer
8734 are the key that we have scanned so far.
8735 Those events are the ones that we will replace
8736 if PARENT maps them into a key sequence. */
8740 /* Lookup KEY in MAP.
8741 MAP is a keymap mapping keys to key vectors or functions.
8742 If the mapping is a function and DO_FUNCALL is true,
8743 the function is called with PROMPT as parameter and its return
8744 value is used as the return value of this function (after checking
8745 that it is indeed a vector). */
8748 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8753 next
= access_keymap (map
, key
, 1, 0, 1);
8755 /* Handle a symbol whose function definition is a keymap
8757 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8758 && (ARRAYP (XSYMBOL (next
)->function
)
8759 || KEYMAPP (XSYMBOL (next
)->function
)))
8760 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8762 /* If the keymap gives a function, not an
8763 array, then call the function with one arg and use
8764 its value instead. */
8765 if (do_funcall
&& FUNCTIONP (next
))
8770 next
= call1 (next
, prompt
);
8771 /* If the function returned something invalid,
8772 barf--don't ignore it.
8773 (To ignore it safely, we would need to gcpro a bunch of
8774 other variables.) */
8775 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8776 error ("Function %s returns invalid key sequence",
8777 SSDATA (SYMBOL_NAME (tem
)));
8782 /* Do one step of the key remapping used for function-key-map and
8783 key-translation-map:
8784 KEYBUF is the buffer holding the input events.
8785 BUFSIZE is its maximum size.
8786 FKEY is a pointer to the keyremap structure to use.
8787 INPUT is the index of the last element in KEYBUF.
8788 DOIT if true says that the remapping can actually take place.
8789 DIFF is used to return the number of keys added/removed by the remapping.
8790 PARENT is the root of the keymap.
8791 PROMPT is the prompt to use if the remapping happens through a function.
8792 Return true if the remapping actually took place. */
8795 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8796 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8798 Lisp_Object next
, key
;
8800 key
= keybuf
[fkey
->end
++];
8802 if (KEYMAPP (fkey
->parent
))
8803 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8807 /* If keybuf[fkey->start..fkey->end] is bound in the
8808 map and we're in a position to do the key remapping, replace it with
8809 the binding and restart with fkey->start at the end. */
8810 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8812 int len
= XFASTINT (Flength (next
));
8815 *diff
= len
- (fkey
->end
- fkey
->start
);
8817 if (bufsize
- input
<= *diff
)
8818 error ("Key sequence too long");
8820 /* Shift the keys that follow fkey->end. */
8822 for (i
= fkey
->end
; i
< input
; i
++)
8823 keybuf
[i
+ *diff
] = keybuf
[i
];
8825 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8826 keybuf
[i
+ *diff
] = keybuf
[i
];
8827 /* Overwrite the old keys with the new ones. */
8828 for (i
= 0; i
< len
; i
++)
8829 keybuf
[fkey
->start
+ i
]
8830 = Faref (next
, make_number (i
));
8832 fkey
->start
= fkey
->end
+= *diff
;
8833 fkey
->map
= fkey
->parent
;
8838 fkey
->map
= get_keymap (next
, 0, 1);
8840 /* If we no longer have a bound suffix, try a new position for
8842 if (!CONSP (fkey
->map
))
8844 fkey
->end
= ++fkey
->start
;
8845 fkey
->map
= fkey
->parent
;
8851 test_undefined (Lisp_Object binding
)
8853 return (NILP (binding
)
8854 || EQ (binding
, Qundefined
)
8855 || (SYMBOLP (binding
)
8856 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8859 /* Read a sequence of keys that ends with a non prefix character,
8860 storing it in KEYBUF, a buffer of size BUFSIZE.
8862 Return the length of the key sequence stored.
8863 Return -1 if the user rejected a command menu.
8865 Echo starting immediately unless `prompt' is 0.
8867 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8868 read_char with a suitable COMMANDFLAG argument.
8870 Where a key sequence ends depends on the currently active keymaps.
8871 These include any minor mode keymaps active in the current buffer,
8872 the current buffer's local map, and the global map.
8874 If a key sequence has no other bindings, we check Vfunction_key_map
8875 to see if some trailing subsequence might be the beginning of a
8876 function key's sequence. If so, we try to read the whole function
8877 key, and substitute its symbolic name into the key sequence.
8879 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8880 `double-' events into similar click events, if that would make them
8881 bound. We try to turn `triple-' events first into `double-' events,
8884 If we get a mouse click in a mode line, vertical divider, or other
8885 non-text area, we treat the click as if it were prefixed by the
8886 symbol denoting that area - `mode-line', `vertical-line', or
8889 If the sequence starts with a mouse click, we read the key sequence
8890 with respect to the buffer clicked on, not the current buffer.
8892 If the user switches frames in the midst of a key sequence, we put
8893 off the switch-frame event until later; the next call to
8894 read_char will return it.
8896 If FIX_CURRENT_BUFFER, we restore current_buffer
8897 from the selected window's buffer. */
8900 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8901 bool dont_downcase_last
, bool can_return_switch_frame
,
8902 bool fix_current_buffer
, bool prevent_redisplay
)
8904 /* How many keys there are in the current key sequence. */
8907 /* The length of the echo buffer when we started reading, and
8908 the length of this_command_keys when we started reading. */
8909 ptrdiff_t echo_start
IF_LINT (= 0);
8910 ptrdiff_t keys_start
;
8912 Lisp_Object current_binding
= Qnil
;
8913 Lisp_Object first_event
= Qnil
;
8915 /* Index of the first key that has no binding.
8916 It is useless to try fkey.start larger than that. */
8919 /* If t < mock_input, then KEYBUF[t] should be read as the next
8922 We use this to recover after recognizing a function key. Once we
8923 realize that a suffix of the current key sequence is actually a
8924 function key's escape sequence, we replace the suffix with the
8925 function key's binding from Vfunction_key_map. Now keybuf
8926 contains a new and different key sequence, so the echo area,
8927 this_command_keys, and the submaps and defs arrays are wrong. In
8928 this situation, we set mock_input to t, set t to 0, and jump to
8929 restart_sequence; the loop will read keys from keybuf up until
8930 mock_input, thus rebuilding the state; and then it will resume
8931 reading characters from the keyboard. */
8934 /* If the sequence is unbound in submaps[], then
8935 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8936 and fkey.map is its binding.
8938 These might be > t, indicating that all function key scanning
8939 should hold off until t reaches them. We do this when we've just
8940 recognized a function key, to avoid searching for the function
8941 key's again in Vfunction_key_map. */
8944 /* Likewise, for key_translation_map and input-decode-map. */
8945 keyremap keytran
, indec
;
8947 /* True if we are trying to map a key by changing an upper-case
8948 letter to lower case, or a shifted function key to an unshifted
8950 bool shift_translated
= 0;
8952 /* If we receive a `switch-frame' or `select-window' event in the middle of
8953 a key sequence, we put it off for later.
8954 While we're reading, we keep the event here. */
8955 Lisp_Object delayed_switch_frame
;
8957 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8958 int original_uppercase_position
= -1;
8960 /* Gets around Microsoft compiler limitations. */
8963 struct buffer
*starting_buffer
;
8965 /* List of events for which a fake prefix key has been generated. */
8966 Lisp_Object fake_prefixed_keys
= Qnil
;
8968 struct gcpro gcpro1
;
8972 GCPRO1 (fake_prefixed_keys
);
8973 raw_keybuf_count
= 0;
8975 last_nonmenu_event
= Qnil
;
8977 delayed_switch_frame
= Qnil
;
8983 /* Install the string PROMPT as the beginning of the string
8984 of echoing, so that it serves as a prompt for the next
8986 kset_echo_string (current_kboard
, prompt
);
8987 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8990 else if (cursor_in_echo_area
8991 && echo_keystrokes_p ())
8992 /* This doesn't put in a dash if the echo buffer is empty, so
8993 you don't always see a dash hanging out in the minibuffer. */
8997 /* Record the initial state of the echo area and this_command_keys;
8998 we will need to restore them if we replay a key sequence. */
9000 echo_start
= echo_length ();
9001 keys_start
= this_command_key_count
;
9002 this_single_command_key_start
= keys_start
;
9004 /* We jump here when we need to reinitialize fkey and keytran; this
9005 happens if we switch keyboards between rescans. */
9006 replay_entire_sequence
:
9008 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9009 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9010 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9011 indec
.start
= indec
.end
= 0;
9012 fkey
.start
= fkey
.end
= 0;
9013 keytran
.start
= keytran
.end
= 0;
9015 /* We jump here when the key sequence has been thoroughly changed, and
9016 we need to rescan it starting from the beginning. When we jump here,
9017 keybuf[0..mock_input] holds the sequence we should reread. */
9020 starting_buffer
= current_buffer
;
9021 first_unbound
= bufsize
+ 1;
9023 /* Build our list of keymaps.
9024 If we recognize a function key and replace its escape sequence in
9025 keybuf with its symbol, or if the sequence starts with a mouse
9026 click and we need to switch buffers, we jump back here to rebuild
9027 the initial keymaps from the current buffer. */
9028 current_binding
= active_maps (first_event
);
9030 /* Start from the beginning in keybuf. */
9033 /* These are no-ops the first time through, but if we restart, they
9034 revert the echo area and this_command_keys to their original state. */
9035 this_command_key_count
= keys_start
;
9036 if (INTERACTIVE
&& t
< mock_input
)
9037 echo_truncate (echo_start
);
9039 /* If the best binding for the current key sequence is a keymap, or
9040 we may be looking at a function key's escape sequence, keep on
9042 while (!NILP (current_binding
)
9043 /* Keep reading as long as there's a prefix binding. */
9044 ? KEYMAPP (current_binding
)
9045 /* Don't return in the middle of a possible function key sequence,
9046 if the only bindings we found were via case conversion.
9047 Thus, if ESC O a has a function-key-map translation
9048 and ESC o has a binding, don't return after ESC O,
9049 so that we can translate ESC O plus the next character. */
9050 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9053 bool used_mouse_menu
= 0;
9055 /* Where the last real key started. If we need to throw away a
9056 key that has expanded into more than one element of keybuf
9057 (say, a mouse click on the mode line which is being treated
9058 as [mode-line (mouse-...)], then we backtrack to this point
9060 int last_real_key_start
;
9062 /* These variables are analogous to echo_start and keys_start;
9063 while those allow us to restart the entire key sequence,
9064 echo_local_start and keys_local_start allow us to throw away
9066 ptrdiff_t echo_local_start
IF_LINT (= 0);
9067 int keys_local_start
;
9068 Lisp_Object new_binding
;
9070 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9071 eassert (indec
.start
<= indec
.end
);
9072 eassert (fkey
.start
<= fkey
.end
);
9073 eassert (keytran
.start
<= keytran
.end
);
9074 /* key-translation-map is applied *after* function-key-map
9075 which is itself applied *after* input-decode-map. */
9076 eassert (fkey
.end
<= indec
.start
);
9077 eassert (keytran
.end
<= fkey
.start
);
9079 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9080 first_unbound
< keytran
.start
)
9081 { /* The prefix upto first_unbound has no binding and has
9082 no translation left to do either, so we know it's unbound.
9083 If we don't stop now, we risk staying here indefinitely
9084 (if the user keeps entering fkey or keytran prefixes
9085 like C-c ESC ESC ESC ESC ...) */
9087 for (i
= first_unbound
+ 1; i
< t
; i
++)
9088 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9089 mock_input
= t
- first_unbound
- 1;
9090 indec
.end
= indec
.start
-= first_unbound
+ 1;
9091 indec
.map
= indec
.parent
;
9092 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9093 fkey
.map
= fkey
.parent
;
9094 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9095 keytran
.map
= keytran
.parent
;
9096 goto replay_sequence
;
9100 error ("Key sequence too long");
9103 echo_local_start
= echo_length ();
9104 keys_local_start
= this_command_key_count
;
9107 /* These are no-ops, unless we throw away a keystroke below and
9108 jumped back up to replay_key; in that case, these restore the
9109 variables to their original state, allowing us to replay the
9111 if (INTERACTIVE
&& t
< mock_input
)
9112 echo_truncate (echo_local_start
);
9113 this_command_key_count
= keys_local_start
;
9115 /* By default, assume each event is "real". */
9116 last_real_key_start
= t
;
9118 /* Does mock_input indicate that we are re-reading a key sequence? */
9122 add_command_key (key
);
9123 if (echo_keystrokes_p ()
9124 && current_kboard
->immediate_echo
)
9131 /* If not, we should actually read a character. */
9135 KBOARD
*interrupted_kboard
= current_kboard
;
9136 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9137 /* Calling read_char with COMMANDFLAG = -2 avoids
9138 redisplay in read_char and its subroutines. */
9139 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9140 current_binding
, last_nonmenu_event
,
9141 &used_mouse_menu
, NULL
);
9142 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9143 /* When switching to a new tty (with a new keyboard),
9144 read_char returns the new buffer, rather than -2
9145 (Bug#5095). This is because `terminal-init-xterm'
9146 calls read-char, which eats the wrong_kboard_jmpbuf
9147 return. Any better way to fix this? -- cyd */
9148 || (interrupted_kboard
!= current_kboard
))
9153 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9154 if (k
== interrupted_kboard
)
9159 /* Don't touch interrupted_kboard when it's been
9161 delayed_switch_frame
= Qnil
;
9162 goto replay_entire_sequence
;
9165 if (!NILP (delayed_switch_frame
))
9168 (interrupted_kboard
,
9169 Fcons (delayed_switch_frame
,
9170 KVAR (interrupted_kboard
, kbd_queue
)));
9171 delayed_switch_frame
= Qnil
;
9176 (interrupted_kboard
,
9177 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9179 /* If the side queue is non-empty, ensure it begins with a
9180 switch-frame, so we'll replay it in the right context. */
9181 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9182 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9183 !(EVENT_HAS_PARAMETERS (key
)
9184 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9188 XSETFRAME (frame
, interrupted_frame
);
9190 (interrupted_kboard
,
9191 Fcons (make_lispy_switch_frame (frame
),
9192 KVAR (interrupted_kboard
, kbd_queue
)));
9195 goto replay_entire_sequence
;
9199 /* read_char returns t when it shows a menu and the user rejects it.
9208 /* read_char returns -1 at the end of a macro.
9209 Emacs 18 handles this by returning immediately with a
9210 zero, so that's what we'll do. */
9211 if (INTEGERP (key
) && XINT (key
) == -1)
9214 /* The Microsoft C compiler can't handle the goto that
9220 /* If the current buffer has been changed from under us, the
9221 keymap may have changed, so replay the sequence. */
9224 timer_resume_idle ();
9227 /* Reset the current buffer from the selected window
9228 in case something changed the former and not the latter.
9229 This is to be more consistent with the behavior
9230 of the command_loop_1. */
9231 if (fix_current_buffer
)
9233 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9235 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9237 Fset_buffer (XWINDOW (selected_window
)->contents
);
9240 goto replay_sequence
;
9243 /* If we have a quit that was typed in another frame, and
9244 quit_throw_to_read_char switched buffers,
9245 replay to get the right keymap. */
9247 && XINT (key
) == quit_char
9248 && current_buffer
!= starting_buffer
)
9251 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9256 goto replay_sequence
;
9261 if (EVENT_HAS_PARAMETERS (key
)
9262 /* Either a `switch-frame' or a `select-window' event. */
9263 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9265 /* If we're at the beginning of a key sequence, and the caller
9266 says it's okay, go ahead and return this event. If we're
9267 in the midst of a key sequence, delay it until the end. */
9268 if (t
> 0 || !can_return_switch_frame
)
9270 delayed_switch_frame
= key
;
9275 if (NILP (first_event
))
9278 /* Even if first_event does not specify a particular
9279 window/position, it's important to recompute the maps here
9280 since a long time might have passed since we entered
9281 read_key_sequence, and a timer (or process-filter or
9282 special-event-map, ...) might have switched the current buffer
9283 or the selected window from under us in the mean time. */
9284 if (fix_current_buffer
9285 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9287 Fset_buffer (XWINDOW (selected_window
)->contents
);
9288 current_binding
= active_maps (first_event
);
9292 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9296 /* Clicks in non-text areas get prefixed by the symbol
9297 in their CHAR-ADDRESS field. For example, a click on
9298 the mode line is prefixed by the symbol `mode-line'.
9300 Furthermore, key sequences beginning with mouse clicks
9301 are read using the keymaps of the buffer clicked on, not
9302 the current buffer. So we may have to switch the buffer
9305 When we turn one event into two events, we must make sure
9306 that neither of the two looks like the original--so that,
9307 if we replay the events, they won't be expanded again.
9308 If not for this, such reexpansion could happen either here
9309 or when user programs play with this-command-keys. */
9310 if (EVENT_HAS_PARAMETERS (key
))
9312 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9313 if (EQ (kind
, Qmouse_click
))
9315 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9316 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9319 || (!NILP (fake_prefixed_keys
)
9320 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9322 /* We're looking a second time at an event for which
9323 we generated a fake prefix key. Set
9324 last_real_key_start appropriately. */
9326 last_real_key_start
= t
- 1;
9329 if (last_real_key_start
== 0)
9331 /* Key sequences beginning with mouse clicks are
9332 read using the keymaps in the buffer clicked on,
9333 not the current buffer. If we're at the
9334 beginning of a key sequence, switch buffers. */
9335 if (WINDOWP (window
)
9336 && BUFFERP (XWINDOW (window
)->contents
)
9337 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9339 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9344 /* Arrange to go back to the original buffer once we're
9345 done reading the key sequence. Note that we can't
9346 use save_excursion_{save,restore} here, because they
9347 save point as well as the current buffer; we don't
9348 want to save point, because redisplay may change it,
9349 to accommodate a Fset_window_start or something. We
9350 don't want to do this at the top of the function,
9351 because we may get input from a subprocess which
9352 wants to change the selected window and stuff (say,
9354 record_unwind_current_buffer ();
9356 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9358 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9359 goto replay_sequence
;
9363 /* Expand mode-line and scroll-bar events into two events:
9364 use posn as a fake prefix key. */
9366 && (NILP (fake_prefixed_keys
)
9367 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9369 if (bufsize
- t
<= 1)
9370 error ("Key sequence too long");
9373 keybuf
[t
+ 1] = key
;
9376 /* Record that a fake prefix key has been generated
9377 for KEY. Don't modify the event; this would
9378 prevent proper action when the event is pushed
9379 back into unread-command-events. */
9380 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9384 else if (CONSP (XCDR (key
))
9385 && CONSP (EVENT_START (key
))
9386 && CONSP (XCDR (EVENT_START (key
))))
9390 posn
= POSN_POSN (EVENT_START (key
));
9391 /* Handle menu-bar events:
9392 insert the dummy prefix event `menu-bar'. */
9393 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9395 if (bufsize
- t
<= 1)
9396 error ("Key sequence too long");
9398 keybuf
[t
+ 1] = key
;
9400 /* Zap the position in key, so we know that we've
9401 expanded it, and don't try to do so again. */
9402 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9405 goto replay_sequence
;
9407 else if (CONSP (posn
))
9409 /* We're looking at the second event of a
9410 sequence which we expanded before. Set
9411 last_real_key_start appropriately. */
9412 if (last_real_key_start
== t
&& t
> 0)
9413 last_real_key_start
= t
- 1;
9418 /* We have finally decided that KEY is something we might want
9420 new_binding
= follow_key (current_binding
, key
);
9422 /* If KEY wasn't bound, we'll try some fallbacks. */
9423 if (!NILP (new_binding
))
9424 /* This is needed for the following scenario:
9425 event 0: a down-event that gets dropped by calling replay_key.
9426 event 1: some normal prefix like C-h.
9427 After event 0, first_unbound is 0, after event 1 indec.start,
9428 fkey.start, and keytran.start are all 1, so when we see that
9429 C-h is bound, we need to update first_unbound. */
9430 first_unbound
= max (t
+ 1, first_unbound
);
9435 /* Remember the position to put an upper bound on indec.start. */
9436 first_unbound
= min (t
, first_unbound
);
9438 head
= EVENT_HEAD (key
);
9442 Lisp_Object breakdown
;
9445 breakdown
= parse_modifiers (head
);
9446 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9447 /* Attempt to reduce an unbound mouse event to a simpler
9448 event that is bound:
9449 Drags reduce to clicks.
9450 Double-clicks reduce to clicks.
9451 Triple-clicks reduce to double-clicks, then to clicks.
9452 Down-clicks are eliminated.
9453 Double-downs reduce to downs, then are eliminated.
9454 Triple-downs reduce to double-downs, then to downs,
9455 then are eliminated. */
9456 if (modifiers
& (down_modifier
| drag_modifier
9457 | double_modifier
| triple_modifier
))
9459 while (modifiers
& (down_modifier
| drag_modifier
9460 | double_modifier
| triple_modifier
))
9462 Lisp_Object new_head
, new_click
;
9463 if (modifiers
& triple_modifier
)
9464 modifiers
^= (double_modifier
| triple_modifier
);
9465 else if (modifiers
& double_modifier
)
9466 modifiers
&= ~double_modifier
;
9467 else if (modifiers
& drag_modifier
)
9468 modifiers
&= ~drag_modifier
;
9471 /* Dispose of this `down' event by simply jumping
9472 back to replay_key, to get another event.
9474 Note that if this event came from mock input,
9475 then just jumping back to replay_key will just
9476 hand it to us again. So we have to wipe out any
9479 We could delete keybuf[t] and shift everything
9480 after that to the left by one spot, but we'd also
9481 have to fix up any variable that points into
9482 keybuf, and shifting isn't really necessary
9485 Adding prefixes for non-textual mouse clicks
9486 creates two characters of mock input, and both
9487 must be thrown away. If we're only looking at
9488 the prefix now, we can just jump back to
9489 replay_key. On the other hand, if we've already
9490 processed the prefix, and now the actual click
9491 itself is giving us trouble, then we've lost the
9492 state of the keymaps we want to backtrack to, and
9493 we need to replay the whole sequence to rebuild
9496 Beyond that, only function key expansion could
9497 create more than two keys, but that should never
9498 generate mouse events, so it's okay to zero
9499 mock_input in that case too.
9501 FIXME: The above paragraph seems just plain
9502 wrong, if you consider things like
9503 xterm-mouse-mode. -stef
9505 Isn't this just the most wonderful code ever? */
9507 /* If mock_input > t + 1, the above simplification
9508 will actually end up dropping keys on the floor.
9509 This is probably OK for now, but even
9510 if mock_input <= t + 1, we need to adjust indec,
9512 Typical case [header-line down-mouse-N]:
9513 mock_input = 2, t = 1, fkey.end = 1,
9514 last_real_key_start = 0. */
9515 if (indec
.end
> last_real_key_start
)
9517 indec
.end
= indec
.start
9518 = min (last_real_key_start
, indec
.start
);
9519 indec
.map
= indec
.parent
;
9520 if (fkey
.end
> last_real_key_start
)
9522 fkey
.end
= fkey
.start
9523 = min (last_real_key_start
, fkey
.start
);
9524 fkey
.map
= fkey
.parent
;
9525 if (keytran
.end
> last_real_key_start
)
9527 keytran
.end
= keytran
.start
9528 = min (last_real_key_start
, keytran
.start
);
9529 keytran
.map
= keytran
.parent
;
9533 if (t
== last_real_key_start
)
9540 mock_input
= last_real_key_start
;
9541 goto replay_sequence
;
9546 = apply_modifiers (modifiers
, XCAR (breakdown
));
9547 new_click
= list2 (new_head
, EVENT_START (key
));
9549 /* Look for a binding for this new key. */
9550 new_binding
= follow_key (current_binding
, new_click
);
9552 /* If that click is bound, go for it. */
9553 if (!NILP (new_binding
))
9555 current_binding
= new_binding
;
9559 /* Otherwise, we'll leave key set to the drag event. */
9564 current_binding
= new_binding
;
9567 /* Normally, last_nonmenu_event gets the previous key we read.
9568 But when a mouse popup menu is being used,
9569 we don't update last_nonmenu_event; it continues to hold the mouse
9570 event that preceded the first level of menu. */
9571 if (!used_mouse_menu
)
9572 last_nonmenu_event
= key
;
9574 /* Record what part of this_command_keys is the current key sequence. */
9575 this_single_command_key_start
= this_command_key_count
- t
;
9577 /* Look for this sequence in input-decode-map.
9578 Scan from indec.end until we find a bound suffix. */
9579 while (indec
.end
< t
)
9581 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9585 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9586 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9591 mock_input
= diff
+ max (t
, mock_input
);
9592 goto replay_sequence
;
9596 if (!KEYMAPP (current_binding
)
9597 && !test_undefined (current_binding
)
9598 && indec
.start
>= t
)
9599 /* There is a binding and it's not a prefix.
9600 (and it doesn't have any input-decode-map translation pending).
9601 There is thus no function-key in this sequence.
9602 Moving fkey.start is important in this case to allow keytran.start
9603 to go over the sequence before we return (since we keep the
9604 invariant that keytran.end <= fkey.start). */
9607 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9610 /* If the sequence is unbound, see if we can hang a function key
9611 off the end of it. */
9612 /* Continue scan from fkey.end until we find a bound suffix. */
9613 while (fkey
.end
< indec
.start
)
9615 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9619 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9620 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9621 max (t
, mock_input
),
9622 /* If there's a binding (i.e.
9623 first_binding >= nmaps) we don't want
9624 to apply this function-key-mapping. */
9626 && (test_undefined (current_binding
)),
9631 mock_input
= diff
+ max (t
, mock_input
);
9632 /* Adjust the input-decode-map counters. */
9634 indec
.start
+= diff
;
9636 goto replay_sequence
;
9640 /* Look for this sequence in key-translation-map.
9641 Scan from keytran.end until we find a bound suffix. */
9642 while (keytran
.end
< fkey
.start
)
9644 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9648 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9649 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9654 mock_input
= diff
+ max (t
, mock_input
);
9655 /* Adjust the function-key-map and input-decode-map counters. */
9657 indec
.start
+= diff
;
9661 goto replay_sequence
;
9665 /* If KEY is not defined in any of the keymaps,
9666 and cannot be part of a function key or translation,
9667 and is an upper case letter
9668 use the corresponding lower-case letter instead. */
9669 if (NILP (current_binding
)
9670 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9672 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9673 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9674 || (XINT (key
) & shift_modifier
)))
9676 Lisp_Object new_key
;
9678 original_uppercase
= key
;
9679 original_uppercase_position
= t
- 1;
9681 if (XINT (key
) & shift_modifier
)
9682 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9684 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9685 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9687 /* We have to do this unconditionally, regardless of whether
9688 the lower-case char is defined in the keymaps, because they
9689 might get translated through function-key-map. */
9690 keybuf
[t
- 1] = new_key
;
9691 mock_input
= max (t
, mock_input
);
9692 shift_translated
= 1;
9694 goto replay_sequence
;
9697 if (NILP (current_binding
)
9698 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9700 read_key_sequence_cmd
= Vprefix_help_command
;
9701 /* The Microsoft C compiler can't handle the goto that
9707 /* If KEY is not defined in any of the keymaps,
9708 and cannot be part of a function key or translation,
9709 and is a shifted function key,
9710 use the corresponding unshifted function key instead. */
9711 if (NILP (current_binding
)
9712 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9714 Lisp_Object breakdown
= parse_modifiers (key
);
9716 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9718 if (modifiers
& shift_modifier
9719 /* Treat uppercase keys as shifted. */
9721 && (KEY_TO_CHAR (key
)
9722 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9723 && uppercasep (KEY_TO_CHAR (key
))))
9726 = (modifiers
& shift_modifier
9727 ? apply_modifiers (modifiers
& ~shift_modifier
,
9729 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9731 original_uppercase
= key
;
9732 original_uppercase_position
= t
- 1;
9734 /* We have to do this unconditionally, regardless of whether
9735 the lower-case char is defined in the keymaps, because they
9736 might get translated through function-key-map. */
9737 keybuf
[t
- 1] = new_key
;
9738 mock_input
= max (t
, mock_input
);
9739 /* Reset fkey (and consequently keytran) to apply
9740 function-key-map on the result, so that S-backspace is
9741 correctly mapped to DEL (via backspace). OTOH,
9742 input-decode-map doesn't need to go through it again. */
9743 fkey
.start
= fkey
.end
= 0;
9744 keytran
.start
= keytran
.end
= 0;
9745 shift_translated
= 1;
9747 goto replay_sequence
;
9752 read_key_sequence_cmd
= current_binding
;
9753 read_key_sequence_remapped
9754 /* Remap command through active keymaps.
9755 Do the remapping here, before the unbind_to so it uses the keymaps
9756 of the appropriate buffer. */
9757 = SYMBOLP (read_key_sequence_cmd
)
9758 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9761 unread_switch_frame
= delayed_switch_frame
;
9764 /* Don't downcase the last character if the caller says don't.
9765 Don't downcase it if the result is undefined, either. */
9766 if ((dont_downcase_last
|| NILP (current_binding
))
9768 && t
- 1 == original_uppercase_position
)
9770 keybuf
[t
- 1] = original_uppercase
;
9771 shift_translated
= 0;
9774 if (shift_translated
)
9775 Vthis_command_keys_shift_translated
= Qt
;
9777 /* Occasionally we fabricate events, perhaps by expanding something
9778 according to function-key-map, or by adding a prefix symbol to a
9779 mouse click in the scroll bar or modeline. In this cases, return
9780 the entire generated key sequence, even if we hit an unbound
9781 prefix or a definition before the end. This means that you will
9782 be able to push back the event properly, and also means that
9783 read-key-sequence will always return a logical unit.
9786 for (; t
< mock_input
; t
++)
9788 if (echo_keystrokes_p ())
9789 echo_char (keybuf
[t
]);
9790 add_command_key (keybuf
[t
]);
9798 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9799 Lisp_Object dont_downcase_last
,
9800 Lisp_Object can_return_switch_frame
,
9801 Lisp_Object cmd_loop
, bool allow_string
)
9803 Lisp_Object keybuf
[30];
9805 struct gcpro gcpro1
;
9806 ptrdiff_t count
= SPECPDL_INDEX ();
9809 CHECK_STRING (prompt
);
9812 specbind (Qinput_method_exit_on_first_char
,
9813 (NILP (cmd_loop
) ? Qt
: Qnil
));
9814 specbind (Qinput_method_use_echo_area
,
9815 (NILP (cmd_loop
) ? Qt
: Qnil
));
9817 memset (keybuf
, 0, sizeof keybuf
);
9819 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9821 if (NILP (continue_echo
))
9823 this_command_key_count
= 0;
9824 this_command_key_count_reset
= 0;
9825 this_single_command_key_start
= 0;
9828 #ifdef HAVE_WINDOW_SYSTEM
9829 if (display_hourglass_p
)
9830 cancel_hourglass ();
9833 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9834 prompt
, ! NILP (dont_downcase_last
),
9835 ! NILP (can_return_switch_frame
), 0, 0);
9837 #if 0 /* The following is fine for code reading a key sequence and
9838 then proceeding with a lengthy computation, but it's not good
9839 for code reading keys in a loop, like an input method. */
9840 #ifdef HAVE_WINDOW_SYSTEM
9841 if (display_hourglass_p
)
9852 return unbind_to (count
,
9853 ((allow_string
? make_event_array
: Fvector
)
9857 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9858 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9859 The sequence is sufficient to specify a non-prefix command in the
9860 current local and global maps.
9862 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9863 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9864 as a continuation of the previous key.
9866 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9867 convert the last event to lower case. (Normally any upper case event
9868 is converted to lower case if the original event is undefined and the lower
9869 case equivalent is defined.) A non-nil value is appropriate for reading
9870 a key sequence to be defined.
9872 A C-g typed while in this function is treated like any other character,
9873 and `quit-flag' is not set.
9875 If the key sequence starts with a mouse click, then the sequence is read
9876 using the keymaps of the buffer of the window clicked in, not the buffer
9877 of the selected window as normal.
9879 `read-key-sequence' drops unbound button-down events, since you normally
9880 only care about the click or drag events which follow them. If a drag
9881 or multi-click event is unbound, but the corresponding click event would
9882 be bound, `read-key-sequence' turns the event into a click event at the
9883 drag's starting position. This means that you don't have to distinguish
9884 between click and drag, double, or triple events unless you want to.
9886 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9887 lines separating windows, and scroll bars with imaginary keys
9888 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9890 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9891 function will process a switch-frame event if the user switches frames
9892 before typing anything. If the user switches frames in the middle of a
9893 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9894 is nil, then the event will be put off until after the current key sequence.
9896 `read-key-sequence' checks `function-key-map' for function key
9897 sequences, where they wouldn't conflict with ordinary bindings. See
9898 `function-key-map' for more details.
9900 The optional fifth argument CMD-LOOP, if non-nil, means
9901 that this key sequence is being read by something that will
9902 read commands one after another. It should be nil if the caller
9903 will read just one key sequence. */)
9904 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9906 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9907 can_return_switch_frame
, cmd_loop
, true);
9910 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9911 Sread_key_sequence_vector
, 1, 5, 0,
9912 doc
: /* Like `read-key-sequence' but always return a vector. */)
9913 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9915 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9916 can_return_switch_frame
, cmd_loop
, false);
9919 /* Return true if input events are pending. */
9922 detect_input_pending (void)
9924 return input_pending
|| get_input_pending (0);
9927 /* Return true if input events other than mouse movements are
9931 detect_input_pending_ignore_squeezables (void)
9933 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9936 /* Return true if input events are pending, and run any pending timers. */
9939 detect_input_pending_run_timers (bool do_display
)
9941 unsigned old_timers_run
= timers_run
;
9944 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9946 if (old_timers_run
!= timers_run
&& do_display
)
9947 redisplay_preserve_echo_area (8);
9949 return input_pending
;
9952 /* This is called in some cases before a possible quit.
9953 It cases the next call to detect_input_pending to recompute input_pending.
9954 So calling this function unnecessarily can't do any harm. */
9957 clear_input_pending (void)
9962 /* Return true if there are pending requeued events.
9963 This isn't used yet. The hope is to make wait_reading_process_output
9964 call it, and return if it runs Lisp code that unreads something.
9965 The problem is, kbd_buffer_get_event needs to be fixed to know what
9966 to do in that case. It isn't trivial. */
9969 requeued_events_pending_p (void)
9971 return (!NILP (Vunread_command_events
));
9974 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9975 doc
: /* Return t if command input is currently available with no wait.
9976 Actually, the value is nil only if we can be sure that no input is available;
9977 if there is a doubt, the value is t.
9979 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9980 (Lisp_Object check_timers
)
9982 if (!NILP (Vunread_command_events
)
9983 || !NILP (Vunread_post_input_method_events
)
9984 || !NILP (Vunread_input_method_events
))
9987 /* Process non-user-visible events (Bug#10195). */
9988 process_special_events ();
9990 return (get_input_pending ((NILP (check_timers
)
9991 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9992 | READABLE_EVENTS_FILTER_EVENTS
)
9996 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9997 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10000 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10003 if (total_keys
< NUM_RECENT_KEYS
)
10004 return Fvector (total_keys
, keys
);
10007 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10008 vcopy (val
, 0, keys
+ recent_keys_index
,
10009 NUM_RECENT_KEYS
- recent_keys_index
);
10010 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10011 keys
, recent_keys_index
);
10016 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10017 doc
: /* Return the key sequence that invoked this command.
10018 However, if the command has called `read-key-sequence', it returns
10019 the last key sequence that has been read.
10020 The value is a string or a vector.
10022 See also `this-command-keys-vector'. */)
10025 return make_event_array (this_command_key_count
,
10026 XVECTOR (this_command_keys
)->contents
);
10029 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10030 doc
: /* Return the key sequence that invoked this command, as a vector.
10031 However, if the command has called `read-key-sequence', it returns
10032 the last key sequence that has been read.
10034 See also `this-command-keys'. */)
10037 return Fvector (this_command_key_count
,
10038 XVECTOR (this_command_keys
)->contents
);
10041 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10042 Sthis_single_command_keys
, 0, 0, 0,
10043 doc
: /* Return the key sequence that invoked this command.
10044 More generally, it returns the last key sequence read, either by
10045 the command loop or by `read-key-sequence'.
10046 Unlike `this-command-keys', this function's value
10047 does not include prefix arguments.
10048 The value is always a vector. */)
10051 return Fvector (this_command_key_count
10052 - this_single_command_key_start
,
10053 (XVECTOR (this_command_keys
)->contents
10054 + this_single_command_key_start
));
10057 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10058 Sthis_single_command_raw_keys
, 0, 0, 0,
10059 doc
: /* Return the raw events that were read for this command.
10060 More generally, it returns the last key sequence read, either by
10061 the command loop or by `read-key-sequence'.
10062 Unlike `this-single-command-keys', this function's value
10063 shows the events before all translations (except for input methods).
10064 The value is always a vector. */)
10067 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10070 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10071 Sreset_this_command_lengths
, 0, 0, 0,
10072 doc
: /* Make the unread events replace the last command and echo.
10073 Used in `universal-argument-other-key'.
10075 `universal-argument-other-key' rereads the event just typed.
10076 It then gets translated through `function-key-map'.
10077 The translated event has to replace the real events,
10078 both in the value of (this-command-keys) and in echoing.
10079 To achieve this, `universal-argument-other-key' calls
10080 `reset-this-command-lengths', which discards the record of reading
10081 these events the first time. */)
10084 this_command_key_count
= before_command_key_count
;
10085 if (this_command_key_count
< this_single_command_key_start
)
10086 this_single_command_key_start
= this_command_key_count
;
10088 echo_truncate (before_command_echo_length
);
10090 /* Cause whatever we put into unread-command-events
10091 to echo as if it were being freshly read from the keyboard. */
10092 this_command_key_count_reset
= 1;
10097 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10098 Sclear_this_command_keys
, 0, 1, 0,
10099 doc
: /* Clear out the vector that `this-command-keys' returns.
10100 Also clear the record of the last 100 events, unless optional arg
10101 KEEP-RECORD is non-nil. */)
10102 (Lisp_Object keep_record
)
10106 this_command_key_count
= 0;
10107 this_command_key_count_reset
= 0;
10109 if (NILP (keep_record
))
10111 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10112 ASET (recent_keys
, i
, Qnil
);
10114 recent_keys_index
= 0;
10119 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10120 doc
: /* Return the current depth in recursive edits. */)
10124 /* Wrap around reliably on integer overflow. */
10125 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10126 XSETINT (temp
, sum
);
10130 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10131 "FOpen dribble file: ",
10132 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10133 If FILE is nil, close any open dribble file.
10134 The file will be closed when Emacs exits.
10136 Be aware that this records ALL characters you type!
10137 This may include sensitive information such as passwords. */)
10150 Lisp_Object encfile
;
10152 file
= Fexpand_file_name (file
, Qnil
);
10153 encfile
= ENCODE_FILE (file
);
10154 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10155 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10156 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10157 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10159 report_file_error ("Opening dribble", file
);
10164 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10165 doc
: /* Discard the contents of the terminal input buffer.
10166 Also end any kbd macro being defined. */)
10169 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10171 /* Discard the last command from the macro. */
10172 Fcancel_kbd_macro_events ();
10176 Vunread_command_events
= Qnil
;
10178 discard_tty_input ();
10180 kbd_fetch_ptr
= kbd_store_ptr
;
10186 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10187 doc
: /* Stop Emacs and return to superior process. You can resume later.
10188 If `cannot-suspend' is non-nil, or if the system doesn't support job
10189 control, run a subshell instead.
10191 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10192 to be read as terminal input by Emacs's parent, after suspension.
10194 Before suspending, run the normal hook `suspend-hook'.
10195 After resumption run the normal hook `suspend-resume-hook'.
10197 Some operating systems cannot stop the Emacs process and resume it later.
10198 On such systems, Emacs starts a subshell instead of suspending. */)
10199 (Lisp_Object stuffstring
)
10201 ptrdiff_t count
= SPECPDL_INDEX ();
10202 int old_height
, old_width
;
10204 struct gcpro gcpro1
;
10207 if (tty_list
&& tty_list
->next
)
10208 error ("There are other tty frames open; close them before suspending Emacs");
10210 if (!NILP (stuffstring
))
10211 CHECK_STRING (stuffstring
);
10213 /* Run the functions in suspend-hook. */
10214 hook
= intern ("suspend-hook");
10215 Frun_hooks (1, &hook
);
10217 GCPRO1 (stuffstring
);
10218 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10219 reset_all_sys_modes ();
10220 /* sys_suspend can get an error if it tries to fork a subshell
10221 and the system resources aren't available for that. */
10222 record_unwind_protect_void (init_all_sys_modes
);
10223 stuff_buffered_input (stuffstring
);
10224 if (cannot_suspend
)
10228 unbind_to (count
, Qnil
);
10230 /* Check if terminal/window size has changed.
10231 Note that this is not useful when we are running directly
10232 with a window system; but suspend should be disabled in that case. */
10233 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10234 if (width
!= old_width
|| height
!= old_height
)
10235 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10237 /* Run suspend-resume-hook. */
10238 hook
= intern ("suspend-resume-hook");
10239 Frun_hooks (1, &hook
);
10245 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10246 Then in any case stuff anything Emacs has read ahead and not used. */
10249 stuff_buffered_input (Lisp_Object stuffstring
)
10251 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10252 register unsigned char *p
;
10254 if (STRINGP (stuffstring
))
10256 register ptrdiff_t count
;
10258 p
= SDATA (stuffstring
);
10259 count
= SBYTES (stuffstring
);
10260 while (count
-- > 0)
10265 /* Anything we have read ahead, put back for the shell to read. */
10266 /* ?? What should this do when we have multiple keyboards??
10267 Should we ignore anything that was typed in at the "wrong" kboard?
10269 rms: we should stuff everything back into the kboard
10271 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10274 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10275 kbd_fetch_ptr
= kbd_buffer
;
10276 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10277 stuff_char (kbd_fetch_ptr
->code
);
10279 clear_event (kbd_fetch_ptr
);
10283 #endif /* SIGTSTP */
10287 set_waiting_for_input (struct timespec
*time_to_clear
)
10289 input_available_clear_time
= time_to_clear
;
10291 /* Tell handle_interrupt to throw back to read_char, */
10292 waiting_for_input
= 1;
10294 /* If handle_interrupt was called before and buffered a C-g,
10295 make it run again now, to avoid timing error. */
10296 if (!NILP (Vquit_flag
))
10297 quit_throw_to_read_char (0);
10301 clear_waiting_for_input (void)
10303 /* Tell handle_interrupt not to throw back to read_char, */
10304 waiting_for_input
= 0;
10305 input_available_clear_time
= 0;
10308 /* The SIGINT handler.
10310 If we have a frame on the controlling tty, we assume that the
10311 SIGINT was generated by C-g, so we call handle_interrupt.
10312 Otherwise, tell QUIT to kill Emacs. */
10315 handle_interrupt_signal (int sig
)
10317 /* See if we have an active terminal on our controlling tty. */
10318 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10321 /* If there are no frames there, let's pretend that we are a
10322 well-behaving UN*X program and quit. We must not call Lisp
10323 in a signal handler, so tell QUIT to exit when it is
10325 Vquit_flag
= Qkill_emacs
;
10329 /* Otherwise, the SIGINT was probably generated by C-g. */
10331 /* Set internal_last_event_frame to the top frame of the
10332 controlling tty, if we have a frame there. We disable the
10333 interrupt key on secondary ttys, so the SIGINT must have come
10334 from the controlling tty. */
10335 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10337 handle_interrupt (1);
10342 deliver_interrupt_signal (int sig
)
10344 deliver_process_signal (sig
, handle_interrupt_signal
);
10348 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10349 of the number of times C-g has been requested. If C-g is pressed
10350 enough times, then quit anyway. See bug#6585. */
10351 static int volatile force_quit_count
;
10353 /* This routine is called at interrupt level in response to C-g.
10355 It is called from the SIGINT handler or kbd_buffer_store_event.
10357 If `waiting_for_input' is non zero, then unless `echoing' is
10358 nonzero, immediately throw back to read_char.
10360 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10361 eval to throw, when it gets a chance. If quit-flag is already
10362 non-nil, it stops the job right away. */
10365 handle_interrupt (bool in_signal_handler
)
10371 /* XXX This code needs to be revised for multi-tty support. */
10372 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10374 if (! in_signal_handler
)
10376 /* If SIGINT isn't blocked, don't let us be interrupted by
10377 a SIGINT. It might be harmful due to non-reentrancy
10378 in I/O functions. */
10380 sigemptyset (&blocked
);
10381 sigaddset (&blocked
, SIGINT
);
10382 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10386 reset_all_sys_modes ();
10390 * On systems which can suspend the current process and return to the original
10391 * shell, this command causes the user to end up back at the shell.
10392 * The "Auto-save" and "Abort" questions are not asked until
10393 * the user elects to return to emacs, at which point he can save the current
10394 * job and either dump core or continue.
10398 /* Perhaps should really fork an inferior shell?
10399 But that would not provide any way to get back
10400 to the original shell, ever. */
10401 printf ("No support for stopping a process on this operating system;\n");
10402 printf ("you can continue or abort.\n");
10403 #endif /* not SIGTSTP */
10405 /* We must remain inside the screen area when the internal terminal
10406 is used. Note that [Enter] is not echoed by dos. */
10407 cursor_to (SELECTED_FRAME (), 0, 0);
10409 printf ("Auto-save? (y or n) ");
10411 if (((c
= getchar ()) & ~040) == 'Y')
10413 Fdo_auto_save (Qt
, Qnil
);
10415 printf ("\r\nAuto-save done");
10416 #else /* not MSDOS */
10417 printf ("Auto-save done\n");
10418 #endif /* not MSDOS */
10420 while (c
!= '\n') c
= getchar ();
10423 printf ("\r\nAbort? (y or n) ");
10424 #else /* not MSDOS */
10425 printf ("Abort (and dump core)? (y or n) ");
10426 #endif /* not MSDOS */
10428 if (((c
= getchar ()) & ~040) == 'Y')
10430 while (c
!= '\n') c
= getchar ();
10432 printf ("\r\nContinuing...\r\n");
10433 #else /* not MSDOS */
10434 printf ("Continuing...\n");
10435 #endif /* not MSDOS */
10437 init_all_sys_modes ();
10441 /* If executing a function that wants to be interrupted out of
10442 and the user has not deferred quitting by binding `inhibit-quit'
10443 then quit right away. */
10444 if (immediate_quit
&& NILP (Vinhibit_quit
))
10446 struct gl_state_s saved
;
10447 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10449 immediate_quit
= 0;
10450 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10452 GCPRO4 (saved
.object
, saved
.global_code
,
10453 saved
.current_syntax_table
, saved
.old_prop
);
10454 Fsignal (Qquit
, Qnil
);
10459 { /* Else request quit when it's safe. */
10460 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10461 force_quit_count
= count
;
10464 immediate_quit
= 1;
10465 Vinhibit_quit
= Qnil
;
10471 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10473 /* TODO: The longjmp in this call throws the NS event loop integration off,
10474 and it seems to do fine without this. Probably some attention
10475 needs to be paid to the setting of waiting_for_input in
10476 wait_reading_process_output() under HAVE_NS because of the call
10477 to ns_select there (needed because otherwise events aren't picked up
10478 outside of polling since we don't get SIGIO like X and we don't have a
10479 separate event loop thread like W32. */
10481 if (waiting_for_input
&& !echoing
)
10482 quit_throw_to_read_char (in_signal_handler
);
10486 /* Handle a C-g by making read_char return C-g. */
10489 quit_throw_to_read_char (bool from_signal
)
10491 /* When not called from a signal handler it is safe to call
10493 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10494 Fkill_emacs (Qnil
);
10496 /* Prevent another signal from doing this before we finish. */
10497 clear_waiting_for_input ();
10500 Vunread_command_events
= Qnil
;
10502 if (FRAMEP (internal_last_event_frame
)
10503 && !EQ (internal_last_event_frame
, selected_frame
))
10504 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10507 sys_longjmp (getcjmp
, 1);
10510 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10511 Sset_input_interrupt_mode
, 1, 1, 0,
10512 doc
: /* Set interrupt mode of reading keyboard input.
10513 If INTERRUPT is non-nil, Emacs will use input interrupts;
10514 otherwise Emacs uses CBREAK mode.
10516 See also `current-input-mode'. */)
10517 (Lisp_Object interrupt
)
10519 bool new_interrupt_input
;
10520 #ifdef USABLE_SIGIO
10521 #ifdef HAVE_X_WINDOWS
10522 if (x_display_list
!= NULL
)
10524 /* When using X, don't give the user a real choice,
10525 because we haven't implemented the mechanisms to support it. */
10526 new_interrupt_input
= 1;
10529 #endif /* HAVE_X_WINDOWS */
10530 new_interrupt_input
= !NILP (interrupt
);
10531 #else /* not USABLE_SIGIO */
10532 new_interrupt_input
= 0;
10533 #endif /* not USABLE_SIGIO */
10535 if (new_interrupt_input
!= interrupt_input
)
10537 #ifdef POLL_FOR_INPUT
10541 /* this causes startup screen to be restored and messes with the mouse */
10542 reset_all_sys_modes ();
10543 interrupt_input
= new_interrupt_input
;
10544 init_all_sys_modes ();
10546 interrupt_input
= new_interrupt_input
;
10549 #ifdef POLL_FOR_INPUT
10550 poll_suppress_count
= 1;
10557 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10558 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10559 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10560 C-q in key sequences.
10562 This setting only has an effect on tty terminals and only when
10563 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10565 See also `current-input-mode'. */)
10566 (Lisp_Object flow
, Lisp_Object terminal
)
10568 struct terminal
*t
= get_terminal (terminal
, 1);
10569 struct tty_display_info
*tty
;
10570 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10572 tty
= t
->display_info
.tty
;
10574 if (tty
->flow_control
!= !NILP (flow
))
10577 /* This causes startup screen to be restored and messes with the mouse. */
10578 reset_sys_modes (tty
);
10581 tty
->flow_control
= !NILP (flow
);
10584 init_sys_modes (tty
);
10590 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10591 doc
: /* Enable or disable 8-bit input on TERMINAL.
10592 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10593 bit as the Meta modifier.
10595 If META is nil, Emacs will ignore the top bit, on the assumption it is
10598 Otherwise, Emacs will accept and pass through 8-bit input without
10599 specially interpreting the top bit.
10601 This setting only has an effect on tty terminal devices.
10603 Optional parameter TERMINAL specifies the tty terminal device to use.
10604 It may be a terminal object, a frame, or nil for the terminal used by
10605 the currently selected frame.
10607 See also `current-input-mode'. */)
10608 (Lisp_Object meta
, Lisp_Object terminal
)
10610 struct terminal
*t
= get_terminal (terminal
, 1);
10611 struct tty_display_info
*tty
;
10614 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10616 tty
= t
->display_info
.tty
;
10620 else if (EQ (meta
, Qt
))
10625 if (tty
->meta_key
!= new_meta
)
10628 /* this causes startup screen to be restored and messes with the mouse */
10629 reset_sys_modes (tty
);
10632 tty
->meta_key
= new_meta
;
10635 init_sys_modes (tty
);
10641 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10642 doc
: /* Specify character used for quitting.
10643 QUIT must be an ASCII character.
10645 This function only has an effect on the controlling tty of the Emacs
10648 See also `current-input-mode'. */)
10651 struct terminal
*t
= get_named_tty ("/dev/tty");
10652 struct tty_display_info
*tty
;
10653 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10655 tty
= t
->display_info
.tty
;
10657 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10658 error ("QUIT must be an ASCII character");
10661 /* this causes startup screen to be restored and messes with the mouse */
10662 reset_sys_modes (tty
);
10665 /* Don't let this value be out of range. */
10666 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10669 init_sys_modes (tty
);
10675 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10676 doc
: /* Set mode of reading keyboard input.
10677 First arg INTERRUPT non-nil means use input interrupts;
10678 nil means use CBREAK mode.
10679 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10680 (no effect except in CBREAK mode).
10681 Third arg META t means accept 8-bit input (for a Meta key).
10682 META nil means ignore the top bit, on the assumption it is parity.
10683 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10684 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10685 See also `current-input-mode'. */)
10686 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10688 Fset_input_interrupt_mode (interrupt
);
10689 Fset_output_flow_control (flow
, Qnil
);
10690 Fset_input_meta_mode (meta
, Qnil
);
10692 Fset_quit_char (quit
);
10696 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10697 doc
: /* Return information about the way Emacs currently reads keyboard input.
10698 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10699 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10700 nil, Emacs is using CBREAK mode.
10701 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10702 terminal; this does not apply if Emacs uses interrupt-driven input.
10703 META is t if accepting 8-bit input with 8th bit as Meta flag.
10704 META nil means ignoring the top bit, on the assumption it is parity.
10705 META is neither t nor nil if accepting 8-bit input and using
10706 all 8 bits as the character code.
10707 QUIT is the character Emacs currently uses to quit.
10708 The elements of this list correspond to the arguments of
10709 `set-input-mode'. */)
10712 Lisp_Object val
[4];
10713 struct frame
*sf
= XFRAME (selected_frame
);
10715 val
[0] = interrupt_input
? Qt
: Qnil
;
10716 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10718 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10719 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10721 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10728 XSETFASTINT (val
[3], quit_char
);
10730 return Flist (ARRAYELTS (val
), val
);
10733 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10734 doc
: /* Return position information for pixel coordinates X and Y.
10735 By default, X and Y are relative to text area of the selected window.
10736 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10737 If optional fourth arg WHOLE is non-nil, X is relative to the left
10738 edge of the window.
10740 The return value is similar to a mouse click 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 x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10749 if (NILP (frame_or_window
))
10750 frame_or_window
= selected_window
;
10752 if (WINDOWP (frame_or_window
))
10754 struct window
*w
= decode_live_window (frame_or_window
);
10756 XSETINT (x
, (XINT (x
)
10757 + WINDOW_LEFT_EDGE_X (w
)
10759 ? window_box_left_offset (w
, TEXT_AREA
)
10761 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10762 frame_or_window
= w
->frame
;
10765 CHECK_LIVE_FRAME (frame_or_window
);
10767 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10770 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10771 doc
: /* Return position information for buffer POS in WINDOW.
10772 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10774 Return nil if position is not visible in window. Otherwise,
10775 the return value is similar to that returned by `event-start' for
10776 a mouse click at the upper left corner of the glyph corresponding
10777 to the given buffer position:
10778 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10779 IMAGE (DX . DY) (WIDTH . HEIGHT))
10780 The `posn-' functions access elements of such lists. */)
10781 (Lisp_Object pos
, Lisp_Object window
)
10786 window
= selected_window
;
10788 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10791 Lisp_Object x
= XCAR (tem
);
10792 Lisp_Object y
= XCAR (XCDR (tem
));
10794 /* Point invisible due to hscrolling? */
10797 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10803 /* Set up a new kboard object with reasonable initial values.
10804 TYPE is a window system for which this keyboard is used. */
10807 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10809 kset_overriding_terminal_local_map (kb
, Qnil
);
10810 kset_last_command (kb
, Qnil
);
10811 kset_real_last_command (kb
, Qnil
);
10812 kset_keyboard_translate_table (kb
, Qnil
);
10813 kset_last_repeatable_command (kb
, Qnil
);
10814 kset_prefix_arg (kb
, Qnil
);
10815 kset_last_prefix_arg (kb
, Qnil
);
10816 kset_kbd_queue (kb
, Qnil
);
10817 kb
->kbd_queue_has_data
= 0;
10818 kb
->immediate_echo
= 0;
10819 kset_echo_string (kb
, Qnil
);
10820 kb
->echo_after_prompt
= -1;
10821 kb
->kbd_macro_buffer
= 0;
10822 kb
->kbd_macro_bufsize
= 0;
10823 kset_defining_kbd_macro (kb
, Qnil
);
10824 kset_last_kbd_macro (kb
, Qnil
);
10825 kb
->reference_count
= 0;
10826 kset_system_key_alist (kb
, Qnil
);
10827 kset_system_key_syms (kb
, Qnil
);
10828 kset_window_system (kb
, type
);
10829 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10830 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10831 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10832 kset_default_minibuffer_frame (kb
, Qnil
);
10835 /* Allocate and basically initialize keyboard
10836 object to use with window system TYPE. */
10839 allocate_kboard (Lisp_Object type
)
10841 KBOARD
*kb
= xmalloc (sizeof *kb
);
10843 init_kboard (kb
, type
);
10844 kb
->next_kboard
= all_kboards
;
10850 * Destroy the contents of a kboard object, but not the object itself.
10851 * We use this just before deleting it, or if we're going to initialize
10852 * it a second time.
10855 wipe_kboard (KBOARD
*kb
)
10857 xfree (kb
->kbd_macro_buffer
);
10860 /* Free KB and memory referenced from it. */
10863 delete_kboard (KBOARD
*kb
)
10867 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10870 *kbp
= kb
->next_kboard
;
10872 /* Prevent a dangling reference to KB. */
10873 if (kb
== current_kboard
10874 && FRAMEP (selected_frame
)
10875 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10877 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10879 if (current_kboard
== kb
)
10888 init_keyboard (void)
10890 /* This is correct before outermost invocation of the editor loop. */
10891 command_loop_level
= -1;
10892 immediate_quit
= 0;
10893 quit_char
= Ctl ('g');
10894 Vunread_command_events
= Qnil
;
10895 timer_idleness_start_time
= invalid_timespec ();
10897 recent_keys_index
= 0;
10898 kbd_fetch_ptr
= kbd_buffer
;
10899 kbd_store_ptr
= kbd_buffer
;
10900 do_mouse_tracking
= Qnil
;
10902 interrupt_input_blocked
= 0;
10903 pending_signals
= 0;
10905 /* This means that command_loop_1 won't try to select anything the first
10907 internal_last_event_frame
= Qnil
;
10908 Vlast_event_frame
= internal_last_event_frame
;
10910 current_kboard
= initial_kboard
;
10911 /* Re-initialize the keyboard again. */
10912 wipe_kboard (current_kboard
);
10913 /* A value of nil for Vwindow_system normally means a tty, but we also use
10914 it for the initial terminal since there is no window system there. */
10915 init_kboard (current_kboard
, Qnil
);
10917 if (!noninteractive
)
10919 /* Before multi-tty support, these handlers used to be installed
10920 only if the current session was a tty session. Now an Emacs
10921 session may have multiple display types, so we always handle
10922 SIGINT. There is special code in handle_interrupt_signal to exit
10923 Emacs on SIGINT when there are no termcap frames on the
10924 controlling terminal. */
10925 struct sigaction action
;
10926 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10927 sigaction (SIGINT
, &action
, 0);
10929 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10930 SIGQUIT and we can't tell which one it will give us. */
10931 sigaction (SIGQUIT
, &action
, 0);
10932 #endif /* not DOS_NT */
10934 #ifdef USABLE_SIGIO
10935 if (!noninteractive
)
10937 struct sigaction action
;
10938 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10939 sigaction (SIGIO
, &action
, 0);
10943 /* Use interrupt input by default, if it works and noninterrupt input
10944 has deficiencies. */
10946 #ifdef INTERRUPT_INPUT
10947 interrupt_input
= 1;
10949 interrupt_input
= 0;
10952 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10955 if (keyboard_init_hook
)
10956 (*keyboard_init_hook
) ();
10958 #ifdef POLL_FOR_INPUT
10960 poll_suppress_count
= 1;
10965 /* This type's only use is in syms_of_keyboard, to initialize the
10966 event header symbols and put properties on them. */
10967 struct event_head
{
10973 static const struct event_head head_table
[] = {
10974 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10975 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10976 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10977 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10978 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10979 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10980 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10981 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10982 /* `select-window' should be handled just like `switch-frame'
10983 in read_key_sequence. */
10984 {&Qselect_window
, "select-window", &Qswitch_frame
}
10988 syms_of_keyboard (void)
10990 #include "keyboard.x"
10992 pending_funcalls
= Qnil
;
10993 staticpro (&pending_funcalls
);
10995 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10996 staticpro (&Vlispy_mouse_stem
);
10999 DEFSYM (QCimage
, ":image");
11000 DEFSYM (Qhelp_echo
, "help-echo");
11001 DEFSYM (QCrtl
, ":rtl");
11003 staticpro (&item_properties
);
11004 item_properties
= Qnil
;
11006 staticpro (&tool_bar_item_properties
);
11007 tool_bar_item_properties
= Qnil
;
11008 staticpro (&tool_bar_items_vector
);
11009 tool_bar_items_vector
= Qnil
;
11011 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11012 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11013 DEFSYM (Qself_insert_command
, "self-insert-command");
11014 DEFSYM (Qforward_char
, "forward-char");
11015 DEFSYM (Qbackward_char
, "backward-char");
11016 DEFSYM (Qdisabled
, "disabled");
11017 DEFSYM (Qundefined
, "undefined");
11018 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11019 DEFSYM (Qpost_command_hook
, "post-command-hook");
11020 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11021 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11022 DEFSYM (Qfunction_key
, "function-key");
11023 DEFSYM (Qmouse_click
, "mouse-click");
11024 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11025 DEFSYM (Qsave_session
, "save-session");
11026 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11027 DEFSYM (Qmenu_enable
, "menu-enable");
11030 DEFSYM (Qlanguage_change
, "language-change");
11034 DEFSYM (Qdbus_event
, "dbus-event");
11037 #ifdef USE_FILE_NOTIFY
11038 DEFSYM (Qfile_notify
, "file-notify");
11039 #endif /* USE_FILE_NOTIFY */
11041 DEFSYM (QCenable
, ":enable");
11042 DEFSYM (QCvisible
, ":visible");
11043 DEFSYM (QChelp
, ":help");
11044 DEFSYM (QCfilter
, ":filter");
11045 DEFSYM (QCbutton
, ":button");
11046 DEFSYM (QCkeys
, ":keys");
11047 DEFSYM (QCkey_sequence
, ":key-sequence");
11048 DEFSYM (QCtoggle
, ":toggle");
11049 DEFSYM (QCradio
, ":radio");
11050 DEFSYM (QClabel
, ":label");
11051 DEFSYM (QCvert_only
, ":vert-only");
11053 DEFSYM (Qmode_line
, "mode-line");
11054 DEFSYM (Qvertical_line
, "vertical-line");
11055 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11056 DEFSYM (Qmenu_bar
, "menu-bar");
11057 DEFSYM (Qright_divider
, "right-divider");
11058 DEFSYM (Qbottom_divider
, "bottom-divider");
11060 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11062 DEFSYM (Qabove_handle
, "above-handle");
11063 DEFSYM (Qhandle
, "handle");
11064 DEFSYM (Qbelow_handle
, "below-handle");
11065 DEFSYM (Qup
, "up");
11066 DEFSYM (Qdown
, "down");
11067 DEFSYM (Qtop
, "top");
11068 DEFSYM (Qbottom
, "bottom");
11069 DEFSYM (Qend_scroll
, "end-scroll");
11070 DEFSYM (Qratio
, "ratio");
11072 DEFSYM (Qevent_kind
, "event-kind");
11073 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11074 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11075 DEFSYM (Qmodifier_cache
, "modifier-cache");
11077 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11078 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11080 DEFSYM (Qpolling_period
, "polling-period");
11082 DEFSYM (Qx_set_selection
, "x-set-selection");
11083 DEFSYM (QPRIMARY
, "PRIMARY");
11084 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11085 DEFSYM (Qhandle_select_window
, "handle-select-window");
11087 DEFSYM (Qinput_method_function
, "input-method-function");
11088 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11089 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11091 DEFSYM (Qhelp_form_show
, "help-form-show");
11093 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11095 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11096 Fset (Qinput_method_use_echo_area
, Qnil
);
11100 int len
= ARRAYELTS (head_table
);
11102 for (i
= 0; i
< len
; i
++)
11104 const struct event_head
*p
= &head_table
[i
];
11105 *p
->var
= intern_c_string (p
->name
);
11106 staticpro (p
->var
);
11107 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11108 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11112 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11113 staticpro (&button_down_location
);
11114 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11115 staticpro (&mouse_syms
);
11116 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11118 staticpro (&wheel_syms
);
11122 int len
= ARRAYELTS (modifier_names
);
11124 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11125 for (i
= 0; i
< len
; i
++)
11126 if (modifier_names
[i
])
11127 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11128 staticpro (&modifier_symbols
);
11131 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11132 staticpro (&recent_keys
);
11134 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11135 staticpro (&this_command_keys
);
11137 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11138 staticpro (&raw_keybuf
);
11140 DEFSYM (Qcommand_execute
, "command-execute");
11142 accent_key_syms
= Qnil
;
11143 staticpro (&accent_key_syms
);
11145 func_key_syms
= Qnil
;
11146 staticpro (&func_key_syms
);
11148 drag_n_drop_syms
= Qnil
;
11149 staticpro (&drag_n_drop_syms
);
11151 unread_switch_frame
= Qnil
;
11152 staticpro (&unread_switch_frame
);
11154 internal_last_event_frame
= Qnil
;
11155 staticpro (&internal_last_event_frame
);
11157 read_key_sequence_cmd
= Qnil
;
11158 staticpro (&read_key_sequence_cmd
);
11159 read_key_sequence_remapped
= Qnil
;
11160 staticpro (&read_key_sequence_remapped
);
11162 menu_bar_one_keymap_changed_items
= Qnil
;
11163 staticpro (&menu_bar_one_keymap_changed_items
);
11165 menu_bar_items_vector
= Qnil
;
11166 staticpro (&menu_bar_items_vector
);
11168 help_form_saved_window_configs
= Qnil
;
11169 staticpro (&help_form_saved_window_configs
);
11171 DEFVAR_LISP ("last-command-event", last_command_event
,
11172 doc
: /* Last input event that was part of a command. */);
11174 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11175 doc
: /* Last input event in a command, except for mouse menu events.
11176 Mouse menus give back keys that don't look like mouse events;
11177 this variable holds the actual mouse event that led to the menu,
11178 so that you can determine whether the command was run by mouse or not. */);
11180 DEFVAR_LISP ("last-input-event", last_input_event
,
11181 doc
: /* Last input event. */);
11183 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11184 doc
: /* List of events to be read as the command input.
11185 These events are processed first, before actual keyboard input.
11186 Events read from this list are not normally added to `this-command-keys',
11187 as they will already have been added once as they were read for the first time.
11188 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11189 Vunread_command_events
= Qnil
;
11191 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11192 doc
: /* List of events to be processed as input by input methods.
11193 These events are processed before `unread-command-events'
11194 and actual keyboard input, but are not given to `input-method-function'. */);
11195 Vunread_post_input_method_events
= Qnil
;
11197 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11198 doc
: /* List of events to be processed as input by input methods.
11199 These events are processed after `unread-command-events', but
11200 before actual keyboard input.
11201 If there's an active input method, the events are given to
11202 `input-method-function'. */);
11203 Vunread_input_method_events
= Qnil
;
11205 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11206 doc
: /* Meta-prefix character code.
11207 Meta-foo as command input turns into this character followed by foo. */);
11208 XSETINT (meta_prefix_char
, 033);
11210 DEFVAR_KBOARD ("last-command", Vlast_command
,
11211 doc
: /* The last command executed.
11212 Normally a symbol with a function definition, but can be whatever was found
11213 in the keymap, or whatever the variable `this-command' was set to by that
11216 The value `mode-exit' is special; it means that the previous command
11217 read an event that told it to exit, and it did so and unread that event.
11218 In other words, the present command is the event that made the previous
11221 The value `kill-region' is special; it means that the previous command
11222 was a kill command.
11224 `last-command' has a separate binding for each terminal device.
11225 See Info node `(elisp)Multiple Terminals'. */);
11227 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11228 doc
: /* Same as `last-command', but never altered by Lisp code.
11229 Taken from the previous value of `real-this-command'. */);
11231 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11232 doc
: /* Last command that may be repeated.
11233 The last command executed that was not bound to an input event.
11234 This is the command `repeat' will try to repeat.
11235 Taken from a previous value of `real-this-command'. */);
11237 DEFVAR_LISP ("this-command", Vthis_command
,
11238 doc
: /* The command now being executed.
11239 The command can set this variable; whatever is put here
11240 will be in `last-command' during the following command. */);
11241 Vthis_command
= Qnil
;
11243 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11244 doc
: /* This is like `this-command', except that commands should never modify it. */);
11245 Vreal_this_command
= Qnil
;
11247 DEFVAR_LISP ("this-command-keys-shift-translated",
11248 Vthis_command_keys_shift_translated
,
11249 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11250 Shift-translation occurs when there is no binding for the key sequence
11251 as entered, but a binding was found by changing an upper-case letter
11252 to lower-case, or a shifted function key to an unshifted one. */);
11253 Vthis_command_keys_shift_translated
= Qnil
;
11255 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11256 doc
: /* The command bound to the current key sequence before remapping.
11257 It equals `this-command' if the original command was not remapped through
11258 any of the active keymaps. Otherwise, the value of `this-command' is the
11259 result of looking up the original command in the active keymaps. */);
11260 Vthis_original_command
= Qnil
;
11262 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11263 doc
: /* Number of input events between auto-saves.
11264 Zero means disable autosaving due to number of characters typed. */);
11265 auto_save_interval
= 300;
11267 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11268 doc
: /* Number of seconds idle time before auto-save.
11269 Zero or nil means disable auto-saving due to idleness.
11270 After auto-saving due to this many seconds of idle time,
11271 Emacs also does a garbage collection if that seems to be warranted. */);
11272 XSETFASTINT (Vauto_save_timeout
, 30);
11274 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11275 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11276 The value may be integer or floating point.
11277 If the value is zero, don't echo at all. */);
11278 Vecho_keystrokes
= make_number (1);
11280 DEFVAR_INT ("polling-period", polling_period
,
11281 doc
: /* Interval between polling for input during Lisp execution.
11282 The reason for polling is to make C-g work to stop a running program.
11283 Polling is needed only when using X windows and SIGIO does not work.
11284 Polling is automatically disabled in all other cases. */);
11285 polling_period
= 2;
11287 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11288 doc
: /* Maximum time between mouse clicks to make a double-click.
11289 Measured in milliseconds. The value nil means disable double-click
11290 recognition; t means double-clicks have no time limit and are detected
11291 by position only. */);
11292 Vdouble_click_time
= make_number (500);
11294 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11295 doc
: /* Maximum mouse movement between clicks to make a double-click.
11296 On window-system frames, value is the number of pixels the mouse may have
11297 moved horizontally or vertically between two clicks to make a double-click.
11298 On non window-system frames, value is interpreted in units of 1/8 characters
11301 This variable is also the threshold for motion of the mouse
11302 to count as a drag. */);
11303 double_click_fuzz
= 3;
11305 DEFVAR_INT ("num-input-keys", num_input_keys
,
11306 doc
: /* Number of complete key sequences read as input so far.
11307 This includes key sequences read from keyboard macros.
11308 The number is effectively the number of interactive command invocations. */);
11309 num_input_keys
= 0;
11311 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11312 doc
: /* Number of input events read from the keyboard so far.
11313 This does not include events generated by keyboard macros. */);
11314 num_nonmacro_input_events
= 0;
11316 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11317 doc
: /* The frame in which the most recently read event occurred.
11318 If the last event came from a keyboard macro, this is set to `macro'. */);
11319 Vlast_event_frame
= Qnil
;
11321 /* This variable is set up in sysdep.c. */
11322 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11323 doc
: /* The ERASE character as set by the user with stty. */);
11325 DEFVAR_LISP ("help-char", Vhelp_char
,
11326 doc
: /* Character to recognize as meaning Help.
11327 When it is read, do `(eval help-form)', and display result if it's a string.
11328 If the value of `help-form' is nil, this char can be read normally. */);
11329 XSETINT (Vhelp_char
, Ctl ('H'));
11331 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11332 doc
: /* List of input events to recognize as meaning Help.
11333 These work just like the value of `help-char' (see that). */);
11334 Vhelp_event_list
= Qnil
;
11336 DEFVAR_LISP ("help-form", Vhelp_form
,
11337 doc
: /* Form to execute when character `help-char' is read.
11338 If the form returns a string, that string is displayed.
11339 If `help-form' is nil, the help char is not recognized. */);
11342 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11343 doc
: /* Command to run when `help-char' character follows a prefix key.
11344 This command is used only when there is no actual binding
11345 for that character after that prefix key. */);
11346 Vprefix_help_command
= Qnil
;
11348 DEFVAR_LISP ("top-level", Vtop_level
,
11349 doc
: /* Form to evaluate when Emacs starts up.
11350 Useful to set before you dump a modified Emacs. */);
11353 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11354 doc
: /* Translate table for local keyboard input, or nil.
11355 If non-nil, the value should be a char-table. Each character read
11356 from the keyboard is looked up in this char-table. If the value found
11357 there is non-nil, then it is used instead of the actual input character.
11359 The value can also be a string or vector, but this is considered obsolete.
11360 If it is a string or vector of length N, character codes N and up are left
11361 untranslated. In a vector, an element which is nil means "no translation".
11363 This is applied to the characters supplied to input methods, not their
11364 output. See also `translation-table-for-input'.
11366 This variable has a separate binding for each terminal.
11367 See Info node `(elisp)Multiple Terminals'. */);
11369 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11370 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11371 \(Even if the operating system has support for stopping a process.\) */);
11372 cannot_suspend
= 0;
11374 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11375 doc
: /* Non-nil means prompt with menus when appropriate.
11376 This is done when reading from a keymap that has a prompt string,
11377 for elements that have prompt strings.
11378 The menu is displayed on the screen
11379 if X menus were enabled at configuration
11380 time and the previous event was a mouse click prefix key.
11381 Otherwise, menu prompting uses the echo area. */);
11382 menu_prompting
= 1;
11384 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11385 doc
: /* Character to see next line of menu prompt.
11386 Type this character while in a menu prompt to rotate around the lines of it. */);
11387 XSETINT (menu_prompt_more_char
, ' ');
11389 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11390 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11391 Emacs applies the modifiers of the character stored here to each keyboard
11392 character it reads. For example, after evaluating the expression
11393 (setq extra-keyboard-modifiers ?\\C-x)
11394 all input characters will have the control modifier applied to them.
11396 Note that the character ?\\C-@, equivalent to the integer zero, does
11397 not count as a control character; rather, it counts as a character
11398 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11399 cancels any modification. */);
11400 extra_keyboard_modifiers
= 0;
11402 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11403 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11404 The command loop sets this to nil before each command,
11405 and tests the value when the command returns.
11406 Buffer modification stores t in this variable. */);
11407 Vdeactivate_mark
= Qnil
;
11408 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11409 Fmake_variable_buffer_local (Qdeactivate_mark
);
11411 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11412 doc
: /* Normal hook run before each command is executed.
11413 If an unhandled error happens in running this hook,
11414 the function in which the error occurred is unconditionally removed, since
11415 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11416 Vpre_command_hook
= Qnil
;
11418 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11419 doc
: /* Normal hook run after each command is executed.
11420 If an unhandled error happens in running this hook,
11421 the function in which the error occurred is unconditionally removed, since
11422 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11423 Vpost_command_hook
= Qnil
;
11426 DEFVAR_LISP ("echo-area-clear-hook", ...,
11427 doc
: /* Normal hook run when clearing the echo area. */);
11429 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11430 Fset (Qecho_area_clear_hook
, Qnil
);
11432 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11433 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11434 Vlucid_menu_bar_dirty_flag
= Qnil
;
11436 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11437 doc
: /* List of menu bar items to move to the end of the menu bar.
11438 The elements of the list are event types that may have menu bar bindings. */);
11439 Vmenu_bar_final_items
= Qnil
;
11441 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11442 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11443 This is used internally by graphical displays that do not render
11444 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11445 Vtool_bar_separator_image_expression
= Qnil
;
11447 DEFVAR_KBOARD ("overriding-terminal-local-map",
11448 Voverriding_terminal_local_map
,
11449 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11450 This variable is intended to let commands such as `universal-argument'
11451 set up a different keymap for reading the next command.
11453 `overriding-terminal-local-map' has a separate binding for each
11454 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11456 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11457 doc
: /* Keymap that replaces (overrides) local keymaps.
11458 If this variable is non-nil, Emacs looks up key bindings in this
11459 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11460 buffer's local map. Hence, the only active keymaps would be
11461 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11462 order of precedence. */);
11463 Voverriding_local_map
= Qnil
;
11465 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11466 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11467 Otherwise, the menu bar continues to reflect the buffer's local map
11468 and the minor mode maps regardless of `overriding-local-map'. */);
11469 Voverriding_local_map_menu_flag
= Qnil
;
11471 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11472 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11473 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11475 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11476 doc
: /* Non-nil means generate motion events for mouse motion. */);
11478 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11479 doc
: /* Alist of system-specific X windows key symbols.
11480 Each element should have the form (N . SYMBOL) where N is the
11481 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11482 and SYMBOL is its name.
11484 `system-key-alist' has a separate binding for each terminal device.
11485 See Info node `(elisp)Multiple Terminals'. */);
11487 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11488 doc
: /* Keymap that translates key sequences to key sequences during input.
11489 This is used mainly for mapping key sequences into some preferred
11490 key events (symbols).
11492 The `read-key-sequence' function replaces any subsequence bound by
11493 `local-function-key-map' with its binding. More precisely, when the
11494 active keymaps have no binding for the current key sequence but
11495 `local-function-key-map' binds a suffix of the sequence to a vector or
11496 string, `read-key-sequence' replaces the matching suffix with its
11497 binding, and continues with the new sequence.
11499 If the binding is a function, it is called with one argument (the prompt)
11500 and its return value (a key sequence) is used.
11502 The events that come from bindings in `local-function-key-map' are not
11503 themselves looked up in `local-function-key-map'.
11505 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11506 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11507 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11508 typing `ESC O P x' would return [f1 x].
11510 `local-function-key-map' has a separate binding for each terminal
11511 device. See Info node `(elisp)Multiple Terminals'. If you need to
11512 define a binding on all terminals, change `function-key-map'
11513 instead. Initially, `local-function-key-map' is an empty keymap that
11514 has `function-key-map' as its parent on all terminal devices. */);
11516 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11517 doc
: /* Keymap that decodes input escape sequences.
11518 This is used mainly for mapping ASCII function key sequences into
11519 real Emacs function key events (symbols).
11521 The `read-key-sequence' function replaces any subsequence bound by
11522 `input-decode-map' with its binding. Contrary to `function-key-map',
11523 this map applies its rebinding regardless of the presence of an ordinary
11524 binding. So it is more like `key-translation-map' except that it applies
11525 before `function-key-map' rather than after.
11527 If the binding is a function, it is called with one argument (the prompt)
11528 and its return value (a key sequence) is used.
11530 The events that come from bindings in `input-decode-map' are not
11531 themselves looked up in `input-decode-map'. */);
11533 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11534 doc
: /* The parent keymap of all `local-function-key-map' instances.
11535 Function key definitions that apply to all terminal devices should go
11536 here. If a mapping is defined in both the current
11537 `local-function-key-map' binding and this variable, then the local
11538 definition will take precedence. */);
11539 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11541 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11542 doc
: /* Keymap of key translations that can override keymaps.
11543 This keymap works like `input-decode-map', but comes after `function-key-map'.
11544 Another difference is that it is global rather than terminal-local. */);
11545 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11547 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11548 doc
: /* List of deferred actions to be performed at a later time.
11549 The precise format isn't relevant here; we just check whether it is nil. */);
11550 Vdeferred_action_list
= Qnil
;
11552 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11553 doc
: /* Function to call to handle deferred actions, after each command.
11554 This function is called with no arguments after each command
11555 whenever `deferred-action-list' is non-nil. */);
11556 Vdeferred_action_function
= Qnil
;
11558 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11559 doc
: /* List of warnings to be displayed after this command.
11560 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11561 as per the args of `display-warning' (which see).
11562 If this variable is non-nil, `delayed-warnings-hook' will be run
11563 immediately after running `post-command-hook'. */);
11564 Vdelayed_warnings_list
= Qnil
;
11566 DEFVAR_LISP ("timer-list", Vtimer_list
,
11567 doc
: /* List of active absolute time timers in order of increasing time. */);
11568 Vtimer_list
= Qnil
;
11570 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11571 doc
: /* List of active idle-time timers in order of increasing time. */);
11572 Vtimer_idle_list
= Qnil
;
11574 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11575 doc
: /* If non-nil, the function that implements the current input method.
11576 It's called with one argument, a printing character that was just read.
11577 \(That means a character with code 040...0176.)
11578 Typically this function uses `read-event' to read additional events.
11579 When it does so, it should first bind `input-method-function' to nil
11580 so it will not be called recursively.
11582 The function should return a list of zero or more events
11583 to be used as input. If it wants to put back some events
11584 to be reconsidered, separately, by the input method,
11585 it can add them to the beginning of `unread-command-events'.
11587 The input method function can find in `input-method-previous-message'
11588 the previous echo area message.
11590 The input method function should refer to the variables
11591 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11592 for guidance on what to do. */);
11593 Vinput_method_function
= Qnil
;
11595 DEFVAR_LISP ("input-method-previous-message",
11596 Vinput_method_previous_message
,
11597 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11598 This variable exists because `read-event' clears the echo area
11599 before running the input method. It is nil if there was no message. */);
11600 Vinput_method_previous_message
= Qnil
;
11602 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11603 doc
: /* If non-nil, the function that implements the display of help.
11604 It's called with one argument, the help string to display. */);
11605 Vshow_help_function
= Qnil
;
11607 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11608 doc
: /* If non-nil, suppress point adjustment after executing a command.
11610 After a command is executed, if point is moved into a region that has
11611 special properties (e.g. composition, display), we adjust point to
11612 the boundary of the region. But, when a command sets this variable to
11613 non-nil, we suppress the point adjustment.
11615 This variable is set to nil before reading a command, and is checked
11616 just after executing the command. */);
11617 Vdisable_point_adjustment
= Qnil
;
11619 DEFVAR_LISP ("global-disable-point-adjustment",
11620 Vglobal_disable_point_adjustment
,
11621 doc
: /* If non-nil, always suppress point adjustment.
11623 The default value is nil, in which case, point adjustment are
11624 suppressed only after special commands that set
11625 `disable-point-adjustment' (which see) to non-nil. */);
11626 Vglobal_disable_point_adjustment
= Qnil
;
11628 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11629 doc
: /* How long to display an echo-area message when the minibuffer is active.
11630 If the value is not a number, such messages don't time out. */);
11631 Vminibuffer_message_timeout
= make_number (2);
11633 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11634 doc
: /* If non-nil, any keyboard input throws to this symbol.
11635 The value of that variable is passed to `quit-flag' and later causes a
11636 peculiar kind of quitting. */);
11637 Vthrow_on_input
= Qnil
;
11639 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11640 doc
: /* Function to output error messages.
11641 Called with three arguments:
11642 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11643 such as what `condition-case' would bind its variable to,
11644 - the context (a string which normally goes at the start of the message),
11645 - the Lisp function within which the error was signaled. */);
11646 Vcommand_error_function
= intern ("command-error-default-function");
11648 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11649 Venable_disabled_menus_and_buttons
,
11650 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11652 Help functions bind this to allow help on disabled menu items
11653 and tool-bar buttons. */);
11654 Venable_disabled_menus_and_buttons
= Qnil
;
11656 DEFVAR_LISP ("select-active-regions",
11657 Vselect_active_regions
,
11658 doc
: /* If non-nil, an active region automatically sets the primary selection.
11659 If the value is `only', only temporarily active regions (usually made
11660 by mouse-dragging or shift-selection) set the window selection.
11662 This takes effect only when Transient Mark mode is enabled. */);
11663 Vselect_active_regions
= Qt
;
11665 DEFVAR_LISP ("saved-region-selection",
11666 Vsaved_region_selection
,
11667 doc
: /* Contents of active region prior to buffer modification.
11668 If `select-active-regions' is non-nil, Emacs sets this to the
11669 text in the region before modifying the buffer. The next call to
11670 the function `deactivate-mark' uses this to set the window selection. */);
11671 Vsaved_region_selection
= Qnil
;
11673 DEFVAR_LISP ("selection-inhibit-update-commands",
11674 Vselection_inhibit_update_commands
,
11675 doc
: /* List of commands which should not update the selection.
11676 Normally, if `select-active-regions' is non-nil and the mark remains
11677 active after a command (i.e. the mark was not deactivated), the Emacs
11678 command loop sets the selection to the text in the region. However,
11679 if the command is in this list, the selection is not updated. */);
11680 Vselection_inhibit_update_commands
11681 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11683 DEFVAR_LISP ("debug-on-event",
11685 doc
: /* Enter debugger on this event. When Emacs
11686 receives the special event specified by this variable, it will try to
11687 break into the debugger as soon as possible instead of processing the
11688 event normally through `special-event-map'.
11690 Currently, the only supported values for this
11691 variable are `sigusr1' and `sigusr2'. */);
11692 Vdebug_on_event
= intern_c_string ("sigusr2");
11694 /* Create the initial keyboard. Qt means 'unset'. */
11695 initial_kboard
= allocate_kboard (Qt
);
11699 keys_of_keyboard (void)
11701 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11702 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11703 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11704 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11705 initial_define_key (meta_map
, 'x', "execute-extended-command");
11707 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11708 "handle-delete-frame");
11709 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11710 "ns-put-working-text");
11711 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11712 "ns-unput-working-text");
11713 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11714 current-prefix-arg, as is done in `handle-switch-frame'.
11715 But `handle-switch-frame is not run from the special-map.
11716 Commands from that map are run in a special way that automatically
11717 preserves the prefix-arg. Restoring the prefix arg here is not just
11718 redundant but harmful:
11720 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11721 - after the first prompt, the exit-minibuffer-hook is run which may
11722 iconify a frame and thus push a `iconify-frame' event.
11723 - after running exit-minibuffer-hook, current-prefix-arg is
11724 restored to the non-nil value it had before the prompt.
11725 - we enter the second prompt.
11726 current-prefix-arg is non-nil, prefix-arg is nil.
11727 - before running the first real event, we run the special iconify-frame
11728 event, but we pass the `special' arg to execute-command so
11729 current-prefix-arg and prefix-arg are left untouched.
11730 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11731 - the next key event will have a spuriously non-nil current-prefix-arg. */
11732 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11734 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11736 /* Handling it at such a low-level causes read_key_sequence to get
11737 * confused because it doesn't realize that the current_buffer was
11738 * changed by read_char.
11740 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11741 * "handle-select-window"); */
11742 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11743 "handle-save-session");
11746 /* Define a special event which is raised for dbus callback
11748 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11749 "dbus-handle-event");
11752 #ifdef USE_FILE_NOTIFY
11753 /* Define a special event which is raised for notification callback
11755 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11756 "file-notify-handle-event");
11757 #endif /* USE_FILE_NOTIFY */
11759 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11761 #if defined (WINDOWSNT)
11762 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11765 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11766 "handle-focus-in");
11767 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11768 "handle-focus-out");