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
*);
2418 /* {{coccinelle:skip_start}} */
2420 read_char (int commandflag
, Lisp_Object map
,
2421 Lisp_Object prev_event
,
2422 bool *used_mouse_menu
, struct timespec
*end_time
)
2424 volatile struct read_char_state
*state
= xmalloc (sizeof *state
);
2426 state
->commandflag
= commandflag
;
2428 state
->prev_event
= prev_event
;
2429 state
->used_mouse_menu
= used_mouse_menu
;
2430 state
->end_time
= end_time
;
2432 state
->local_getcjmp
= xmalloc (sizeof (*state
->local_getcjmp
));
2433 state
->save_jump
= xmalloc (sizeof (*state
->save_jump
));
2434 state
->previous_echo_area_message
= Qnil
;
2435 state
->also_record
= Qnil
;
2436 state
->reread
= false;
2437 state
->polling_stopped_here
= false;
2438 state
->orig_kboard
= current_kboard
;
2440 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2441 We will do that below, temporarily for short sections of code,
2442 when appropriate. local_getcjmp must be in effect
2443 around any call to sit_for or kbd_buffer_get_event;
2444 it *must not* be in effect when we call redisplay. */
2446 state
->jmpcount
= SPECPDL_INDEX ();
2447 if (sys_setjmp (*state
->local_getcjmp
))
2449 /* Handle quits while reading the keyboard. */
2450 /* We must have saved the outer value of getcjmp here,
2451 so restore it now. */
2452 restore_getcjmp (state
->save_jump
);
2453 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2454 unbind_to (state
->jmpcount
, Qnil
);
2455 XSETINT (state
->c
, quit_char
);
2456 internal_last_event_frame
= selected_frame
;
2457 Vlast_event_frame
= internal_last_event_frame
;
2458 /* If we report the quit char as an event,
2459 don't do so more than once. */
2460 if (!NILP (Vinhibit_quit
))
2464 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2465 if (kb
!= current_kboard
)
2467 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2468 /* We shouldn't get here if we were in single-kboard mode! */
2473 while (CONSP (XCDR (last
)))
2475 if (!NILP (XCDR (last
)))
2479 kset_kbd_queue (kb
, list1 (state
->c
));
2481 XSETCDR (last
, list1 (state
->c
));
2482 kb
->kbd_queue_has_data
= 1;
2483 current_kboard
= kb
;
2484 /* This is going to exit from read_char
2485 so we had better get rid of this frame's stuff. */
2487 return make_number (-2); /* wrong_kboard_jmpbuf */
2490 return read_char_1 (true, state
);
2493 return read_char_1 (false, state
);
2497 read_char_1 (bool jump
, volatile struct read_char_state
*state
)
2499 #define commandflag state->commandflag
2500 #define map state->map
2501 #define prev_event state->prev_event
2502 #define used_mouse_menu state->used_mouse_menu
2503 #define end_time state->end_time
2505 #define jmpcount state->jmpcount
2506 #define local_getcjmp state->local_getcjmp
2507 #define save_jump state->save_jump
2508 #define previous_echo_area_message state->previous_echo_area_message
2509 #define also_record state->also_record
2510 #define reread state->reread
2511 #define polling_stopped_here state->polling_stopped_here
2512 #define orig_kboard state->orig_kboard
2513 Lisp_Object tem
, save
;
2520 if (CONSP (Vunread_post_input_method_events
))
2522 c
= XCAR (Vunread_post_input_method_events
);
2523 Vunread_post_input_method_events
2524 = XCDR (Vunread_post_input_method_events
);
2526 /* Undo what read_char_x_menu_prompt did when it unread
2527 additional keys returned by Fx_popup_menu. */
2529 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2540 if (CONSP (Vunread_command_events
))
2542 bool was_disabled
= 0;
2544 c
= XCAR (Vunread_command_events
);
2545 Vunread_command_events
= XCDR (Vunread_command_events
);
2547 /* Undo what sit-for did when it unread additional keys
2548 inside universal-argument. */
2550 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2555 /* Undo what read_char_x_menu_prompt did when it unread
2556 additional keys returned by Fx_popup_menu. */
2558 && EQ (XCDR (c
), Qdisabled
)
2559 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2565 /* If the queued event is something that used the mouse,
2566 set used_mouse_menu accordingly. */
2568 /* Also check was_disabled so last-nonmenu-event won't return
2569 a bad value when submenus are involved. (Bug#447) */
2570 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2571 *used_mouse_menu
= 1;
2573 goto reread_for_input_method
;
2576 if (CONSP (Vunread_input_method_events
))
2578 c
= XCAR (Vunread_input_method_events
);
2579 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2581 /* Undo what read_char_x_menu_prompt did when it unread
2582 additional keys returned by Fx_popup_menu. */
2584 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2588 goto reread_for_input_method
;
2591 this_command_key_count_reset
= 0;
2593 if (!NILP (Vexecuting_kbd_macro
))
2595 /* We set this to Qmacro; since that's not a frame, nobody will
2596 try to switch frames on us, and the selected window will
2599 Since this event came from a macro, it would be misleading to
2600 leave internal_last_event_frame set to wherever the last
2601 real event came from. Normally, a switch-frame event selects
2602 internal_last_event_frame after each command is read, but
2603 events read from a macro should never cause a new frame to be
2605 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2607 /* Exit the macro if we are at the end.
2608 Also, some things replace the macro with t
2609 to force an early exit. */
2610 if (EQ (Vexecuting_kbd_macro
, Qt
)
2611 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2617 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2618 if (STRINGP (Vexecuting_kbd_macro
)
2619 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2620 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2622 executing_kbd_macro_index
++;
2627 if (!NILP (unread_switch_frame
))
2629 c
= unread_switch_frame
;
2630 unread_switch_frame
= Qnil
;
2632 /* This event should make it into this_command_keys, and get echoed
2633 again, so we do not set `reread'. */
2637 /* If redisplay was requested. */
2638 if (commandflag
>= 0)
2640 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2642 /* If there is pending input, process any events which are not
2643 user-visible, such as X selection_request events. */
2645 || detect_input_pending_run_timers (0))
2646 swallow_events (0); /* May clear input_pending. */
2648 /* Redisplay if no pending input. */
2649 while (!input_pending
)
2651 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2652 redisplay_preserve_echo_area (5);
2657 /* Normal case: no input arrived during redisplay. */
2660 /* Input arrived and pre-empted redisplay.
2661 Process any events which are not user-visible. */
2663 /* If that cleared input_pending, try again to redisplay. */
2666 /* Prevent the redisplay we just did
2667 from messing up echoing of the input after the prompt. */
2668 if (commandflag
== 0 && echo_current
)
2669 echo_message_buffer
= echo_area_buffer
[0];
2673 /* Message turns off echoing unless more keystrokes turn it on again.
2675 The code in 20.x for the condition was
2677 1. echo_area_glyphs && *echo_area_glyphs
2678 2. && echo_area_glyphs != current_kboard->echobuf
2679 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2681 (1) means there's a current message displayed
2683 (2) means it's not the message from echoing from the current
2686 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2687 is set to a non-null value. This is done in read_char and it is
2688 set to echo_area_glyphs after a call to echo_char. That means
2689 ok_to_echo_at_next_pause is either null or
2690 current_kboard->echobuf with the appropriate current_kboard at
2693 So, condition (3) means in clear text ok_to_echo_at_next_pause
2694 must be either null, or the current message isn't from echoing at
2695 all, or it's from echoing from a different kboard than the
2698 if (/* There currently is something in the echo area. */
2699 !NILP (echo_area_buffer
[0])
2700 && (/* It's an echo from a different kboard. */
2701 echo_kboard
!= current_kboard
2702 /* Or we explicitly allow overwriting whatever there is. */
2703 || ok_to_echo_at_next_pause
== NULL
))
2708 /* Try reading a character via menu prompting in the minibuf.
2709 Try this before the sit-for, because the sit-for
2710 would do the wrong thing if we are supposed to do
2711 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2712 after a mouse event so don't try a minibuf menu. */
2714 if (KEYMAPP (map
) && INTERACTIVE
2715 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2716 /* Don't bring up a menu if we already have another event. */
2717 && NILP (Vunread_command_events
)
2718 && !detect_input_pending_run_timers (0))
2720 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2722 if (INTEGERP (c
) && XINT (c
) == -2)
2723 return c
; /* wrong_kboard_jmpbuf */
2729 /* Start idle timers if no time limit is supplied. We don't do it
2730 if a time limit is supplied to avoid an infinite recursion in the
2731 situation where an idle timer calls `sit-for'. */
2734 timer_start_idle ();
2736 /* If in middle of key sequence and minibuffer not active,
2737 start echoing if enough time elapses. */
2739 if (minibuf_level
== 0
2741 && !current_kboard
->immediate_echo
2742 && this_command_key_count
> 0
2744 && echo_keystrokes_p ()
2745 && (/* No message. */
2746 NILP (echo_area_buffer
[0])
2747 /* Or empty message. */
2748 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2749 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2750 /* Or already echoing from same kboard. */
2751 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2752 /* Or not echoing before and echoing allowed. */
2753 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2755 /* After a mouse event, start echoing right away.
2756 This is because we are probably about to display a menu,
2757 and we don't want to delay before doing so. */
2758 if (EVENT_HAS_PARAMETERS (prev_event
))
2764 save_getcjmp (save_jump
);
2765 restore_getcjmp (local_getcjmp
);
2766 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2767 restore_getcjmp (save_jump
);
2769 && ! CONSP (Vunread_command_events
))
2774 /* Maybe auto save due to number of keystrokes. */
2776 if (commandflag
!= 0 && commandflag
!= -2
2777 && auto_save_interval
> 0
2778 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2779 && !detect_input_pending_run_timers (0))
2781 Fdo_auto_save (Qnil
, Qnil
);
2782 /* Hooks can actually change some buffers in auto save. */
2786 /* Try reading using an X menu.
2787 This is never confused with reading using the minibuf
2788 because the recursive call of read_char in read_char_minibuf_menu_prompt
2789 does not pass on any keymaps. */
2791 if (KEYMAPP (map
) && INTERACTIVE
2792 && !NILP (prev_event
)
2793 && EVENT_HAS_PARAMETERS (prev_event
)
2794 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2795 && !EQ (XCAR (prev_event
), Qtool_bar
)
2796 /* Don't bring up a menu if we already have another event. */
2797 && NILP (Vunread_command_events
))
2799 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2801 /* Now that we have read an event, Emacs is not idle. */
2808 /* Maybe autosave and/or garbage collect due to idleness. */
2810 if (INTERACTIVE
&& NILP (c
))
2813 ptrdiff_t buffer_size
;
2815 /* Slow down auto saves logarithmically in size of current buffer,
2816 and garbage collect while we're at it. */
2817 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2818 last_non_minibuf_size
= Z
- BEG
;
2819 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2821 while (buffer_size
> 64)
2822 delay_level
++, buffer_size
-= buffer_size
>> 2;
2823 if (delay_level
< 4) delay_level
= 4;
2824 /* delay_level is 4 for files under around 50k, 7 at 100k,
2825 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2827 /* Auto save if enough time goes by without input. */
2828 if (commandflag
!= 0 && commandflag
!= -2
2829 && num_nonmacro_input_events
> last_auto_save
2830 && INTEGERP (Vauto_save_timeout
)
2831 && XINT (Vauto_save_timeout
) > 0)
2834 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2836 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2837 timeout
= delay_level
* timeout
/ 4;
2838 save_getcjmp (save_jump
);
2839 restore_getcjmp (local_getcjmp
);
2840 tem0
= sit_for (make_number (timeout
), 1, 1);
2841 restore_getcjmp (save_jump
);
2844 && ! CONSP (Vunread_command_events
))
2846 Fdo_auto_save (Qnil
, Qnil
);
2851 /* If there is still no input available, ask for GC. */
2852 if (!detect_input_pending_run_timers (0))
2853 GC_collect_a_little ();
2856 /* Notify the caller if an autosave hook, or a timer, sentinel or
2857 filter in the sit_for calls above have changed the current
2858 kboard. This could happen if they use the minibuffer or start a
2859 recursive edit, like the fancy splash screen in server.el's
2860 filter. If this longjmp wasn't here, read_key_sequence would
2861 interpret the next key sequence using the wrong translation
2862 tables and function keymaps. */
2863 if (NILP (c
) && current_kboard
!= orig_kboard
)
2866 return make_number (-2); /* wrong_kboard_jmpbuf */
2869 /* If this has become non-nil here, it has been set by a timer
2870 or sentinel or filter. */
2871 if (CONSP (Vunread_command_events
))
2873 c
= XCAR (Vunread_command_events
);
2874 Vunread_command_events
= XCDR (Vunread_command_events
);
2876 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2882 /* Read something from current KBOARD's side queue, if possible. */
2886 if (current_kboard
->kbd_queue_has_data
)
2888 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2890 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2891 kset_kbd_queue (current_kboard
,
2892 XCDR (KVAR (current_kboard
, kbd_queue
)));
2893 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2894 current_kboard
->kbd_queue_has_data
= 0;
2895 input_pending
= readable_events (0);
2896 if (EVENT_HAS_PARAMETERS (c
)
2897 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2898 internal_last_event_frame
= XCAR (XCDR (c
));
2899 Vlast_event_frame
= internal_last_event_frame
;
2903 /* If current_kboard's side queue is empty check the other kboards.
2904 If one of them has data that we have not yet seen here,
2905 switch to it and process the data waiting for it.
2907 Note: if the events queued up for another kboard
2908 have already been seen here, and therefore are not a complete command,
2909 the kbd_queue_has_data field is 0, so we skip that kboard here.
2910 That's to avoid an infinite loop switching between kboards here. */
2911 if (NILP (c
) && !single_kboard
)
2914 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2915 if (kb
->kbd_queue_has_data
)
2917 current_kboard
= kb
;
2918 /* This is going to exit from read_char
2919 so we had better get rid of this frame's stuff. */
2921 return make_number (-2); /* wrong_kboard_jmpbuf */
2931 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2932 prev_event
, used_mouse_menu
);
2933 if (NILP (c
) && end_time
2934 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2939 if (EQ (c
, make_number (-2)))
2941 /* This is going to exit from read_char
2942 so we had better get rid of this frame's stuff. */
2956 if (commandflag
>= 0
2957 && !input_pending
&& !detect_input_pending_run_timers (0))
2963 /* Buffer switch events are only for internal wakeups
2964 so don't show them to the user.
2965 Also, don't record a key if we already did. */
2969 /* Process special events within read_char
2970 and loop around to read another event. */
2973 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2978 struct buffer
*prev_buffer
= current_buffer
;
2979 last_input_event
= c
;
2980 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2982 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2983 /* We stopped being idle for this event; undo that. This
2984 prevents automatic window selection (under
2985 mouse_autoselect_window from acting as a real input event, for
2986 example banishing the mouse under mouse-avoidance-mode. */
2987 timer_resume_idle ();
2989 if (current_buffer
!= prev_buffer
)
2991 /* The command may have changed the keymaps. Pretend there
2992 is input in another keyboard and return. This will
2993 recalculate keymaps. */
2994 c
= make_number (-2);
3001 /* Handle things that only apply to characters. */
3004 /* If kbd_buffer_get_event gave us an EOF, return that. */
3008 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3009 && UNSIGNED_CMP (XFASTINT (c
), <,
3010 SCHARS (KVAR (current_kboard
,
3011 Vkeyboard_translate_table
))))
3012 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3013 && UNSIGNED_CMP (XFASTINT (c
), <,
3014 ASIZE (KVAR (current_kboard
,
3015 Vkeyboard_translate_table
))))
3016 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3020 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3021 /* nil in keyboard-translate-table means no translation. */
3027 /* If this event is a mouse click in the menu bar,
3028 return just menu-bar for now. Modify the mouse click event
3029 so we won't do this twice, then queue it up. */
3030 if (EVENT_HAS_PARAMETERS (c
)
3032 && CONSP (EVENT_START (c
))
3033 && CONSP (XCDR (EVENT_START (c
))))
3037 posn
= POSN_POSN (EVENT_START (c
));
3038 /* Handle menu-bar events:
3039 insert the dummy prefix event `menu-bar'. */
3040 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3042 /* Change menu-bar to (menu-bar) as the event "position". */
3043 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3046 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3051 /* Store these characters into recent_keys, the dribble file if any,
3052 and the keyboard macro being defined, if any. */
3054 if (! NILP (also_record
))
3055 record_char (also_record
);
3057 /* Wipe the echo area.
3058 But first, if we are about to use an input method,
3059 save the echo area contents for it to refer to. */
3061 && ! NILP (Vinput_method_function
)
3062 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3064 previous_echo_area_message
= Fcurrent_message ();
3065 Vinput_method_previous_message
= previous_echo_area_message
;
3068 /* Now wipe the echo area, except for help events which do their
3069 own stuff with the echo area. */
3071 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3072 && !(EQ (Qswitch_frame
, XCAR (c
)))
3073 /* Don't wipe echo area for select window events: These might
3074 get delayed via `mouse-autoselect-window' (Bug#11304). */
3075 && !(EQ (Qselect_window
, XCAR (c
)))))
3077 if (!NILP (echo_area_buffer
[0]))
3079 safe_run_hooks (Qecho_area_clear_hook
);
3080 clear_message (1, 0);
3084 reread_for_input_method
:
3086 /* Pass this to the input method, if appropriate. */
3088 && ! NILP (Vinput_method_function
)
3089 /* Don't run the input method within a key sequence,
3090 after the first event of the key sequence. */
3091 && NILP (prev_event
)
3092 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3095 ptrdiff_t key_count
;
3096 bool key_count_reset
;
3097 struct gcpro gcpro1
;
3099 /* Save the echo status. */
3100 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3101 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3102 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3103 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3108 if (before_command_restore_flag
)
3110 this_command_key_count
= before_command_key_count_1
;
3111 if (this_command_key_count
< this_single_command_key_start
)
3112 this_single_command_key_start
= this_command_key_count
;
3113 echo_truncate (before_command_echo_length_1
);
3114 before_command_restore_flag
= 0;
3118 /* Save the this_command_keys status. */
3119 key_count
= this_command_key_count
;
3120 key_count_reset
= this_command_key_count_reset
;
3123 keys
= Fcopy_sequence (this_command_keys
);
3128 /* Clear out this_command_keys. */
3129 this_command_key_count
= 0;
3130 this_command_key_count_reset
= 0;
3132 /* Now wipe the echo area. */
3133 if (!NILP (echo_area_buffer
[0]))
3134 safe_run_hooks (Qecho_area_clear_hook
);
3135 clear_message (1, 0);
3138 /* If we are not reading a key sequence,
3139 never use the echo area. */
3142 specbind (Qinput_method_use_echo_area
, Qt
);
3145 /* Call the input method. */
3146 tem
= call1 (Vinput_method_function
, c
);
3150 /* Restore the saved echoing state
3151 and this_command_keys state. */
3152 this_command_key_count
= key_count
;
3153 this_command_key_count_reset
= key_count_reset
;
3155 this_command_keys
= keys
;
3158 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3159 kset_echo_string (current_kboard
, saved_echo_string
);
3160 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3161 if (saved_immediate_echo
)
3166 /* The input method can return no events. */
3169 /* Bring back the previous message, if any. */
3170 if (! NILP (previous_echo_area_message
))
3171 message_with_string ("%s", previous_echo_area_message
, 0);
3174 /* It returned one event or more. */
3176 Vunread_post_input_method_events
3177 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3182 /* Display help if not echoing. */
3183 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3185 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3186 Lisp_Object help
, object
, position
, window
, htem
;
3188 htem
= Fcdr (XCDR (c
));
3191 window
= Fcar (htem
);
3193 object
= Fcar (htem
);
3195 position
= Fcar (htem
);
3197 show_help_echo (help
, window
, object
, position
);
3199 /* We stopped being idle for this event; undo that. */
3201 timer_resume_idle ();
3205 if ((! reread
|| this_command_key_count
== 0
3206 || this_command_key_count_reset
)
3210 /* Don't echo mouse motion events. */
3211 if (echo_keystrokes_p ()
3212 && ! (EVENT_HAS_PARAMETERS (c
)
3213 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3216 if (! NILP (also_record
))
3217 echo_char (also_record
);
3218 /* Once we reread a character, echoing can happen
3219 the next time we pause to read a new one. */
3220 ok_to_echo_at_next_pause
= current_kboard
;
3223 /* Record this character as part of the current key. */
3224 add_command_key (c
);
3225 if (! NILP (also_record
))
3226 add_command_key (also_record
);
3229 last_input_event
= c
;
3232 /* Process the help character specially if enabled. */
3233 if (!NILP (Vhelp_form
) && help_char_p (c
))
3237 help_form_saved_window_configs
3238 = Fcons (Fcurrent_window_configuration (Qnil
),
3239 help_form_saved_window_configs
);
3240 record_unwind_protect_void (read_char_help_form_unwind
);
3241 call0 (Qhelp_form_show
);
3246 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3247 if (EVENT_HAS_PARAMETERS (c
)
3248 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3249 XSETCAR (help_form_saved_window_configs
, Qnil
);
3251 while (BUFFERP (c
));
3252 /* Remove the help from the frame. */
3256 if (EQ (c
, make_number (040)))
3260 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3261 while (BUFFERP (c
));
3271 #undef used_mouse_menu
3275 #undef local_getcjmp
3277 #undef previous_echo_area_message
3280 #undef polling_stopped_here
3283 /* {{coccinelle:skip_end}} */
3285 /* Record a key that came from a mouse menu.
3286 Record it for echoing, for this-command-keys, and so on. */
3289 record_menu_key (Lisp_Object c
)
3291 /* Wipe the echo area. */
3292 clear_message (1, 0);
3297 before_command_key_count
= this_command_key_count
;
3298 before_command_echo_length
= echo_length ();
3301 /* Don't echo mouse motion events. */
3302 if (echo_keystrokes_p ())
3306 /* Once we reread a character, echoing can happen
3307 the next time we pause to read a new one. */
3308 ok_to_echo_at_next_pause
= 0;
3311 /* Record this character as part of the current key. */
3312 add_command_key (c
);
3314 /* Re-reading in the middle of a command. */
3315 last_input_event
= c
;
3319 /* Return true if should recognize C as "the help character". */
3322 help_char_p (Lisp_Object c
)
3326 if (EQ (c
, Vhelp_char
))
3328 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3329 if (EQ (c
, XCAR (tail
)))
3334 /* Record the input event C in various ways. */
3337 record_char (Lisp_Object c
)
3341 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3343 /* To avoid filling recent_keys with help-echo and mouse-movement
3344 events, we filter out repeated help-echo events, only store the
3345 first and last in a series of mouse-movement events, and don't
3346 store repeated help-echo events which are only separated by
3347 mouse-movement events. */
3349 Lisp_Object ev1
, ev2
, ev3
;
3352 if ((ix1
= recent_keys_index
- 1) < 0)
3353 ix1
= NUM_RECENT_KEYS
- 1;
3354 ev1
= AREF (recent_keys
, ix1
);
3356 if ((ix2
= ix1
- 1) < 0)
3357 ix2
= NUM_RECENT_KEYS
- 1;
3358 ev2
= AREF (recent_keys
, ix2
);
3360 if ((ix3
= ix2
- 1) < 0)
3361 ix3
= NUM_RECENT_KEYS
- 1;
3362 ev3
= AREF (recent_keys
, ix3
);
3364 if (EQ (XCAR (c
), Qhelp_echo
))
3366 /* Don't record `help-echo' in recent_keys unless it shows some help
3367 message, and a different help than the previously recorded
3369 Lisp_Object help
, last_help
;
3371 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3372 if (!STRINGP (help
))
3374 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3375 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3377 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3378 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3379 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3381 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3382 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3383 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3384 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3387 else if (EQ (XCAR (c
), Qmouse_movement
))
3389 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3390 So additional mouse movement events replace the last element. */
3391 Lisp_Object last_window
, window
;
3393 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3394 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3395 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3396 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3397 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3399 ASET (recent_keys
, ix1
, c
);
3405 store_kbd_macro_char (c
);
3409 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3410 ASET (recent_keys
, recent_keys_index
, c
);
3411 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3412 recent_keys_index
= 0;
3414 else if (recorded
< 0)
3416 /* We need to remove one or two events from recent_keys.
3417 To do this, we simply put nil at those events and move the
3418 recent_keys_index backwards over those events. Usually,
3419 users will never see those nil events, as they will be
3420 overwritten by the command keys entered to see recent_keys
3423 while (recorded
++ < 0 && total_keys
> 0)
3425 if (total_keys
< NUM_RECENT_KEYS
)
3427 if (--recent_keys_index
< 0)
3428 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3429 ASET (recent_keys
, recent_keys_index
, Qnil
);
3433 num_nonmacro_input_events
++;
3435 /* Write c to the dribble file. If c is a lispy event, write
3436 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3437 If you, dear reader, have a better idea, you've got the source. :-) */
3443 if (XUINT (c
) < 0x100)
3444 putc (XUINT (c
), dribble
);
3446 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3450 Lisp_Object dribblee
;
3452 /* If it's a structured event, take the event header. */
3453 dribblee
= EVENT_HEAD (c
);
3455 if (SYMBOLP (dribblee
))
3457 putc ('<', dribble
);
3458 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3459 SBYTES (SYMBOL_NAME (dribblee
)),
3461 putc ('>', dribble
);
3470 /* Copy out or in the info on where C-g should throw to.
3471 This is used when running Lisp code from within get_char,
3472 in case get_char is called recursively.
3473 See read_process_output. */
3476 save_getcjmp (sys_jmp_buf
*temp
)
3478 memcpy (*temp
, getcjmp
, sizeof getcjmp
);
3482 restore_getcjmp (sys_jmp_buf
*temp
)
3484 memcpy (getcjmp
, *temp
, sizeof getcjmp
);
3487 /* Low level keyboard/mouse input.
3488 kbd_buffer_store_event places events in kbd_buffer, and
3489 kbd_buffer_get_event retrieves them. */
3491 /* Return true if there are any events in the queue that read-char
3492 would return. If this returns false, a read-char would block. */
3494 readable_events (int flags
)
3496 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3499 /* If the buffer contains only FOCUS_IN_EVENT events, and
3500 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3501 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3503 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3504 #ifdef USE_TOOLKIT_SCROLL_BARS
3505 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3509 struct input_event
*event
;
3511 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3518 #ifdef USE_TOOLKIT_SCROLL_BARS
3519 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3521 event
->kind
== FOCUS_IN_EVENT
)
3522 #ifdef USE_TOOLKIT_SCROLL_BARS
3523 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3524 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3525 && event
->part
== scroll_bar_handle
3526 && event
->modifiers
== 0)
3531 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3534 while (event
!= kbd_store_ptr
);
3540 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3541 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3545 if (current_kboard
->kbd_queue_has_data
)
3551 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3552 if (kb
->kbd_queue_has_data
)
3558 /* Set this for debugging, to have a way to get out */
3559 int stop_character EXTERNALLY_VISIBLE
;
3562 event_to_kboard (struct input_event
*event
)
3564 /* Not applicable for these special events. */
3565 if (event
->kind
== SELECTION_REQUEST_EVENT
3566 || event
->kind
== SELECTION_CLEAR_EVENT
)
3570 Lisp_Object obj
= event
->frame_or_window
;
3571 /* There are some events that set this field to nil or string. */
3573 obj
= WINDOW_FRAME (XWINDOW (obj
));
3574 /* Also ignore dead frames here. */
3575 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3576 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3581 /* Return the number of slots occupied in kbd_buffer. */
3584 kbd_buffer_nr_stored (void)
3586 return kbd_fetch_ptr
== kbd_store_ptr
3588 : (kbd_fetch_ptr
< kbd_store_ptr
3589 ? kbd_store_ptr
- kbd_fetch_ptr
3590 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3591 + (kbd_store_ptr
- kbd_buffer
)));
3593 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3596 kbd_buffer_store_event (register struct input_event
*event
)
3598 kbd_buffer_store_event_hold (event
, 0);
3601 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3603 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3604 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3605 Else, if EVENT is a quit event, store the quit event
3606 in HOLD_QUIT, and return (thus ignoring further events).
3608 This is used to postpone the processing of the quit event until all
3609 subsequent input events have been parsed (and discarded). */
3612 kbd_buffer_store_event_hold (register struct input_event
*event
,
3613 struct input_event
*hold_quit
)
3615 if (event
->kind
== NO_EVENT
)
3618 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3621 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3623 register int c
= event
->code
& 0377;
3625 if (event
->modifiers
& ctrl_modifier
)
3626 c
= make_ctrl_char (c
);
3628 c
|= (event
->modifiers
3629 & (meta_modifier
| alt_modifier
3630 | hyper_modifier
| super_modifier
));
3634 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3635 struct input_event
*sp
;
3637 if (single_kboard
&& kb
!= current_kboard
)
3640 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3642 kb
->kbd_queue_has_data
= 1;
3643 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3645 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3648 if (event_to_kboard (sp
) == kb
)
3650 sp
->kind
= NO_EVENT
;
3651 sp
->frame_or_window
= Qnil
;
3660 *hold_quit
= *event
;
3664 /* If this results in a quit_char being returned to Emacs as
3665 input, set Vlast_event_frame properly. If this doesn't
3666 get returned to Emacs as an event, the next event read
3667 will set Vlast_event_frame again, so this is safe to do. */
3671 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3673 focus
= event
->frame_or_window
;
3674 internal_last_event_frame
= focus
;
3675 Vlast_event_frame
= focus
;
3678 handle_interrupt (0);
3682 if (c
&& c
== stop_character
)
3688 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3689 Just ignore the second one. */
3690 else if (event
->kind
== BUFFER_SWITCH_EVENT
3691 && kbd_fetch_ptr
!= kbd_store_ptr
3692 && ((kbd_store_ptr
== kbd_buffer
3693 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3694 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3697 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3698 kbd_store_ptr
= kbd_buffer
;
3700 /* Don't let the very last slot in the buffer become full,
3701 since that would make the two pointers equal,
3702 and that is indistinguishable from an empty buffer.
3703 Discard the event if it would fill the last slot. */
3704 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3706 *kbd_store_ptr
= *event
;
3709 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3710 && ! kbd_on_hold_p ())
3712 /* Don't read keyboard input until we have processed kbd_buffer.
3713 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3714 hold_keyboard_input ();
3715 if (!noninteractive
)
3719 #endif /* subprocesses */
3722 /* If we're inside while-no-input, and this event qualifies
3723 as input, set quit-flag to cause an interrupt. */
3724 if (!NILP (Vthrow_on_input
)
3725 && event
->kind
!= FOCUS_IN_EVENT
3726 && event
->kind
!= HELP_EVENT
3727 && event
->kind
!= DEICONIFY_EVENT
)
3729 Vquit_flag
= Vthrow_on_input
;
3730 /* If we're inside a function that wants immediate quits,
3732 if (immediate_quit
&& NILP (Vinhibit_quit
))
3741 /* Put an input event back in the head of the event queue. */
3744 kbd_buffer_unget_event (register struct input_event
*event
)
3746 if (kbd_fetch_ptr
== kbd_buffer
)
3747 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3749 /* Don't let the very last slot in the buffer become full, */
3750 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3753 *kbd_fetch_ptr
= *event
;
3758 /* Generate a HELP_EVENT input_event and store it in the keyboard
3761 HELP is the help form.
3763 FRAME and WINDOW are the frame and window where the help is
3764 generated. OBJECT is the Lisp object where the help was found (a
3765 buffer, a string, an overlay, or nil if neither from a string nor
3766 from a buffer). POS is the position within OBJECT where the help
3770 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3771 Lisp_Object object
, ptrdiff_t pos
)
3773 struct input_event event
;
3777 event
.kind
= HELP_EVENT
;
3778 event
.frame_or_window
= frame
;
3780 event
.x
= WINDOWP (window
) ? window
: frame
;
3783 kbd_buffer_store_event (&event
);
3787 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3790 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3792 struct input_event event
;
3794 event
.kind
= HELP_EVENT
;
3795 event
.frame_or_window
= frame
;
3800 kbd_buffer_store_event (&event
);
3804 /* Discard any mouse events in the event buffer by setting them to
3807 discard_mouse_events (void)
3809 struct input_event
*sp
;
3810 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3812 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3815 if (sp
->kind
== MOUSE_CLICK_EVENT
3816 || sp
->kind
== WHEEL_EVENT
3817 || sp
->kind
== HORIZ_WHEEL_EVENT
3819 || sp
->kind
== GPM_CLICK_EVENT
3821 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3823 sp
->kind
= NO_EVENT
;
3829 /* Return true if there are any real events waiting in the event
3830 buffer, not counting `NO_EVENT's.
3832 Discard NO_EVENT events at the front of the input queue, possibly
3833 leaving the input queue empty if there are no real input events. */
3836 kbd_buffer_events_waiting (void)
3838 struct input_event
*sp
;
3840 for (sp
= kbd_fetch_ptr
;
3841 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3844 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3849 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3853 /* Clear input event EVENT. */
3856 clear_event (struct input_event
*event
)
3858 event
->kind
= NO_EVENT
;
3862 /* Read one event from the event buffer, waiting if necessary.
3863 The value is a Lisp object representing the event.
3864 The value is nil for an event that should be ignored,
3865 or that was handled here.
3866 We always read and discard one event. */
3869 kbd_buffer_get_event (KBOARD
**kbp
,
3870 bool *used_mouse_menu
,
3871 struct timespec
*end_time
)
3876 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3878 /* Start reading input again because we have processed enough to
3879 be able to accept new events again. */
3880 unhold_keyboard_input ();
3883 #endif /* subprocesses */
3885 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3887 /* In case we are running as a daemon, only do this before
3888 detaching from the terminal. */
3889 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3893 *kbp
= current_kboard
;
3896 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3898 /* Wait until there is input available. */
3901 /* Break loop if there's an unread command event. Needed in
3902 moused window autoselection which uses a timer to insert such
3904 if (CONSP (Vunread_command_events
))
3907 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3909 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3912 /* If the quit flag is set, then read_char will return
3913 quit_char, so that counts as "available input." */
3914 if (!NILP (Vquit_flag
))
3915 quit_throw_to_read_char (0);
3917 /* One way or another, wait until input is available; then, if
3918 interrupt handlers have not read it, read it now. */
3923 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3925 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3929 struct timespec now
= current_timespec ();
3930 if (timespec_cmp (*end_time
, now
) <= 0)
3931 return Qnil
; /* Finished waiting. */
3934 struct timespec duration
= timespec_sub (*end_time
, now
);
3935 wait_reading_process_output (min (duration
.tv_sec
,
3938 -1, 1, Qnil
, NULL
, 0);
3943 bool do_display
= true;
3945 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3947 struct tty_display_info
*tty
= CURTTY ();
3949 /* When this TTY is displaying a menu, we must prevent
3950 any redisplay, because we modify the frame's glyph
3951 matrix behind the back of the display engine. */
3952 if (tty
->showing_menu
)
3956 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3959 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3963 if (CONSP (Vunread_command_events
))
3966 first
= XCAR (Vunread_command_events
);
3967 Vunread_command_events
= XCDR (Vunread_command_events
);
3968 *kbp
= current_kboard
;
3972 /* At this point, we know that there is a readable event available
3973 somewhere. If the event queue is empty, then there must be a
3974 mouse movement enabled and available. */
3975 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3977 struct input_event
*event
;
3979 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3983 *kbp
= event_to_kboard (event
);
3985 *kbp
= current_kboard
; /* Better than returning null ptr? */
3989 /* These two kinds of events get special handling
3990 and don't actually appear to the command loop.
3991 We return nil for them. */
3992 if (event
->kind
== SELECTION_REQUEST_EVENT
3993 || event
->kind
== SELECTION_CLEAR_EVENT
)
3996 struct input_event copy
;
3998 /* Remove it from the buffer before processing it,
3999 since otherwise swallow_events will see it
4000 and process it again. */
4002 kbd_fetch_ptr
= event
+ 1;
4003 input_pending
= readable_events (0);
4004 x_handle_selection_event (©
);
4006 /* We're getting selection request events, but we don't have
4012 #if defined (HAVE_NS)
4013 else if (event
->kind
== NS_TEXT_EVENT
)
4015 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4016 obj
= list1 (intern ("ns-put-working-text"));
4018 obj
= list1 (intern ("ns-unput-working-text"));
4019 kbd_fetch_ptr
= event
+ 1;
4020 if (used_mouse_menu
)
4021 *used_mouse_menu
= 1;
4025 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4026 || defined (HAVE_NS)
4027 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4029 /* Make an event (delete-frame (FRAME)). */
4030 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4031 kbd_fetch_ptr
= event
+ 1;
4034 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4035 || defined (HAVE_NS)
4036 else if (event
->kind
== ICONIFY_EVENT
)
4038 /* Make an event (iconify-frame (FRAME)). */
4039 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4040 kbd_fetch_ptr
= event
+ 1;
4042 else if (event
->kind
== DEICONIFY_EVENT
)
4044 /* Make an event (make-frame-visible (FRAME)). */
4045 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4046 kbd_fetch_ptr
= event
+ 1;
4049 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4051 /* The value doesn't matter here; only the type is tested. */
4052 XSETBUFFER (obj
, current_buffer
);
4053 kbd_fetch_ptr
= event
+ 1;
4055 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4056 || defined (HAVE_NS) || defined (USE_GTK)
4057 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4059 kbd_fetch_ptr
= event
+ 1;
4060 input_pending
= readable_events (0);
4061 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4062 x_activate_menubar (XFRAME (event
->frame_or_window
));
4066 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4068 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4069 obj
= list4 (Qlanguage_change
,
4070 event
->frame_or_window
,
4071 make_number (event
->code
),
4072 make_number (event
->modifiers
));
4073 kbd_fetch_ptr
= event
+ 1;
4076 #ifdef USE_FILE_NOTIFY
4077 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4079 #ifdef HAVE_W32NOTIFY
4080 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4081 obj
= list3 (Qfile_notify
,
4082 list3 (make_number (event
->code
),
4085 event
->frame_or_window
);
4087 obj
= make_lispy_event (event
);
4089 kbd_fetch_ptr
= event
+ 1;
4091 #endif /* USE_FILE_NOTIFY */
4092 else if (event
->kind
== SAVE_SESSION_EVENT
)
4094 obj
= list2 (Qsave_session
, event
->arg
);
4095 kbd_fetch_ptr
= event
+ 1;
4097 /* Just discard these, by returning nil.
4098 With MULTI_KBOARD, these events are used as placeholders
4099 when we need to randomly delete events from the queue.
4100 (They shouldn't otherwise be found in the buffer,
4101 but on some machines it appears they do show up
4102 even without MULTI_KBOARD.) */
4103 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4104 mouse events during a popup-menu call. */
4105 else if (event
->kind
== NO_EVENT
)
4106 kbd_fetch_ptr
= event
+ 1;
4107 else if (event
->kind
== HELP_EVENT
)
4109 Lisp_Object object
, position
, help
, frame
, window
;
4111 frame
= event
->frame_or_window
;
4112 object
= event
->arg
;
4113 position
= make_number (event
->code
);
4116 clear_event (event
);
4118 kbd_fetch_ptr
= event
+ 1;
4119 if (!WINDOWP (window
))
4121 obj
= Fcons (Qhelp_echo
,
4122 list5 (frame
, help
, window
, object
, position
));
4124 else if (event
->kind
== FOCUS_IN_EVENT
)
4126 /* Notification of a FocusIn event. The frame receiving the
4127 focus is in event->frame_or_window. Generate a
4128 switch-frame event if necessary. */
4129 Lisp_Object frame
, focus
;
4131 frame
= event
->frame_or_window
;
4132 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4141 !EQ (frame
, internal_last_event_frame
)
4142 && !EQ (frame
, selected_frame
))
4143 obj
= make_lispy_switch_frame (frame
);
4145 obj
= make_lispy_focus_in (frame
);
4147 internal_last_event_frame
= frame
;
4148 kbd_fetch_ptr
= event
+ 1;
4150 else if (event
->kind
== FOCUS_OUT_EVENT
)
4152 #ifdef HAVE_WINDOW_SYSTEM
4155 Lisp_Object frame
= event
->frame_or_window
;
4156 bool focused
= false;
4158 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4159 focused
= di
->x_highlight_frame
!= 0;
4162 obj
= make_lispy_focus_out (frame
);
4164 #endif /* HAVE_WINDOW_SYSTEM */
4166 kbd_fetch_ptr
= event
+ 1;
4169 else if (event
->kind
== DBUS_EVENT
)
4171 obj
= make_lispy_event (event
);
4172 kbd_fetch_ptr
= event
+ 1;
4175 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4177 obj
= make_lispy_event (event
);
4178 kbd_fetch_ptr
= event
+ 1;
4182 /* If this event is on a different frame, return a switch-frame this
4183 time, and leave the event in the queue for next time. */
4187 frame
= event
->frame_or_window
;
4189 frame
= XCAR (frame
);
4190 else if (WINDOWP (frame
))
4191 frame
= WINDOW_FRAME (XWINDOW (frame
));
4193 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4197 if (! EQ (frame
, internal_last_event_frame
)
4198 && !EQ (frame
, selected_frame
))
4199 obj
= make_lispy_switch_frame (frame
);
4200 internal_last_event_frame
= frame
;
4202 /* If we didn't decide to make a switch-frame event, go ahead
4203 and build a real event from the queue entry. */
4207 obj
= make_lispy_event (event
);
4209 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4210 || defined (HAVE_NS) || defined (USE_GTK)
4211 /* If this was a menu selection, then set the flag to inhibit
4212 writing to last_nonmenu_event. Don't do this if the event
4213 we're returning is (menu-bar), though; that indicates the
4214 beginning of the menu sequence, and we might as well leave
4215 that as the `event with parameters' for this selection. */
4217 && !EQ (event
->frame_or_window
, event
->arg
)
4218 && (event
->kind
== MENU_BAR_EVENT
4219 || event
->kind
== TOOL_BAR_EVENT
))
4220 *used_mouse_menu
= 1;
4223 /* Certain system events are non-key events. */
4225 && event
->kind
== NS_NONKEY_EVENT
)
4226 *used_mouse_menu
= 1;
4229 /* Wipe out this event, to catch bugs. */
4230 clear_event (event
);
4231 kbd_fetch_ptr
= event
+ 1;
4235 /* Try generating a mouse motion event. */
4236 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4238 struct frame
*f
= some_mouse_moved ();
4239 Lisp_Object bar_window
;
4240 enum scroll_bar_part part
;
4244 *kbp
= current_kboard
;
4245 /* Note that this uses F to determine which terminal to look at.
4246 If there is no valid info, it does not store anything
4247 so x remains nil. */
4250 /* XXX Can f or mouse_position_hook be NULL here? */
4251 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4252 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4257 /* Decide if we should generate a switch-frame event. Don't
4258 generate switch-frame events for motion outside of all Emacs
4264 frame
= FRAME_FOCUS_FRAME (f
);
4266 XSETFRAME (frame
, f
);
4268 if (! EQ (frame
, internal_last_event_frame
)
4269 && !EQ (frame
, selected_frame
))
4270 obj
= make_lispy_switch_frame (frame
);
4271 internal_last_event_frame
= frame
;
4274 /* If we didn't decide to make a switch-frame event, go ahead and
4275 return a mouse-motion event. */
4276 if (!NILP (x
) && NILP (obj
))
4277 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4280 /* We were promised by the above while loop that there was
4281 something for us to read! */
4284 input_pending
= readable_events (0);
4286 Vlast_event_frame
= internal_last_event_frame
;
4291 /* Process any non-user-visible events (currently X selection events),
4292 without reading any user-visible events. */
4295 process_special_events (void)
4297 struct input_event
*event
;
4299 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4301 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4304 if (event
== kbd_store_ptr
)
4308 /* If we find a stored X selection request, handle it now. */
4309 if (event
->kind
== SELECTION_REQUEST_EVENT
4310 || event
->kind
== SELECTION_CLEAR_EVENT
)
4314 /* Remove the event from the fifo buffer before processing;
4315 otherwise swallow_events called recursively could see it
4316 and process it again. To do this, we move the events
4317 between kbd_fetch_ptr and EVENT one slot to the right,
4320 struct input_event copy
= *event
;
4321 struct input_event
*beg
4322 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4323 ? kbd_buffer
: kbd_fetch_ptr
;
4326 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4327 else if (event
< beg
)
4329 if (event
> kbd_buffer
)
4330 memmove (kbd_buffer
+ 1, kbd_buffer
,
4331 (event
- kbd_buffer
) * sizeof (struct input_event
));
4332 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4333 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4334 memmove (beg
+ 1, beg
,
4335 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4336 * sizeof (struct input_event
));
4339 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4340 kbd_fetch_ptr
= kbd_buffer
+ 1;
4344 input_pending
= readable_events (0);
4345 x_handle_selection_event (©
);
4347 /* We're getting selection request events, but we don't have
4355 /* Process any events that are not user-visible, run timer events that
4356 are ripe, and return, without reading any user-visible events. */
4359 swallow_events (bool do_display
)
4361 unsigned old_timers_run
;
4363 process_special_events ();
4365 old_timers_run
= timers_run
;
4366 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4368 if (timers_run
!= old_timers_run
&& do_display
)
4369 redisplay_preserve_echo_area (7);
4372 /* Record the start of when Emacs is idle,
4373 for the sake of running idle-time timers. */
4376 timer_start_idle (void)
4378 /* If we are already in the idle state, do nothing. */
4379 if (timespec_valid_p (timer_idleness_start_time
))
4382 timer_idleness_start_time
= current_timespec ();
4383 timer_last_idleness_start_time
= timer_idleness_start_time
;
4385 /* Mark all idle-time timers as once again candidates for running. */
4386 call0 (intern ("internal-timer-start-idle"));
4389 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4392 timer_stop_idle (void)
4394 timer_idleness_start_time
= invalid_timespec ();
4397 /* Resume idle timer from last idle start time. */
4400 timer_resume_idle (void)
4402 if (timespec_valid_p (timer_idleness_start_time
))
4405 timer_idleness_start_time
= timer_last_idleness_start_time
;
4408 /* This is only for debugging. */
4409 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4411 /* List of elisp functions to call, delayed because they were generated in
4412 a context where Elisp could not be safely run (e.g. redisplay, signal,
4413 ...). Each element has the form (FUN . ARGS). */
4414 Lisp_Object pending_funcalls
;
4416 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4418 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4420 Lisp_Object
*vector
;
4422 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4424 vector
= XVECTOR (timer
)->contents
;
4425 if (! NILP (vector
[0]))
4428 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4433 /* Check whether a timer has fired. To prevent larger problems we simply
4434 disregard elements that are not proper timers. Do not make a circular
4435 timer list for the time being.
4437 Returns the time to wait until the next timer fires. If a
4438 timer is triggering now, return zero.
4439 If no timer is active, return -1.
4441 If a timer is ripe, we run it, with quitting turned off.
4442 In that case we return 0 to indicate that a new timer_check_2 call
4445 static struct timespec
4446 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4448 struct timespec nexttime
;
4449 struct timespec now
;
4450 struct timespec idleness_now
;
4451 Lisp_Object chosen_timer
;
4452 struct gcpro gcpro1
;
4454 nexttime
= invalid_timespec ();
4456 chosen_timer
= Qnil
;
4457 GCPRO1 (chosen_timer
);
4459 /* First run the code that was delayed. */
4460 while (CONSP (pending_funcalls
))
4462 Lisp_Object funcall
= XCAR (pending_funcalls
);
4463 pending_funcalls
= XCDR (pending_funcalls
);
4464 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4467 if (CONSP (timers
) || CONSP (idle_timers
))
4469 now
= current_timespec ();
4470 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4471 ? timespec_sub (now
, timer_idleness_start_time
)
4472 : make_timespec (0, 0));
4475 while (CONSP (timers
) || CONSP (idle_timers
))
4477 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4478 struct timespec timer_time
, idle_timer_time
;
4479 struct timespec difference
;
4480 struct timespec timer_difference
= invalid_timespec ();
4481 struct timespec idle_timer_difference
= invalid_timespec ();
4482 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4484 /* Set TIMER and TIMER_DIFFERENCE
4485 based on the next ordinary timer.
4486 TIMER_DIFFERENCE is the distance in time from NOW to when
4487 this timer becomes ripe (negative if it's already ripe).
4488 Skip past invalid timers and timers already handled. */
4491 timer
= XCAR (timers
);
4492 if (! decode_timer (timer
, &timer_time
))
4494 timers
= XCDR (timers
);
4498 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4499 timer_difference
= (timer_ripe
4500 ? timespec_sub (now
, timer_time
)
4501 : timespec_sub (timer_time
, now
));
4504 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4505 based on the next idle timer. */
4506 if (CONSP (idle_timers
))
4508 idle_timer
= XCAR (idle_timers
);
4509 if (! decode_timer (idle_timer
, &idle_timer_time
))
4511 idle_timers
= XCDR (idle_timers
);
4515 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4516 idle_timer_difference
4518 ? timespec_sub (idleness_now
, idle_timer_time
)
4519 : timespec_sub (idle_timer_time
, idleness_now
));
4522 /* Decide which timer is the next timer,
4523 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4524 Also step down the list where we found that timer. */
4526 if (timespec_valid_p (timer_difference
)
4527 && (! timespec_valid_p (idle_timer_difference
)
4528 || idle_timer_ripe
< timer_ripe
4529 || (idle_timer_ripe
== timer_ripe
4531 ? timespec_cmp (idle_timer_difference
,
4533 : timespec_cmp (timer_difference
,
4534 idle_timer_difference
))
4537 chosen_timer
= timer
;
4538 timers
= XCDR (timers
);
4539 difference
= timer_difference
;
4544 chosen_timer
= idle_timer
;
4545 idle_timers
= XCDR (idle_timers
);
4546 difference
= idle_timer_difference
;
4547 ripe
= idle_timer_ripe
;
4550 /* If timer is ripe, run it if it hasn't been run. */
4553 if (NILP (AREF (chosen_timer
, 0)))
4555 ptrdiff_t count
= SPECPDL_INDEX ();
4556 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4558 /* Mark the timer as triggered to prevent problems if the lisp
4559 code fails to reschedule it right. */
4560 ASET (chosen_timer
, 0, Qt
);
4562 specbind (Qinhibit_quit
, Qt
);
4564 call1 (Qtimer_event_handler
, chosen_timer
);
4565 Vdeactivate_mark
= old_deactivate_mark
;
4567 unbind_to (count
, Qnil
);
4569 /* Since we have handled the event,
4570 we don't need to tell the caller to wake up and do it. */
4571 /* But the caller must still wait for the next timer, so
4572 return 0 to indicate that. */
4575 nexttime
= make_timespec (0, 0);
4579 /* When we encounter a timer that is still waiting,
4580 return the amount of time to wait before it is ripe. */
4587 /* No timers are pending in the future. */
4588 /* Return 0 if we generated an event, and -1 if not. */
4594 /* Check whether a timer has fired. To prevent larger problems we simply
4595 disregard elements that are not proper timers. Do not make a circular
4596 timer list for the time being.
4598 Returns the time to wait until the next timer fires.
4599 If no timer is active, return an invalid value.
4601 As long as any timer is ripe, we run it. */
4606 struct timespec nexttime
;
4607 Lisp_Object timers
, idle_timers
;
4608 struct gcpro gcpro1
, gcpro2
;
4610 Lisp_Object tem
= Vinhibit_quit
;
4613 /* We use copies of the timers' lists to allow a timer to add itself
4614 again, without locking up Emacs if the newly added timer is
4615 already ripe when added. */
4617 /* Always consider the ordinary timers. */
4618 timers
= Fcopy_sequence (Vtimer_list
);
4619 /* Consider the idle timers only if Emacs is idle. */
4620 if (timespec_valid_p (timer_idleness_start_time
))
4621 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4625 Vinhibit_quit
= tem
;
4627 GCPRO2 (timers
, idle_timers
);
4631 nexttime
= timer_check_2 (timers
, idle_timers
);
4633 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4639 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4640 doc
: /* Return the current length of Emacs idleness, or nil.
4641 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4642 in the same style as (current-time).
4644 The value when Emacs is not idle is nil.
4646 PSEC is a multiple of the system clock resolution. */)
4649 if (timespec_valid_p (timer_idleness_start_time
))
4650 return make_lisp_time (timespec_sub (current_timespec (),
4651 timer_idleness_start_time
));
4656 /* Caches for modify_event_symbol. */
4657 static Lisp_Object accent_key_syms
;
4658 static Lisp_Object func_key_syms
;
4659 static Lisp_Object mouse_syms
;
4660 static Lisp_Object wheel_syms
;
4661 static Lisp_Object drag_n_drop_syms
;
4663 /* This is a list of keysym codes for special "accent" characters.
4664 It parallels lispy_accent_keys. */
4666 static const int lispy_accent_codes
[] =
4668 #ifdef XK_dead_circumflex
4673 #ifdef XK_dead_grave
4678 #ifdef XK_dead_tilde
4683 #ifdef XK_dead_diaeresis
4688 #ifdef XK_dead_macron
4693 #ifdef XK_dead_degree
4698 #ifdef XK_dead_acute
4703 #ifdef XK_dead_cedilla
4708 #ifdef XK_dead_breve
4713 #ifdef XK_dead_ogonek
4718 #ifdef XK_dead_caron
4723 #ifdef XK_dead_doubleacute
4724 XK_dead_doubleacute
,
4728 #ifdef XK_dead_abovedot
4733 #ifdef XK_dead_abovering
4743 #ifdef XK_dead_belowdot
4748 #ifdef XK_dead_voiced_sound
4749 XK_dead_voiced_sound
,
4753 #ifdef XK_dead_semivoiced_sound
4754 XK_dead_semivoiced_sound
,
4770 /* This is a list of Lisp names for special "accent" characters.
4771 It parallels lispy_accent_codes. */
4773 static const char *const lispy_accent_keys
[] =
4791 "dead-voiced-sound",
4792 "dead-semivoiced-sound",
4798 #define FUNCTION_KEY_OFFSET 0x0
4800 const char *const lispy_function_keys
[] =
4804 0, /* VK_LBUTTON 0x01 */
4805 0, /* VK_RBUTTON 0x02 */
4806 "cancel", /* VK_CANCEL 0x03 */
4807 0, /* VK_MBUTTON 0x04 */
4809 0, 0, 0, /* 0x05 .. 0x07 */
4811 "backspace", /* VK_BACK 0x08 */
4812 "tab", /* VK_TAB 0x09 */
4814 0, 0, /* 0x0A .. 0x0B */
4816 "clear", /* VK_CLEAR 0x0C */
4817 "return", /* VK_RETURN 0x0D */
4819 0, 0, /* 0x0E .. 0x0F */
4821 0, /* VK_SHIFT 0x10 */
4822 0, /* VK_CONTROL 0x11 */
4823 0, /* VK_MENU 0x12 */
4824 "pause", /* VK_PAUSE 0x13 */
4825 "capslock", /* VK_CAPITAL 0x14 */
4826 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4828 "junja", /* VK_JUNJA 0x17 */
4829 "final", /* VK_FINAL 0x18 */
4830 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4832 "escape", /* VK_ESCAPE 0x1B */
4833 "convert", /* VK_CONVERT 0x1C */
4834 "non-convert", /* VK_NONCONVERT 0x1D */
4835 "accept", /* VK_ACCEPT 0x1E */
4836 "mode-change", /* VK_MODECHANGE 0x1F */
4837 0, /* VK_SPACE 0x20 */
4838 "prior", /* VK_PRIOR 0x21 */
4839 "next", /* VK_NEXT 0x22 */
4840 "end", /* VK_END 0x23 */
4841 "home", /* VK_HOME 0x24 */
4842 "left", /* VK_LEFT 0x25 */
4843 "up", /* VK_UP 0x26 */
4844 "right", /* VK_RIGHT 0x27 */
4845 "down", /* VK_DOWN 0x28 */
4846 "select", /* VK_SELECT 0x29 */
4847 "print", /* VK_PRINT 0x2A */
4848 "execute", /* VK_EXECUTE 0x2B */
4849 "snapshot", /* VK_SNAPSHOT 0x2C */
4850 "insert", /* VK_INSERT 0x2D */
4851 "delete", /* VK_DELETE 0x2E */
4852 "help", /* VK_HELP 0x2F */
4854 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4856 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4858 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4860 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4862 0, 0, 0, 0, 0, 0, 0, 0, 0,
4863 0, 0, 0, 0, 0, 0, 0, 0, 0,
4864 0, 0, 0, 0, 0, 0, 0, 0,
4866 "lwindow", /* VK_LWIN 0x5B */
4867 "rwindow", /* VK_RWIN 0x5C */
4868 "apps", /* VK_APPS 0x5D */
4871 "kp-0", /* VK_NUMPAD0 0x60 */
4872 "kp-1", /* VK_NUMPAD1 0x61 */
4873 "kp-2", /* VK_NUMPAD2 0x62 */
4874 "kp-3", /* VK_NUMPAD3 0x63 */
4875 "kp-4", /* VK_NUMPAD4 0x64 */
4876 "kp-5", /* VK_NUMPAD5 0x65 */
4877 "kp-6", /* VK_NUMPAD6 0x66 */
4878 "kp-7", /* VK_NUMPAD7 0x67 */
4879 "kp-8", /* VK_NUMPAD8 0x68 */
4880 "kp-9", /* VK_NUMPAD9 0x69 */
4881 "kp-multiply", /* VK_MULTIPLY 0x6A */
4882 "kp-add", /* VK_ADD 0x6B */
4883 "kp-separator", /* VK_SEPARATOR 0x6C */
4884 "kp-subtract", /* VK_SUBTRACT 0x6D */
4885 "kp-decimal", /* VK_DECIMAL 0x6E */
4886 "kp-divide", /* VK_DIVIDE 0x6F */
4887 "f1", /* VK_F1 0x70 */
4888 "f2", /* VK_F2 0x71 */
4889 "f3", /* VK_F3 0x72 */
4890 "f4", /* VK_F4 0x73 */
4891 "f5", /* VK_F5 0x74 */
4892 "f6", /* VK_F6 0x75 */
4893 "f7", /* VK_F7 0x76 */
4894 "f8", /* VK_F8 0x77 */
4895 "f9", /* VK_F9 0x78 */
4896 "f10", /* VK_F10 0x79 */
4897 "f11", /* VK_F11 0x7A */
4898 "f12", /* VK_F12 0x7B */
4899 "f13", /* VK_F13 0x7C */
4900 "f14", /* VK_F14 0x7D */
4901 "f15", /* VK_F15 0x7E */
4902 "f16", /* VK_F16 0x7F */
4903 "f17", /* VK_F17 0x80 */
4904 "f18", /* VK_F18 0x81 */
4905 "f19", /* VK_F19 0x82 */
4906 "f20", /* VK_F20 0x83 */
4907 "f21", /* VK_F21 0x84 */
4908 "f22", /* VK_F22 0x85 */
4909 "f23", /* VK_F23 0x86 */
4910 "f24", /* VK_F24 0x87 */
4912 0, 0, 0, 0, /* 0x88 .. 0x8B */
4913 0, 0, 0, 0, /* 0x8C .. 0x8F */
4915 "kp-numlock", /* VK_NUMLOCK 0x90 */
4916 "scroll", /* VK_SCROLL 0x91 */
4917 /* Not sure where the following block comes from.
4918 Windows headers have NEC and Fujitsu specific keys in
4919 this block, but nothing generic. */
4920 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4921 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4922 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4923 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4924 "kp-end", /* VK_NUMPAD_END 0x96 */
4925 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4926 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4927 "kp-up", /* VK_NUMPAD_UP 0x99 */
4928 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4929 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4930 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4931 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4933 0, 0, /* 0x9E .. 0x9F */
4936 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4937 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4938 * No other API or message will distinguish left and right keys this way.
4943 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4944 to enable them selectively, and gives access to a few more functions.
4945 See lispy_multimedia_keys below. */
4946 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4947 0, 0, 0, /* 0xAD .. 0xAF Volume */
4948 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4949 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4951 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4952 0, 0, 0, 0, 0, 0, 0, 0, 0,
4954 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4955 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4956 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4959 "ax", /* VK_OEM_AX 0xE1 */
4960 0, /* VK_OEM_102 0xE2 */
4961 "ico-help", /* VK_ICO_HELP 0xE3 */
4962 "ico-00", /* VK_ICO_00 0xE4 */
4963 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4964 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4965 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4967 "reset", /* VK_OEM_RESET 0xE9 */
4968 "jump", /* VK_OEM_JUMP 0xEA */
4969 "oem-pa1", /* VK_OEM_PA1 0xEB */
4970 "oem-pa2", /* VK_OEM_PA2 0xEC */
4971 "oem-pa3", /* VK_OEM_PA3 0xED */
4972 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4973 "cusel", /* VK_OEM_CUSEL 0xEF */
4974 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4975 "finish", /* VK_OEM_FINISH 0xF1 */
4976 "copy", /* VK_OEM_COPY 0xF2 */
4977 "auto", /* VK_OEM_AUTO 0xF3 */
4978 "enlw", /* VK_OEM_ENLW 0xF4 */
4979 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4980 "attn", /* VK_ATTN 0xF6 */
4981 "crsel", /* VK_CRSEL 0xF7 */
4982 "exsel", /* VK_EXSEL 0xF8 */
4983 "ereof", /* VK_EREOF 0xF9 */
4984 "play", /* VK_PLAY 0xFA */
4985 "zoom", /* VK_ZOOM 0xFB */
4986 "noname", /* VK_NONAME 0xFC */
4987 "pa1", /* VK_PA1 0xFD */
4988 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4992 /* Some of these duplicate the "Media keys" on newer keyboards,
4993 but they are delivered to the application in a different way. */
4994 static const char *const lispy_multimedia_keys
[] =
5002 "browser-favorites",
5039 "toggle-dictate-command",
5045 "media-fast-forward",
5048 "media-channel-down"
5051 #else /* not HAVE_NTGUI */
5053 /* This should be dealt with in XTread_socket now, and that doesn't
5054 depend on the client system having the Kana syms defined. See also
5055 the XK_kana_A case below. */
5058 static const char *const lispy_kana_keys
[] =
5060 /* X Keysym value */
5061 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5062 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5063 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5064 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5065 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5066 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5069 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5070 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5071 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5072 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5073 "kana-i", "kana-u", "kana-e", "kana-o",
5074 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5075 "prolongedsound", "kana-A", "kana-I", "kana-U",
5076 "kana-E", "kana-O", "kana-KA", "kana-KI",
5077 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5078 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5079 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5080 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5081 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5082 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5083 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5084 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5085 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5086 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5087 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5088 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5090 #endif /* XK_kana_A */
5093 #define FUNCTION_KEY_OFFSET 0xff00
5095 /* You'll notice that this table is arranged to be conveniently
5096 indexed by X Windows keysym values. */
5097 static const char *const lispy_function_keys
[] =
5099 /* X Keysym value */
5101 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5102 "backspace", "tab", "linefeed", "clear",
5104 0, 0, 0, "pause", /* 0xff10...1f */
5105 0, 0, 0, 0, 0, 0, 0, "escape",
5107 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5108 "romaji", "hiragana", "katakana", "hiragana-katakana",
5109 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5110 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5111 "eisu-toggle", /* 0xff30...3f */
5112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5113 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5115 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5116 "down", "prior", "next", "end",
5117 "begin", 0, 0, 0, 0, 0, 0, 0,
5118 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5129 "break", /* 0xff6b */
5132 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5133 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5134 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5135 0, 0, 0, 0, 0, 0, 0, 0,
5136 "kp-tab", /* 0xff89 */
5138 "kp-enter", /* 0xff8d */
5140 "kp-f1", /* 0xff91 */
5144 "kp-home", /* 0xff95 */
5149 "kp-prior", /* kp-page-up */
5150 "kp-next", /* kp-page-down */
5156 0, 0, 0, 0, 0, 0, 0, 0, 0,
5157 "kp-multiply", /* 0xffaa */
5162 "kp-divide", /* 0xffaf */
5163 "kp-0", /* 0xffb0 */
5164 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5167 "kp-equal", /* 0xffbd */
5168 "f1", /* 0xffbe */ /* IsFunctionKey */
5170 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5171 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5172 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5173 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5174 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5175 0, 0, 0, 0, 0, 0, 0, 0,
5176 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5177 0, 0, 0, 0, 0, 0, 0, "delete"
5180 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5181 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5183 static const char *const iso_lispy_function_keys
[] =
5185 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5186 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5187 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5188 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5189 "iso-lefttab", /* 0xfe20 */
5190 "iso-move-line-up", "iso-move-line-down",
5191 "iso-partial-line-up", "iso-partial-line-down",
5192 "iso-partial-space-left", "iso-partial-space-right",
5193 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5194 "iso-release-margin-left", "iso-release-margin-right",
5195 "iso-release-both-margins",
5196 "iso-fast-cursor-left", "iso-fast-cursor-right",
5197 "iso-fast-cursor-up", "iso-fast-cursor-down",
5198 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5199 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5202 #endif /* not HAVE_NTGUI */
5204 static Lisp_Object Vlispy_mouse_stem
;
5206 static const char *const lispy_wheel_names
[] =
5208 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5211 /* drag-n-drop events are generated when a set of selected files are
5212 dragged from another application and dropped onto an Emacs window. */
5213 static const char *const lispy_drag_n_drop_names
[] =
5218 /* Scroll bar parts. */
5219 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5220 Lisp_Object Qup
, Qdown
, Qbottom
;
5221 static Lisp_Object Qend_scroll
;
5223 static Lisp_Object Qratio
;
5225 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5226 static Lisp_Object
*const scroll_bar_parts
[] = {
5227 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5228 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5231 /* A vector, indexed by button number, giving the down-going location
5232 of currently depressed buttons, both scroll bar and non-scroll bar.
5234 The elements have the form
5235 (BUTTON-NUMBER MODIFIER-MASK . REST)
5236 where REST is the cdr of a position as it would be reported in the event.
5238 The make_lispy_event function stores positions here to tell the
5239 difference between click and drag events, and to store the starting
5240 location to be included in drag events. */
5242 static Lisp_Object button_down_location
;
5244 /* Information about the most recent up-going button event: Which
5245 button, what location, and what time. */
5247 static int last_mouse_button
;
5248 static int last_mouse_x
;
5249 static int last_mouse_y
;
5250 static Time button_down_time
;
5252 /* The number of clicks in this multiple-click. */
5254 static int double_click_count
;
5256 /* X and Y are frame-relative coordinates for a click or wheel event.
5257 Return a Lisp-style event list. */
5260 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5263 enum window_part part
;
5264 Lisp_Object posn
= Qnil
;
5265 Lisp_Object extra_info
= Qnil
;
5266 /* Coordinate pixel positions to return. */
5267 int xret
= 0, yret
= 0;
5268 /* The window under frame pixel coordinates (x,y) */
5269 Lisp_Object window
= f
5270 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5273 if (WINDOWP (window
))
5275 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5276 struct window
*w
= XWINDOW (window
);
5277 Lisp_Object string_info
= Qnil
;
5278 ptrdiff_t textpos
= 0;
5279 int col
= -1, row
= -1;
5280 int dx
= -1, dy
= -1;
5281 int width
= -1, height
= -1;
5282 Lisp_Object object
= Qnil
;
5284 /* Pixel coordinates relative to the window corner. */
5285 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5286 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5288 /* For text area clicks, return X, Y relative to the corner of
5289 this text area. Note that dX, dY etc are set below, by
5290 buffer_posn_from_coords. */
5291 if (part
== ON_TEXT
)
5293 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5294 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5296 /* For mode line and header line clicks, return X, Y relative to
5297 the left window edge. Use mode_line_string to look for a
5298 string on the click position. */
5299 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5304 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5305 /* Note that mode_line_string takes COL, ROW as pixels and
5306 converts them to characters. */
5309 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5310 &object
, &dx
, &dy
, &width
, &height
);
5311 if (STRINGP (string
))
5312 string_info
= Fcons (string
, make_number (charpos
));
5318 /* For fringes and margins, Y is relative to the area's (and the
5319 window's) top edge, while X is meaningless. */
5320 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5325 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5328 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5329 &object
, &dx
, &dy
, &width
, &height
);
5330 if (STRINGP (string
))
5331 string_info
= Fcons (string
, make_number (charpos
));
5332 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5334 else if (part
== ON_LEFT_FRINGE
)
5336 posn
= Qleft_fringe
;
5339 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5340 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5341 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5343 else if (part
== ON_RIGHT_FRINGE
)
5345 posn
= Qright_fringe
;
5348 - window_box_width (w
, LEFT_MARGIN_AREA
)
5349 - window_box_width (w
, TEXT_AREA
)
5350 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5351 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5353 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5355 else if (part
== ON_VERTICAL_BORDER
)
5357 posn
= Qvertical_line
;
5362 /* Nothing special for part == ON_SCROLL_BAR. */
5363 else if (part
== ON_RIGHT_DIVIDER
)
5365 posn
= Qright_divider
;
5366 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5370 else if (part
== ON_BOTTOM_DIVIDER
)
5372 posn
= Qbottom_divider
;
5373 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5378 /* For clicks in the text area, fringes, or margins, call
5379 buffer_posn_from_coords to extract TEXTPOS, the buffer
5380 position nearest to the click. */
5383 Lisp_Object string2
, object2
= Qnil
;
5384 struct display_pos p
;
5386 int width2
, height2
;
5387 /* The pixel X coordinate passed to buffer_posn_from_coords
5388 is the X coordinate relative to the text area for
5389 text-area and right-margin clicks, zero otherwise. */
5391 = (part
== ON_TEXT
) ? xret
5392 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5393 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5397 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5398 &object2
, &dx2
, &dy2
,
5400 textpos
= CHARPOS (p
.pos
);
5401 if (col
< 0) col
= x2
;
5402 if (row
< 0) row
= y2
;
5403 if (dx
< 0) dx
= dx2
;
5404 if (dy
< 0) dy
= dy2
;
5405 if (width
< 0) width
= width2
;
5406 if (height
< 0) height
= height2
;
5410 posn
= make_number (textpos
);
5411 if (STRINGP (string2
))
5412 string_info
= Fcons (string2
,
5413 make_number (CHARPOS (p
.string_pos
)));
5419 #ifdef HAVE_WINDOW_SYSTEM
5420 if (IMAGEP (object
))
5422 Lisp_Object image_map
, hotspot
;
5423 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5425 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5427 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5428 posn
= XCAR (hotspot
);
5435 Fcons (make_number (dx
), make_number (dy
)),
5436 Fcons (make_number (width
), make_number (height
)));
5439 extra_info
= Fcons (string_info
,
5440 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5441 Fcons (Fcons (make_number (col
),
5446 XSETFRAME (window
, f
);
5450 return Fcons (window
,
5452 Fcons (Fcons (make_number (xret
),
5453 make_number (yret
)),
5454 Fcons (make_number (t
),
5458 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5459 menu bar. This really means that Emacs draws and manages the menu
5460 bar as part of its normal display, and therefore can compute its
5463 toolkit_menubar_in_use (struct frame
*f
)
5465 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5466 return !(!FRAME_WINDOW_P (f
));
5472 /* Given a struct input_event, build the lisp event which represents
5473 it. If EVENT is 0, build a mouse movement event from the mouse
5474 movement buffer, which should have a movement event in it.
5476 Note that events must be passed to this function in the order they
5477 are received; this function stores the location of button presses
5478 in order to build drag events when the button is released. */
5481 make_lispy_event (struct input_event
*event
)
5485 switch (event
->kind
)
5487 /* A simple keystroke. */
5488 case ASCII_KEYSTROKE_EVENT
:
5489 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5491 Lisp_Object lispy_c
;
5492 EMACS_INT c
= event
->code
;
5493 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5496 eassert (c
== event
->code
);
5497 /* Turn ASCII characters into control characters
5499 if (event
->modifiers
& ctrl_modifier
)
5501 c
= make_ctrl_char (c
);
5502 event
->modifiers
&= ~ctrl_modifier
;
5506 /* Add in the other modifier bits. The shift key was taken care
5507 of by the X code. */
5508 c
|= (event
->modifiers
5509 & (meta_modifier
| alt_modifier
5510 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5511 /* Distinguish Shift-SPC from SPC. */
5512 if ((event
->code
) == 040
5513 && event
->modifiers
& shift_modifier
)
5514 c
|= shift_modifier
;
5515 button_down_time
= 0;
5516 XSETFASTINT (lispy_c
, c
);
5521 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5522 except that they are non-key events (last-nonmenu-event is nil). */
5523 case NS_NONKEY_EVENT
:
5526 /* A function key. The symbol may need to have modifier prefixes
5528 case NON_ASCII_KEYSTROKE_EVENT
:
5529 button_down_time
= 0;
5531 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5532 if (event
->code
== lispy_accent_codes
[i
])
5533 return modify_event_symbol (i
,
5535 Qfunction_key
, Qnil
,
5536 lispy_accent_keys
, &accent_key_syms
,
5537 ARRAYELTS (lispy_accent_keys
));
5541 if (event
->code
>= 0x400 && event
->code
< 0x500)
5542 return modify_event_symbol (event
->code
- 0x400,
5543 event
->modifiers
& ~shift_modifier
,
5544 Qfunction_key
, Qnil
,
5545 lispy_kana_keys
, &func_key_syms
,
5546 ARRAYELTS (lispy_kana_keys
));
5547 #endif /* XK_kana_A */
5550 #ifdef ISO_FUNCTION_KEY_OFFSET
5551 if (event
->code
< FUNCTION_KEY_OFFSET
5552 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5553 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5555 Qfunction_key
, Qnil
,
5556 iso_lispy_function_keys
, &func_key_syms
,
5557 ARRAYELTS (iso_lispy_function_keys
));
5560 /* Handle system-specific or unknown keysyms. */
5561 if (event
->code
& (1 << 28)
5562 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5563 || (event
->code
- FUNCTION_KEY_OFFSET
5564 >= ARRAYELTS (lispy_function_keys
))
5565 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5567 /* We need to use an alist rather than a vector as the cache
5568 since we can't make a vector long enough. */
5569 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5570 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5571 return modify_event_symbol (event
->code
,
5574 KVAR (current_kboard
, Vsystem_key_alist
),
5575 0, &KVAR (current_kboard
, system_key_syms
),
5579 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5581 Qfunction_key
, Qnil
,
5582 lispy_function_keys
, &func_key_syms
,
5583 ARRAYELTS (lispy_function_keys
));
5586 case MULTIMEDIA_KEY_EVENT
:
5587 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5588 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5590 return modify_event_symbol (event
->code
, event
->modifiers
,
5591 Qfunction_key
, Qnil
,
5592 lispy_multimedia_keys
, &func_key_syms
,
5593 ARRAYELTS (lispy_multimedia_keys
));
5598 /* A mouse click. Figure out where it is, decide whether it's
5599 a press, click or drag, and build the appropriate structure. */
5600 case MOUSE_CLICK_EVENT
:
5602 case GPM_CLICK_EVENT
:
5604 #ifndef USE_TOOLKIT_SCROLL_BARS
5605 case SCROLL_BAR_CLICK_EVENT
:
5608 int button
= event
->code
;
5610 Lisp_Object position
;
5611 Lisp_Object
*start_pos_ptr
;
5612 Lisp_Object start_pos
;
5616 /* Build the position as appropriate for this mouse click. */
5617 if (event
->kind
== MOUSE_CLICK_EVENT
5619 || event
->kind
== GPM_CLICK_EVENT
5623 struct frame
*f
= XFRAME (event
->frame_or_window
);
5626 /* Ignore mouse events that were made on frame that
5627 have been deleted. */
5628 if (! FRAME_LIVE_P (f
))
5631 /* EVENT->x and EVENT->y are frame-relative pixel
5632 coordinates at this place. Under old redisplay, COLUMN
5633 and ROW are set to frame relative glyph coordinates
5634 which are then used to determine whether this click is
5635 in a menu (non-toolkit version). */
5636 if (!toolkit_menubar_in_use (f
))
5638 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5639 &column
, &row
, NULL
, 1);
5641 /* In the non-toolkit version, clicks on the menu bar
5642 are ordinary button events in the event buffer.
5643 Distinguish them, and invoke the menu.
5645 (In the toolkit version, the toolkit handles the
5646 menu bar and Emacs doesn't know about it until
5647 after the user makes a selection.) */
5648 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5649 && (event
->modifiers
& down_modifier
))
5651 Lisp_Object items
, item
;
5653 /* Find the menu bar item under `column'. */
5655 items
= FRAME_MENU_BAR_ITEMS (f
);
5656 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5658 Lisp_Object pos
, string
;
5659 string
= AREF (items
, i
+ 1);
5660 pos
= AREF (items
, i
+ 3);
5663 if (column
>= XINT (pos
)
5664 && column
< XINT (pos
) + SCHARS (string
))
5666 item
= AREF (items
, i
);
5671 /* ELisp manual 2.4b says (x y) are window
5672 relative but code says they are
5674 position
= list4 (event
->frame_or_window
,
5676 Fcons (event
->x
, event
->y
),
5677 make_number (event
->timestamp
));
5679 return list2 (item
, position
);
5683 position
= make_lispy_position (f
, event
->x
, event
->y
,
5686 #ifndef USE_TOOLKIT_SCROLL_BARS
5689 /* It's a scrollbar click. */
5691 Lisp_Object portion_whole
;
5694 window
= event
->frame_or_window
;
5695 portion_whole
= Fcons (event
->x
, event
->y
);
5696 part
= *scroll_bar_parts
[(int) event
->part
];
5698 position
= list5 (window
, Qvertical_scroll_bar
,
5699 portion_whole
, make_number (event
->timestamp
),
5702 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5704 if (button
>= ASIZE (button_down_location
))
5706 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5707 button_down_location
= larger_vector (button_down_location
,
5709 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5712 start_pos_ptr
= aref_addr (button_down_location
, button
);
5713 start_pos
= *start_pos_ptr
;
5714 *start_pos_ptr
= Qnil
;
5717 /* On window-system frames, use the value of
5718 double-click-fuzz as is. On other frames, interpret it
5719 as a multiple of 1/8 characters. */
5723 if (WINDOWP (event
->frame_or_window
))
5724 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5725 else if (FRAMEP (event
->frame_or_window
))
5726 f
= XFRAME (event
->frame_or_window
);
5730 if (FRAME_WINDOW_P (f
))
5731 fuzz
= double_click_fuzz
;
5733 fuzz
= double_click_fuzz
/ 8;
5735 is_double
= (button
== last_mouse_button
5736 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5737 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5738 && button_down_time
!= 0
5739 && (EQ (Vdouble_click_time
, Qt
)
5740 || (NATNUMP (Vdouble_click_time
)
5741 && (event
->timestamp
- button_down_time
5742 < XFASTINT (Vdouble_click_time
)))));
5745 last_mouse_button
= button
;
5746 last_mouse_x
= XINT (event
->x
);
5747 last_mouse_y
= XINT (event
->y
);
5749 /* If this is a button press, squirrel away the location, so
5750 we can decide later whether it was a click or a drag. */
5751 if (event
->modifiers
& down_modifier
)
5755 double_click_count
++;
5756 event
->modifiers
|= ((double_click_count
> 2)
5761 double_click_count
= 1;
5762 button_down_time
= event
->timestamp
;
5763 *start_pos_ptr
= Fcopy_alist (position
);
5764 ignore_mouse_drag_p
= 0;
5767 /* Now we're releasing a button - check the co-ordinates to
5768 see if this was a click or a drag. */
5769 else if (event
->modifiers
& up_modifier
)
5771 /* If we did not see a down before this up, ignore the up.
5772 Probably this happened because the down event chose a
5773 menu item. It would be an annoyance to treat the
5774 release of the button that chose the menu item as a
5777 if (!CONSP (start_pos
))
5780 event
->modifiers
&= ~up_modifier
;
5783 Lisp_Object new_down
, down
;
5784 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5786 /* The third element of every position
5787 should be the (x,y) pair. */
5788 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5789 new_down
= Fcar (Fcdr (Fcdr (position
)));
5792 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5794 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5795 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5798 if (ignore_mouse_drag_p
)
5800 event
->modifiers
|= click_modifier
;
5801 ignore_mouse_drag_p
= 0;
5803 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5804 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5805 /* Maybe the mouse has moved a lot, caused scrolling, and
5806 eventually ended up at the same screen position (but
5807 not buffer position) in which case it is a drag, not
5809 /* FIXME: OTOH if the buffer position has changed
5810 because of a timer or process filter rather than
5811 because of mouse movement, it should be considered as
5812 a click. But mouse-drag-region completely ignores
5813 this case and it hasn't caused any real problem, so
5814 it's probably OK to ignore it as well. */
5815 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5816 /* Mouse hasn't moved (much). */
5817 event
->modifiers
|= click_modifier
;
5820 button_down_time
= 0;
5821 event
->modifiers
|= drag_modifier
;
5824 /* Don't check is_double; treat this as multiple
5825 if the down-event was multiple. */
5826 if (double_click_count
> 1)
5827 event
->modifiers
|= ((double_click_count
> 2)
5833 /* Every mouse event should either have the down_modifier or
5834 the up_modifier set. */
5838 /* Get the symbol we should use for the mouse click. */
5841 head
= modify_event_symbol (button
,
5843 Qmouse_click
, Vlispy_mouse_stem
,
5846 ASIZE (mouse_syms
));
5847 if (event
->modifiers
& drag_modifier
)
5848 return list3 (head
, start_pos
, position
);
5849 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5850 return list3 (head
, position
, make_number (double_click_count
));
5852 return list2 (head
, position
);
5857 case HORIZ_WHEEL_EVENT
:
5859 Lisp_Object position
;
5862 /* Build the position as appropriate for this mouse click. */
5863 struct frame
*f
= XFRAME (event
->frame_or_window
);
5865 /* Ignore wheel events that were made on frame that have been
5867 if (! FRAME_LIVE_P (f
))
5870 position
= make_lispy_position (f
, event
->x
, event
->y
,
5873 /* Set double or triple modifiers to indicate the wheel speed. */
5875 /* On window-system frames, use the value of
5876 double-click-fuzz as is. On other frames, interpret it
5877 as a multiple of 1/8 characters. */
5883 if (WINDOWP (event
->frame_or_window
))
5884 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5885 else if (FRAMEP (event
->frame_or_window
))
5886 fr
= XFRAME (event
->frame_or_window
);
5890 fuzz
= FRAME_WINDOW_P (fr
)
5891 ? double_click_fuzz
: double_click_fuzz
/ 8;
5893 if (event
->modifiers
& up_modifier
)
5895 /* Emit a wheel-up event. */
5896 event
->modifiers
&= ~up_modifier
;
5899 else if (event
->modifiers
& down_modifier
)
5901 /* Emit a wheel-down event. */
5902 event
->modifiers
&= ~down_modifier
;
5906 /* Every wheel event should either have the down_modifier or
5907 the up_modifier set. */
5910 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5913 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5914 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5915 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5916 && button_down_time
!= 0
5917 && (EQ (Vdouble_click_time
, Qt
)
5918 || (NATNUMP (Vdouble_click_time
)
5919 && (event
->timestamp
- button_down_time
5920 < XFASTINT (Vdouble_click_time
)))));
5923 double_click_count
++;
5924 event
->modifiers
|= ((double_click_count
> 2)
5930 double_click_count
= 1;
5931 event
->modifiers
|= click_modifier
;
5934 button_down_time
= event
->timestamp
;
5935 /* Use a negative value to distinguish wheel from mouse button. */
5936 last_mouse_button
= - (1 + symbol_num
);
5937 last_mouse_x
= XINT (event
->x
);
5938 last_mouse_y
= XINT (event
->y
);
5940 /* Get the symbol we should use for the wheel event. */
5941 head
= modify_event_symbol (symbol_num
,
5947 ASIZE (wheel_syms
));
5950 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5951 return list3 (head
, position
, make_number (double_click_count
));
5953 return list2 (head
, position
);
5957 #ifdef USE_TOOLKIT_SCROLL_BARS
5959 /* We don't have down and up events if using toolkit scroll bars,
5960 so make this always a click event. Store in the `part' of
5961 the Lisp event a symbol which maps to the following actions:
5963 `above_handle' page up
5964 `below_handle' page down
5968 `bottom' bottom of buffer
5969 `handle' thumb has been dragged.
5970 `end-scroll' end of interaction with scroll bar
5972 The incoming input_event contains in its `part' member an
5973 index of type `enum scroll_bar_part' which we can use as an
5974 index in scroll_bar_parts to get the appropriate symbol. */
5976 case SCROLL_BAR_CLICK_EVENT
:
5978 Lisp_Object position
, head
, window
, portion_whole
, part
;
5980 window
= event
->frame_or_window
;
5981 portion_whole
= Fcons (event
->x
, event
->y
);
5982 part
= *scroll_bar_parts
[(int) event
->part
];
5984 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5985 make_number (event
->timestamp
), part
);
5987 /* Always treat scroll bar events as clicks. */
5988 event
->modifiers
|= click_modifier
;
5989 event
->modifiers
&= ~up_modifier
;
5991 if (event
->code
>= ASIZE (mouse_syms
))
5992 mouse_syms
= larger_vector (mouse_syms
,
5993 event
->code
- ASIZE (mouse_syms
) + 1,
5996 /* Get the symbol we should use for the mouse click. */
5997 head
= modify_event_symbol (event
->code
,
6002 ASIZE (mouse_syms
));
6003 return list2 (head
, position
);
6006 #endif /* USE_TOOLKIT_SCROLL_BARS */
6008 case DRAG_N_DROP_EVENT
:
6011 Lisp_Object head
, position
;
6014 f
= XFRAME (event
->frame_or_window
);
6017 /* Ignore mouse events that were made on frames that
6018 have been deleted. */
6019 if (! FRAME_LIVE_P (f
))
6022 position
= make_lispy_position (f
, event
->x
, event
->y
,
6025 head
= modify_event_symbol (0, event
->modifiers
,
6027 lispy_drag_n_drop_names
,
6028 &drag_n_drop_syms
, 1);
6029 return list3 (head
, position
, files
);
6032 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6033 || defined (HAVE_NS) || defined (USE_GTK)
6034 case MENU_BAR_EVENT
:
6035 if (EQ (event
->arg
, event
->frame_or_window
))
6036 /* This is the prefix key. We translate this to
6037 `(menu_bar)' because the code in keyboard.c for menu
6038 events, which we use, relies on this. */
6039 return list1 (Qmenu_bar
);
6043 case SELECT_WINDOW_EVENT
:
6044 /* Make an event (select-window (WINDOW)). */
6045 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6047 case TOOL_BAR_EVENT
:
6048 if (EQ (event
->arg
, event
->frame_or_window
))
6049 /* This is the prefix key. We translate this to
6050 `(tool_bar)' because the code in keyboard.c for tool bar
6051 events, which we use, relies on this. */
6052 return list1 (Qtool_bar
);
6053 else if (SYMBOLP (event
->arg
))
6054 return apply_modifiers (event
->modifiers
, event
->arg
);
6057 case USER_SIGNAL_EVENT
:
6058 /* A user signal. */
6060 char *name
= find_user_signal_name (event
->code
);
6063 return intern (name
);
6066 case SAVE_SESSION_EVENT
:
6067 return Qsave_session
;
6072 return Fcons (Qdbus_event
, event
->arg
);
6074 #endif /* HAVE_DBUS */
6076 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6077 case FILE_NOTIFY_EVENT
:
6079 return Fcons (Qfile_notify
, event
->arg
);
6081 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6083 case CONFIG_CHANGED_EVENT
:
6084 return list3 (Qconfig_changed_event
,
6085 event
->arg
, event
->frame_or_window
);
6087 /* The 'kind' field of the event is something we don't recognize. */
6094 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6095 Lisp_Object x
, Lisp_Object y
, Time t
)
6097 /* Is it a scroll bar movement? */
6098 if (frame
&& ! NILP (bar_window
))
6100 Lisp_Object part_sym
;
6102 part_sym
= *scroll_bar_parts
[(int) part
];
6103 return list2 (Qscroll_bar_movement
,
6105 Qvertical_scroll_bar
,
6110 /* Or is it an ordinary mouse movement? */
6113 Lisp_Object position
;
6114 position
= make_lispy_position (frame
, x
, y
, t
);
6115 return list2 (Qmouse_movement
, position
);
6119 /* Construct a switch frame event. */
6121 make_lispy_switch_frame (Lisp_Object frame
)
6123 return list2 (Qswitch_frame
, frame
);
6127 make_lispy_focus_in (Lisp_Object frame
)
6129 return list2 (Qfocus_in
, frame
);
6132 #ifdef HAVE_WINDOW_SYSTEM
6135 make_lispy_focus_out (Lisp_Object frame
)
6137 return list2 (Qfocus_out
, frame
);
6140 #endif /* HAVE_WINDOW_SYSTEM */
6142 /* Manipulating modifiers. */
6144 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6146 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6147 SYMBOL's name of the end of the modifiers; the string from this
6148 position is the unmodified symbol name.
6150 This doesn't use any caches. */
6153 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6159 CHECK_SYMBOL (symbol
);
6162 name
= SYMBOL_NAME (symbol
);
6164 for (i
= 0; i
< SBYTES (name
) - 1; )
6166 ptrdiff_t this_mod_end
= 0;
6169 /* See if the name continues with a modifier word.
6170 Check that the word appears, but don't check what follows it.
6171 Set this_mod and this_mod_end to record what we find. */
6173 switch (SREF (name
, i
))
6175 #define SINGLE_LETTER_MOD(BIT) \
6176 (this_mod_end = i + 1, this_mod = BIT)
6179 SINGLE_LETTER_MOD (alt_modifier
);
6183 SINGLE_LETTER_MOD (ctrl_modifier
);
6187 SINGLE_LETTER_MOD (hyper_modifier
);
6191 SINGLE_LETTER_MOD (meta_modifier
);
6195 SINGLE_LETTER_MOD (shift_modifier
);
6199 SINGLE_LETTER_MOD (super_modifier
);
6202 #undef SINGLE_LETTER_MOD
6204 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6205 if (i + LEN + 1 <= SBYTES (name) \
6206 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6208 this_mod_end = i + LEN; \
6213 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6214 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6215 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6219 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6221 #undef MULTI_LETTER_MOD
6225 /* If we found no modifier, stop looking for them. */
6226 if (this_mod_end
== 0)
6229 /* Check there is a dash after the modifier, so that it
6230 really is a modifier. */
6231 if (this_mod_end
>= SBYTES (name
)
6232 || SREF (name
, this_mod_end
) != '-')
6235 /* This modifier is real; look for another. */
6236 modifiers
|= this_mod
;
6237 i
= this_mod_end
+ 1;
6240 /* Should we include the `click' modifier? */
6241 if (! (modifiers
& (down_modifier
| drag_modifier
6242 | double_modifier
| triple_modifier
))
6243 && i
+ 7 == SBYTES (name
)
6244 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6245 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6246 modifiers
|= click_modifier
;
6248 if (! (modifiers
& (double_modifier
| triple_modifier
))
6249 && i
+ 6 < SBYTES (name
)
6250 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6251 modifiers
|= click_modifier
;
6259 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6260 prepended to the string BASE[0..BASE_LEN-1].
6261 This doesn't use any caches. */
6263 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6265 /* Since BASE could contain nulls, we can't use intern here; we have
6266 to use Fintern, which expects a genuine Lisp_String, and keeps a
6268 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6274 /* Only the event queue may use the `up' modifier; it should always
6275 be turned into a click or drag event before presented to lisp code. */
6276 if (modifiers
& up_modifier
)
6279 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6280 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6281 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6282 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6283 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6284 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6285 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6286 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6287 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6288 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6289 /* The click modifier is denoted by the absence of other modifiers. */
6293 mod_len
= p
- new_mods
;
6297 Lisp_Object new_name
;
6299 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6300 mod_len
+ base_len_byte
);
6301 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6302 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6304 return Fintern (new_name
, Qnil
);
6309 static const char *const modifier_names
[] =
6311 "up", "down", "drag", "click", "double", "triple", 0, 0,
6312 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6313 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6315 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6317 static Lisp_Object modifier_symbols
;
6319 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6321 lispy_modifier_list (int modifiers
)
6323 Lisp_Object modifier_list
;
6326 modifier_list
= Qnil
;
6327 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6328 if (modifiers
& (1<<i
))
6329 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6332 return modifier_list
;
6336 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6337 where UNMODIFIED is the unmodified form of SYMBOL,
6338 MASK is the set of modifiers present in SYMBOL's name.
6339 This is similar to parse_modifiers_uncached, but uses the cache in
6340 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6341 Qevent_symbol_elements property. */
6343 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6346 parse_modifiers (Lisp_Object symbol
)
6348 Lisp_Object elements
;
6350 if (INTEGERP (symbol
))
6351 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6352 else if (!SYMBOLP (symbol
))
6355 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6356 if (CONSP (elements
))
6361 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6362 Lisp_Object unmodified
;
6365 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6366 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6369 if (modifiers
& ~INTMASK
)
6371 XSETFASTINT (mask
, modifiers
);
6372 elements
= list2 (unmodified
, mask
);
6374 /* Cache the parsing results on SYMBOL. */
6375 Fput (symbol
, Qevent_symbol_element_mask
,
6377 Fput (symbol
, Qevent_symbol_elements
,
6378 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6380 /* Since we know that SYMBOL is modifiers applied to unmodified,
6381 it would be nice to put that in unmodified's cache.
6382 But we can't, since we're not sure that parse_modifiers is
6389 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6390 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6391 doc
: /* Parse the event symbol. For internal use. */)
6392 (Lisp_Object symbol
)
6394 /* Fill the cache if needed. */
6395 parse_modifiers (symbol
);
6396 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6397 and use the Lispier representation stored on Qevent_symbol_elements
6399 return Fget (symbol
, Qevent_symbol_elements
);
6402 /* Apply the modifiers MODIFIERS to the symbol BASE.
6403 BASE must be unmodified.
6405 This is like apply_modifiers_uncached, but uses BASE's
6406 Qmodifier_cache property, if present. It also builds
6407 Qevent_symbol_elements properties, since it has that info anyway.
6409 apply_modifiers copies the value of BASE's Qevent_kind property to
6410 the modified symbol. */
6412 apply_modifiers (int modifiers
, Lisp_Object base
)
6414 Lisp_Object cache
, idx
, entry
, new_symbol
;
6416 /* Mask out upper bits. We don't know where this value's been. */
6417 modifiers
&= INTMASK
;
6419 if (INTEGERP (base
))
6420 return make_number (XINT (base
) | modifiers
);
6422 /* The click modifier never figures into cache indices. */
6423 cache
= Fget (base
, Qmodifier_cache
);
6424 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6425 entry
= assq_no_quit (idx
, cache
);
6428 new_symbol
= XCDR (entry
);
6431 /* We have to create the symbol ourselves. */
6432 new_symbol
= apply_modifiers_uncached (modifiers
,
6433 SSDATA (SYMBOL_NAME (base
)),
6434 SCHARS (SYMBOL_NAME (base
)),
6435 SBYTES (SYMBOL_NAME (base
)));
6437 /* Add the new symbol to the base's cache. */
6438 entry
= Fcons (idx
, new_symbol
);
6439 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6441 /* We have the parsing info now for free, so we could add it to
6443 XSETFASTINT (idx, modifiers);
6444 Fput (new_symbol, Qevent_symbol_element_mask,
6446 Fput (new_symbol, Qevent_symbol_elements,
6447 Fcons (base, lispy_modifier_list (modifiers)));
6448 Sadly, this is only correct if `base' is indeed a base event,
6449 which is not necessarily the case. -stef */
6452 /* Make sure this symbol is of the same kind as BASE.
6454 You'd think we could just set this once and for all when we
6455 intern the symbol above, but reorder_modifiers may call us when
6456 BASE's property isn't set right; we can't assume that just
6457 because it has a Qmodifier_cache property it must have its
6458 Qevent_kind set right as well. */
6459 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6463 kind
= Fget (base
, Qevent_kind
);
6465 Fput (new_symbol
, Qevent_kind
, kind
);
6472 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6473 return a symbol with the modifiers placed in the canonical order.
6474 Canonical order is alphabetical, except for down and drag, which
6475 always come last. The 'click' modifier is never written out.
6477 Fdefine_key calls this to make sure that (for example) C-M-foo
6478 and M-C-foo end up being equivalent in the keymap. */
6481 reorder_modifiers (Lisp_Object symbol
)
6483 /* It's hopefully okay to write the code this way, since everything
6484 will soon be in caches, and no consing will be done at all. */
6487 parsed
= parse_modifiers (symbol
);
6488 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6493 /* For handling events, we often want to produce a symbol whose name
6494 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6495 to some base, like the name of a function key or mouse button.
6496 modify_event_symbol produces symbols of this sort.
6498 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6499 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6502 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6503 into symbol names, or a string specifying a name stem used to
6504 construct a symbol name or the form `STEM-N', where N is the decimal
6505 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6506 non-nil; otherwise NAME_TABLE is used.
6508 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6509 persist between calls to modify_event_symbol that it can use to
6510 store a cache of the symbols it's generated for this NAME_TABLE
6511 before. The object stored there may be a vector or an alist.
6513 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6515 MODIFIERS is a set of modifier bits (as given in struct input_events)
6516 whose prefixes should be applied to the symbol name.
6518 SYMBOL_KIND is the value to be placed in the event_kind property of
6519 the returned symbol.
6521 The symbols we create are supposed to have an
6522 `event-symbol-elements' property, which lists the modifiers present
6523 in the symbol's name. */
6526 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6527 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6528 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6531 Lisp_Object symbol_int
;
6533 /* Get rid of the "vendor-specific" bit here. */
6534 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6536 /* Is this a request for a valid symbol? */
6537 if (symbol_num
< 0 || symbol_num
>= table_size
)
6540 if (CONSP (*symbol_table
))
6541 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6543 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6544 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6545 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6546 we've never used that symbol before. */
6549 if (! VECTORP (*symbol_table
)
6550 || ASIZE (*symbol_table
) != table_size
)
6554 XSETFASTINT (size
, table_size
);
6555 *symbol_table
= Fmake_vector (size
, Qnil
);
6558 value
= AREF (*symbol_table
, symbol_num
);
6561 /* Have we already used this symbol before? */
6564 /* No; let's create it. */
6565 if (CONSP (name_alist_or_stem
))
6566 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6567 else if (STRINGP (name_alist_or_stem
))
6570 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6571 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6573 buf
= SAFE_ALLOCA (len
);
6574 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6575 XINT (symbol_int
) + 1);
6576 value
= intern (buf
);
6579 else if (name_table
!= 0 && name_table
[symbol_num
])
6580 value
= intern (name_table
[symbol_num
]);
6582 #ifdef HAVE_WINDOW_SYSTEM
6585 char *name
= x_get_keysym_name (symbol_num
);
6587 value
= intern (name
);
6593 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6594 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6595 value
= intern (buf
);
6598 if (CONSP (*symbol_table
))
6599 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6601 ASET (*symbol_table
, symbol_num
, value
);
6603 /* Fill in the cache entries for this symbol; this also
6604 builds the Qevent_symbol_elements property, which the user
6606 apply_modifiers (modifiers
& click_modifier
, value
);
6607 Fput (value
, Qevent_kind
, symbol_kind
);
6610 /* Apply modifiers to that symbol. */
6611 return apply_modifiers (modifiers
, value
);
6614 /* Convert a list that represents an event type,
6615 such as (ctrl meta backspace), into the usual representation of that
6616 event type as a number or a symbol. */
6618 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6619 doc
: /* Convert the event description list EVENT-DESC to an event type.
6620 EVENT-DESC should contain one base event type (a character or symbol)
6621 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6622 drag, down, double or triple). The base must be last.
6623 The return value is an event type (a character or symbol) which
6624 has the same base event type and all the specified modifiers. */)
6625 (Lisp_Object event_desc
)
6633 while (CONSP (rest
))
6641 /* Given a symbol, see if it is a modifier name. */
6642 if (SYMBOLP (elt
) && CONSP (rest
))
6643 this = parse_solitary_modifier (elt
);
6647 else if (!NILP (base
))
6648 error ("Two bases given in one event");
6654 /* Let the symbol A refer to the character A. */
6655 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6656 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6658 if (INTEGERP (base
))
6660 /* Turn (shift a) into A. */
6661 if ((modifiers
& shift_modifier
) != 0
6662 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6664 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6665 modifiers
&= ~shift_modifier
;
6668 /* Turn (control a) into C-a. */
6669 if (modifiers
& ctrl_modifier
)
6670 return make_number ((modifiers
& ~ctrl_modifier
)
6671 | make_ctrl_char (XINT (base
)));
6673 return make_number (modifiers
| XINT (base
));
6675 else if (SYMBOLP (base
))
6676 return apply_modifiers (modifiers
, base
);
6678 error ("Invalid base event");
6681 /* Try to recognize SYMBOL as a modifier name.
6682 Return the modifier flag bit, or 0 if not recognized. */
6685 parse_solitary_modifier (Lisp_Object symbol
)
6687 Lisp_Object name
= SYMBOL_NAME (symbol
);
6689 switch (SREF (name
, 0))
6691 #define SINGLE_LETTER_MOD(BIT) \
6692 if (SBYTES (name) == 1) \
6695 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6696 if (LEN == SBYTES (name) \
6697 && ! memcmp (SDATA (name), NAME, LEN)) \
6701 SINGLE_LETTER_MOD (alt_modifier
);
6705 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6709 SINGLE_LETTER_MOD (ctrl_modifier
);
6713 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6714 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6718 SINGLE_LETTER_MOD (hyper_modifier
);
6722 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6726 SINGLE_LETTER_MOD (meta_modifier
);
6730 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6734 SINGLE_LETTER_MOD (shift_modifier
);
6738 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6739 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6740 SINGLE_LETTER_MOD (super_modifier
);
6744 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6745 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6746 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6750 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6753 #undef SINGLE_LETTER_MOD
6754 #undef MULTI_LETTER_MOD
6760 /* Return true if EVENT is a list whose elements are all integers or symbols.
6761 Such a list is not valid as an event,
6762 but it can be a Lucid-style event type list. */
6765 lucid_event_type_list_p (Lisp_Object object
)
6769 if (! CONSP (object
))
6772 if (EQ (XCAR (object
), Qhelp_echo
)
6773 || EQ (XCAR (object
), Qvertical_line
)
6774 || EQ (XCAR (object
), Qmode_line
)
6775 || EQ (XCAR (object
), Qheader_line
))
6778 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6782 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6789 /* Return true if terminal input chars are available.
6790 Also, store the return value into INPUT_PENDING.
6792 Serves the purpose of ioctl (0, FIONREAD, ...)
6793 but works even if FIONREAD does not exist.
6794 (In fact, this may actually read some input.)
6796 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6797 timer events that are ripe.
6798 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6799 events (FOCUS_IN_EVENT).
6800 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6801 movements and toolkit scroll bar thumb drags. */
6804 get_input_pending (int flags
)
6806 /* First of all, have we already counted some input? */
6807 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6809 /* If input is being read as it arrives, and we have none, there is none. */
6810 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6812 /* Try to read some input and see how much we get. */
6814 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6817 return input_pending
;
6820 /* Put a BUFFER_SWITCH_EVENT in the buffer
6821 so that read_key_sequence will notice the new current buffer. */
6824 record_asynch_buffer_change (void)
6826 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6827 The purpose of the event is to make read_key_sequence look up the
6828 keymaps again. If we aren't in read_key_sequence, we don't need one,
6829 and the event could cause trouble by messing up (input-pending-p).
6830 Note: Fwaiting_for_user_input_p always returns nil when async
6831 subprocesses aren't supported. */
6832 if (!NILP (Fwaiting_for_user_input_p ()))
6834 struct input_event event
;
6837 event
.kind
= BUFFER_SWITCH_EVENT
;
6838 event
.frame_or_window
= Qnil
;
6841 /* Make sure no interrupt happens while storing the event. */
6843 if (interrupt_input
)
6844 kbd_buffer_store_event (&event
);
6849 kbd_buffer_store_event (&event
);
6855 /* Read any terminal input already buffered up by the system
6856 into the kbd_buffer, but do not wait.
6858 Return the number of keyboard chars read, or -1 meaning
6859 this is a bad time to try to read input. */
6868 /* Store pending user signal events, if any. */
6869 store_user_signal_events ();
6871 /* Loop through the available terminals, and call their input hooks. */
6875 struct terminal
*next
= t
->next_terminal
;
6877 if (t
->read_socket_hook
)
6880 struct input_event hold_quit
;
6882 if (input_blocked_p ())
6884 pending_signals
= 1;
6888 EVENT_INIT (hold_quit
);
6889 hold_quit
.kind
= NO_EVENT
;
6891 /* No need for FIONREAD or fcntl; just say don't wait. */
6892 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6895 if (nr
== -1) /* Not OK to read input now. */
6899 else if (nr
== -2) /* Non-transient error. */
6901 /* The terminal device terminated; it should be closed. */
6903 /* Kill Emacs if this was our last terminal. */
6904 if (!terminal_list
->next_terminal
)
6905 /* Formerly simply reported no input, but that
6906 sometimes led to a failure of Emacs to terminate.
6907 SIGHUP seems appropriate if we can't reach the
6909 /* ??? Is it really right to send the signal just to
6910 this process rather than to the whole process
6911 group? Perhaps on systems with FIONREAD Emacs is
6912 alone in its group. */
6913 terminate_due_to_signal (SIGHUP
, 10);
6915 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6918 XSETTERMINAL (tmp
, t
);
6919 Fdelete_terminal (tmp
, Qnoelisp
);
6923 /* If there was no error, make sure the pointer
6924 is visible for all frames on this terminal. */
6927 Lisp_Object tail
, frame
;
6929 FOR_EACH_FRAME (tail
, frame
)
6931 struct frame
*f
= XFRAME (frame
);
6932 if (FRAME_TERMINAL (f
) == t
)
6933 frame_make_pointer_visible (f
);
6937 if (hold_quit
.kind
!= NO_EVENT
)
6938 kbd_buffer_store_event (&hold_quit
);
6950 /* This is the tty way of reading available input.
6952 Note that each terminal device has its own `struct terminal' object,
6953 and so this function is called once for each individual termcap
6954 terminal. The first parameter indicates which terminal to read from. */
6957 tty_read_avail_input (struct terminal
*terminal
,
6958 struct input_event
*hold_quit
)
6960 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6961 the kbd_buffer can really hold. That may prevent loss
6962 of characters on some systems when input is stuffed at us. */
6963 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6965 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6968 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6970 if (kbd_on_hold_p () || buffer_free
<= 0)
6972 #endif /* subprocesses */
6974 if (!terminal
->name
) /* Don't read from a dead terminal. */
6977 if (terminal
->type
!= output_termcap
6978 && terminal
->type
!= output_msdos_raw
)
6981 /* XXX I think the following code should be moved to separate hook
6982 functions in system-dependent files. */
6984 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6985 code sets read_socket_hook to w32_console_read_socket instead! */
6987 #else /* not WINDOWSNT */
6988 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6992 return 0; /* The terminal is suspended. */
6995 n_to_read
= dos_keysns ();
6999 cbuf
[0] = dos_keyread ();
7002 #else /* not MSDOS */
7007 struct input_event gpm_hold_quit
;
7008 int gpm
, fd
= gpm_fd
;
7010 EVENT_INIT (gpm_hold_quit
);
7011 gpm_hold_quit
.kind
= NO_EVENT
;
7013 /* gpm==1 if event received.
7014 gpm==0 if the GPM daemon has closed the connection, in which case
7015 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7016 we save it in `fd' so close_gpm can remove it from the
7018 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7019 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7020 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7023 /* Presumably the GPM daemon has closed the connection. */
7025 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7026 kbd_buffer_store_event (&gpm_hold_quit
);
7030 #endif /* HAVE_GPM */
7032 /* Determine how many characters we should *try* to read. */
7033 #ifdef USABLE_FIONREAD
7034 /* Find out how much input is available. */
7035 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7037 if (! noninteractive
)
7038 return -2; /* Close this terminal. */
7044 if (n_to_read
> sizeof cbuf
)
7045 n_to_read
= sizeof cbuf
;
7046 #elif defined USG || defined CYGWIN
7047 /* Read some input if available, but don't wait. */
7048 n_to_read
= sizeof cbuf
;
7049 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7051 # error "Cannot read without possibly delaying"
7055 /* Don't read more than we can store. */
7056 if (n_to_read
> buffer_free
)
7057 n_to_read
= buffer_free
;
7058 #endif /* subprocesses */
7060 /* Now read; for one reason or another, this will not block.
7061 NREAD is set to the number of chars read. */
7064 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7065 /* POSIX infers that processes which are not in the session leader's
7066 process group won't get SIGHUPs at logout time. BSDI adheres to
7067 this part standard and returns -1 from read (0) with errno==EIO
7068 when the control tty is taken away.
7069 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7070 if (nread
== -1 && errno
== EIO
)
7071 return -2; /* Close this terminal. */
7072 #if defined (AIX) && defined (_BSD)
7073 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7074 This looks incorrect, but it isn't, because _BSD causes
7075 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7076 and that causes a value other than 0 when there is no input. */
7078 return -2; /* Close this terminal. */
7082 /* We used to retry the read if it was interrupted.
7083 But this does the wrong thing when O_NONBLOCK causes
7084 an EAGAIN error. Does anybody know of a situation
7085 where a retry is actually needed? */
7087 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7097 #ifndef USABLE_FIONREAD
7098 #if defined (USG) || defined (CYGWIN)
7099 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7100 #endif /* USG or CYGWIN */
7101 #endif /* no FIONREAD */
7106 #endif /* not MSDOS */
7107 #endif /* not WINDOWSNT */
7109 for (i
= 0; i
< nread
; i
++)
7111 struct input_event buf
;
7113 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7115 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7116 buf
.modifiers
= meta_modifier
;
7117 if (tty
->meta_key
!= 2)
7121 /* Set the frame corresponding to the active tty. Note that the
7122 value of selected_frame is not reliable here, redisplay tends
7123 to temporarily change it. */
7124 buf
.frame_or_window
= tty
->top_frame
;
7127 kbd_buffer_store_event (&buf
);
7128 /* Don't look at input that follows a C-g too closely.
7129 This reduces lossage due to autorepeat on C-g. */
7130 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7131 && buf
.code
== quit_char
)
7139 handle_async_input (void)
7144 int nread
= gobble_input ();
7145 /* -1 means it's not ok to read the input now.
7146 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7147 0 means there was no keyboard input available. */
7155 process_pending_signals (void)
7157 pending_signals
= 0;
7158 handle_async_input ();
7159 do_pending_atimers ();
7162 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7163 and reinvoke any pending signal if the level is now 0 and
7164 a fatal error is not already in progress. */
7167 unblock_input_to (int level
)
7169 interrupt_input_blocked
= level
;
7172 if (pending_signals
&& !fatal_error_in_progress
)
7173 process_pending_signals ();
7179 /* End critical section.
7181 If doing signal-driven input, and a signal came in when input was
7182 blocked, reinvoke the signal handler now to deal with it.
7184 It will also process queued input, if it was not read before.
7185 When a longer code sequence does not use block/unblock input
7186 at all, the whole input gathered up to the next call to
7187 unblock_input will be processed inside that call. */
7190 unblock_input (void)
7192 unblock_input_to (interrupt_input_blocked
- 1);
7195 /* Undo any number of BLOCK_INPUT calls,
7196 and also reinvoke any pending signal. */
7199 totally_unblock_input (void)
7201 unblock_input_to (0);
7207 handle_input_available_signal (int sig
)
7209 pending_signals
= 1;
7211 if (input_available_clear_time
)
7212 *input_available_clear_time
= make_timespec (0, 0);
7216 deliver_input_available_signal (int sig
)
7218 deliver_process_signal (sig
, handle_input_available_signal
);
7220 #endif /* USABLE_SIGIO */
7223 /* User signal events. */
7225 struct user_signal_info
7227 /* Signal number. */
7230 /* Name of the signal. */
7233 /* Number of pending signals. */
7236 struct user_signal_info
*next
;
7239 /* List of user signals. */
7240 static struct user_signal_info
*user_signals
= NULL
;
7243 add_user_signal (int sig
, const char *name
)
7245 struct sigaction action
;
7246 struct user_signal_info
*p
;
7248 for (p
= user_signals
; p
; p
= p
->next
)
7250 /* Already added. */
7253 p
= xmalloc (sizeof *p
);
7255 p
->name
= xstrdup (name
);
7257 p
->next
= user_signals
;
7260 emacs_sigaction_init (&action
, deliver_user_signal
);
7261 sigaction (sig
, &action
, 0);
7265 handle_user_signal (int sig
)
7267 struct user_signal_info
*p
;
7268 const char *special_event_name
= NULL
;
7270 if (SYMBOLP (Vdebug_on_event
))
7271 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7273 for (p
= user_signals
; p
; p
= p
->next
)
7276 if (special_event_name
7277 && strcmp (special_event_name
, p
->name
) == 0)
7279 /* Enter the debugger in many ways. */
7280 debug_on_next_call
= 1;
7283 Vinhibit_quit
= Qnil
;
7285 /* Eat the event. */
7291 if (interrupt_input
)
7292 handle_input_available_signal (sig
);
7296 /* Tell wait_reading_process_output that it needs to wake
7297 up and look around. */
7298 if (input_available_clear_time
)
7299 *input_available_clear_time
= make_timespec (0, 0);
7306 deliver_user_signal (int sig
)
7308 deliver_process_signal (sig
, handle_user_signal
);
7312 find_user_signal_name (int sig
)
7314 struct user_signal_info
*p
;
7316 for (p
= user_signals
; p
; p
= p
->next
)
7324 store_user_signal_events (void)
7326 struct user_signal_info
*p
;
7327 struct input_event buf
;
7328 bool buf_initialized
= 0;
7330 for (p
= user_signals
; p
; p
= p
->next
)
7331 if (p
->npending
> 0)
7333 if (! buf_initialized
)
7335 memset (&buf
, 0, sizeof buf
);
7336 buf
.kind
= USER_SIGNAL_EVENT
;
7337 buf
.frame_or_window
= selected_frame
;
7338 buf_initialized
= 1;
7344 kbd_buffer_store_event (&buf
);
7347 while (p
->npending
> 0);
7352 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7353 static Lisp_Object menu_bar_one_keymap_changed_items
;
7355 /* These variables hold the vector under construction within
7356 menu_bar_items and its subroutines, and the current index
7357 for storing into that vector. */
7358 static Lisp_Object menu_bar_items_vector
;
7359 static int menu_bar_items_index
;
7362 static const char *separator_names
[] = {
7367 "single-dashed-line",
7368 "double-dashed-line",
7370 "shadow-etched-out",
7371 "shadow-etched-in-dash",
7372 "shadow-etched-out-dash",
7373 "shadow-double-etched-in",
7374 "shadow-double-etched-out",
7375 "shadow-double-etched-in-dash",
7376 "shadow-double-etched-out-dash",
7380 /* Return true if LABEL specifies a separator. */
7383 menu_separator_name_p (const char *label
)
7387 else if (strlen (label
) > 3
7388 && memcmp (label
, "--", 2) == 0
7393 for (i
= 0; separator_names
[i
]; ++i
)
7394 if (strcmp (label
, separator_names
[i
]) == 0)
7399 /* It's a separator if it contains only dashes. */
7400 while (*label
== '-')
7402 return (*label
== 0);
7409 /* Return a vector of menu items for a menu bar, appropriate
7410 to the current buffer. Each item has three elements in the vector:
7413 OLD is an old vector we can optionally reuse, or nil. */
7416 menu_bar_items (Lisp_Object old
)
7418 /* The number of keymaps we're scanning right now, and the number of
7419 keymaps we have allocated space for. */
7422 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7423 in the current keymaps, or nil where it is not a prefix. */
7426 Lisp_Object def
, tail
;
7431 /* In order to build the menus, we need to call the keymap
7432 accessors. They all call QUIT. But this function is called
7433 during redisplay, during which a quit is fatal. So inhibit
7434 quitting while building the menus.
7435 We do this instead of specbind because (1) errors will clear it anyway
7436 and (2) this avoids risk of specpdl overflow. */
7437 oquit
= Vinhibit_quit
;
7441 menu_bar_items_vector
= old
;
7443 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7444 menu_bar_items_index
= 0;
7446 /* Build our list of keymaps.
7447 If we recognize a function key and replace its escape sequence in
7448 keybuf with its symbol, or if the sequence starts with a mouse
7449 click and we need to switch buffers, we jump back here to rebuild
7450 the initial keymaps from the current buffer. */
7454 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7455 if (!NILP (Voverriding_local_map_menu_flag
)
7456 && !NILP (Voverriding_local_map
))
7458 /* Yes, use them (if non-nil) as well as the global map. */
7459 maps
= alloca (3 * sizeof (maps
[0]));
7461 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7462 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7463 if (!NILP (Voverriding_local_map
))
7464 maps
[nmaps
++] = Voverriding_local_map
;
7468 /* No, so use major and minor mode keymaps and keymap property.
7469 Note that menu-bar bindings in the local-map and keymap
7470 properties may not work reliable, as they are only
7471 recognized when the menu-bar (or mode-line) is updated,
7472 which does not normally happen after every command. */
7475 nminor
= current_minor_maps (NULL
, &tmaps
);
7476 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7478 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7479 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7480 maps
[nmaps
++] = tem
;
7481 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7482 maps
[nmaps
++] = tem
;
7483 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7485 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7487 maps
[nmaps
++] = current_global_map
;
7490 /* Look up in each map the dummy prefix key `menu-bar'. */
7492 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7493 if (!NILP (maps
[mapno
]))
7495 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7499 menu_bar_one_keymap_changed_items
= Qnil
;
7500 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7504 /* Move to the end those items that should be at the end. */
7506 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7509 int end
= menu_bar_items_index
;
7511 for (i
= 0; i
< end
; i
+= 4)
7512 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7514 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7515 /* Move the item at index I to the end,
7516 shifting all the others forward. */
7517 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7518 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7519 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7520 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7522 memmove (aref_addr (menu_bar_items_vector
, i
),
7523 aref_addr (menu_bar_items_vector
, i
+ 4),
7524 (end
- i
- 4) * word_size
);
7525 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7526 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7527 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7528 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7533 /* Add nil, nil, nil, nil at the end. */
7535 int i
= menu_bar_items_index
;
7536 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7537 menu_bar_items_vector
7538 = larger_vector (menu_bar_items_vector
, 4, -1);
7539 /* Add this item. */
7540 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7541 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7542 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7543 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7544 menu_bar_items_index
= i
;
7547 Vinhibit_quit
= oquit
;
7548 return menu_bar_items_vector
;
7551 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7552 If there's already an item for KEY, add this DEF to it. */
7554 Lisp_Object item_properties
;
7557 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7559 struct gcpro gcpro1
;
7564 if (EQ (item
, Qundefined
))
7566 /* If a map has an explicit `undefined' as definition,
7567 discard any previously made menu bar item. */
7569 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7570 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7572 if (menu_bar_items_index
> i
+ 4)
7573 memmove (aref_addr (menu_bar_items_vector
, i
),
7574 aref_addr (menu_bar_items_vector
, i
+ 4),
7575 (menu_bar_items_index
- i
- 4) * word_size
);
7576 menu_bar_items_index
-= 4;
7580 /* If this keymap has already contributed to this KEY,
7581 don't contribute to it a second time. */
7582 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7583 if (!NILP (tem
) || NILP (item
))
7586 menu_bar_one_keymap_changed_items
7587 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7589 /* We add to menu_bar_one_keymap_changed_items before doing the
7590 parse_menu_item, so that if it turns out it wasn't a menu item,
7591 it still correctly hides any further menu item. */
7593 parsed
= parse_menu_item (item
, 1);
7598 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7600 /* Find any existing item for this KEY. */
7601 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7602 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7605 /* If we did not find this KEY, add it at the end. */
7606 if (i
== menu_bar_items_index
)
7608 /* If vector is too small, get a bigger one. */
7609 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7610 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7611 /* Add this item. */
7612 ASET (menu_bar_items_vector
, i
, key
); i
++;
7613 ASET (menu_bar_items_vector
, i
,
7614 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7615 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7616 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7617 menu_bar_items_index
= i
;
7619 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7623 old
= AREF (menu_bar_items_vector
, i
+ 2);
7624 /* If the new and the old items are not both keymaps,
7625 the lookup will only find `item'. */
7626 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7627 ASET (menu_bar_items_vector
, i
+ 2, item
);
7631 /* This is used as the handler when calling menu_item_eval_property. */
7633 menu_item_eval_property_1 (Lisp_Object arg
)
7635 /* If we got a quit from within the menu computation,
7636 quit all the way out of it. This takes care of C-] in the debugger. */
7637 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7638 Fsignal (Qquit
, Qnil
);
7644 eval_dyn (Lisp_Object form
)
7646 return Feval (form
, Qnil
);
7649 /* Evaluate an expression and return the result (or nil if something
7650 went wrong). Used to evaluate dynamic parts of menu items. */
7652 menu_item_eval_property (Lisp_Object sexpr
)
7654 ptrdiff_t count
= SPECPDL_INDEX ();
7656 specbind (Qinhibit_redisplay
, Qt
);
7657 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7658 menu_item_eval_property_1
);
7659 return unbind_to (count
, val
);
7662 /* This function parses a menu item and leaves the result in the
7663 vector item_properties.
7664 ITEM is a key binding, a possible menu item.
7665 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7667 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7668 parse_menu_item returns true if the item is a menu item and false
7672 parse_menu_item (Lisp_Object item
, int inmenubar
)
7674 Lisp_Object def
, tem
, item_string
, start
;
7676 Lisp_Object keyhint
;
7685 /* Create item_properties vector if necessary. */
7686 if (NILP (item_properties
))
7688 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7690 /* Initialize optional entries. */
7691 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7692 ASET (item_properties
, i
, Qnil
);
7693 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7695 /* Save the item here to protect it from GC. */
7696 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7698 item_string
= XCAR (item
);
7702 if (STRINGP (item_string
))
7704 /* Old format menu item. */
7705 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7707 /* Maybe help string. */
7708 if (CONSP (item
) && STRINGP (XCAR (item
)))
7710 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7715 /* Maybe an obsolete key binding cache. */
7716 if (CONSP (item
) && CONSP (XCAR (item
))
7717 && (NILP (XCAR (XCAR (item
)))
7718 || VECTORP (XCAR (XCAR (item
)))))
7721 /* This is the real definition--the function to run. */
7722 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7724 /* Get enable property, if any. */
7727 tem
= Fget (item
, Qmenu_enable
);
7728 if (!NILP (Venable_disabled_menus_and_buttons
))
7729 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7730 else if (!NILP (tem
))
7731 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7734 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7736 /* New format menu item. */
7737 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7738 start
= XCDR (item
);
7741 /* We have a real binding. */
7742 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7744 item
= XCDR (start
);
7745 /* Is there an obsolete cache list with key equivalences. */
7746 if (CONSP (item
) && CONSP (XCAR (item
)))
7749 /* Parse properties. */
7750 while (CONSP (item
) && CONSP (XCDR (item
)))
7755 if (EQ (tem
, QCenable
))
7757 if (!NILP (Venable_disabled_menus_and_buttons
))
7758 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7760 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7762 else if (EQ (tem
, QCvisible
))
7764 /* If got a visible property and that evaluates to nil
7765 then ignore this item. */
7766 tem
= menu_item_eval_property (XCAR (item
));
7770 else if (EQ (tem
, QChelp
))
7771 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7772 else if (EQ (tem
, QCfilter
))
7774 else if (EQ (tem
, QCkey_sequence
))
7777 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7778 /* Be GC protected. Set keyhint to item instead of tem. */
7781 else if (EQ (tem
, QCkeys
))
7784 if (CONSP (tem
) || STRINGP (tem
))
7785 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7787 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7792 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7794 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7796 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7802 else if (inmenubar
|| !NILP (start
))
7806 return 0; /* not a menu item */
7808 /* If item string is not a string, evaluate it to get string.
7809 If we don't get a string, skip this item. */
7810 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7811 if (!(STRINGP (item_string
)))
7813 item_string
= menu_item_eval_property (item_string
);
7814 if (!STRINGP (item_string
))
7816 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7819 /* If got a filter apply it on definition. */
7820 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7823 def
= menu_item_eval_property (list2 (XCAR (filter
),
7824 list2 (Qquote
, def
)));
7826 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7829 /* Enable or disable selection of item. */
7830 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7833 tem
= menu_item_eval_property (tem
);
7834 if (inmenubar
&& NILP (tem
))
7835 return 0; /* Ignore disabled items in menu bar. */
7836 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7839 /* If we got no definition, this item is just unselectable text which
7840 is OK in a submenu but not in the menubar. */
7842 return (!inmenubar
);
7844 /* See if this is a separate pane or a submenu. */
7845 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7846 tem
= get_keymap (def
, 0, 1);
7847 /* For a subkeymap, just record its details and exit. */
7850 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7851 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7855 /* At the top level in the menu bar, do likewise for commands also.
7856 The menu bar does not display equivalent key bindings anyway.
7857 ITEM_PROPERTY_DEF is already set up properly. */
7861 { /* This is a command. See if there is an equivalent key binding. */
7862 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7864 /* The previous code preferred :key-sequence to :keys, so we
7865 preserve this behavior. */
7866 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7867 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7870 Lisp_Object prefix
= keyeq
;
7871 Lisp_Object keys
= Qnil
;
7875 def
= XCAR (prefix
);
7876 prefix
= XCDR (prefix
);
7879 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7881 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7883 keys
= XCAR (keyhint
);
7884 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7886 /* We have a suggested key. Is it bound to the command? */
7889 /* If the command is an alias for another
7890 (such as lmenu.el set it up), check if the
7891 original command matches the cached command. */
7893 && EQ (tem
, XSYMBOL (def
)->function
))))
7898 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7902 tem
= Fkey_description (keys
, Qnil
);
7905 if (STRINGP (XCAR (prefix
)))
7906 tem
= concat2 (XCAR (prefix
), tem
);
7907 if (STRINGP (XCDR (prefix
)))
7908 tem
= concat2 (tem
, XCDR (prefix
));
7910 keyeq
= concat2 (build_string (" "), tem
);
7911 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7917 /* If we have an equivalent key binding, use that. */
7918 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7921 /* Include this when menu help is implemented.
7922 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7923 if (!(NILP (tem) || STRINGP (tem)))
7925 tem = menu_item_eval_property (tem);
7928 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7932 /* Handle radio buttons or toggle boxes. */
7933 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7935 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7936 menu_item_eval_property (tem
));
7943 /***********************************************************************
7945 ***********************************************************************/
7947 /* A vector holding tool bar items while they are parsed in function
7948 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7951 static Lisp_Object tool_bar_items_vector
;
7953 /* A vector holding the result of parse_tool_bar_item. Layout is like
7954 the one for a single item in tool_bar_items_vector. */
7956 static Lisp_Object tool_bar_item_properties
;
7958 /* Next free index in tool_bar_items_vector. */
7960 static int ntool_bar_items
;
7962 /* The symbols `:image' and `:rtl'. */
7964 static Lisp_Object QCimage
;
7965 static Lisp_Object QCrtl
;
7967 /* Function prototypes. */
7969 static void init_tool_bar_items (Lisp_Object
);
7970 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7972 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7973 static void append_tool_bar_item (void);
7976 /* Return a vector of tool bar items for keymaps currently in effect.
7977 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7978 tool bar items found. */
7981 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7990 /* In order to build the menus, we need to call the keymap
7991 accessors. They all call QUIT. But this function is called
7992 during redisplay, during which a quit is fatal. So inhibit
7993 quitting while building the menus. We do this instead of
7994 specbind because (1) errors will clear it anyway and (2) this
7995 avoids risk of specpdl overflow. */
7996 oquit
= Vinhibit_quit
;
7999 /* Initialize tool_bar_items_vector and protect it from GC. */
8000 init_tool_bar_items (reuse
);
8002 /* Build list of keymaps in maps. Set nmaps to the number of maps
8005 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8006 if (!NILP (Voverriding_local_map_menu_flag
)
8007 && !NILP (Voverriding_local_map
))
8009 /* Yes, use them (if non-nil) as well as the global map. */
8010 maps
= alloca (3 * sizeof *maps
);
8012 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8013 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8014 if (!NILP (Voverriding_local_map
))
8015 maps
[nmaps
++] = Voverriding_local_map
;
8019 /* No, so use major and minor mode keymaps and keymap property.
8020 Note that tool-bar bindings in the local-map and keymap
8021 properties may not work reliable, as they are only
8022 recognized when the tool-bar (or mode-line) is updated,
8023 which does not normally happen after every command. */
8026 nminor
= current_minor_maps (NULL
, &tmaps
);
8027 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8029 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8030 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8031 maps
[nmaps
++] = tem
;
8032 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8033 maps
[nmaps
++] = tem
;
8034 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8036 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8039 /* Add global keymap at the end. */
8040 maps
[nmaps
++] = current_global_map
;
8042 /* Process maps in reverse order and look up in each map the prefix
8044 for (i
= nmaps
- 1; i
>= 0; --i
)
8045 if (!NILP (maps
[i
]))
8049 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8051 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8054 Vinhibit_quit
= oquit
;
8055 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8056 return tool_bar_items_vector
;
8060 /* Process the definition of KEY which is DEF. */
8063 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8066 struct gcpro gcpro1
, gcpro2
;
8068 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8072 if (EQ (def
, Qundefined
))
8074 /* If a map has an explicit `undefined' as definition,
8075 discard any previously made item. */
8076 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8078 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8080 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8082 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8083 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8084 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8086 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8091 else if (parse_tool_bar_item (key
, def
))
8092 /* Append a new tool bar item to tool_bar_items_vector. Accept
8093 more than one definition for the same key. */
8094 append_tool_bar_item ();
8099 /* Access slot with index IDX of vector tool_bar_item_properties. */
8100 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8102 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8104 ASET (tool_bar_item_properties
, idx
, val
);
8108 /* Parse a tool bar item specification ITEM for key KEY and return the
8109 result in tool_bar_item_properties. Value is false if ITEM is
8112 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8114 CAPTION is the caption of the item, If it's not a string, it is
8115 evaluated to get a string.
8117 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8118 as binding are currently ignored.
8120 The following properties are recognized:
8124 FORM is evaluated and specifies whether the tool bar item is
8125 enabled or disabled.
8129 FORM is evaluated and specifies whether the tool bar item is visible.
8131 - `:filter FUNCTION'
8133 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8134 result is stored as the new binding.
8136 - `:button (TYPE SELECTED)'
8138 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8139 and specifies whether the button is selected (pressed) or not.
8143 IMAGES is either a single image specification or a vector of four
8144 image specifications. See enum tool_bar_item_images.
8146 - `:help HELP-STRING'.
8148 Gives a help string to display for the tool bar item.
8150 - `:label LABEL-STRING'.
8152 A text label to show with the tool bar button if labels are enabled. */
8155 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8157 Lisp_Object filter
= Qnil
;
8158 Lisp_Object caption
;
8160 bool have_label
= 0;
8162 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8163 Rule out items that aren't lists, don't start with
8164 `menu-item' or whose rest following `tool-bar-item' is not a
8169 /* As an exception, allow old-style menu separators. */
8170 if (STRINGP (XCAR (item
)))
8171 item
= list1 (XCAR (item
));
8172 else if (!EQ (XCAR (item
), Qmenu_item
)
8173 || (item
= XCDR (item
), !CONSP (item
)))
8176 /* Create tool_bar_item_properties vector if necessary. Reset it to
8178 if (VECTORP (tool_bar_item_properties
))
8180 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8184 tool_bar_item_properties
8185 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8188 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8189 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8191 /* Get the caption of the item. If the caption is not a string,
8192 evaluate it to get a string. If we don't get a string, skip this
8194 caption
= XCAR (item
);
8195 if (!STRINGP (caption
))
8197 caption
= menu_item_eval_property (caption
);
8198 if (!STRINGP (caption
))
8201 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8203 /* If the rest following the caption is not a list, the menu item is
8204 either a separator, or invalid. */
8208 if (menu_separator_name_p (SSDATA (caption
)))
8210 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8211 #if !defined (USE_GTK) && !defined (HAVE_NS)
8212 /* If we use build_desired_tool_bar_string to render the
8213 tool bar, the separator is rendered as an image. */
8214 set_prop (TOOL_BAR_ITEM_IMAGES
,
8215 (menu_item_eval_property
8216 (Vtool_bar_separator_image_expression
)));
8217 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8218 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8219 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8226 /* Store the binding. */
8227 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8230 /* Ignore cached key binding, if any. */
8231 if (CONSP (item
) && CONSP (XCAR (item
)))
8234 /* Process the rest of the properties. */
8235 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8237 Lisp_Object ikey
, value
;
8240 value
= XCAR (XCDR (item
));
8242 if (EQ (ikey
, QCenable
))
8244 /* `:enable FORM'. */
8245 if (!NILP (Venable_disabled_menus_and_buttons
))
8246 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8248 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8250 else if (EQ (ikey
, QCvisible
))
8252 /* `:visible FORM'. If got a visible property and that
8253 evaluates to nil then ignore this item. */
8254 if (NILP (menu_item_eval_property (value
)))
8257 else if (EQ (ikey
, QChelp
))
8258 /* `:help HELP-STRING'. */
8259 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8260 else if (EQ (ikey
, QCvert_only
))
8261 /* `:vert-only t/nil'. */
8262 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8263 else if (EQ (ikey
, QClabel
))
8265 const char *bad_label
= "!!?GARBLED ITEM?!!";
8266 /* `:label LABEL-STRING'. */
8267 set_prop (TOOL_BAR_ITEM_LABEL
,
8268 STRINGP (value
) ? value
: build_string (bad_label
));
8271 else if (EQ (ikey
, QCfilter
))
8272 /* ':filter FORM'. */
8274 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8276 /* `:button (TYPE . SELECTED)'. */
8277 Lisp_Object type
, selected
;
8279 type
= XCAR (value
);
8280 selected
= XCDR (value
);
8281 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8283 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8284 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8287 else if (EQ (ikey
, QCimage
)
8289 || (VECTORP (value
) && ASIZE (value
) == 4)))
8290 /* Value is either a single image specification or a vector
8291 of 4 such specifications for the different button states. */
8292 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8293 else if (EQ (ikey
, QCrtl
))
8295 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8301 /* Try to make one from caption and key. */
8302 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8303 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8304 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8305 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8307 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8308 char *buf
= xmalloc_atomic (max_lbl
+ 1);
8309 Lisp_Object new_lbl
;
8310 ptrdiff_t caption_len
= strlen (capt
);
8312 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8315 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8317 buf
[caption_len
] = '\0';
8321 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8325 strcpy (buf
, label
);
8327 for (j
= 0; buf
[j
] != '\0'; ++j
)
8335 new_lbl
= Fupcase_initials (build_string (label
));
8336 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8337 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8339 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8343 /* If got a filter apply it on binding. */
8345 set_prop (TOOL_BAR_ITEM_BINDING
,
8346 (menu_item_eval_property
8349 PROP (TOOL_BAR_ITEM_BINDING
))))));
8351 /* See if the binding is a keymap. Give up if it is. */
8352 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8355 /* Enable or disable selection of item. */
8356 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8357 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8358 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8360 /* Handle radio buttons or toggle boxes. */
8361 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8362 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8363 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8371 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8372 that can be reused. */
8375 init_tool_bar_items (Lisp_Object reuse
)
8377 if (VECTORP (reuse
))
8378 tool_bar_items_vector
= reuse
;
8380 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8381 ntool_bar_items
= 0;
8385 /* Append parsed tool bar item properties from
8386 tool_bar_item_properties */
8389 append_tool_bar_item (void)
8393 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8395 /* Enlarge tool_bar_items_vector if necessary. */
8397 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8399 /* Append entries from tool_bar_item_properties to the end of
8400 tool_bar_items_vector. */
8401 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8402 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8403 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8410 /* Read a character using menus based on the keymap MAP.
8411 Return nil if there are no menus in the maps.
8412 Return t if we displayed a menu but the user rejected it.
8414 PREV_EVENT is the previous input event, or nil if we are reading
8415 the first event of a key sequence.
8417 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8418 if we used a mouse menu to read the input, or false otherwise. If
8419 USED_MOUSE_MENU is null, don't dereference it.
8421 The prompting is done based on the prompt-string of the map
8422 and the strings associated with various map elements.
8424 This can be done with X menus or with menus put in the minibuf.
8425 These are done in different ways, depending on how the input will be read.
8426 Menus using X are done after auto-saving in read-char, getting the input
8427 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8428 and do auto-saving in the inner call of read_char. */
8431 read_char_x_menu_prompt (Lisp_Object map
,
8432 Lisp_Object prev_event
, bool *used_mouse_menu
)
8434 if (used_mouse_menu
)
8435 *used_mouse_menu
= 0;
8437 /* Use local over global Menu maps. */
8439 if (! menu_prompting
)
8442 /* If we got to this point via a mouse click,
8443 use a real menu for mouse selection. */
8444 if (EVENT_HAS_PARAMETERS (prev_event
)
8445 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8446 && !EQ (XCAR (prev_event
), Qtool_bar
))
8448 /* Display the menu and get the selection. */
8451 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8456 record_menu_key (XCAR (value
));
8458 /* If we got multiple events, unread all but
8460 There is no way to prevent those unread events
8461 from showing up later in last_nonmenu_event.
8462 So turn symbol and integer events into lists,
8463 to indicate that they came from a mouse menu,
8464 so that when present in last_nonmenu_event
8465 they won't confuse things. */
8466 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8468 record_menu_key (XCAR (tem
));
8469 if (SYMBOLP (XCAR (tem
))
8470 || INTEGERP (XCAR (tem
)))
8471 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8474 /* If we got more than one event, put all but the first
8475 onto this list to be read later.
8476 Return just the first event now. */
8477 Vunread_command_events
8478 = nconc2 (XCDR (value
), Vunread_command_events
);
8479 value
= XCAR (value
);
8481 else if (NILP (value
))
8483 if (used_mouse_menu
)
8484 *used_mouse_menu
= 1;
8491 read_char_minibuf_menu_prompt (int commandflag
,
8494 register Lisp_Object name
;
8496 /* FIXME: Use the minibuffer's frame width. */
8497 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8499 bool nobindings
= 1;
8500 Lisp_Object rest
, vector
;
8501 Lisp_Object prompt_strings
= Qnil
;
8505 if (! menu_prompting
)
8508 map
= get_keymap (map
, 0, 1);
8509 name
= Fkeymap_prompt (map
);
8511 /* If we don't have any menus, just read a character normally. */
8512 if (!STRINGP (name
))
8515 #define PUSH_C_STR(str, listvar) \
8516 listvar = Fcons (build_unibyte_string (str), listvar)
8518 /* Prompt string always starts with map's prompt, and a space. */
8519 prompt_strings
= Fcons (name
, prompt_strings
);
8520 PUSH_C_STR (": ", prompt_strings
);
8521 nlength
= SCHARS (name
) + 2;
8525 /* Present the documented bindings, a line at a time. */
8529 Lisp_Object menu_strings
= prompt_strings
;
8530 ptrdiff_t i
= nlength
;
8532 Lisp_Object orig_defn_macro
;
8534 /* Loop over elements of map. */
8539 /* FIXME: Use map_keymap to handle new keymap formats. */
8541 /* At end of map, wrap around if just starting,
8542 or end this line if already have something on it. */
8545 if (notfirst
|| nobindings
)
8551 /* Look at the next element of the map. */
8553 elt
= AREF (vector
, idx
);
8555 elt
= Fcar_safe (rest
);
8557 if (idx
< 0 && VECTORP (elt
))
8559 /* If we found a dense table in the keymap,
8560 advanced past it, but start scanning its contents. */
8561 rest
= Fcdr_safe (rest
);
8567 /* An ordinary element. */
8568 Lisp_Object event
, tem
;
8572 event
= Fcar_safe (elt
); /* alist */
8573 elt
= Fcdr_safe (elt
);
8577 XSETINT (event
, idx
); /* vector */
8580 /* Ignore the element if it has no prompt string. */
8581 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8583 /* True if the char to type matches the string. */
8585 Lisp_Object upcased_event
, downcased_event
;
8586 Lisp_Object desc
= Qnil
;
8588 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8590 upcased_event
= Fupcase (event
);
8591 downcased_event
= Fdowncase (event
);
8592 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8593 || XINT (downcased_event
) == SREF (s
, 0));
8595 desc
= Fsingle_key_description (event
, Qnil
);
8597 #if 0 /* It is redundant to list the equivalent key bindings because
8598 the prefix is what the user has already typed. */
8600 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8602 /* Insert equivalent keybinding. */
8603 s
= concat2 (s
, tem
);
8606 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8607 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8609 /* Insert button prefix. */
8610 Lisp_Object selected
8611 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8612 if (EQ (tem
, QCradio
))
8613 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8615 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8616 s
= concat2 (tem
, s
);
8620 /* If we have room for the prompt string, add it to this line.
8621 If this is the first on the line, always add it. */
8622 if ((SCHARS (s
) + i
+ 2
8623 + (char_matches
? 0 : SCHARS (desc
) + 3))
8627 ptrdiff_t thiswidth
;
8629 /* Punctuate between strings. */
8632 PUSH_C_STR (", ", menu_strings
);
8638 /* If the char to type doesn't match the string's
8639 first char, explicitly show what char to type. */
8642 /* Add as much of string as fits. */
8643 thiswidth
= min (SCHARS (desc
), width
- i
);
8645 = Fcons (Fsubstring (desc
, make_number (0),
8646 make_number (thiswidth
)),
8649 PUSH_C_STR (" = ", menu_strings
);
8653 /* Add as much of string as fits. */
8654 thiswidth
= min (SCHARS (s
), width
- i
);
8656 = Fcons (Fsubstring (s
, make_number (0),
8657 make_number (thiswidth
)),
8663 /* If this element does not fit, end the line now,
8664 and save the element for the next line. */
8665 PUSH_C_STR ("...", menu_strings
);
8670 /* Move past this element. */
8671 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8672 /* Handle reaching end of dense table. */
8677 rest
= Fcdr_safe (rest
);
8681 /* Prompt with that and read response. */
8682 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8684 /* Make believe it's not a keyboard macro in case the help char
8685 is pressed. Help characters are not recorded because menu prompting
8686 is not used on replay. */
8687 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8688 kset_defining_kbd_macro (current_kboard
, Qnil
);
8690 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8691 while (BUFFERP (obj
));
8692 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8694 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8697 if (! EQ (obj
, menu_prompt_more_char
)
8698 && (!INTEGERP (menu_prompt_more_char
)
8699 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8701 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8702 store_kbd_macro_char (obj
);
8705 /* Help char - go round again. */
8709 /* Reading key sequences. */
8712 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8714 return access_keymap (get_keymap (keymap
, 0, 1),
8719 active_maps (Lisp_Object first_event
)
8721 Lisp_Object position
8722 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8723 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8726 /* Structure used to keep track of partial application of key remapping
8727 such as Vfunction_key_map and Vkey_translation_map. */
8728 typedef struct keyremap
8730 /* This is the map originally specified for this use. */
8732 /* This is a submap reached by looking up, in PARENT,
8733 the events from START to END. */
8735 /* Positions [START, END) in the key sequence buffer
8736 are the key that we have scanned so far.
8737 Those events are the ones that we will replace
8738 if PARENT maps them into a key sequence. */
8742 /* Lookup KEY in MAP.
8743 MAP is a keymap mapping keys to key vectors or functions.
8744 If the mapping is a function and DO_FUNCALL is true,
8745 the function is called with PROMPT as parameter and its return
8746 value is used as the return value of this function (after checking
8747 that it is indeed a vector). */
8750 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8755 next
= access_keymap (map
, key
, 1, 0, 1);
8757 /* Handle a symbol whose function definition is a keymap
8759 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8760 && (ARRAYP (XSYMBOL (next
)->function
)
8761 || KEYMAPP (XSYMBOL (next
)->function
)))
8762 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8764 /* If the keymap gives a function, not an
8765 array, then call the function with one arg and use
8766 its value instead. */
8767 if (do_funcall
&& FUNCTIONP (next
))
8772 next
= call1 (next
, prompt
);
8773 /* If the function returned something invalid,
8774 barf--don't ignore it.
8775 (To ignore it safely, we would need to gcpro a bunch of
8776 other variables.) */
8777 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8778 error ("Function %s returns invalid key sequence",
8779 SSDATA (SYMBOL_NAME (tem
)));
8784 /* Do one step of the key remapping used for function-key-map and
8785 key-translation-map:
8786 KEYBUF is the buffer holding the input events.
8787 BUFSIZE is its maximum size.
8788 FKEY is a pointer to the keyremap structure to use.
8789 INPUT is the index of the last element in KEYBUF.
8790 DOIT if true says that the remapping can actually take place.
8791 DIFF is used to return the number of keys added/removed by the remapping.
8792 PARENT is the root of the keymap.
8793 PROMPT is the prompt to use if the remapping happens through a function.
8794 Return true if the remapping actually took place. */
8797 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8798 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8800 Lisp_Object next
, key
;
8802 key
= keybuf
[fkey
->end
++];
8804 if (KEYMAPP (fkey
->parent
))
8805 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8809 /* If keybuf[fkey->start..fkey->end] is bound in the
8810 map and we're in a position to do the key remapping, replace it with
8811 the binding and restart with fkey->start at the end. */
8812 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8814 int len
= XFASTINT (Flength (next
));
8817 *diff
= len
- (fkey
->end
- fkey
->start
);
8819 if (bufsize
- input
<= *diff
)
8820 error ("Key sequence too long");
8822 /* Shift the keys that follow fkey->end. */
8824 for (i
= fkey
->end
; i
< input
; i
++)
8825 keybuf
[i
+ *diff
] = keybuf
[i
];
8827 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8828 keybuf
[i
+ *diff
] = keybuf
[i
];
8829 /* Overwrite the old keys with the new ones. */
8830 for (i
= 0; i
< len
; i
++)
8831 keybuf
[fkey
->start
+ i
]
8832 = Faref (next
, make_number (i
));
8834 fkey
->start
= fkey
->end
+= *diff
;
8835 fkey
->map
= fkey
->parent
;
8840 fkey
->map
= get_keymap (next
, 0, 1);
8842 /* If we no longer have a bound suffix, try a new position for
8844 if (!CONSP (fkey
->map
))
8846 fkey
->end
= ++fkey
->start
;
8847 fkey
->map
= fkey
->parent
;
8853 test_undefined (Lisp_Object binding
)
8855 return (NILP (binding
)
8856 || EQ (binding
, Qundefined
)
8857 || (SYMBOLP (binding
)
8858 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8861 /* Read a sequence of keys that ends with a non prefix character,
8862 storing it in KEYBUF, a buffer of size BUFSIZE.
8864 Return the length of the key sequence stored.
8865 Return -1 if the user rejected a command menu.
8867 Echo starting immediately unless `prompt' is 0.
8869 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8870 read_char with a suitable COMMANDFLAG argument.
8872 Where a key sequence ends depends on the currently active keymaps.
8873 These include any minor mode keymaps active in the current buffer,
8874 the current buffer's local map, and the global map.
8876 If a key sequence has no other bindings, we check Vfunction_key_map
8877 to see if some trailing subsequence might be the beginning of a
8878 function key's sequence. If so, we try to read the whole function
8879 key, and substitute its symbolic name into the key sequence.
8881 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8882 `double-' events into similar click events, if that would make them
8883 bound. We try to turn `triple-' events first into `double-' events,
8886 If we get a mouse click in a mode line, vertical divider, or other
8887 non-text area, we treat the click as if it were prefixed by the
8888 symbol denoting that area - `mode-line', `vertical-line', or
8891 If the sequence starts with a mouse click, we read the key sequence
8892 with respect to the buffer clicked on, not the current buffer.
8894 If the user switches frames in the midst of a key sequence, we put
8895 off the switch-frame event until later; the next call to
8896 read_char will return it.
8898 If FIX_CURRENT_BUFFER, we restore current_buffer
8899 from the selected window's buffer. */
8902 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8903 bool dont_downcase_last
, bool can_return_switch_frame
,
8904 bool fix_current_buffer
, bool prevent_redisplay
)
8906 /* How many keys there are in the current key sequence. */
8909 /* The length of the echo buffer when we started reading, and
8910 the length of this_command_keys when we started reading. */
8911 ptrdiff_t echo_start
IF_LINT (= 0);
8912 ptrdiff_t keys_start
;
8914 Lisp_Object current_binding
= Qnil
;
8915 Lisp_Object first_event
= Qnil
;
8917 /* Index of the first key that has no binding.
8918 It is useless to try fkey.start larger than that. */
8921 /* If t < mock_input, then KEYBUF[t] should be read as the next
8924 We use this to recover after recognizing a function key. Once we
8925 realize that a suffix of the current key sequence is actually a
8926 function key's escape sequence, we replace the suffix with the
8927 function key's binding from Vfunction_key_map. Now keybuf
8928 contains a new and different key sequence, so the echo area,
8929 this_command_keys, and the submaps and defs arrays are wrong. In
8930 this situation, we set mock_input to t, set t to 0, and jump to
8931 restart_sequence; the loop will read keys from keybuf up until
8932 mock_input, thus rebuilding the state; and then it will resume
8933 reading characters from the keyboard. */
8936 /* If the sequence is unbound in submaps[], then
8937 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8938 and fkey.map is its binding.
8940 These might be > t, indicating that all function key scanning
8941 should hold off until t reaches them. We do this when we've just
8942 recognized a function key, to avoid searching for the function
8943 key's again in Vfunction_key_map. */
8946 /* Likewise, for key_translation_map and input-decode-map. */
8947 keyremap keytran
, indec
;
8949 /* True if we are trying to map a key by changing an upper-case
8950 letter to lower case, or a shifted function key to an unshifted
8952 bool shift_translated
= 0;
8954 /* If we receive a `switch-frame' or `select-window' event in the middle of
8955 a key sequence, we put it off for later.
8956 While we're reading, we keep the event here. */
8957 Lisp_Object delayed_switch_frame
;
8959 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8960 int original_uppercase_position
= -1;
8962 /* Gets around Microsoft compiler limitations. */
8965 struct buffer
*starting_buffer
;
8967 /* List of events for which a fake prefix key has been generated. */
8968 Lisp_Object fake_prefixed_keys
= Qnil
;
8970 struct gcpro gcpro1
;
8974 GCPRO1 (fake_prefixed_keys
);
8975 raw_keybuf_count
= 0;
8977 last_nonmenu_event
= Qnil
;
8979 delayed_switch_frame
= Qnil
;
8985 /* Install the string PROMPT as the beginning of the string
8986 of echoing, so that it serves as a prompt for the next
8988 kset_echo_string (current_kboard
, prompt
);
8989 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8992 else if (cursor_in_echo_area
8993 && echo_keystrokes_p ())
8994 /* This doesn't put in a dash if the echo buffer is empty, so
8995 you don't always see a dash hanging out in the minibuffer. */
8999 /* Record the initial state of the echo area and this_command_keys;
9000 we will need to restore them if we replay a key sequence. */
9002 echo_start
= echo_length ();
9003 keys_start
= this_command_key_count
;
9004 this_single_command_key_start
= keys_start
;
9006 /* We jump here when we need to reinitialize fkey and keytran; this
9007 happens if we switch keyboards between rescans. */
9008 replay_entire_sequence
:
9010 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9011 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9012 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9013 indec
.start
= indec
.end
= 0;
9014 fkey
.start
= fkey
.end
= 0;
9015 keytran
.start
= keytran
.end
= 0;
9017 /* We jump here when the key sequence has been thoroughly changed, and
9018 we need to rescan it starting from the beginning. When we jump here,
9019 keybuf[0..mock_input] holds the sequence we should reread. */
9022 starting_buffer
= current_buffer
;
9023 first_unbound
= bufsize
+ 1;
9025 /* Build our list of keymaps.
9026 If we recognize a function key and replace its escape sequence in
9027 keybuf with its symbol, or if the sequence starts with a mouse
9028 click and we need to switch buffers, we jump back here to rebuild
9029 the initial keymaps from the current buffer. */
9030 current_binding
= active_maps (first_event
);
9032 /* Start from the beginning in keybuf. */
9035 /* These are no-ops the first time through, but if we restart, they
9036 revert the echo area and this_command_keys to their original state. */
9037 this_command_key_count
= keys_start
;
9038 if (INTERACTIVE
&& t
< mock_input
)
9039 echo_truncate (echo_start
);
9041 /* If the best binding for the current key sequence is a keymap, or
9042 we may be looking at a function key's escape sequence, keep on
9044 while (!NILP (current_binding
)
9045 /* Keep reading as long as there's a prefix binding. */
9046 ? KEYMAPP (current_binding
)
9047 /* Don't return in the middle of a possible function key sequence,
9048 if the only bindings we found were via case conversion.
9049 Thus, if ESC O a has a function-key-map translation
9050 and ESC o has a binding, don't return after ESC O,
9051 so that we can translate ESC O plus the next character. */
9052 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9055 bool used_mouse_menu
= 0;
9057 /* Where the last real key started. If we need to throw away a
9058 key that has expanded into more than one element of keybuf
9059 (say, a mouse click on the mode line which is being treated
9060 as [mode-line (mouse-...)], then we backtrack to this point
9062 int last_real_key_start
;
9064 /* These variables are analogous to echo_start and keys_start;
9065 while those allow us to restart the entire key sequence,
9066 echo_local_start and keys_local_start allow us to throw away
9068 ptrdiff_t echo_local_start
IF_LINT (= 0);
9069 int keys_local_start
;
9070 Lisp_Object new_binding
;
9072 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9073 eassert (indec
.start
<= indec
.end
);
9074 eassert (fkey
.start
<= fkey
.end
);
9075 eassert (keytran
.start
<= keytran
.end
);
9076 /* key-translation-map is applied *after* function-key-map
9077 which is itself applied *after* input-decode-map. */
9078 eassert (fkey
.end
<= indec
.start
);
9079 eassert (keytran
.end
<= fkey
.start
);
9081 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9082 first_unbound
< keytran
.start
)
9083 { /* The prefix upto first_unbound has no binding and has
9084 no translation left to do either, so we know it's unbound.
9085 If we don't stop now, we risk staying here indefinitely
9086 (if the user keeps entering fkey or keytran prefixes
9087 like C-c ESC ESC ESC ESC ...) */
9089 for (i
= first_unbound
+ 1; i
< t
; i
++)
9090 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9091 mock_input
= t
- first_unbound
- 1;
9092 indec
.end
= indec
.start
-= first_unbound
+ 1;
9093 indec
.map
= indec
.parent
;
9094 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9095 fkey
.map
= fkey
.parent
;
9096 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9097 keytran
.map
= keytran
.parent
;
9098 goto replay_sequence
;
9102 error ("Key sequence too long");
9105 echo_local_start
= echo_length ();
9106 keys_local_start
= this_command_key_count
;
9109 /* These are no-ops, unless we throw away a keystroke below and
9110 jumped back up to replay_key; in that case, these restore the
9111 variables to their original state, allowing us to replay the
9113 if (INTERACTIVE
&& t
< mock_input
)
9114 echo_truncate (echo_local_start
);
9115 this_command_key_count
= keys_local_start
;
9117 /* By default, assume each event is "real". */
9118 last_real_key_start
= t
;
9120 /* Does mock_input indicate that we are re-reading a key sequence? */
9124 add_command_key (key
);
9125 if (echo_keystrokes_p ()
9126 && current_kboard
->immediate_echo
)
9133 /* If not, we should actually read a character. */
9137 KBOARD
*interrupted_kboard
= current_kboard
;
9138 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9139 /* Calling read_char with COMMANDFLAG = -2 avoids
9140 redisplay in read_char and its subroutines. */
9141 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9142 current_binding
, last_nonmenu_event
,
9143 &used_mouse_menu
, NULL
);
9144 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9145 /* When switching to a new tty (with a new keyboard),
9146 read_char returns the new buffer, rather than -2
9147 (Bug#5095). This is because `terminal-init-xterm'
9148 calls read-char, which eats the wrong_kboard_jmpbuf
9149 return. Any better way to fix this? -- cyd */
9150 || (interrupted_kboard
!= current_kboard
))
9155 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9156 if (k
== interrupted_kboard
)
9161 /* Don't touch interrupted_kboard when it's been
9163 delayed_switch_frame
= Qnil
;
9164 goto replay_entire_sequence
;
9167 if (!NILP (delayed_switch_frame
))
9170 (interrupted_kboard
,
9171 Fcons (delayed_switch_frame
,
9172 KVAR (interrupted_kboard
, kbd_queue
)));
9173 delayed_switch_frame
= Qnil
;
9178 (interrupted_kboard
,
9179 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9181 /* If the side queue is non-empty, ensure it begins with a
9182 switch-frame, so we'll replay it in the right context. */
9183 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9184 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9185 !(EVENT_HAS_PARAMETERS (key
)
9186 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9190 XSETFRAME (frame
, interrupted_frame
);
9192 (interrupted_kboard
,
9193 Fcons (make_lispy_switch_frame (frame
),
9194 KVAR (interrupted_kboard
, kbd_queue
)));
9197 goto replay_entire_sequence
;
9201 /* read_char returns t when it shows a menu and the user rejects it.
9210 /* read_char returns -1 at the end of a macro.
9211 Emacs 18 handles this by returning immediately with a
9212 zero, so that's what we'll do. */
9213 if (INTEGERP (key
) && XINT (key
) == -1)
9216 /* The Microsoft C compiler can't handle the goto that
9222 /* If the current buffer has been changed from under us, the
9223 keymap may have changed, so replay the sequence. */
9226 timer_resume_idle ();
9229 /* Reset the current buffer from the selected window
9230 in case something changed the former and not the latter.
9231 This is to be more consistent with the behavior
9232 of the command_loop_1. */
9233 if (fix_current_buffer
)
9235 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9237 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9239 Fset_buffer (XWINDOW (selected_window
)->contents
);
9242 goto replay_sequence
;
9245 /* If we have a quit that was typed in another frame, and
9246 quit_throw_to_read_char switched buffers,
9247 replay to get the right keymap. */
9249 && XINT (key
) == quit_char
9250 && current_buffer
!= starting_buffer
)
9253 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9258 goto replay_sequence
;
9263 if (EVENT_HAS_PARAMETERS (key
)
9264 /* Either a `switch-frame' or a `select-window' event. */
9265 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9267 /* If we're at the beginning of a key sequence, and the caller
9268 says it's okay, go ahead and return this event. If we're
9269 in the midst of a key sequence, delay it until the end. */
9270 if (t
> 0 || !can_return_switch_frame
)
9272 delayed_switch_frame
= key
;
9277 if (NILP (first_event
))
9280 /* Even if first_event does not specify a particular
9281 window/position, it's important to recompute the maps here
9282 since a long time might have passed since we entered
9283 read_key_sequence, and a timer (or process-filter or
9284 special-event-map, ...) might have switched the current buffer
9285 or the selected window from under us in the mean time. */
9286 if (fix_current_buffer
9287 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9289 Fset_buffer (XWINDOW (selected_window
)->contents
);
9290 current_binding
= active_maps (first_event
);
9294 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9298 /* Clicks in non-text areas get prefixed by the symbol
9299 in their CHAR-ADDRESS field. For example, a click on
9300 the mode line is prefixed by the symbol `mode-line'.
9302 Furthermore, key sequences beginning with mouse clicks
9303 are read using the keymaps of the buffer clicked on, not
9304 the current buffer. So we may have to switch the buffer
9307 When we turn one event into two events, we must make sure
9308 that neither of the two looks like the original--so that,
9309 if we replay the events, they won't be expanded again.
9310 If not for this, such reexpansion could happen either here
9311 or when user programs play with this-command-keys. */
9312 if (EVENT_HAS_PARAMETERS (key
))
9314 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9315 if (EQ (kind
, Qmouse_click
))
9317 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9318 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9321 || (!NILP (fake_prefixed_keys
)
9322 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9324 /* We're looking a second time at an event for which
9325 we generated a fake prefix key. Set
9326 last_real_key_start appropriately. */
9328 last_real_key_start
= t
- 1;
9331 if (last_real_key_start
== 0)
9333 /* Key sequences beginning with mouse clicks are
9334 read using the keymaps in the buffer clicked on,
9335 not the current buffer. If we're at the
9336 beginning of a key sequence, switch buffers. */
9337 if (WINDOWP (window
)
9338 && BUFFERP (XWINDOW (window
)->contents
)
9339 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9341 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9346 /* Arrange to go back to the original buffer once we're
9347 done reading the key sequence. Note that we can't
9348 use save_excursion_{save,restore} here, because they
9349 save point as well as the current buffer; we don't
9350 want to save point, because redisplay may change it,
9351 to accommodate a Fset_window_start or something. We
9352 don't want to do this at the top of the function,
9353 because we may get input from a subprocess which
9354 wants to change the selected window and stuff (say,
9356 record_unwind_current_buffer ();
9358 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9360 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9361 goto replay_sequence
;
9365 /* Expand mode-line and scroll-bar events into two events:
9366 use posn as a fake prefix key. */
9368 && (NILP (fake_prefixed_keys
)
9369 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9371 if (bufsize
- t
<= 1)
9372 error ("Key sequence too long");
9375 keybuf
[t
+ 1] = key
;
9378 /* Record that a fake prefix key has been generated
9379 for KEY. Don't modify the event; this would
9380 prevent proper action when the event is pushed
9381 back into unread-command-events. */
9382 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9386 else if (CONSP (XCDR (key
))
9387 && CONSP (EVENT_START (key
))
9388 && CONSP (XCDR (EVENT_START (key
))))
9392 posn
= POSN_POSN (EVENT_START (key
));
9393 /* Handle menu-bar events:
9394 insert the dummy prefix event `menu-bar'. */
9395 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9397 if (bufsize
- t
<= 1)
9398 error ("Key sequence too long");
9400 keybuf
[t
+ 1] = key
;
9402 /* Zap the position in key, so we know that we've
9403 expanded it, and don't try to do so again. */
9404 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9407 goto replay_sequence
;
9409 else if (CONSP (posn
))
9411 /* We're looking at the second event of a
9412 sequence which we expanded before. Set
9413 last_real_key_start appropriately. */
9414 if (last_real_key_start
== t
&& t
> 0)
9415 last_real_key_start
= t
- 1;
9420 /* We have finally decided that KEY is something we might want
9422 new_binding
= follow_key (current_binding
, key
);
9424 /* If KEY wasn't bound, we'll try some fallbacks. */
9425 if (!NILP (new_binding
))
9426 /* This is needed for the following scenario:
9427 event 0: a down-event that gets dropped by calling replay_key.
9428 event 1: some normal prefix like C-h.
9429 After event 0, first_unbound is 0, after event 1 indec.start,
9430 fkey.start, and keytran.start are all 1, so when we see that
9431 C-h is bound, we need to update first_unbound. */
9432 first_unbound
= max (t
+ 1, first_unbound
);
9437 /* Remember the position to put an upper bound on indec.start. */
9438 first_unbound
= min (t
, first_unbound
);
9440 head
= EVENT_HEAD (key
);
9444 Lisp_Object breakdown
;
9447 breakdown
= parse_modifiers (head
);
9448 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9449 /* Attempt to reduce an unbound mouse event to a simpler
9450 event that is bound:
9451 Drags reduce to clicks.
9452 Double-clicks reduce to clicks.
9453 Triple-clicks reduce to double-clicks, then to clicks.
9454 Down-clicks are eliminated.
9455 Double-downs reduce to downs, then are eliminated.
9456 Triple-downs reduce to double-downs, then to downs,
9457 then are eliminated. */
9458 if (modifiers
& (down_modifier
| drag_modifier
9459 | double_modifier
| triple_modifier
))
9461 while (modifiers
& (down_modifier
| drag_modifier
9462 | double_modifier
| triple_modifier
))
9464 Lisp_Object new_head
, new_click
;
9465 if (modifiers
& triple_modifier
)
9466 modifiers
^= (double_modifier
| triple_modifier
);
9467 else if (modifiers
& double_modifier
)
9468 modifiers
&= ~double_modifier
;
9469 else if (modifiers
& drag_modifier
)
9470 modifiers
&= ~drag_modifier
;
9473 /* Dispose of this `down' event by simply jumping
9474 back to replay_key, to get another event.
9476 Note that if this event came from mock input,
9477 then just jumping back to replay_key will just
9478 hand it to us again. So we have to wipe out any
9481 We could delete keybuf[t] and shift everything
9482 after that to the left by one spot, but we'd also
9483 have to fix up any variable that points into
9484 keybuf, and shifting isn't really necessary
9487 Adding prefixes for non-textual mouse clicks
9488 creates two characters of mock input, and both
9489 must be thrown away. If we're only looking at
9490 the prefix now, we can just jump back to
9491 replay_key. On the other hand, if we've already
9492 processed the prefix, and now the actual click
9493 itself is giving us trouble, then we've lost the
9494 state of the keymaps we want to backtrack to, and
9495 we need to replay the whole sequence to rebuild
9498 Beyond that, only function key expansion could
9499 create more than two keys, but that should never
9500 generate mouse events, so it's okay to zero
9501 mock_input in that case too.
9503 FIXME: The above paragraph seems just plain
9504 wrong, if you consider things like
9505 xterm-mouse-mode. -stef
9507 Isn't this just the most wonderful code ever? */
9509 /* If mock_input > t + 1, the above simplification
9510 will actually end up dropping keys on the floor.
9511 This is probably OK for now, but even
9512 if mock_input <= t + 1, we need to adjust indec,
9514 Typical case [header-line down-mouse-N]:
9515 mock_input = 2, t = 1, fkey.end = 1,
9516 last_real_key_start = 0. */
9517 if (indec
.end
> last_real_key_start
)
9519 indec
.end
= indec
.start
9520 = min (last_real_key_start
, indec
.start
);
9521 indec
.map
= indec
.parent
;
9522 if (fkey
.end
> last_real_key_start
)
9524 fkey
.end
= fkey
.start
9525 = min (last_real_key_start
, fkey
.start
);
9526 fkey
.map
= fkey
.parent
;
9527 if (keytran
.end
> last_real_key_start
)
9529 keytran
.end
= keytran
.start
9530 = min (last_real_key_start
, keytran
.start
);
9531 keytran
.map
= keytran
.parent
;
9535 if (t
== last_real_key_start
)
9542 mock_input
= last_real_key_start
;
9543 goto replay_sequence
;
9548 = apply_modifiers (modifiers
, XCAR (breakdown
));
9549 new_click
= list2 (new_head
, EVENT_START (key
));
9551 /* Look for a binding for this new key. */
9552 new_binding
= follow_key (current_binding
, new_click
);
9554 /* If that click is bound, go for it. */
9555 if (!NILP (new_binding
))
9557 current_binding
= new_binding
;
9561 /* Otherwise, we'll leave key set to the drag event. */
9566 current_binding
= new_binding
;
9569 /* Normally, last_nonmenu_event gets the previous key we read.
9570 But when a mouse popup menu is being used,
9571 we don't update last_nonmenu_event; it continues to hold the mouse
9572 event that preceded the first level of menu. */
9573 if (!used_mouse_menu
)
9574 last_nonmenu_event
= key
;
9576 /* Record what part of this_command_keys is the current key sequence. */
9577 this_single_command_key_start
= this_command_key_count
- t
;
9579 /* Look for this sequence in input-decode-map.
9580 Scan from indec.end until we find a bound suffix. */
9581 while (indec
.end
< t
)
9583 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9587 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9588 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9593 mock_input
= diff
+ max (t
, mock_input
);
9594 goto replay_sequence
;
9598 if (!KEYMAPP (current_binding
)
9599 && !test_undefined (current_binding
)
9600 && indec
.start
>= t
)
9601 /* There is a binding and it's not a prefix.
9602 (and it doesn't have any input-decode-map translation pending).
9603 There is thus no function-key in this sequence.
9604 Moving fkey.start is important in this case to allow keytran.start
9605 to go over the sequence before we return (since we keep the
9606 invariant that keytran.end <= fkey.start). */
9609 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9612 /* If the sequence is unbound, see if we can hang a function key
9613 off the end of it. */
9614 /* Continue scan from fkey.end until we find a bound suffix. */
9615 while (fkey
.end
< indec
.start
)
9617 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9621 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9622 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9623 max (t
, mock_input
),
9624 /* If there's a binding (i.e.
9625 first_binding >= nmaps) we don't want
9626 to apply this function-key-mapping. */
9628 && (test_undefined (current_binding
)),
9633 mock_input
= diff
+ max (t
, mock_input
);
9634 /* Adjust the input-decode-map counters. */
9636 indec
.start
+= diff
;
9638 goto replay_sequence
;
9642 /* Look for this sequence in key-translation-map.
9643 Scan from keytran.end until we find a bound suffix. */
9644 while (keytran
.end
< fkey
.start
)
9646 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9650 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9651 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9656 mock_input
= diff
+ max (t
, mock_input
);
9657 /* Adjust the function-key-map and input-decode-map counters. */
9659 indec
.start
+= diff
;
9663 goto replay_sequence
;
9667 /* If KEY is not defined in any of the keymaps,
9668 and cannot be part of a function key or translation,
9669 and is an upper case letter
9670 use the corresponding lower-case letter instead. */
9671 if (NILP (current_binding
)
9672 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9674 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9675 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9676 || (XINT (key
) & shift_modifier
)))
9678 Lisp_Object new_key
;
9680 original_uppercase
= key
;
9681 original_uppercase_position
= t
- 1;
9683 if (XINT (key
) & shift_modifier
)
9684 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9686 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9687 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9689 /* We have to do this unconditionally, regardless of whether
9690 the lower-case char is defined in the keymaps, because they
9691 might get translated through function-key-map. */
9692 keybuf
[t
- 1] = new_key
;
9693 mock_input
= max (t
, mock_input
);
9694 shift_translated
= 1;
9696 goto replay_sequence
;
9699 if (NILP (current_binding
)
9700 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9702 read_key_sequence_cmd
= Vprefix_help_command
;
9703 /* The Microsoft C compiler can't handle the goto that
9709 /* If KEY is not defined in any of the keymaps,
9710 and cannot be part of a function key or translation,
9711 and is a shifted function key,
9712 use the corresponding unshifted function key instead. */
9713 if (NILP (current_binding
)
9714 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9716 Lisp_Object breakdown
= parse_modifiers (key
);
9718 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9720 if (modifiers
& shift_modifier
9721 /* Treat uppercase keys as shifted. */
9723 && (KEY_TO_CHAR (key
)
9724 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9725 && uppercasep (KEY_TO_CHAR (key
))))
9728 = (modifiers
& shift_modifier
9729 ? apply_modifiers (modifiers
& ~shift_modifier
,
9731 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9733 original_uppercase
= key
;
9734 original_uppercase_position
= t
- 1;
9736 /* We have to do this unconditionally, regardless of whether
9737 the lower-case char is defined in the keymaps, because they
9738 might get translated through function-key-map. */
9739 keybuf
[t
- 1] = new_key
;
9740 mock_input
= max (t
, mock_input
);
9741 /* Reset fkey (and consequently keytran) to apply
9742 function-key-map on the result, so that S-backspace is
9743 correctly mapped to DEL (via backspace). OTOH,
9744 input-decode-map doesn't need to go through it again. */
9745 fkey
.start
= fkey
.end
= 0;
9746 keytran
.start
= keytran
.end
= 0;
9747 shift_translated
= 1;
9749 goto replay_sequence
;
9754 read_key_sequence_cmd
= current_binding
;
9755 read_key_sequence_remapped
9756 /* Remap command through active keymaps.
9757 Do the remapping here, before the unbind_to so it uses the keymaps
9758 of the appropriate buffer. */
9759 = SYMBOLP (read_key_sequence_cmd
)
9760 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9763 unread_switch_frame
= delayed_switch_frame
;
9766 /* Don't downcase the last character if the caller says don't.
9767 Don't downcase it if the result is undefined, either. */
9768 if ((dont_downcase_last
|| NILP (current_binding
))
9770 && t
- 1 == original_uppercase_position
)
9772 keybuf
[t
- 1] = original_uppercase
;
9773 shift_translated
= 0;
9776 if (shift_translated
)
9777 Vthis_command_keys_shift_translated
= Qt
;
9779 /* Occasionally we fabricate events, perhaps by expanding something
9780 according to function-key-map, or by adding a prefix symbol to a
9781 mouse click in the scroll bar or modeline. In this cases, return
9782 the entire generated key sequence, even if we hit an unbound
9783 prefix or a definition before the end. This means that you will
9784 be able to push back the event properly, and also means that
9785 read-key-sequence will always return a logical unit.
9788 for (; t
< mock_input
; t
++)
9790 if (echo_keystrokes_p ())
9791 echo_char (keybuf
[t
]);
9792 add_command_key (keybuf
[t
]);
9800 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9801 Lisp_Object dont_downcase_last
,
9802 Lisp_Object can_return_switch_frame
,
9803 Lisp_Object cmd_loop
, bool allow_string
)
9805 Lisp_Object keybuf
[30];
9807 struct gcpro gcpro1
;
9808 ptrdiff_t count
= SPECPDL_INDEX ();
9811 CHECK_STRING (prompt
);
9814 specbind (Qinput_method_exit_on_first_char
,
9815 (NILP (cmd_loop
) ? Qt
: Qnil
));
9816 specbind (Qinput_method_use_echo_area
,
9817 (NILP (cmd_loop
) ? Qt
: Qnil
));
9819 memset (keybuf
, 0, sizeof keybuf
);
9821 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9823 if (NILP (continue_echo
))
9825 this_command_key_count
= 0;
9826 this_command_key_count_reset
= 0;
9827 this_single_command_key_start
= 0;
9830 #ifdef HAVE_WINDOW_SYSTEM
9831 if (display_hourglass_p
)
9832 cancel_hourglass ();
9835 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9836 prompt
, ! NILP (dont_downcase_last
),
9837 ! NILP (can_return_switch_frame
), 0, 0);
9839 #if 0 /* The following is fine for code reading a key sequence and
9840 then proceeding with a lengthy computation, but it's not good
9841 for code reading keys in a loop, like an input method. */
9842 #ifdef HAVE_WINDOW_SYSTEM
9843 if (display_hourglass_p
)
9854 return unbind_to (count
,
9855 ((allow_string
? make_event_array
: Fvector
)
9859 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9860 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9861 The sequence is sufficient to specify a non-prefix command in the
9862 current local and global maps.
9864 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9865 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9866 as a continuation of the previous key.
9868 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9869 convert the last event to lower case. (Normally any upper case event
9870 is converted to lower case if the original event is undefined and the lower
9871 case equivalent is defined.) A non-nil value is appropriate for reading
9872 a key sequence to be defined.
9874 A C-g typed while in this function is treated like any other character,
9875 and `quit-flag' is not set.
9877 If the key sequence starts with a mouse click, then the sequence is read
9878 using the keymaps of the buffer of the window clicked in, not the buffer
9879 of the selected window as normal.
9881 `read-key-sequence' drops unbound button-down events, since you normally
9882 only care about the click or drag events which follow them. If a drag
9883 or multi-click event is unbound, but the corresponding click event would
9884 be bound, `read-key-sequence' turns the event into a click event at the
9885 drag's starting position. This means that you don't have to distinguish
9886 between click and drag, double, or triple events unless you want to.
9888 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9889 lines separating windows, and scroll bars with imaginary keys
9890 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9892 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9893 function will process a switch-frame event if the user switches frames
9894 before typing anything. If the user switches frames in the middle of a
9895 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9896 is nil, then the event will be put off until after the current key sequence.
9898 `read-key-sequence' checks `function-key-map' for function key
9899 sequences, where they wouldn't conflict with ordinary bindings. See
9900 `function-key-map' for more details.
9902 The optional fifth argument CMD-LOOP, if non-nil, means
9903 that this key sequence is being read by something that will
9904 read commands one after another. It should be nil if the caller
9905 will read just one key sequence. */)
9906 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9908 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9909 can_return_switch_frame
, cmd_loop
, true);
9912 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9913 Sread_key_sequence_vector
, 1, 5, 0,
9914 doc
: /* Like `read-key-sequence' but always return a vector. */)
9915 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9917 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9918 can_return_switch_frame
, cmd_loop
, false);
9921 /* Return true if input events are pending. */
9924 detect_input_pending (void)
9926 return input_pending
|| get_input_pending (0);
9929 /* Return true if input events other than mouse movements are
9933 detect_input_pending_ignore_squeezables (void)
9935 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9938 /* Return true if input events are pending, and run any pending timers. */
9941 detect_input_pending_run_timers (bool do_display
)
9943 unsigned old_timers_run
= timers_run
;
9946 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9948 if (old_timers_run
!= timers_run
&& do_display
)
9949 redisplay_preserve_echo_area (8);
9951 return input_pending
;
9954 /* This is called in some cases before a possible quit.
9955 It cases the next call to detect_input_pending to recompute input_pending.
9956 So calling this function unnecessarily can't do any harm. */
9959 clear_input_pending (void)
9964 /* Return true if there are pending requeued events.
9965 This isn't used yet. The hope is to make wait_reading_process_output
9966 call it, and return if it runs Lisp code that unreads something.
9967 The problem is, kbd_buffer_get_event needs to be fixed to know what
9968 to do in that case. It isn't trivial. */
9971 requeued_events_pending_p (void)
9973 return (!NILP (Vunread_command_events
));
9976 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9977 doc
: /* Return t if command input is currently available with no wait.
9978 Actually, the value is nil only if we can be sure that no input is available;
9979 if there is a doubt, the value is t.
9981 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9982 (Lisp_Object check_timers
)
9984 if (!NILP (Vunread_command_events
)
9985 || !NILP (Vunread_post_input_method_events
)
9986 || !NILP (Vunread_input_method_events
))
9989 /* Process non-user-visible events (Bug#10195). */
9990 process_special_events ();
9992 return (get_input_pending ((NILP (check_timers
)
9993 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9994 | READABLE_EVENTS_FILTER_EVENTS
)
9998 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9999 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10002 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10005 if (total_keys
< NUM_RECENT_KEYS
)
10006 return Fvector (total_keys
, keys
);
10009 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10010 vcopy (val
, 0, keys
+ recent_keys_index
,
10011 NUM_RECENT_KEYS
- recent_keys_index
);
10012 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10013 keys
, recent_keys_index
);
10018 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10019 doc
: /* Return the key sequence that invoked this command.
10020 However, if the command has called `read-key-sequence', it returns
10021 the last key sequence that has been read.
10022 The value is a string or a vector.
10024 See also `this-command-keys-vector'. */)
10027 return make_event_array (this_command_key_count
,
10028 XVECTOR (this_command_keys
)->contents
);
10031 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10032 doc
: /* Return the key sequence that invoked this command, as a vector.
10033 However, if the command has called `read-key-sequence', it returns
10034 the last key sequence that has been read.
10036 See also `this-command-keys'. */)
10039 return Fvector (this_command_key_count
,
10040 XVECTOR (this_command_keys
)->contents
);
10043 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10044 Sthis_single_command_keys
, 0, 0, 0,
10045 doc
: /* Return the key sequence that invoked this command.
10046 More generally, it returns the last key sequence read, either by
10047 the command loop or by `read-key-sequence'.
10048 Unlike `this-command-keys', this function's value
10049 does not include prefix arguments.
10050 The value is always a vector. */)
10053 return Fvector (this_command_key_count
10054 - this_single_command_key_start
,
10055 (XVECTOR (this_command_keys
)->contents
10056 + this_single_command_key_start
));
10059 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10060 Sthis_single_command_raw_keys
, 0, 0, 0,
10061 doc
: /* Return the raw events that were read for this command.
10062 More generally, it returns the last key sequence read, either by
10063 the command loop or by `read-key-sequence'.
10064 Unlike `this-single-command-keys', this function's value
10065 shows the events before all translations (except for input methods).
10066 The value is always a vector. */)
10069 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10072 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10073 Sreset_this_command_lengths
, 0, 0, 0,
10074 doc
: /* Make the unread events replace the last command and echo.
10075 Used in `universal-argument-other-key'.
10077 `universal-argument-other-key' rereads the event just typed.
10078 It then gets translated through `function-key-map'.
10079 The translated event has to replace the real events,
10080 both in the value of (this-command-keys) and in echoing.
10081 To achieve this, `universal-argument-other-key' calls
10082 `reset-this-command-lengths', which discards the record of reading
10083 these events the first time. */)
10086 this_command_key_count
= before_command_key_count
;
10087 if (this_command_key_count
< this_single_command_key_start
)
10088 this_single_command_key_start
= this_command_key_count
;
10090 echo_truncate (before_command_echo_length
);
10092 /* Cause whatever we put into unread-command-events
10093 to echo as if it were being freshly read from the keyboard. */
10094 this_command_key_count_reset
= 1;
10099 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10100 Sclear_this_command_keys
, 0, 1, 0,
10101 doc
: /* Clear out the vector that `this-command-keys' returns.
10102 Also clear the record of the last 100 events, unless optional arg
10103 KEEP-RECORD is non-nil. */)
10104 (Lisp_Object keep_record
)
10108 this_command_key_count
= 0;
10109 this_command_key_count_reset
= 0;
10111 if (NILP (keep_record
))
10113 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10114 ASET (recent_keys
, i
, Qnil
);
10116 recent_keys_index
= 0;
10121 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10122 doc
: /* Return the current depth in recursive edits. */)
10126 /* Wrap around reliably on integer overflow. */
10127 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10128 XSETINT (temp
, sum
);
10132 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10133 "FOpen dribble file: ",
10134 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10135 If FILE is nil, close any open dribble file.
10136 The file will be closed when Emacs exits.
10138 Be aware that this records ALL characters you type!
10139 This may include sensitive information such as passwords. */)
10152 Lisp_Object encfile
;
10154 file
= Fexpand_file_name (file
, Qnil
);
10155 encfile
= ENCODE_FILE (file
);
10156 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10157 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10158 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10159 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10161 report_file_error ("Opening dribble", file
);
10166 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10167 doc
: /* Discard the contents of the terminal input buffer.
10168 Also end any kbd macro being defined. */)
10171 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10173 /* Discard the last command from the macro. */
10174 Fcancel_kbd_macro_events ();
10178 Vunread_command_events
= Qnil
;
10180 discard_tty_input ();
10182 kbd_fetch_ptr
= kbd_store_ptr
;
10188 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10189 doc
: /* Stop Emacs and return to superior process. You can resume later.
10190 If `cannot-suspend' is non-nil, or if the system doesn't support job
10191 control, run a subshell instead.
10193 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10194 to be read as terminal input by Emacs's parent, after suspension.
10196 Before suspending, run the normal hook `suspend-hook'.
10197 After resumption run the normal hook `suspend-resume-hook'.
10199 Some operating systems cannot stop the Emacs process and resume it later.
10200 On such systems, Emacs starts a subshell instead of suspending. */)
10201 (Lisp_Object stuffstring
)
10203 ptrdiff_t count
= SPECPDL_INDEX ();
10204 int old_height
, old_width
;
10206 struct gcpro gcpro1
;
10209 if (tty_list
&& tty_list
->next
)
10210 error ("There are other tty frames open; close them before suspending Emacs");
10212 if (!NILP (stuffstring
))
10213 CHECK_STRING (stuffstring
);
10215 /* Run the functions in suspend-hook. */
10216 hook
= intern ("suspend-hook");
10217 Frun_hooks (1, &hook
);
10219 GCPRO1 (stuffstring
);
10220 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10221 reset_all_sys_modes ();
10222 /* sys_suspend can get an error if it tries to fork a subshell
10223 and the system resources aren't available for that. */
10224 record_unwind_protect_void (init_all_sys_modes
);
10225 stuff_buffered_input (stuffstring
);
10226 if (cannot_suspend
)
10230 unbind_to (count
, Qnil
);
10232 /* Check if terminal/window size has changed.
10233 Note that this is not useful when we are running directly
10234 with a window system; but suspend should be disabled in that case. */
10235 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10236 if (width
!= old_width
|| height
!= old_height
)
10237 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10239 /* Run suspend-resume-hook. */
10240 hook
= intern ("suspend-resume-hook");
10241 Frun_hooks (1, &hook
);
10247 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10248 Then in any case stuff anything Emacs has read ahead and not used. */
10251 stuff_buffered_input (Lisp_Object stuffstring
)
10253 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10254 register unsigned char *p
;
10256 if (STRINGP (stuffstring
))
10258 register ptrdiff_t count
;
10260 p
= SDATA (stuffstring
);
10261 count
= SBYTES (stuffstring
);
10262 while (count
-- > 0)
10267 /* Anything we have read ahead, put back for the shell to read. */
10268 /* ?? What should this do when we have multiple keyboards??
10269 Should we ignore anything that was typed in at the "wrong" kboard?
10271 rms: we should stuff everything back into the kboard
10273 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10276 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10277 kbd_fetch_ptr
= kbd_buffer
;
10278 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10279 stuff_char (kbd_fetch_ptr
->code
);
10281 clear_event (kbd_fetch_ptr
);
10285 #endif /* SIGTSTP */
10289 set_waiting_for_input (struct timespec
*time_to_clear
)
10291 input_available_clear_time
= time_to_clear
;
10293 /* Tell handle_interrupt to throw back to read_char, */
10294 waiting_for_input
= 1;
10296 /* If handle_interrupt was called before and buffered a C-g,
10297 make it run again now, to avoid timing error. */
10298 if (!NILP (Vquit_flag
))
10299 quit_throw_to_read_char (0);
10303 clear_waiting_for_input (void)
10305 /* Tell handle_interrupt not to throw back to read_char, */
10306 waiting_for_input
= 0;
10307 input_available_clear_time
= 0;
10310 /* The SIGINT handler.
10312 If we have a frame on the controlling tty, we assume that the
10313 SIGINT was generated by C-g, so we call handle_interrupt.
10314 Otherwise, tell QUIT to kill Emacs. */
10317 handle_interrupt_signal (int sig
)
10319 /* See if we have an active terminal on our controlling tty. */
10320 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10323 /* If there are no frames there, let's pretend that we are a
10324 well-behaving UN*X program and quit. We must not call Lisp
10325 in a signal handler, so tell QUIT to exit when it is
10327 Vquit_flag
= Qkill_emacs
;
10331 /* Otherwise, the SIGINT was probably generated by C-g. */
10333 /* Set internal_last_event_frame to the top frame of the
10334 controlling tty, if we have a frame there. We disable the
10335 interrupt key on secondary ttys, so the SIGINT must have come
10336 from the controlling tty. */
10337 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10339 handle_interrupt (1);
10344 deliver_interrupt_signal (int sig
)
10346 deliver_process_signal (sig
, handle_interrupt_signal
);
10350 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10351 of the number of times C-g has been requested. If C-g is pressed
10352 enough times, then quit anyway. See bug#6585. */
10353 static int volatile force_quit_count
;
10355 /* This routine is called at interrupt level in response to C-g.
10357 It is called from the SIGINT handler or kbd_buffer_store_event.
10359 If `waiting_for_input' is non zero, then unless `echoing' is
10360 nonzero, immediately throw back to read_char.
10362 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10363 eval to throw, when it gets a chance. If quit-flag is already
10364 non-nil, it stops the job right away. */
10367 handle_interrupt (bool in_signal_handler
)
10373 /* XXX This code needs to be revised for multi-tty support. */
10374 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10376 if (! in_signal_handler
)
10378 /* If SIGINT isn't blocked, don't let us be interrupted by
10379 a SIGINT. It might be harmful due to non-reentrancy
10380 in I/O functions. */
10382 sigemptyset (&blocked
);
10383 sigaddset (&blocked
, SIGINT
);
10384 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10388 reset_all_sys_modes ();
10392 * On systems which can suspend the current process and return to the original
10393 * shell, this command causes the user to end up back at the shell.
10394 * The "Auto-save" and "Abort" questions are not asked until
10395 * the user elects to return to emacs, at which point he can save the current
10396 * job and either dump core or continue.
10400 /* Perhaps should really fork an inferior shell?
10401 But that would not provide any way to get back
10402 to the original shell, ever. */
10403 printf ("No support for stopping a process on this operating system;\n");
10404 printf ("you can continue or abort.\n");
10405 #endif /* not SIGTSTP */
10407 /* We must remain inside the screen area when the internal terminal
10408 is used. Note that [Enter] is not echoed by dos. */
10409 cursor_to (SELECTED_FRAME (), 0, 0);
10411 printf ("Auto-save? (y or n) ");
10413 if (((c
= getchar ()) & ~040) == 'Y')
10415 Fdo_auto_save (Qt
, Qnil
);
10417 printf ("\r\nAuto-save done");
10418 #else /* not MSDOS */
10419 printf ("Auto-save done\n");
10420 #endif /* not MSDOS */
10422 while (c
!= '\n') c
= getchar ();
10425 printf ("\r\nAbort? (y or n) ");
10426 #else /* not MSDOS */
10427 printf ("Abort (and dump core)? (y or n) ");
10428 #endif /* not MSDOS */
10430 if (((c
= getchar ()) & ~040) == 'Y')
10432 while (c
!= '\n') c
= getchar ();
10434 printf ("\r\nContinuing...\r\n");
10435 #else /* not MSDOS */
10436 printf ("Continuing...\n");
10437 #endif /* not MSDOS */
10439 init_all_sys_modes ();
10443 /* If executing a function that wants to be interrupted out of
10444 and the user has not deferred quitting by binding `inhibit-quit'
10445 then quit right away. */
10446 if (immediate_quit
&& NILP (Vinhibit_quit
))
10448 struct gl_state_s saved
;
10449 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10451 immediate_quit
= 0;
10452 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10454 GCPRO4 (saved
.object
, saved
.global_code
,
10455 saved
.current_syntax_table
, saved
.old_prop
);
10456 Fsignal (Qquit
, Qnil
);
10461 { /* Else request quit when it's safe. */
10462 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10463 force_quit_count
= count
;
10466 immediate_quit
= 1;
10467 Vinhibit_quit
= Qnil
;
10473 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10475 /* TODO: The longjmp in this call throws the NS event loop integration off,
10476 and it seems to do fine without this. Probably some attention
10477 needs to be paid to the setting of waiting_for_input in
10478 wait_reading_process_output() under HAVE_NS because of the call
10479 to ns_select there (needed because otherwise events aren't picked up
10480 outside of polling since we don't get SIGIO like X and we don't have a
10481 separate event loop thread like W32. */
10483 if (waiting_for_input
&& !echoing
)
10484 quit_throw_to_read_char (in_signal_handler
);
10488 /* Handle a C-g by making read_char return C-g. */
10491 quit_throw_to_read_char (bool from_signal
)
10493 /* When not called from a signal handler it is safe to call
10495 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10496 Fkill_emacs (Qnil
);
10498 /* Prevent another signal from doing this before we finish. */
10499 clear_waiting_for_input ();
10502 Vunread_command_events
= Qnil
;
10504 if (FRAMEP (internal_last_event_frame
)
10505 && !EQ (internal_last_event_frame
, selected_frame
))
10506 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10509 sys_longjmp (getcjmp
, 1);
10512 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10513 Sset_input_interrupt_mode
, 1, 1, 0,
10514 doc
: /* Set interrupt mode of reading keyboard input.
10515 If INTERRUPT is non-nil, Emacs will use input interrupts;
10516 otherwise Emacs uses CBREAK mode.
10518 See also `current-input-mode'. */)
10519 (Lisp_Object interrupt
)
10521 bool new_interrupt_input
;
10522 #ifdef USABLE_SIGIO
10523 #ifdef HAVE_X_WINDOWS
10524 if (x_display_list
!= NULL
)
10526 /* When using X, don't give the user a real choice,
10527 because we haven't implemented the mechanisms to support it. */
10528 new_interrupt_input
= 1;
10531 #endif /* HAVE_X_WINDOWS */
10532 new_interrupt_input
= !NILP (interrupt
);
10533 #else /* not USABLE_SIGIO */
10534 new_interrupt_input
= 0;
10535 #endif /* not USABLE_SIGIO */
10537 if (new_interrupt_input
!= interrupt_input
)
10539 #ifdef POLL_FOR_INPUT
10543 /* this causes startup screen to be restored and messes with the mouse */
10544 reset_all_sys_modes ();
10545 interrupt_input
= new_interrupt_input
;
10546 init_all_sys_modes ();
10548 interrupt_input
= new_interrupt_input
;
10551 #ifdef POLL_FOR_INPUT
10552 poll_suppress_count
= 1;
10559 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10560 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10561 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10562 C-q in key sequences.
10564 This setting only has an effect on tty terminals and only when
10565 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10567 See also `current-input-mode'. */)
10568 (Lisp_Object flow
, Lisp_Object terminal
)
10570 struct terminal
*t
= get_terminal (terminal
, 1);
10571 struct tty_display_info
*tty
;
10572 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10574 tty
= t
->display_info
.tty
;
10576 if (tty
->flow_control
!= !NILP (flow
))
10579 /* This causes startup screen to be restored and messes with the mouse. */
10580 reset_sys_modes (tty
);
10583 tty
->flow_control
= !NILP (flow
);
10586 init_sys_modes (tty
);
10592 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10593 doc
: /* Enable or disable 8-bit input on TERMINAL.
10594 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10595 bit as the Meta modifier.
10597 If META is nil, Emacs will ignore the top bit, on the assumption it is
10600 Otherwise, Emacs will accept and pass through 8-bit input without
10601 specially interpreting the top bit.
10603 This setting only has an effect on tty terminal devices.
10605 Optional parameter TERMINAL specifies the tty terminal device to use.
10606 It may be a terminal object, a frame, or nil for the terminal used by
10607 the currently selected frame.
10609 See also `current-input-mode'. */)
10610 (Lisp_Object meta
, Lisp_Object terminal
)
10612 struct terminal
*t
= get_terminal (terminal
, 1);
10613 struct tty_display_info
*tty
;
10616 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10618 tty
= t
->display_info
.tty
;
10622 else if (EQ (meta
, Qt
))
10627 if (tty
->meta_key
!= new_meta
)
10630 /* this causes startup screen to be restored and messes with the mouse */
10631 reset_sys_modes (tty
);
10634 tty
->meta_key
= new_meta
;
10637 init_sys_modes (tty
);
10643 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10644 doc
: /* Specify character used for quitting.
10645 QUIT must be an ASCII character.
10647 This function only has an effect on the controlling tty of the Emacs
10650 See also `current-input-mode'. */)
10653 struct terminal
*t
= get_named_tty ("/dev/tty");
10654 struct tty_display_info
*tty
;
10655 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10657 tty
= t
->display_info
.tty
;
10659 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10660 error ("QUIT must be an ASCII character");
10663 /* this causes startup screen to be restored and messes with the mouse */
10664 reset_sys_modes (tty
);
10667 /* Don't let this value be out of range. */
10668 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10671 init_sys_modes (tty
);
10677 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10678 doc
: /* Set mode of reading keyboard input.
10679 First arg INTERRUPT non-nil means use input interrupts;
10680 nil means use CBREAK mode.
10681 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10682 (no effect except in CBREAK mode).
10683 Third arg META t means accept 8-bit input (for a Meta key).
10684 META nil means ignore the top bit, on the assumption it is parity.
10685 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10686 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10687 See also `current-input-mode'. */)
10688 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10690 Fset_input_interrupt_mode (interrupt
);
10691 Fset_output_flow_control (flow
, Qnil
);
10692 Fset_input_meta_mode (meta
, Qnil
);
10694 Fset_quit_char (quit
);
10698 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10699 doc
: /* Return information about the way Emacs currently reads keyboard input.
10700 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10701 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10702 nil, Emacs is using CBREAK mode.
10703 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10704 terminal; this does not apply if Emacs uses interrupt-driven input.
10705 META is t if accepting 8-bit input with 8th bit as Meta flag.
10706 META nil means ignoring the top bit, on the assumption it is parity.
10707 META is neither t nor nil if accepting 8-bit input and using
10708 all 8 bits as the character code.
10709 QUIT is the character Emacs currently uses to quit.
10710 The elements of this list correspond to the arguments of
10711 `set-input-mode'. */)
10714 Lisp_Object val
[4];
10715 struct frame
*sf
= XFRAME (selected_frame
);
10717 val
[0] = interrupt_input
? Qt
: Qnil
;
10718 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10720 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10721 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10723 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10730 XSETFASTINT (val
[3], quit_char
);
10732 return Flist (ARRAYELTS (val
), val
);
10735 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10736 doc
: /* Return position information for pixel coordinates X and Y.
10737 By default, X and Y are relative to text area of the selected window.
10738 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10739 If optional fourth arg WHOLE is non-nil, X is relative to the left
10740 edge of the window.
10742 The return value is similar to a mouse click position:
10743 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10744 IMAGE (DX . DY) (WIDTH . HEIGHT))
10745 The `posn-' functions access elements of such lists. */)
10746 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10751 if (NILP (frame_or_window
))
10752 frame_or_window
= selected_window
;
10754 if (WINDOWP (frame_or_window
))
10756 struct window
*w
= decode_live_window (frame_or_window
);
10758 XSETINT (x
, (XINT (x
)
10759 + WINDOW_LEFT_EDGE_X (w
)
10761 ? window_box_left_offset (w
, TEXT_AREA
)
10763 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10764 frame_or_window
= w
->frame
;
10767 CHECK_LIVE_FRAME (frame_or_window
);
10769 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10772 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10773 doc
: /* Return position information for buffer POS in WINDOW.
10774 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10776 Return nil if position is not visible in window. Otherwise,
10777 the return value is similar to that returned by `event-start' for
10778 a mouse click at the upper left corner of the glyph corresponding
10779 to the given buffer position:
10780 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10781 IMAGE (DX . DY) (WIDTH . HEIGHT))
10782 The `posn-' functions access elements of such lists. */)
10783 (Lisp_Object pos
, Lisp_Object window
)
10788 window
= selected_window
;
10790 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10793 Lisp_Object x
= XCAR (tem
);
10794 Lisp_Object y
= XCAR (XCDR (tem
));
10796 /* Point invisible due to hscrolling? */
10799 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10805 /* Set up a new kboard object with reasonable initial values.
10806 TYPE is a window system for which this keyboard is used. */
10809 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10811 kset_overriding_terminal_local_map (kb
, Qnil
);
10812 kset_last_command (kb
, Qnil
);
10813 kset_real_last_command (kb
, Qnil
);
10814 kset_keyboard_translate_table (kb
, Qnil
);
10815 kset_last_repeatable_command (kb
, Qnil
);
10816 kset_prefix_arg (kb
, Qnil
);
10817 kset_last_prefix_arg (kb
, Qnil
);
10818 kset_kbd_queue (kb
, Qnil
);
10819 kb
->kbd_queue_has_data
= 0;
10820 kb
->immediate_echo
= 0;
10821 kset_echo_string (kb
, Qnil
);
10822 kb
->echo_after_prompt
= -1;
10823 kb
->kbd_macro_buffer
= 0;
10824 kb
->kbd_macro_bufsize
= 0;
10825 kset_defining_kbd_macro (kb
, Qnil
);
10826 kset_last_kbd_macro (kb
, Qnil
);
10827 kb
->reference_count
= 0;
10828 kset_system_key_alist (kb
, Qnil
);
10829 kset_system_key_syms (kb
, Qnil
);
10830 kset_window_system (kb
, type
);
10831 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10832 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10833 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10834 kset_default_minibuffer_frame (kb
, Qnil
);
10837 /* Allocate and basically initialize keyboard
10838 object to use with window system TYPE. */
10841 allocate_kboard (Lisp_Object type
)
10843 KBOARD
*kb
= xmalloc (sizeof *kb
);
10845 init_kboard (kb
, type
);
10846 kb
->next_kboard
= all_kboards
;
10852 * Destroy the contents of a kboard object, but not the object itself.
10853 * We use this just before deleting it, or if we're going to initialize
10854 * it a second time.
10857 wipe_kboard (KBOARD
*kb
)
10859 xfree (kb
->kbd_macro_buffer
);
10862 /* Free KB and memory referenced from it. */
10865 delete_kboard (KBOARD
*kb
)
10869 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10872 *kbp
= kb
->next_kboard
;
10874 /* Prevent a dangling reference to KB. */
10875 if (kb
== current_kboard
10876 && FRAMEP (selected_frame
)
10877 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10879 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10881 if (current_kboard
== kb
)
10890 init_keyboard (void)
10892 /* This is correct before outermost invocation of the editor loop. */
10893 command_loop_level
= -1;
10894 immediate_quit
= 0;
10895 quit_char
= Ctl ('g');
10896 Vunread_command_events
= Qnil
;
10897 timer_idleness_start_time
= invalid_timespec ();
10899 recent_keys_index
= 0;
10900 kbd_fetch_ptr
= kbd_buffer
;
10901 kbd_store_ptr
= kbd_buffer
;
10902 do_mouse_tracking
= Qnil
;
10904 interrupt_input_blocked
= 0;
10905 pending_signals
= 0;
10907 /* This means that command_loop_1 won't try to select anything the first
10909 internal_last_event_frame
= Qnil
;
10910 Vlast_event_frame
= internal_last_event_frame
;
10912 current_kboard
= initial_kboard
;
10913 /* Re-initialize the keyboard again. */
10914 wipe_kboard (current_kboard
);
10915 /* A value of nil for Vwindow_system normally means a tty, but we also use
10916 it for the initial terminal since there is no window system there. */
10917 init_kboard (current_kboard
, Qnil
);
10919 if (!noninteractive
)
10921 /* Before multi-tty support, these handlers used to be installed
10922 only if the current session was a tty session. Now an Emacs
10923 session may have multiple display types, so we always handle
10924 SIGINT. There is special code in handle_interrupt_signal to exit
10925 Emacs on SIGINT when there are no termcap frames on the
10926 controlling terminal. */
10927 struct sigaction action
;
10928 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10929 sigaction (SIGINT
, &action
, 0);
10931 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10932 SIGQUIT and we can't tell which one it will give us. */
10933 sigaction (SIGQUIT
, &action
, 0);
10934 #endif /* not DOS_NT */
10936 #ifdef USABLE_SIGIO
10937 if (!noninteractive
)
10939 struct sigaction action
;
10940 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10941 sigaction (SIGIO
, &action
, 0);
10945 /* Use interrupt input by default, if it works and noninterrupt input
10946 has deficiencies. */
10948 #ifdef INTERRUPT_INPUT
10949 interrupt_input
= 1;
10951 interrupt_input
= 0;
10954 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10957 if (keyboard_init_hook
)
10958 (*keyboard_init_hook
) ();
10960 #ifdef POLL_FOR_INPUT
10962 poll_suppress_count
= 1;
10967 /* This type's only use is in syms_of_keyboard, to initialize the
10968 event header symbols and put properties on them. */
10969 struct event_head
{
10975 static const struct event_head head_table
[] = {
10976 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10977 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10978 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10979 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10980 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10981 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10982 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10983 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10984 /* `select-window' should be handled just like `switch-frame'
10985 in read_key_sequence. */
10986 {&Qselect_window
, "select-window", &Qswitch_frame
}
10990 syms_of_keyboard (void)
10992 #include "keyboard.x"
10994 pending_funcalls
= Qnil
;
10995 staticpro (&pending_funcalls
);
10997 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10998 staticpro (&Vlispy_mouse_stem
);
11001 DEFSYM (QCimage
, ":image");
11002 DEFSYM (Qhelp_echo
, "help-echo");
11003 DEFSYM (QCrtl
, ":rtl");
11005 staticpro (&item_properties
);
11006 item_properties
= Qnil
;
11008 staticpro (&tool_bar_item_properties
);
11009 tool_bar_item_properties
= Qnil
;
11010 staticpro (&tool_bar_items_vector
);
11011 tool_bar_items_vector
= Qnil
;
11013 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11014 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11015 DEFSYM (Qself_insert_command
, "self-insert-command");
11016 DEFSYM (Qforward_char
, "forward-char");
11017 DEFSYM (Qbackward_char
, "backward-char");
11018 DEFSYM (Qdisabled
, "disabled");
11019 DEFSYM (Qundefined
, "undefined");
11020 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11021 DEFSYM (Qpost_command_hook
, "post-command-hook");
11022 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11023 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11024 DEFSYM (Qfunction_key
, "function-key");
11025 DEFSYM (Qmouse_click
, "mouse-click");
11026 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11027 DEFSYM (Qsave_session
, "save-session");
11028 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11029 DEFSYM (Qmenu_enable
, "menu-enable");
11032 DEFSYM (Qlanguage_change
, "language-change");
11036 DEFSYM (Qdbus_event
, "dbus-event");
11039 #ifdef USE_FILE_NOTIFY
11040 DEFSYM (Qfile_notify
, "file-notify");
11041 #endif /* USE_FILE_NOTIFY */
11043 DEFSYM (QCenable
, ":enable");
11044 DEFSYM (QCvisible
, ":visible");
11045 DEFSYM (QChelp
, ":help");
11046 DEFSYM (QCfilter
, ":filter");
11047 DEFSYM (QCbutton
, ":button");
11048 DEFSYM (QCkeys
, ":keys");
11049 DEFSYM (QCkey_sequence
, ":key-sequence");
11050 DEFSYM (QCtoggle
, ":toggle");
11051 DEFSYM (QCradio
, ":radio");
11052 DEFSYM (QClabel
, ":label");
11053 DEFSYM (QCvert_only
, ":vert-only");
11055 DEFSYM (Qmode_line
, "mode-line");
11056 DEFSYM (Qvertical_line
, "vertical-line");
11057 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11058 DEFSYM (Qmenu_bar
, "menu-bar");
11059 DEFSYM (Qright_divider
, "right-divider");
11060 DEFSYM (Qbottom_divider
, "bottom-divider");
11062 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11064 DEFSYM (Qabove_handle
, "above-handle");
11065 DEFSYM (Qhandle
, "handle");
11066 DEFSYM (Qbelow_handle
, "below-handle");
11067 DEFSYM (Qup
, "up");
11068 DEFSYM (Qdown
, "down");
11069 DEFSYM (Qtop
, "top");
11070 DEFSYM (Qbottom
, "bottom");
11071 DEFSYM (Qend_scroll
, "end-scroll");
11072 DEFSYM (Qratio
, "ratio");
11074 DEFSYM (Qevent_kind
, "event-kind");
11075 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11076 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11077 DEFSYM (Qmodifier_cache
, "modifier-cache");
11079 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11080 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11082 DEFSYM (Qpolling_period
, "polling-period");
11084 DEFSYM (Qx_set_selection
, "x-set-selection");
11085 DEFSYM (QPRIMARY
, "PRIMARY");
11086 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11087 DEFSYM (Qhandle_select_window
, "handle-select-window");
11089 DEFSYM (Qinput_method_function
, "input-method-function");
11090 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11091 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11093 DEFSYM (Qhelp_form_show
, "help-form-show");
11095 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11097 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11098 Fset (Qinput_method_use_echo_area
, Qnil
);
11102 int len
= ARRAYELTS (head_table
);
11104 for (i
= 0; i
< len
; i
++)
11106 const struct event_head
*p
= &head_table
[i
];
11107 *p
->var
= intern_c_string (p
->name
);
11108 staticpro (p
->var
);
11109 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11110 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11114 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11115 staticpro (&button_down_location
);
11116 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11117 staticpro (&mouse_syms
);
11118 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11120 staticpro (&wheel_syms
);
11124 int len
= ARRAYELTS (modifier_names
);
11126 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11127 for (i
= 0; i
< len
; i
++)
11128 if (modifier_names
[i
])
11129 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11130 staticpro (&modifier_symbols
);
11133 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11134 staticpro (&recent_keys
);
11136 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11137 staticpro (&this_command_keys
);
11139 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11140 staticpro (&raw_keybuf
);
11142 DEFSYM (Qcommand_execute
, "command-execute");
11144 accent_key_syms
= Qnil
;
11145 staticpro (&accent_key_syms
);
11147 func_key_syms
= Qnil
;
11148 staticpro (&func_key_syms
);
11150 drag_n_drop_syms
= Qnil
;
11151 staticpro (&drag_n_drop_syms
);
11153 unread_switch_frame
= Qnil
;
11154 staticpro (&unread_switch_frame
);
11156 internal_last_event_frame
= Qnil
;
11157 staticpro (&internal_last_event_frame
);
11159 read_key_sequence_cmd
= Qnil
;
11160 staticpro (&read_key_sequence_cmd
);
11161 read_key_sequence_remapped
= Qnil
;
11162 staticpro (&read_key_sequence_remapped
);
11164 menu_bar_one_keymap_changed_items
= Qnil
;
11165 staticpro (&menu_bar_one_keymap_changed_items
);
11167 menu_bar_items_vector
= Qnil
;
11168 staticpro (&menu_bar_items_vector
);
11170 help_form_saved_window_configs
= Qnil
;
11171 staticpro (&help_form_saved_window_configs
);
11173 DEFVAR_LISP ("last-command-event", last_command_event
,
11174 doc
: /* Last input event that was part of a command. */);
11176 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11177 doc
: /* Last input event in a command, except for mouse menu events.
11178 Mouse menus give back keys that don't look like mouse events;
11179 this variable holds the actual mouse event that led to the menu,
11180 so that you can determine whether the command was run by mouse or not. */);
11182 DEFVAR_LISP ("last-input-event", last_input_event
,
11183 doc
: /* Last input event. */);
11185 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11186 doc
: /* List of events to be read as the command input.
11187 These events are processed first, before actual keyboard input.
11188 Events read from this list are not normally added to `this-command-keys',
11189 as they will already have been added once as they were read for the first time.
11190 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11191 Vunread_command_events
= Qnil
;
11193 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11194 doc
: /* List of events to be processed as input by input methods.
11195 These events are processed before `unread-command-events'
11196 and actual keyboard input, but are not given to `input-method-function'. */);
11197 Vunread_post_input_method_events
= Qnil
;
11199 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11200 doc
: /* List of events to be processed as input by input methods.
11201 These events are processed after `unread-command-events', but
11202 before actual keyboard input.
11203 If there's an active input method, the events are given to
11204 `input-method-function'. */);
11205 Vunread_input_method_events
= Qnil
;
11207 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11208 doc
: /* Meta-prefix character code.
11209 Meta-foo as command input turns into this character followed by foo. */);
11210 XSETINT (meta_prefix_char
, 033);
11212 DEFVAR_KBOARD ("last-command", Vlast_command
,
11213 doc
: /* The last command executed.
11214 Normally a symbol with a function definition, but can be whatever was found
11215 in the keymap, or whatever the variable `this-command' was set to by that
11218 The value `mode-exit' is special; it means that the previous command
11219 read an event that told it to exit, and it did so and unread that event.
11220 In other words, the present command is the event that made the previous
11223 The value `kill-region' is special; it means that the previous command
11224 was a kill command.
11226 `last-command' has a separate binding for each terminal device.
11227 See Info node `(elisp)Multiple Terminals'. */);
11229 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11230 doc
: /* Same as `last-command', but never altered by Lisp code.
11231 Taken from the previous value of `real-this-command'. */);
11233 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11234 doc
: /* Last command that may be repeated.
11235 The last command executed that was not bound to an input event.
11236 This is the command `repeat' will try to repeat.
11237 Taken from a previous value of `real-this-command'. */);
11239 DEFVAR_LISP ("this-command", Vthis_command
,
11240 doc
: /* The command now being executed.
11241 The command can set this variable; whatever is put here
11242 will be in `last-command' during the following command. */);
11243 Vthis_command
= Qnil
;
11245 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11246 doc
: /* This is like `this-command', except that commands should never modify it. */);
11247 Vreal_this_command
= Qnil
;
11249 DEFVAR_LISP ("this-command-keys-shift-translated",
11250 Vthis_command_keys_shift_translated
,
11251 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11252 Shift-translation occurs when there is no binding for the key sequence
11253 as entered, but a binding was found by changing an upper-case letter
11254 to lower-case, or a shifted function key to an unshifted one. */);
11255 Vthis_command_keys_shift_translated
= Qnil
;
11257 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11258 doc
: /* The command bound to the current key sequence before remapping.
11259 It equals `this-command' if the original command was not remapped through
11260 any of the active keymaps. Otherwise, the value of `this-command' is the
11261 result of looking up the original command in the active keymaps. */);
11262 Vthis_original_command
= Qnil
;
11264 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11265 doc
: /* Number of input events between auto-saves.
11266 Zero means disable autosaving due to number of characters typed. */);
11267 auto_save_interval
= 300;
11269 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11270 doc
: /* Number of seconds idle time before auto-save.
11271 Zero or nil means disable auto-saving due to idleness.
11272 After auto-saving due to this many seconds of idle time,
11273 Emacs also does a garbage collection if that seems to be warranted. */);
11274 XSETFASTINT (Vauto_save_timeout
, 30);
11276 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11277 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11278 The value may be integer or floating point.
11279 If the value is zero, don't echo at all. */);
11280 Vecho_keystrokes
= make_number (1);
11282 DEFVAR_INT ("polling-period", polling_period
,
11283 doc
: /* Interval between polling for input during Lisp execution.
11284 The reason for polling is to make C-g work to stop a running program.
11285 Polling is needed only when using X windows and SIGIO does not work.
11286 Polling is automatically disabled in all other cases. */);
11287 polling_period
= 2;
11289 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11290 doc
: /* Maximum time between mouse clicks to make a double-click.
11291 Measured in milliseconds. The value nil means disable double-click
11292 recognition; t means double-clicks have no time limit and are detected
11293 by position only. */);
11294 Vdouble_click_time
= make_number (500);
11296 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11297 doc
: /* Maximum mouse movement between clicks to make a double-click.
11298 On window-system frames, value is the number of pixels the mouse may have
11299 moved horizontally or vertically between two clicks to make a double-click.
11300 On non window-system frames, value is interpreted in units of 1/8 characters
11303 This variable is also the threshold for motion of the mouse
11304 to count as a drag. */);
11305 double_click_fuzz
= 3;
11307 DEFVAR_INT ("num-input-keys", num_input_keys
,
11308 doc
: /* Number of complete key sequences read as input so far.
11309 This includes key sequences read from keyboard macros.
11310 The number is effectively the number of interactive command invocations. */);
11311 num_input_keys
= 0;
11313 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11314 doc
: /* Number of input events read from the keyboard so far.
11315 This does not include events generated by keyboard macros. */);
11316 num_nonmacro_input_events
= 0;
11318 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11319 doc
: /* The frame in which the most recently read event occurred.
11320 If the last event came from a keyboard macro, this is set to `macro'. */);
11321 Vlast_event_frame
= Qnil
;
11323 /* This variable is set up in sysdep.c. */
11324 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11325 doc
: /* The ERASE character as set by the user with stty. */);
11327 DEFVAR_LISP ("help-char", Vhelp_char
,
11328 doc
: /* Character to recognize as meaning Help.
11329 When it is read, do `(eval help-form)', and display result if it's a string.
11330 If the value of `help-form' is nil, this char can be read normally. */);
11331 XSETINT (Vhelp_char
, Ctl ('H'));
11333 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11334 doc
: /* List of input events to recognize as meaning Help.
11335 These work just like the value of `help-char' (see that). */);
11336 Vhelp_event_list
= Qnil
;
11338 DEFVAR_LISP ("help-form", Vhelp_form
,
11339 doc
: /* Form to execute when character `help-char' is read.
11340 If the form returns a string, that string is displayed.
11341 If `help-form' is nil, the help char is not recognized. */);
11344 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11345 doc
: /* Command to run when `help-char' character follows a prefix key.
11346 This command is used only when there is no actual binding
11347 for that character after that prefix key. */);
11348 Vprefix_help_command
= Qnil
;
11350 DEFVAR_LISP ("top-level", Vtop_level
,
11351 doc
: /* Form to evaluate when Emacs starts up.
11352 Useful to set before you dump a modified Emacs. */);
11355 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11356 doc
: /* Translate table for local keyboard input, or nil.
11357 If non-nil, the value should be a char-table. Each character read
11358 from the keyboard is looked up in this char-table. If the value found
11359 there is non-nil, then it is used instead of the actual input character.
11361 The value can also be a string or vector, but this is considered obsolete.
11362 If it is a string or vector of length N, character codes N and up are left
11363 untranslated. In a vector, an element which is nil means "no translation".
11365 This is applied to the characters supplied to input methods, not their
11366 output. See also `translation-table-for-input'.
11368 This variable has a separate binding for each terminal.
11369 See Info node `(elisp)Multiple Terminals'. */);
11371 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11372 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11373 \(Even if the operating system has support for stopping a process.\) */);
11374 cannot_suspend
= 0;
11376 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11377 doc
: /* Non-nil means prompt with menus when appropriate.
11378 This is done when reading from a keymap that has a prompt string,
11379 for elements that have prompt strings.
11380 The menu is displayed on the screen
11381 if X menus were enabled at configuration
11382 time and the previous event was a mouse click prefix key.
11383 Otherwise, menu prompting uses the echo area. */);
11384 menu_prompting
= 1;
11386 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11387 doc
: /* Character to see next line of menu prompt.
11388 Type this character while in a menu prompt to rotate around the lines of it. */);
11389 XSETINT (menu_prompt_more_char
, ' ');
11391 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11392 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11393 Emacs applies the modifiers of the character stored here to each keyboard
11394 character it reads. For example, after evaluating the expression
11395 (setq extra-keyboard-modifiers ?\\C-x)
11396 all input characters will have the control modifier applied to them.
11398 Note that the character ?\\C-@, equivalent to the integer zero, does
11399 not count as a control character; rather, it counts as a character
11400 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11401 cancels any modification. */);
11402 extra_keyboard_modifiers
= 0;
11404 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11405 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11406 The command loop sets this to nil before each command,
11407 and tests the value when the command returns.
11408 Buffer modification stores t in this variable. */);
11409 Vdeactivate_mark
= Qnil
;
11410 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11411 Fmake_variable_buffer_local (Qdeactivate_mark
);
11413 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11414 doc
: /* Normal hook run before each command is executed.
11415 If an unhandled error happens in running this hook,
11416 the function in which the error occurred is unconditionally removed, since
11417 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11418 Vpre_command_hook
= Qnil
;
11420 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11421 doc
: /* Normal hook run after each command is executed.
11422 If an unhandled error happens in running this hook,
11423 the function in which the error occurred is unconditionally removed, since
11424 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11425 Vpost_command_hook
= Qnil
;
11428 DEFVAR_LISP ("echo-area-clear-hook", ...,
11429 doc
: /* Normal hook run when clearing the echo area. */);
11431 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11432 Fset (Qecho_area_clear_hook
, Qnil
);
11434 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11435 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11436 Vlucid_menu_bar_dirty_flag
= Qnil
;
11438 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11439 doc
: /* List of menu bar items to move to the end of the menu bar.
11440 The elements of the list are event types that may have menu bar bindings. */);
11441 Vmenu_bar_final_items
= Qnil
;
11443 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11444 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11445 This is used internally by graphical displays that do not render
11446 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11447 Vtool_bar_separator_image_expression
= Qnil
;
11449 DEFVAR_KBOARD ("overriding-terminal-local-map",
11450 Voverriding_terminal_local_map
,
11451 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11452 This variable is intended to let commands such as `universal-argument'
11453 set up a different keymap for reading the next command.
11455 `overriding-terminal-local-map' has a separate binding for each
11456 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11458 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11459 doc
: /* Keymap that replaces (overrides) local keymaps.
11460 If this variable is non-nil, Emacs looks up key bindings in this
11461 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11462 buffer's local map. Hence, the only active keymaps would be
11463 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11464 order of precedence. */);
11465 Voverriding_local_map
= Qnil
;
11467 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11468 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11469 Otherwise, the menu bar continues to reflect the buffer's local map
11470 and the minor mode maps regardless of `overriding-local-map'. */);
11471 Voverriding_local_map_menu_flag
= Qnil
;
11473 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11474 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11475 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11477 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11478 doc
: /* Non-nil means generate motion events for mouse motion. */);
11480 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11481 doc
: /* Alist of system-specific X windows key symbols.
11482 Each element should have the form (N . SYMBOL) where N is the
11483 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11484 and SYMBOL is its name.
11486 `system-key-alist' has a separate binding for each terminal device.
11487 See Info node `(elisp)Multiple Terminals'. */);
11489 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11490 doc
: /* Keymap that translates key sequences to key sequences during input.
11491 This is used mainly for mapping key sequences into some preferred
11492 key events (symbols).
11494 The `read-key-sequence' function replaces any subsequence bound by
11495 `local-function-key-map' with its binding. More precisely, when the
11496 active keymaps have no binding for the current key sequence but
11497 `local-function-key-map' binds a suffix of the sequence to a vector or
11498 string, `read-key-sequence' replaces the matching suffix with its
11499 binding, and continues with the new sequence.
11501 If the binding is a function, it is called with one argument (the prompt)
11502 and its return value (a key sequence) is used.
11504 The events that come from bindings in `local-function-key-map' are not
11505 themselves looked up in `local-function-key-map'.
11507 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11508 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11509 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11510 typing `ESC O P x' would return [f1 x].
11512 `local-function-key-map' has a separate binding for each terminal
11513 device. See Info node `(elisp)Multiple Terminals'. If you need to
11514 define a binding on all terminals, change `function-key-map'
11515 instead. Initially, `local-function-key-map' is an empty keymap that
11516 has `function-key-map' as its parent on all terminal devices. */);
11518 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11519 doc
: /* Keymap that decodes input escape sequences.
11520 This is used mainly for mapping ASCII function key sequences into
11521 real Emacs function key events (symbols).
11523 The `read-key-sequence' function replaces any subsequence bound by
11524 `input-decode-map' with its binding. Contrary to `function-key-map',
11525 this map applies its rebinding regardless of the presence of an ordinary
11526 binding. So it is more like `key-translation-map' except that it applies
11527 before `function-key-map' rather than after.
11529 If the binding is a function, it is called with one argument (the prompt)
11530 and its return value (a key sequence) is used.
11532 The events that come from bindings in `input-decode-map' are not
11533 themselves looked up in `input-decode-map'. */);
11535 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11536 doc
: /* The parent keymap of all `local-function-key-map' instances.
11537 Function key definitions that apply to all terminal devices should go
11538 here. If a mapping is defined in both the current
11539 `local-function-key-map' binding and this variable, then the local
11540 definition will take precedence. */);
11541 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11543 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11544 doc
: /* Keymap of key translations that can override keymaps.
11545 This keymap works like `input-decode-map', but comes after `function-key-map'.
11546 Another difference is that it is global rather than terminal-local. */);
11547 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11549 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11550 doc
: /* List of deferred actions to be performed at a later time.
11551 The precise format isn't relevant here; we just check whether it is nil. */);
11552 Vdeferred_action_list
= Qnil
;
11554 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11555 doc
: /* Function to call to handle deferred actions, after each command.
11556 This function is called with no arguments after each command
11557 whenever `deferred-action-list' is non-nil. */);
11558 Vdeferred_action_function
= Qnil
;
11560 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11561 doc
: /* List of warnings to be displayed after this command.
11562 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11563 as per the args of `display-warning' (which see).
11564 If this variable is non-nil, `delayed-warnings-hook' will be run
11565 immediately after running `post-command-hook'. */);
11566 Vdelayed_warnings_list
= Qnil
;
11568 DEFVAR_LISP ("timer-list", Vtimer_list
,
11569 doc
: /* List of active absolute time timers in order of increasing time. */);
11570 Vtimer_list
= Qnil
;
11572 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11573 doc
: /* List of active idle-time timers in order of increasing time. */);
11574 Vtimer_idle_list
= Qnil
;
11576 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11577 doc
: /* If non-nil, the function that implements the current input method.
11578 It's called with one argument, a printing character that was just read.
11579 \(That means a character with code 040...0176.)
11580 Typically this function uses `read-event' to read additional events.
11581 When it does so, it should first bind `input-method-function' to nil
11582 so it will not be called recursively.
11584 The function should return a list of zero or more events
11585 to be used as input. If it wants to put back some events
11586 to be reconsidered, separately, by the input method,
11587 it can add them to the beginning of `unread-command-events'.
11589 The input method function can find in `input-method-previous-message'
11590 the previous echo area message.
11592 The input method function should refer to the variables
11593 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11594 for guidance on what to do. */);
11595 Vinput_method_function
= Qnil
;
11597 DEFVAR_LISP ("input-method-previous-message",
11598 Vinput_method_previous_message
,
11599 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11600 This variable exists because `read-event' clears the echo area
11601 before running the input method. It is nil if there was no message. */);
11602 Vinput_method_previous_message
= Qnil
;
11604 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11605 doc
: /* If non-nil, the function that implements the display of help.
11606 It's called with one argument, the help string to display. */);
11607 Vshow_help_function
= Qnil
;
11609 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11610 doc
: /* If non-nil, suppress point adjustment after executing a command.
11612 After a command is executed, if point is moved into a region that has
11613 special properties (e.g. composition, display), we adjust point to
11614 the boundary of the region. But, when a command sets this variable to
11615 non-nil, we suppress the point adjustment.
11617 This variable is set to nil before reading a command, and is checked
11618 just after executing the command. */);
11619 Vdisable_point_adjustment
= Qnil
;
11621 DEFVAR_LISP ("global-disable-point-adjustment",
11622 Vglobal_disable_point_adjustment
,
11623 doc
: /* If non-nil, always suppress point adjustment.
11625 The default value is nil, in which case, point adjustment are
11626 suppressed only after special commands that set
11627 `disable-point-adjustment' (which see) to non-nil. */);
11628 Vglobal_disable_point_adjustment
= Qnil
;
11630 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11631 doc
: /* How long to display an echo-area message when the minibuffer is active.
11632 If the value is not a number, such messages don't time out. */);
11633 Vminibuffer_message_timeout
= make_number (2);
11635 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11636 doc
: /* If non-nil, any keyboard input throws to this symbol.
11637 The value of that variable is passed to `quit-flag' and later causes a
11638 peculiar kind of quitting. */);
11639 Vthrow_on_input
= Qnil
;
11641 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11642 doc
: /* Function to output error messages.
11643 Called with three arguments:
11644 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11645 such as what `condition-case' would bind its variable to,
11646 - the context (a string which normally goes at the start of the message),
11647 - the Lisp function within which the error was signaled. */);
11648 Vcommand_error_function
= intern ("command-error-default-function");
11650 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11651 Venable_disabled_menus_and_buttons
,
11652 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11654 Help functions bind this to allow help on disabled menu items
11655 and tool-bar buttons. */);
11656 Venable_disabled_menus_and_buttons
= Qnil
;
11658 DEFVAR_LISP ("select-active-regions",
11659 Vselect_active_regions
,
11660 doc
: /* If non-nil, an active region automatically sets the primary selection.
11661 If the value is `only', only temporarily active regions (usually made
11662 by mouse-dragging or shift-selection) set the window selection.
11664 This takes effect only when Transient Mark mode is enabled. */);
11665 Vselect_active_regions
= Qt
;
11667 DEFVAR_LISP ("saved-region-selection",
11668 Vsaved_region_selection
,
11669 doc
: /* Contents of active region prior to buffer modification.
11670 If `select-active-regions' is non-nil, Emacs sets this to the
11671 text in the region before modifying the buffer. The next call to
11672 the function `deactivate-mark' uses this to set the window selection. */);
11673 Vsaved_region_selection
= Qnil
;
11675 DEFVAR_LISP ("selection-inhibit-update-commands",
11676 Vselection_inhibit_update_commands
,
11677 doc
: /* List of commands which should not update the selection.
11678 Normally, if `select-active-regions' is non-nil and the mark remains
11679 active after a command (i.e. the mark was not deactivated), the Emacs
11680 command loop sets the selection to the text in the region. However,
11681 if the command is in this list, the selection is not updated. */);
11682 Vselection_inhibit_update_commands
11683 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11685 DEFVAR_LISP ("debug-on-event",
11687 doc
: /* Enter debugger on this event. When Emacs
11688 receives the special event specified by this variable, it will try to
11689 break into the debugger as soon as possible instead of processing the
11690 event normally through `special-event-map'.
11692 Currently, the only supported values for this
11693 variable are `sigusr1' and `sigusr2'. */);
11694 Vdebug_on_event
= intern_c_string ("sigusr2");
11696 /* Create the initial keyboard. Qt means 'unset'. */
11697 initial_kboard
= allocate_kboard (Qt
);
11701 keys_of_keyboard (void)
11703 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11704 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11705 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11706 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11707 initial_define_key (meta_map
, 'x', "execute-extended-command");
11709 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11710 "handle-delete-frame");
11711 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11712 "ns-put-working-text");
11713 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11714 "ns-unput-working-text");
11715 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11716 current-prefix-arg, as is done in `handle-switch-frame'.
11717 But `handle-switch-frame is not run from the special-map.
11718 Commands from that map are run in a special way that automatically
11719 preserves the prefix-arg. Restoring the prefix arg here is not just
11720 redundant but harmful:
11722 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11723 - after the first prompt, the exit-minibuffer-hook is run which may
11724 iconify a frame and thus push a `iconify-frame' event.
11725 - after running exit-minibuffer-hook, current-prefix-arg is
11726 restored to the non-nil value it had before the prompt.
11727 - we enter the second prompt.
11728 current-prefix-arg is non-nil, prefix-arg is nil.
11729 - before running the first real event, we run the special iconify-frame
11730 event, but we pass the `special' arg to execute-command so
11731 current-prefix-arg and prefix-arg are left untouched.
11732 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11733 - the next key event will have a spuriously non-nil current-prefix-arg. */
11734 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11736 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11738 /* Handling it at such a low-level causes read_key_sequence to get
11739 * confused because it doesn't realize that the current_buffer was
11740 * changed by read_char.
11742 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11743 * "handle-select-window"); */
11744 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11745 "handle-save-session");
11748 /* Define a special event which is raised for dbus callback
11750 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11751 "dbus-handle-event");
11754 #ifdef USE_FILE_NOTIFY
11755 /* Define a special event which is raised for notification callback
11757 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11758 "file-notify-handle-event");
11759 #endif /* USE_FILE_NOTIFY */
11761 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11763 #if defined (WINDOWSNT)
11764 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11767 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11768 "handle-focus-in");
11769 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11770 "handle-focus-out");