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)
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
);
784 /* When an auto-save happens, record the "time", and don't do again soon. */
787 record_auto_save (void)
789 last_auto_save
= num_nonmacro_input_events
;
792 /* Make an auto save happen as soon as possible at command level. */
796 force_auto_save_soon (void)
798 last_auto_save
= - auto_save_interval
- 1;
800 record_asynch_buffer_change ();
804 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
805 doc
: /* Invoke the editor command loop recursively.
806 To get out of the recursive edit, a command can throw to `exit' -- for
807 instance `(throw 'exit nil)'.
808 If you throw a value other than t, `recursive-edit' returns normally
809 to the function that called it. Throwing a t value causes
810 `recursive-edit' to quit, so that control returns to the command loop
813 This function is called by the editor initialization to begin editing. */)
819 /* If we enter while input is blocked, don't lock up here.
820 This may happen through the debugger during redisplay. */
821 if (input_blocked_p ()) {
826 if (command_loop_level
>= 0
827 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
828 buffer
= Fcurrent_buffer ();
832 /* Don't do anything interesting between the increment and the
833 record_unwind_protect! Otherwise, we could get distracted and
834 never decrement the counter again. */
835 command_loop_level
++;
836 update_mode_lines
= 17;
837 record_unwind_protect (recursive_edit_unwind
, buffer
);
839 /* If we leave recursive_edit_1 below with a `throw' for instance,
840 like it is done in the splash screen display, we have to
841 make sure that we restore single_kboard as command_loop_1
842 would have done if it were left normally. */
843 if (command_loop_level
> 0)
844 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
852 recursive_edit_unwind (Lisp_Object buffer
)
854 if (BUFFERP (buffer
))
855 Fset_buffer (buffer
);
857 command_loop_level
--;
858 update_mode_lines
= 18;
862 #if 0 /* These two functions are now replaced with
863 temporarily_switch_to_single_kboard. */
867 #if 0 /* Theory: if there's anything in Vunread_command_events,
868 it will right away be read by read_key_sequence,
869 and then if we do switch KBOARDS, it will go into the side
870 queue then. So we don't need to do anything special here -- rms. */
871 if (CONSP (Vunread_command_events
))
873 current_kboard
->kbd_queue
874 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
875 current_kboard
->kbd_queue_has_data
= 1;
877 Vunread_command_events
= Qnil
;
882 /* Switch to the single-kboard state, making current_kboard
883 the only KBOARD from which further input is accepted. */
886 single_kboard_state ()
892 /* If we're in single_kboard state for kboard KBOARD,
896 not_single_kboard_state (KBOARD
*kboard
)
898 if (kboard
== current_kboard
)
902 /* Maintain a stack of kboards, so other parts of Emacs
903 can switch temporarily to the kboard of a given frame
904 and then revert to the previous status. */
909 struct kboard_stack
*next
;
912 static struct kboard_stack
*kboard_stack
;
915 push_kboard (struct kboard
*k
)
917 struct kboard_stack
*p
= xmalloc (sizeof *p
);
919 p
->next
= kboard_stack
;
920 p
->kboard
= current_kboard
;
930 struct kboard_stack
*p
= kboard_stack
;
932 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
934 if (t
->kboard
== p
->kboard
)
936 current_kboard
= p
->kboard
;
943 /* The terminal we remembered has been deleted. */
944 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
947 kboard_stack
= p
->next
;
951 /* Switch to single_kboard mode, making current_kboard the only KBOARD
952 from which further input is accepted. If F is non-nil, set its
953 KBOARD as the current keyboard.
955 This function uses record_unwind_protect_int to return to the previous
958 If Emacs is already in single_kboard mode, and F's keyboard is
959 locked, then this function will throw an error. */
962 temporarily_switch_to_single_kboard (struct frame
*f
)
964 bool was_locked
= single_kboard
;
967 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
968 /* We can not switch keyboards while in single_kboard mode.
969 In rare cases, Lisp code may call `recursive-edit' (or
970 `read-minibuffer' or `y-or-n-p') after it switched to a
971 locked frame. For example, this is likely to happen
972 when server.el connects to a new terminal while Emacs is in
973 single_kboard mode. It is best to throw an error instead
974 of presenting the user with a frozen screen. */
975 error ("Terminal %d is locked, cannot read from it",
976 FRAME_TERMINAL (f
)->id
);
978 /* This call is unnecessary, but helps
979 `restore_kboard_configuration' discover if somebody changed
980 `current_kboard' behind our back. */
981 push_kboard (current_kboard
);
984 current_kboard
= FRAME_KBOARD (f
);
986 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
989 #if 0 /* This function is not needed anymore. */
991 record_single_kboard_state ()
994 push_kboard (current_kboard
);
995 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
1000 restore_kboard_configuration (int was_locked
)
1002 single_kboard
= was_locked
;
1005 struct kboard
*prev
= current_kboard
;
1007 /* The pop should not change the kboard. */
1008 if (single_kboard
&& current_kboard
!= prev
)
1014 /* Handle errors that are not handled at inner levels
1015 by printing an error message and returning to the editor command loop. */
1018 cmd_error (Lisp_Object data
)
1020 Lisp_Object old_level
, old_length
;
1021 char macroerror
[sizeof "After..kbd macro iterations: "
1022 + INT_STRLEN_BOUND (EMACS_INT
)];
1024 #ifdef HAVE_WINDOW_SYSTEM
1025 if (display_hourglass_p
)
1026 cancel_hourglass ();
1029 if (!NILP (executing_kbd_macro
))
1031 if (executing_kbd_macro_iterations
== 1)
1032 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1034 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1035 executing_kbd_macro_iterations
);
1040 Vstandard_output
= Qt
;
1041 Vstandard_input
= Qt
;
1042 Vexecuting_kbd_macro
= Qnil
;
1043 executing_kbd_macro
= Qnil
;
1044 kset_prefix_arg (current_kboard
, Qnil
);
1045 kset_last_prefix_arg (current_kboard
, Qnil
);
1048 /* Avoid unquittable loop if data contains a circular list. */
1049 old_level
= Vprint_level
;
1050 old_length
= Vprint_length
;
1051 XSETFASTINT (Vprint_level
, 10);
1052 XSETFASTINT (Vprint_length
, 10);
1053 cmd_error_internal (data
, macroerror
);
1054 Vprint_level
= old_level
;
1055 Vprint_length
= old_length
;
1058 Vinhibit_quit
= Qnil
;
1060 return make_number (0);
1063 /* Take actions on handling an error. DATA is the data that describes
1066 CONTEXT is a C-string containing ASCII characters only which
1067 describes the context in which the error happened. If we need to
1068 generalize CONTEXT to allow multibyte characters, make it a Lisp
1072 cmd_error_internal (Lisp_Object data
, const char *context
)
1074 /* The immediate context is not interesting for Quits,
1075 since they are asynchronous. */
1076 if (EQ (XCAR (data
), Qquit
))
1077 Vsignaling_function
= Qnil
;
1082 /* Use user's specified output function if any. */
1083 if (!NILP (Vcommand_error_function
))
1084 call3 (Vcommand_error_function
, data
,
1085 context
? build_string (context
) : empty_unibyte_string
,
1086 Vsignaling_function
);
1088 Vsignaling_function
= Qnil
;
1091 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1092 Scommand_error_default_function
, 3, 3, 0,
1093 doc
: /* Produce default output for unhandled error message.
1094 Default value of `command-error-function'. */)
1095 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1097 struct frame
*sf
= SELECTED_FRAME ();
1099 CHECK_STRING (context
);
1101 /* If the window system or terminal frame hasn't been initialized
1102 yet, or we're not interactive, write the message to stderr and exit. */
1103 if (!sf
->glyphs_initialized_p
1104 /* The initial frame is a special non-displaying frame. It
1105 will be current in daemon mode when there are no frames
1106 to display, and in non-daemon mode before the real frame
1107 has finished initializing. If an error is thrown in the
1108 latter case while creating the frame, then the frame
1109 will never be displayed, so the safest thing to do is
1110 write to stderr and quit. In daemon mode, there are
1111 many other potential errors that do not prevent frames
1112 from being created, so continuing as normal is better in
1114 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1117 print_error_message (data
, Qexternal_debugging_output
,
1118 SSDATA (context
), signal
);
1119 Fterpri (Qexternal_debugging_output
);
1120 Fkill_emacs (make_number (-1));
1124 clear_message (1, 0);
1126 message_log_maybe_newline ();
1129 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1134 static Lisp_Object
command_loop_2 (Lisp_Object
);
1135 static Lisp_Object
top_level_1 (Lisp_Object
);
1137 /* Entry to editor-command-loop.
1138 This level has the catches for exiting/returning to editor command loop.
1139 It returns nil to exit recursive edit, t to abort it. */
1144 if (command_loop_level
> 0 || minibuf_level
> 0)
1147 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1148 executing_kbd_macro
= Qnil
;
1154 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1155 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1156 executing_kbd_macro
= Qnil
;
1158 /* End of file in -batch run causes exit here. */
1164 /* Here we catch errors in execution of commands within the
1165 editing loop, and reenter the editing loop.
1166 When there is an error, cmd_error runs and returns a non-nil
1167 value to us. A value of nil means that command_loop_1 itself
1168 returned due to end of file (or end of kbd macro). */
1171 command_loop_2 (Lisp_Object ignore
)
1173 register Lisp_Object val
;
1176 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1177 while (!NILP (val
));
1185 return Feval (Vtop_level
, Qnil
);
1189 top_level_1 (Lisp_Object ignore
)
1191 /* On entry to the outer level, run the startup file. */
1192 if (!NILP (Vtop_level
))
1193 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1194 else if (!NILP (Vpurify_flag
))
1195 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1197 message1 ("Bare Emacs (standard Lisp code not loaded)");
1201 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1202 doc
: /* Exit all recursive editing levels.
1203 This also exits all active minibuffers. */)
1206 #ifdef HAVE_WINDOW_SYSTEM
1207 if (display_hourglass_p
)
1208 cancel_hourglass ();
1211 /* Unblock input if we enter with input blocked. This may happen if
1212 redisplay traps e.g. during tool-bar update with input blocked. */
1213 totally_unblock_input ();
1215 Fthrow (Qtop_level
, Qnil
);
1218 static _Noreturn
void
1219 user_error (const char *msg
)
1221 xsignal1 (Quser_error
, build_string (msg
));
1224 /* _Noreturn will be added to prototype by make-docfile. */
1225 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1226 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1229 if (command_loop_level
> 0 || minibuf_level
> 0)
1230 Fthrow (Qexit
, Qnil
);
1232 user_error ("No recursive edit is in progress");
1235 /* _Noreturn will be added to prototype by make-docfile. */
1236 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1237 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1240 if (command_loop_level
> 0 || minibuf_level
> 0)
1243 user_error ("No recursive edit is in progress");
1246 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1247 of this function. */
1250 tracking_off (Lisp_Object old_value
)
1252 do_mouse_tracking
= old_value
;
1253 if (NILP (old_value
))
1255 /* Redisplay may have been preempted because there was input
1256 available, and it assumes it will be called again after the
1257 input has been processed. If the only input available was
1258 the sort that we have just disabled, then we need to call
1260 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1262 redisplay_preserve_echo_area (6);
1263 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1268 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1269 doc
: /* Evaluate BODY with mouse movement events enabled.
1270 Within a `track-mouse' form, mouse motion generates input events that
1271 you can read with `read-event'.
1272 Normally, mouse motion is ignored.
1273 usage: (track-mouse BODY...) */)
1279 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1281 do_mouse_tracking
= Qt
;
1283 val
= Fprogn (args
);
1288 /* If mouse has moved on some frame, return one of those frames.
1292 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1293 after resizing the tool-bar window. */
1295 bool ignore_mouse_drag_p
;
1297 static struct frame
*
1298 some_mouse_moved (void)
1300 Lisp_Object tail
, frame
;
1302 if (ignore_mouse_drag_p
)
1304 /* ignore_mouse_drag_p = 0; */
1308 FOR_EACH_FRAME (tail
, frame
)
1310 if (XFRAME (frame
)->mouse_moved
)
1311 return XFRAME (frame
);
1318 /* This is the actual command reading loop,
1319 sans error-handling encapsulation. */
1321 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1322 bool, bool, bool, bool);
1323 static void adjust_point_for_property (ptrdiff_t, bool);
1325 /* The last boundary auto-added to buffer-undo-list. */
1326 Lisp_Object last_undo_boundary
;
1328 /* FIXME: This is wrong rather than test window-system, we should call
1329 a new set-selection, which will then dispatch to x-set-selection, or
1330 tty-set-selection, or w32-set-selection, ... */
1333 command_loop_1 (void)
1336 Lisp_Object keybuf
[30];
1338 EMACS_INT prev_modiff
= 0;
1339 struct buffer
*prev_buffer
= NULL
;
1340 bool already_adjusted
= 0;
1342 kset_prefix_arg (current_kboard
, Qnil
);
1343 kset_last_prefix_arg (current_kboard
, Qnil
);
1344 Vdeactivate_mark
= Qnil
;
1345 waiting_for_input
= 0;
1348 this_command_key_count
= 0;
1349 this_command_key_count_reset
= 0;
1350 this_single_command_key_start
= 0;
1352 if (NILP (Vmemory_full
))
1354 /* Make sure this hook runs after commands that get errors and
1355 throw to top level. */
1356 /* Note that the value cell will never directly contain nil
1357 if the symbol is a local variable. */
1358 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1359 safe_run_hooks (Qpost_command_hook
);
1361 /* If displaying a message, resize the echo area window to fit
1362 that message's size exactly. */
1363 if (!NILP (echo_area_buffer
[0]))
1364 resize_echo_area_exactly ();
1366 /* If there are warnings waiting, process them. */
1367 if (!NILP (Vdelayed_warnings_list
))
1368 safe_run_hooks (Qdelayed_warnings_hook
);
1370 if (!NILP (Vdeferred_action_list
))
1371 safe_run_hooks (Qdeferred_action_function
);
1374 /* Do this after running Vpost_command_hook, for consistency. */
1375 kset_last_command (current_kboard
, Vthis_command
);
1376 kset_real_last_command (current_kboard
, Vreal_this_command
);
1377 if (!CONSP (last_command_event
))
1378 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1382 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1385 /* Make sure the current window's buffer is selected. */
1386 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1388 /* Display any malloc warning that just came out. Use while because
1389 displaying one warning can cause another. */
1391 while (pending_malloc_warning
)
1392 display_malloc_warning ();
1394 Vdeactivate_mark
= Qnil
;
1396 /* Don't ignore mouse movements for more than a single command
1397 loop. (This flag is set in xdisp.c whenever the tool bar is
1398 resized, because the resize moves text up or down, and would
1399 generate false mouse drag events if we don't ignore them.) */
1400 ignore_mouse_drag_p
= 0;
1402 /* If minibuffer on and echo area in use,
1403 wait a short time and redraw minibuffer. */
1406 && !NILP (echo_area_buffer
[0])
1407 && EQ (minibuf_window
, echo_area_window
)
1408 && NUMBERP (Vminibuffer_message_timeout
))
1410 /* Bind inhibit-quit to t so that C-g gets read in
1411 rather than quitting back to the minibuffer. */
1413 specbind (Qinhibit_quit
, Qt
);
1415 sit_for (Vminibuffer_message_timeout
, 0, 2);
1417 /* Clear the echo area. */
1419 safe_run_hooks (Qecho_area_clear_hook
);
1423 /* If a C-g came in before, treat it as input now. */
1424 if (!NILP (Vquit_flag
))
1427 Vunread_command_events
= list1 (make_number (quit_char
));
1431 /* If it has changed current-menubar from previous value,
1432 really recompute the menubar from the value. */
1433 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1434 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1435 call0 (Qrecompute_lucid_menubar
);
1437 before_command_key_count
= this_command_key_count
;
1438 before_command_echo_length
= echo_length ();
1440 Vthis_command
= Qnil
;
1441 Vreal_this_command
= Qnil
;
1442 Vthis_original_command
= Qnil
;
1443 Vthis_command_keys_shift_translated
= Qnil
;
1445 /* Read next key sequence; i gets its length. */
1446 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1449 /* A filter may have run while we were reading the input. */
1450 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1452 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1456 /* Now we have read a key sequence of length I,
1457 or else I is 0 and we found end of file. */
1459 if (i
== 0) /* End of file -- happens only in */
1460 return Qnil
; /* a kbd macro, at the end. */
1461 /* -1 means read_key_sequence got a menu that was rejected.
1462 Just loop around and read another command. */
1466 this_command_key_count
= 0;
1467 this_command_key_count_reset
= 0;
1468 this_single_command_key_start
= 0;
1472 last_command_event
= keybuf
[i
- 1];
1474 /* If the previous command tried to force a specific window-start,
1475 forget about that, in case this command moves point far away
1476 from that position. But also throw away beg_unchanged and
1477 end_unchanged information in that case, so that redisplay will
1478 update the whole window properly. */
1479 if (XWINDOW (selected_window
)->force_start
)
1482 XWINDOW (selected_window
)->force_start
= 0;
1483 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1484 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1487 cmd
= read_key_sequence_cmd
;
1488 if (!NILP (Vexecuting_kbd_macro
))
1490 if (!NILP (Vquit_flag
))
1492 Vexecuting_kbd_macro
= Qt
;
1493 QUIT
; /* Make some noise. */
1494 /* Will return since macro now empty. */
1498 /* Do redisplay processing after this command except in special
1499 cases identified below. */
1500 prev_buffer
= current_buffer
;
1501 prev_modiff
= MODIFF
;
1502 last_point_position
= PT
;
1504 /* By default, we adjust point to a boundary of a region that
1505 has such a property that should be treated intangible
1506 (e.g. composition, display). But, some commands will set
1507 this variable differently. */
1508 Vdisable_point_adjustment
= Qnil
;
1510 /* Process filters and timers may have messed with deactivate-mark.
1511 reset it before we execute the command. */
1512 Vdeactivate_mark
= Qnil
;
1514 /* Remap command through active keymaps. */
1515 Vthis_original_command
= cmd
;
1516 if (!NILP (read_key_sequence_remapped
))
1517 cmd
= read_key_sequence_remapped
;
1519 /* Execute the command. */
1521 Vthis_command
= cmd
;
1522 Vreal_this_command
= cmd
;
1523 safe_run_hooks (Qpre_command_hook
);
1525 already_adjusted
= 0;
1527 if (NILP (Vthis_command
))
1528 /* nil means key is undefined. */
1532 /* Here for a command that isn't executed directly. */
1534 #ifdef HAVE_WINDOW_SYSTEM
1537 if (display_hourglass_p
1538 && NILP (Vexecuting_kbd_macro
))
1540 record_unwind_protect_void (cancel_hourglass
);
1545 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1547 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1550 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1551 ? Qnil
: BVAR (current_buffer
, undo_list
));
1553 call1 (Qcommand_execute
, Vthis_command
);
1555 #ifdef HAVE_WINDOW_SYSTEM
1556 /* Do not check display_hourglass_p here, because
1557 `command-execute' could change it, but we should cancel
1558 hourglass cursor anyway.
1559 But don't cancel the hourglass within a macro
1560 just because a command in the macro finishes. */
1564 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1566 safe_run_hooks (Qpost_command_hook
);
1568 /* If displaying a message, resize the echo area window to fit
1569 that message's size exactly. */
1570 if (!NILP (echo_area_buffer
[0]))
1571 resize_echo_area_exactly ();
1573 /* If there are warnings waiting, process them. */
1574 if (!NILP (Vdelayed_warnings_list
))
1575 safe_run_hooks (Qdelayed_warnings_hook
);
1577 safe_run_hooks (Qdeferred_action_function
);
1579 /* If there is a prefix argument,
1580 1) We don't want Vlast_command to be ``universal-argument''
1581 (that would be dumb), so don't set Vlast_command,
1582 2) we want to leave echoing on so that the prefix will be
1583 echoed as part of this key sequence, so don't call
1585 3) we want to leave this_command_key_count non-zero, so that
1586 read_char will realize that it is re-reading a character, and
1587 not echo it a second time.
1589 If the command didn't actually create a prefix arg,
1590 but is merely a frame event that is transparent to prefix args,
1591 then the above doesn't apply. */
1592 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1593 || CONSP (last_command_event
))
1595 kset_last_command (current_kboard
, Vthis_command
);
1596 kset_real_last_command (current_kboard
, Vreal_this_command
);
1597 if (!CONSP (last_command_event
))
1598 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1600 this_command_key_count
= 0;
1601 this_command_key_count_reset
= 0;
1602 this_single_command_key_start
= 0;
1605 if (!NILP (BVAR (current_buffer
, mark_active
))
1606 && !NILP (Vrun_hooks
))
1608 /* In Emacs 22, setting transient-mark-mode to `only' was a
1609 way of turning it on for just one command. This usage is
1610 obsolete, but support it anyway. */
1611 if (EQ (Vtransient_mark_mode
, Qidentity
))
1612 Vtransient_mark_mode
= Qnil
;
1613 else if (EQ (Vtransient_mark_mode
, Qonly
))
1614 Vtransient_mark_mode
= Qidentity
;
1616 if (!NILP (Vdeactivate_mark
))
1617 /* If `select-active-regions' is non-nil, this call to
1618 `deactivate-mark' also sets the PRIMARY selection. */
1619 call0 (Qdeactivate_mark
);
1622 /* Even if not deactivating the mark, set PRIMARY if
1623 `select-active-regions' is non-nil. */
1624 if (!NILP (Fwindow_system (Qnil
))
1625 /* Even if mark_active is non-nil, the actual buffer
1626 marker may not have been set yet (Bug#7044). */
1627 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1628 && (EQ (Vselect_active_regions
, Qonly
)
1629 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1630 : (!NILP (Vselect_active_regions
)
1631 && !NILP (Vtransient_mark_mode
)))
1632 && NILP (Fmemq (Vthis_command
,
1633 Vselection_inhibit_update_commands
)))
1636 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1637 if (XINT (Flength (txt
)) > 0)
1638 /* Don't set empty selections. */
1639 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1642 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1644 Lisp_Object hook
= intern ("activate-mark-hook");
1645 Frun_hooks (1, &hook
);
1649 Vsaved_region_selection
= Qnil
;
1654 if (current_buffer
== prev_buffer
1655 && last_point_position
!= PT
1656 && NILP (Vdisable_point_adjustment
)
1657 && NILP (Vglobal_disable_point_adjustment
))
1659 if (last_point_position
> BEGV
1660 && last_point_position
< ZV
1661 && (composition_adjust_point (last_point_position
,
1662 last_point_position
)
1663 != last_point_position
))
1664 /* The last point was temporarily set within a grapheme
1665 cluster to prevent automatic composition. To recover
1666 the automatic composition, we must update the
1668 windows_or_buffers_changed
= 21;
1669 if (!already_adjusted
)
1670 adjust_point_for_property (last_point_position
,
1671 MODIFF
!= prev_modiff
);
1674 /* Install chars successfully executed in kbd macro. */
1676 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1677 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1678 finalize_kbd_macro_chars ();
1683 read_menu_command (void)
1685 Lisp_Object keybuf
[30];
1686 ptrdiff_t count
= SPECPDL_INDEX ();
1689 /* We don't want to echo the keystrokes while navigating the
1691 specbind (Qecho_keystrokes
, make_number (0));
1693 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1696 unbind_to (count
, Qnil
);
1698 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1700 if (i
== 0 || i
== -1)
1703 return read_key_sequence_cmd
;
1706 /* Adjust point to a boundary of a region that has such a property
1707 that should be treated intangible. For the moment, we check
1708 `composition', `display' and `invisible' properties.
1709 LAST_PT is the last position of point. */
1712 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1715 Lisp_Object val
, overlay
, tmp
;
1716 /* When called after buffer modification, we should temporarily
1717 suppress the point adjustment for automatic composition so that a
1718 user can keep inserting another character at point or keep
1719 deleting characters around point. */
1720 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1721 ptrdiff_t orig_pt
= PT
;
1723 /* FIXME: cycling is probably not necessary because these properties
1724 can't be usefully combined anyway. */
1725 while (check_composition
|| check_display
|| check_invisible
)
1727 /* FIXME: check `intangible'. */
1728 if (check_composition
1729 && PT
> BEGV
&& PT
< ZV
1730 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1733 check_display
= check_invisible
= 1;
1735 check_composition
= 0;
1737 && PT
> BEGV
&& PT
< ZV
1738 && !NILP (val
= get_char_property_and_overlay
1739 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1740 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1741 && (!OVERLAYP (overlay
)
1742 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1743 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1744 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1745 && (beg
< PT
/* && end > PT <- It's always the case. */
1746 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1749 SET_PT (PT
< last_pt
1750 ? (STRINGP (val
) && SCHARS (val
) == 0
1751 ? max (beg
- 1, BEGV
)
1754 check_composition
= check_invisible
= 1;
1757 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1763 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1766 /* FIXME: We should stop if we find a spot between
1767 two runs of `invisible' where inserted text would
1768 be visible. This is important when we have two
1769 invisible boundaries that enclose an area: if the
1770 area is empty, we need this test in order to make
1771 it possible to place point in the middle rather
1772 than skip both boundaries. However, this code
1773 also stops anywhere in a non-sticky text-property,
1774 which breaks (e.g.) Org mode. */
1775 && (val
= Fget_pos_property (make_number (end
),
1777 TEXT_PROP_MEANS_INVISIBLE (val
))
1779 && !NILP (val
= get_char_property_and_overlay
1780 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1781 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1783 ellipsis
= ellipsis
|| inv
> 1
1784 || (OVERLAYP (overlay
)
1785 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1786 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1787 tmp
= Fnext_single_char_property_change
1788 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1789 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1793 && (val
= Fget_pos_property (make_number (beg
),
1795 TEXT_PROP_MEANS_INVISIBLE (val
))
1797 && !NILP (val
= get_char_property_and_overlay
1798 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1799 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1801 ellipsis
= ellipsis
|| inv
> 1
1802 || (OVERLAYP (overlay
)
1803 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1804 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1805 tmp
= Fprevious_single_char_property_change
1806 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1807 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1810 /* Move away from the inside area. */
1811 if (beg
< PT
&& end
> PT
)
1813 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1814 /* We haven't moved yet (so we don't need to fear
1815 infinite-looping) and we were outside the range
1816 before (so either end of the range still corresponds
1817 to a move in the right direction): pretend we moved
1818 less than we actually did, so that we still have
1819 more freedom below in choosing which end of the range
1821 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1822 /* We either have moved already or the last point
1823 was already in the range: we don't get to choose
1824 which end of the range we have to go to. */
1825 : (PT
< last_pt
? beg
: end
));
1826 check_composition
= check_display
= 1;
1828 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1829 the point to something other than its argument, due to
1830 point-motion hooks, intangibility, etc. */
1831 eassert (PT
== beg
|| PT
== end
);
1834 /* Pretend the area doesn't exist if the buffer is not
1836 if (!modified
&& !ellipsis
&& beg
< end
)
1838 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1839 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1840 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1841 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1842 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1843 /* We've already moved as far as we can. Trying to go
1844 to the other end would mean moving backwards and thus
1845 could lead to an infinite loop. */
1847 else if (val
= Fget_pos_property (make_number (PT
),
1849 TEXT_PROP_MEANS_INVISIBLE (val
)
1850 && (val
= (Fget_pos_property
1851 (make_number (PT
== beg
? end
: beg
),
1853 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1854 (check_composition
= check_display
= 1,
1855 SET_PT (PT
== beg
? end
: beg
));
1858 check_invisible
= 0;
1862 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1865 safe_run_hooks_1 (void)
1867 eassert (CONSP (Vinhibit_quit
));
1868 return call0 (XCDR (Vinhibit_quit
));
1871 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1875 safe_run_hooks_error (Lisp_Object error_data
)
1878 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1879 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1880 Lisp_Object args
[4];
1881 args
[0] = build_string ("Error in %s (%S): %S");
1884 args
[3] = error_data
;
1890 Lisp_Object newval
= Qnil
;
1891 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1892 if (EQ (fun
, XCAR (val
)))
1895 newval
= Fcons (XCAR (val
), newval
);
1897 return Fset (hook
, Fnreverse (newval
));
1898 /* Not found in the local part of the hook. Let's look at the global
1901 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1902 : Fdefault_value (hook
));
1903 CONSP (val
); val
= XCDR (val
))
1904 if (EQ (fun
, XCAR (val
)))
1907 newval
= Fcons (XCAR (val
), newval
);
1909 return Fset_default (hook
, Fnreverse (newval
));
1915 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1917 eassert (nargs
== 1);
1918 if (CONSP (Vinhibit_quit
))
1919 XSETCDR (Vinhibit_quit
, args
[0]);
1921 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1923 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1927 /* If we get an error while running the hook, cause the hook variable
1928 to be nil. Also inhibit quits, so that C-g won't cause the hook
1929 to mysteriously evaporate. */
1932 safe_run_hooks (Lisp_Object hook
)
1934 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1935 to its body or to its handlers other than via globals such as
1936 dynamically-bound variables ;-) */
1938 specbind (Qinhibit_quit
, hook
);
1940 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1946 /* Nonzero means polling for input is temporarily suppressed. */
1948 int poll_suppress_count
;
1951 #ifdef POLL_FOR_INPUT
1953 /* Asynchronous timer for polling. */
1955 static struct atimer
*poll_timer
;
1957 /* Poll for input, so that we catch a C-g if it comes in. */
1959 poll_for_input_1 (void)
1961 if (! input_blocked_p ()
1962 && !waiting_for_input
)
1966 /* Timer callback function for poll_timer. TIMER is equal to
1970 poll_for_input (struct atimer
*timer
)
1972 if (poll_suppress_count
== 0)
1973 pending_signals
= 1;
1976 #endif /* POLL_FOR_INPUT */
1978 /* Begin signals to poll for input, if they are appropriate.
1979 This function is called unconditionally from various places. */
1982 start_polling (void)
1984 #ifdef POLL_FOR_INPUT
1985 /* XXX This condition was (read_socket_hook && !interrupt_input),
1986 but read_socket_hook is not global anymore. Let's pretend that
1988 if (!interrupt_input
)
1990 /* Turn alarm handling on unconditionally. It might have
1991 been turned off in process.c. */
1992 turn_on_atimers (1);
1994 /* If poll timer doesn't exist, or we need one with
1995 a different interval, start a new one. */
1996 if (poll_timer
== NULL
1997 || poll_timer
->interval
.tv_sec
!= polling_period
)
1999 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2000 struct timespec interval
= make_timespec (period
, 0);
2003 cancel_atimer (poll_timer
);
2005 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2006 poll_for_input
, NULL
);
2009 /* Let the timer's callback function poll for input
2010 if this becomes zero. */
2011 --poll_suppress_count
;
2016 /* True if we are using polling to handle input asynchronously. */
2019 input_polling_used (void)
2021 #ifdef POLL_FOR_INPUT
2022 /* XXX This condition was (read_socket_hook && !interrupt_input),
2023 but read_socket_hook is not global anymore. Let's pretend that
2025 return !interrupt_input
;
2031 /* Turn off polling. */
2036 #ifdef POLL_FOR_INPUT
2037 /* XXX This condition was (read_socket_hook && !interrupt_input),
2038 but read_socket_hook is not global anymore. Let's pretend that
2040 if (!interrupt_input
)
2041 ++poll_suppress_count
;
2045 /* Set the value of poll_suppress_count to COUNT
2046 and start or stop polling accordingly. */
2049 set_poll_suppress_count (int count
)
2051 #ifdef POLL_FOR_INPUT
2052 if (count
== 0 && poll_suppress_count
!= 0)
2054 poll_suppress_count
= 1;
2057 else if (count
!= 0 && poll_suppress_count
== 0)
2061 poll_suppress_count
= count
;
2065 /* Bind polling_period to a value at least N.
2066 But don't decrease it. */
2069 bind_polling_period (int n
)
2071 #ifdef POLL_FOR_INPUT
2072 EMACS_INT
new = polling_period
;
2077 stop_other_atimers (poll_timer
);
2079 specbind (Qpolling_period
, make_number (new));
2080 /* Start a new alarm with the new period. */
2085 /* Apply the control modifier to CHARACTER. */
2088 make_ctrl_char (int c
)
2090 /* Save the upper bits here. */
2091 int upper
= c
& ~0177;
2093 if (! ASCII_CHAR_P (c
))
2094 return c
|= ctrl_modifier
;
2098 /* Everything in the columns containing the upper-case letters
2099 denotes a control character. */
2100 if (c
>= 0100 && c
< 0140)
2104 /* Set the shift modifier for a control char
2105 made from a shifted letter. But only for letters! */
2106 if (oc
>= 'A' && oc
<= 'Z')
2107 c
|= shift_modifier
;
2110 /* The lower-case letters denote control characters too. */
2111 else if (c
>= 'a' && c
<= 'z')
2114 /* Include the bits for control and shift
2115 only if the basic ASCII code can't indicate them. */
2119 /* Replace the high bits. */
2120 c
|= (upper
& ~ctrl_modifier
);
2125 /* Display the help-echo property of the character after the mouse pointer.
2126 Either show it in the echo area, or call show-help-function to display
2127 it by other means (maybe in a tooltip).
2129 If HELP is nil, that means clear the previous help echo.
2131 If HELP is a string, display that string. If HELP is a function,
2132 call it with OBJECT and POS as arguments; the function should
2133 return a help string or nil for none. For all other types of HELP,
2134 evaluate it to obtain a string.
2136 WINDOW is the window in which the help was generated, if any.
2137 It is nil if not in a window.
2139 If OBJECT is a buffer, POS is the position in the buffer where the
2140 `help-echo' text property was found.
2142 If OBJECT is an overlay, that overlay has a `help-echo' property,
2143 and POS is the position in the overlay's buffer under the mouse.
2145 If OBJECT is a string (an overlay string or a string displayed with
2146 the `display' property). POS is the position in that string under
2149 Note: this function may only be called with HELP nil or a string
2150 from X code running asynchronously. */
2153 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2156 if (!NILP (help
) && !STRINGP (help
))
2158 if (FUNCTIONP (help
))
2159 help
= safe_call (4, help
, window
, object
, pos
);
2161 help
= safe_eval (help
);
2163 if (!STRINGP (help
))
2167 if (!noninteractive
&& STRINGP (help
))
2169 /* The mouse-fixup-help-message Lisp function can call
2170 mouse_position_hook, which resets the mouse_moved flags.
2171 This causes trouble if we are trying to read a mouse motion
2172 event (i.e., if we are inside a `track-mouse' form), so we
2173 restore the mouse_moved flag. */
2174 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2175 help
= call1 (Qmouse_fixup_help_message
, help
);
2180 if (STRINGP (help
) || NILP (help
))
2182 if (!NILP (Vshow_help_function
))
2183 call1 (Vshow_help_function
, help
);
2184 help_echo_showing_p
= STRINGP (help
);
2190 /* Input of single characters from keyboard. */
2192 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2193 struct timespec
*end_time
);
2194 static void record_char (Lisp_Object c
);
2196 static Lisp_Object help_form_saved_window_configs
;
2198 read_char_help_form_unwind (void)
2200 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2201 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2202 if (!NILP (window_config
))
2203 Fset_window_configuration (window_config
);
2206 #define STOP_POLLING \
2207 do { if (! polling_stopped_here) stop_polling (); \
2208 polling_stopped_here = 1; } while (0)
2210 #define RESUME_POLLING \
2211 do { if (polling_stopped_here) start_polling (); \
2212 polling_stopped_here = 0; } while (0)
2215 read_event_from_main_queue (struct timespec
*end_time
,
2216 sys_jmp_buf
*local_getcjmp
,
2217 bool *used_mouse_menu
)
2219 Lisp_Object c
= Qnil
;
2220 sys_jmp_buf
*save_jump
= xmalloc (sizeof *save_jump
);
2221 KBOARD
*kb
IF_LINT (= NULL
);
2225 /* Read from the main queue, and if that gives us something we can't use yet,
2226 we put it on the appropriate side queue and try again. */
2228 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2231 /* Actually read a character, waiting if necessary. */
2232 save_getcjmp (save_jump
);
2233 restore_getcjmp (local_getcjmp
);
2235 timer_start_idle ();
2236 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2237 restore_getcjmp (save_jump
);
2239 if (! NILP (c
) && (kb
!= current_kboard
))
2241 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2244 while (CONSP (XCDR (last
)))
2246 if (!NILP (XCDR (last
)))
2250 kset_kbd_queue (kb
, list1 (c
));
2252 XSETCDR (last
, list1 (c
));
2253 kb
->kbd_queue_has_data
= 1;
2257 current_kboard
= kb
;
2258 /* This is going to exit from read_char
2259 so we had better get rid of this frame's stuff. */
2260 return make_number (-2);
2263 /* Terminate Emacs in batch mode if at eof. */
2264 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2265 Fkill_emacs (make_number (1));
2269 /* Add in any extra modifiers, where appropriate. */
2270 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2271 || ((extra_keyboard_modifiers
& 0177) < ' '
2272 && (extra_keyboard_modifiers
& 0177) != 0))
2273 XSETINT (c
, make_ctrl_char (XINT (c
)));
2275 /* Transfer any other modifier bits directly from
2276 extra_keyboard_modifiers to c. Ignore the actual character code
2277 in the low 16 bits of extra_keyboard_modifiers. */
2278 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2286 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2289 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2290 sys_jmp_buf
*local_getcjmp
,
2291 Lisp_Object prev_event
,
2292 bool *used_mouse_menu
)
2294 #define MAX_ENCODED_BYTES 16
2296 Lisp_Object events
[MAX_ENCODED_BYTES
];
2302 = read_event_from_main_queue (end_time
, local_getcjmp
,
2305 /* w32_console already returns decoded events. It either reads
2306 Unicode characters from the Windows keyboard input, or
2307 converts characters encoded in the current codepage into
2308 Unicode. See w32inevt.c:key_event, near its end. */
2311 struct frame
*frame
= XFRAME (selected_frame
);
2312 struct terminal
*terminal
= frame
->terminal
;
2313 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2314 /* Don't apply decoding if we're just reading a raw event
2315 (e.g. reading bytes sent by the xterm to specify the position
2316 of a mouse click). */
2317 && (!EQ (prev_event
, Qt
))
2318 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2319 & CODING_REQUIRE_DECODING_MASK
)))
2320 return nextevt
; /* No decoding needed. */
2323 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2324 eassert (n
< MAX_ENCODED_BYTES
);
2325 events
[n
++] = nextevt
;
2326 if (NATNUMP (nextevt
)
2327 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2328 { /* An encoded byte sequence, let's try to decode it. */
2329 struct coding_system
*coding
2330 = TERMINAL_KEYBOARD_CODING (terminal
);
2331 unsigned char *src
= alloca (n
);
2333 for (i
= 0; i
< n
; i
++)
2334 src
[i
] = XINT (events
[i
]);
2336 for (i
= 0; i
< n
; i
++)
2338 coding
->destination
= alloca (n
* 4);
2339 coding
->dst_bytes
= n
* 4;
2340 decode_coding_c_string (coding
, src
, n
, Qnil
);
2341 eassert (coding
->produced_char
<= n
);
2342 if (coding
->produced_char
== 0)
2343 { /* The encoded sequence is incomplete. */
2344 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2345 continue; /* Read on! */
2349 const unsigned char *p
= coding
->destination
;
2350 eassert (coding
->carryover_bytes
== 0);
2352 while (n
< coding
->produced_char
)
2353 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2356 /* Now `events' should hold decoded events.
2357 Normally, n should be equal to 1, but better not rely on it.
2358 We can only return one event here, so return the first we
2359 had and keep the others (if any) for later. */
2361 Vunread_command_events
2362 = Fcons (events
[--n
], Vunread_command_events
);
2370 echo_keystrokes_p (void)
2372 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2373 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2376 /* Read a character from the keyboard; call the redisplay if needed. */
2377 /* commandflag 0 means do not autosave, but do redisplay.
2378 -1 means do not redisplay, but do autosave.
2379 -2 means do neither.
2382 /* The argument MAP is a keymap for menu prompting.
2384 PREV_EVENT is the previous input event, or nil if we are reading
2385 the first event of a key sequence (or not reading a key sequence).
2386 If PREV_EVENT is t, that is a "magic" value that says
2387 not to run input methods, but in other respects to act as if
2388 not reading a key sequence.
2390 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2391 if we used a mouse menu to read the input, or false otherwise. If
2392 USED_MOUSE_MENU is null, don't dereference it.
2394 Value is -2 when we find input on another keyboard. A second call
2395 to read_char will read it.
2397 If END_TIME is non-null, it is a pointer to a struct timespec
2398 specifying the maximum time to wait until. If no input arrives by
2399 that time, stop waiting and return nil.
2401 Value is t if we showed a menu and the user rejected it. */
2403 struct read_char_state
2407 Lisp_Object prev_event
;
2408 bool *used_mouse_menu
;
2409 struct timespec
*end_time
;
2412 sys_jmp_buf
*local_getcjmp
;
2413 sys_jmp_buf
*save_jump
;
2414 Lisp_Object previous_echo_area_message
;
2415 Lisp_Object also_record
;
2417 bool polling_stopped_here
;
2418 struct kboard
*orig_kboard
;
2421 static Lisp_Object
read_char_1 (bool, volatile struct read_char_state
*);
2423 /* {{coccinelle:skip_start}} */
2425 read_char (int commandflag
, Lisp_Object map
,
2426 Lisp_Object prev_event
,
2427 bool *used_mouse_menu
, struct timespec
*end_time
)
2429 volatile struct read_char_state
*state
= xmalloc (sizeof *state
);
2431 state
->commandflag
= commandflag
;
2433 state
->prev_event
= prev_event
;
2434 state
->used_mouse_menu
= used_mouse_menu
;
2435 state
->end_time
= end_time
;
2437 state
->local_getcjmp
= xmalloc (sizeof (*state
->local_getcjmp
));
2438 state
->save_jump
= xmalloc (sizeof (*state
->save_jump
));
2439 state
->previous_echo_area_message
= Qnil
;
2440 state
->also_record
= Qnil
;
2441 state
->reread
= false;
2442 state
->polling_stopped_here
= false;
2443 state
->orig_kboard
= current_kboard
;
2445 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2446 We will do that below, temporarily for short sections of code,
2447 when appropriate. local_getcjmp must be in effect
2448 around any call to sit_for or kbd_buffer_get_event;
2449 it *must not* be in effect when we call redisplay. */
2451 state
->jmpcount
= SPECPDL_INDEX ();
2452 if (sys_setjmp (*state
->local_getcjmp
))
2454 /* Handle quits while reading the keyboard. */
2455 /* We must have saved the outer value of getcjmp here,
2456 so restore it now. */
2457 restore_getcjmp (state
->save_jump
);
2458 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2459 unbind_to (state
->jmpcount
, Qnil
);
2460 XSETINT (state
->c
, quit_char
);
2461 internal_last_event_frame
= selected_frame
;
2462 Vlast_event_frame
= internal_last_event_frame
;
2463 /* If we report the quit char as an event,
2464 don't do so more than once. */
2465 if (!NILP (Vinhibit_quit
))
2469 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2470 if (kb
!= current_kboard
)
2472 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2473 /* We shouldn't get here if we were in single-kboard mode! */
2478 while (CONSP (XCDR (last
)))
2480 if (!NILP (XCDR (last
)))
2484 kset_kbd_queue (kb
, list1 (state
->c
));
2486 XSETCDR (last
, list1 (state
->c
));
2487 kb
->kbd_queue_has_data
= 1;
2488 current_kboard
= kb
;
2489 /* This is going to exit from read_char
2490 so we had better get rid of this frame's stuff. */
2492 return make_number (-2); /* wrong_kboard_jmpbuf */
2495 return read_char_1 (true, state
);
2498 return read_char_1 (false, state
);
2502 read_char_1 (bool jump
, volatile struct read_char_state
*state
)
2504 #define commandflag state->commandflag
2505 #define map state->map
2506 #define prev_event state->prev_event
2507 #define used_mouse_menu state->used_mouse_menu
2508 #define end_time state->end_time
2510 #define jmpcount state->jmpcount
2511 #define local_getcjmp state->local_getcjmp
2512 #define save_jump state->save_jump
2513 #define previous_echo_area_message state->previous_echo_area_message
2514 #define also_record state->also_record
2515 #define reread state->reread
2516 #define polling_stopped_here state->polling_stopped_here
2517 #define orig_kboard state->orig_kboard
2518 Lisp_Object tem
, save
;
2525 if (CONSP (Vunread_post_input_method_events
))
2527 c
= XCAR (Vunread_post_input_method_events
);
2528 Vunread_post_input_method_events
2529 = XCDR (Vunread_post_input_method_events
);
2531 /* Undo what read_char_x_menu_prompt did when it unread
2532 additional keys returned by Fx_popup_menu. */
2534 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2545 if (CONSP (Vunread_command_events
))
2547 bool was_disabled
= 0;
2549 c
= XCAR (Vunread_command_events
);
2550 Vunread_command_events
= XCDR (Vunread_command_events
);
2552 /* Undo what sit-for did when it unread additional keys
2553 inside universal-argument. */
2555 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2560 /* Undo what read_char_x_menu_prompt did when it unread
2561 additional keys returned by Fx_popup_menu. */
2563 && EQ (XCDR (c
), Qdisabled
)
2564 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2570 /* If the queued event is something that used the mouse,
2571 set used_mouse_menu accordingly. */
2573 /* Also check was_disabled so last-nonmenu-event won't return
2574 a bad value when submenus are involved. (Bug#447) */
2575 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2576 *used_mouse_menu
= 1;
2578 goto reread_for_input_method
;
2581 if (CONSP (Vunread_input_method_events
))
2583 c
= XCAR (Vunread_input_method_events
);
2584 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2586 /* Undo what read_char_x_menu_prompt did when it unread
2587 additional keys returned by Fx_popup_menu. */
2589 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2593 goto reread_for_input_method
;
2596 this_command_key_count_reset
= 0;
2598 if (!NILP (Vexecuting_kbd_macro
))
2600 /* We set this to Qmacro; since that's not a frame, nobody will
2601 try to switch frames on us, and the selected window will
2604 Since this event came from a macro, it would be misleading to
2605 leave internal_last_event_frame set to wherever the last
2606 real event came from. Normally, a switch-frame event selects
2607 internal_last_event_frame after each command is read, but
2608 events read from a macro should never cause a new frame to be
2610 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2612 /* Exit the macro if we are at the end.
2613 Also, some things replace the macro with t
2614 to force an early exit. */
2615 if (EQ (Vexecuting_kbd_macro
, Qt
)
2616 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2622 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2623 if (STRINGP (Vexecuting_kbd_macro
)
2624 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2625 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2627 executing_kbd_macro_index
++;
2632 if (!NILP (unread_switch_frame
))
2634 c
= unread_switch_frame
;
2635 unread_switch_frame
= Qnil
;
2637 /* This event should make it into this_command_keys, and get echoed
2638 again, so we do not set `reread'. */
2642 /* If redisplay was requested. */
2643 if (commandflag
>= 0)
2645 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2647 /* If there is pending input, process any events which are not
2648 user-visible, such as X selection_request events. */
2650 || detect_input_pending_run_timers (0))
2651 swallow_events (0); /* May clear input_pending. */
2653 /* Redisplay if no pending input. */
2654 while (!input_pending
)
2656 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2657 redisplay_preserve_echo_area (5);
2662 /* Normal case: no input arrived during redisplay. */
2665 /* Input arrived and pre-empted redisplay.
2666 Process any events which are not user-visible. */
2668 /* If that cleared input_pending, try again to redisplay. */
2671 /* Prevent the redisplay we just did
2672 from messing up echoing of the input after the prompt. */
2673 if (commandflag
== 0 && echo_current
)
2674 echo_message_buffer
= echo_area_buffer
[0];
2678 /* Message turns off echoing unless more keystrokes turn it on again.
2680 The code in 20.x for the condition was
2682 1. echo_area_glyphs && *echo_area_glyphs
2683 2. && echo_area_glyphs != current_kboard->echobuf
2684 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2686 (1) means there's a current message displayed
2688 (2) means it's not the message from echoing from the current
2691 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2692 is set to a non-null value. This is done in read_char and it is
2693 set to echo_area_glyphs after a call to echo_char. That means
2694 ok_to_echo_at_next_pause is either null or
2695 current_kboard->echobuf with the appropriate current_kboard at
2698 So, condition (3) means in clear text ok_to_echo_at_next_pause
2699 must be either null, or the current message isn't from echoing at
2700 all, or it's from echoing from a different kboard than the
2703 if (/* There currently is something in the echo area. */
2704 !NILP (echo_area_buffer
[0])
2705 && (/* It's an echo from a different kboard. */
2706 echo_kboard
!= current_kboard
2707 /* Or we explicitly allow overwriting whatever there is. */
2708 || ok_to_echo_at_next_pause
== NULL
))
2713 /* Try reading a character via menu prompting in the minibuf.
2714 Try this before the sit-for, because the sit-for
2715 would do the wrong thing if we are supposed to do
2716 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2717 after a mouse event so don't try a minibuf menu. */
2719 if (KEYMAPP (map
) && INTERACTIVE
2720 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2721 /* Don't bring up a menu if we already have another event. */
2722 && NILP (Vunread_command_events
)
2723 && !detect_input_pending_run_timers (0))
2725 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2727 if (INTEGERP (c
) && XINT (c
) == -2)
2728 return c
; /* wrong_kboard_jmpbuf */
2734 /* Start idle timers if no time limit is supplied. We don't do it
2735 if a time limit is supplied to avoid an infinite recursion in the
2736 situation where an idle timer calls `sit-for'. */
2739 timer_start_idle ();
2741 /* If in middle of key sequence and minibuffer not active,
2742 start echoing if enough time elapses. */
2744 if (minibuf_level
== 0
2746 && !current_kboard
->immediate_echo
2747 && this_command_key_count
> 0
2749 && echo_keystrokes_p ()
2750 && (/* No message. */
2751 NILP (echo_area_buffer
[0])
2752 /* Or empty message. */
2753 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2754 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2755 /* Or already echoing from same kboard. */
2756 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2757 /* Or not echoing before and echoing allowed. */
2758 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2760 /* After a mouse event, start echoing right away.
2761 This is because we are probably about to display a menu,
2762 and we don't want to delay before doing so. */
2763 if (EVENT_HAS_PARAMETERS (prev_event
))
2769 save_getcjmp (save_jump
);
2770 restore_getcjmp (local_getcjmp
);
2771 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2772 restore_getcjmp (save_jump
);
2774 && ! CONSP (Vunread_command_events
))
2779 /* Maybe auto save due to number of keystrokes. */
2781 if (commandflag
!= 0 && commandflag
!= -2
2782 && auto_save_interval
> 0
2783 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2784 && !detect_input_pending_run_timers (0))
2786 Fdo_auto_save (Qnil
, Qnil
);
2787 /* Hooks can actually change some buffers in auto save. */
2791 /* Try reading using an X menu.
2792 This is never confused with reading using the minibuf
2793 because the recursive call of read_char in read_char_minibuf_menu_prompt
2794 does not pass on any keymaps. */
2796 if (KEYMAPP (map
) && INTERACTIVE
2797 && !NILP (prev_event
)
2798 && EVENT_HAS_PARAMETERS (prev_event
)
2799 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2800 && !EQ (XCAR (prev_event
), Qtool_bar
)
2801 /* Don't bring up a menu if we already have another event. */
2802 && NILP (Vunread_command_events
))
2804 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2806 /* Now that we have read an event, Emacs is not idle. */
2813 /* Maybe autosave and/or garbage collect due to idleness. */
2815 if (INTERACTIVE
&& NILP (c
))
2818 ptrdiff_t buffer_size
;
2820 /* Slow down auto saves logarithmically in size of current buffer,
2821 and garbage collect while we're at it. */
2822 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2823 last_non_minibuf_size
= Z
- BEG
;
2824 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2826 while (buffer_size
> 64)
2827 delay_level
++, buffer_size
-= buffer_size
>> 2;
2828 if (delay_level
< 4) delay_level
= 4;
2829 /* delay_level is 4 for files under around 50k, 7 at 100k,
2830 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2832 /* Auto save if enough time goes by without input. */
2833 if (commandflag
!= 0 && commandflag
!= -2
2834 && num_nonmacro_input_events
> last_auto_save
2835 && INTEGERP (Vauto_save_timeout
)
2836 && XINT (Vauto_save_timeout
) > 0)
2839 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2841 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2842 timeout
= delay_level
* timeout
/ 4;
2843 save_getcjmp (save_jump
);
2844 restore_getcjmp (local_getcjmp
);
2845 tem0
= sit_for (make_number (timeout
), 1, 1);
2846 restore_getcjmp (save_jump
);
2849 && ! CONSP (Vunread_command_events
))
2851 Fdo_auto_save (Qnil
, Qnil
);
2856 /* If there is still no input available, ask for GC. */
2857 if (!detect_input_pending_run_timers (0))
2858 GC_collect_a_little ();
2861 /* Notify the caller if an autosave hook, or a timer, sentinel or
2862 filter in the sit_for calls above have changed the current
2863 kboard. This could happen if they use the minibuffer or start a
2864 recursive edit, like the fancy splash screen in server.el's
2865 filter. If this longjmp wasn't here, read_key_sequence would
2866 interpret the next key sequence using the wrong translation
2867 tables and function keymaps. */
2868 if (NILP (c
) && current_kboard
!= orig_kboard
)
2871 return make_number (-2); /* wrong_kboard_jmpbuf */
2874 /* If this has become non-nil here, it has been set by a timer
2875 or sentinel or filter. */
2876 if (CONSP (Vunread_command_events
))
2878 c
= XCAR (Vunread_command_events
);
2879 Vunread_command_events
= XCDR (Vunread_command_events
);
2881 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2887 /* Read something from current KBOARD's side queue, if possible. */
2891 if (current_kboard
->kbd_queue_has_data
)
2893 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2895 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2896 kset_kbd_queue (current_kboard
,
2897 XCDR (KVAR (current_kboard
, kbd_queue
)));
2898 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2899 current_kboard
->kbd_queue_has_data
= 0;
2900 input_pending
= readable_events (0);
2901 if (EVENT_HAS_PARAMETERS (c
)
2902 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2903 internal_last_event_frame
= XCAR (XCDR (c
));
2904 Vlast_event_frame
= internal_last_event_frame
;
2908 /* If current_kboard's side queue is empty check the other kboards.
2909 If one of them has data that we have not yet seen here,
2910 switch to it and process the data waiting for it.
2912 Note: if the events queued up for another kboard
2913 have already been seen here, and therefore are not a complete command,
2914 the kbd_queue_has_data field is 0, so we skip that kboard here.
2915 That's to avoid an infinite loop switching between kboards here. */
2916 if (NILP (c
) && !single_kboard
)
2919 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2920 if (kb
->kbd_queue_has_data
)
2922 current_kboard
= kb
;
2923 /* This is going to exit from read_char
2924 so we had better get rid of this frame's stuff. */
2926 return make_number (-2); /* wrong_kboard_jmpbuf */
2936 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2937 prev_event
, used_mouse_menu
);
2938 if (NILP (c
) && end_time
2939 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2944 if (EQ (c
, make_number (-2)))
2946 /* This is going to exit from read_char
2947 so we had better get rid of this frame's stuff. */
2961 if (commandflag
>= 0
2962 && !input_pending
&& !detect_input_pending_run_timers (0))
2968 /* Buffer switch events are only for internal wakeups
2969 so don't show them to the user.
2970 Also, don't record a key if we already did. */
2974 /* Process special events within read_char
2975 and loop around to read another event. */
2978 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2983 struct buffer
*prev_buffer
= current_buffer
;
2984 last_input_event
= c
;
2985 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2987 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2988 /* We stopped being idle for this event; undo that. This
2989 prevents automatic window selection (under
2990 mouse_autoselect_window from acting as a real input event, for
2991 example banishing the mouse under mouse-avoidance-mode. */
2992 timer_resume_idle ();
2994 if (current_buffer
!= prev_buffer
)
2996 /* The command may have changed the keymaps. Pretend there
2997 is input in another keyboard and return. This will
2998 recalculate keymaps. */
2999 c
= make_number (-2);
3006 /* Handle things that only apply to characters. */
3009 /* If kbd_buffer_get_event gave us an EOF, return that. */
3013 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3014 && UNSIGNED_CMP (XFASTINT (c
), <,
3015 SCHARS (KVAR (current_kboard
,
3016 Vkeyboard_translate_table
))))
3017 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3018 && UNSIGNED_CMP (XFASTINT (c
), <,
3019 ASIZE (KVAR (current_kboard
,
3020 Vkeyboard_translate_table
))))
3021 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3025 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3026 /* nil in keyboard-translate-table means no translation. */
3032 /* If this event is a mouse click in the menu bar,
3033 return just menu-bar for now. Modify the mouse click event
3034 so we won't do this twice, then queue it up. */
3035 if (EVENT_HAS_PARAMETERS (c
)
3037 && CONSP (EVENT_START (c
))
3038 && CONSP (XCDR (EVENT_START (c
))))
3042 posn
= POSN_POSN (EVENT_START (c
));
3043 /* Handle menu-bar events:
3044 insert the dummy prefix event `menu-bar'. */
3045 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3047 /* Change menu-bar to (menu-bar) as the event "position". */
3048 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3051 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3056 /* Store these characters into recent_keys, the dribble file if any,
3057 and the keyboard macro being defined, if any. */
3059 if (! NILP (also_record
))
3060 record_char (also_record
);
3062 /* Wipe the echo area.
3063 But first, if we are about to use an input method,
3064 save the echo area contents for it to refer to. */
3066 && ! NILP (Vinput_method_function
)
3067 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3069 previous_echo_area_message
= Fcurrent_message ();
3070 Vinput_method_previous_message
= previous_echo_area_message
;
3073 /* Now wipe the echo area, except for help events which do their
3074 own stuff with the echo area. */
3076 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3077 && !(EQ (Qswitch_frame
, XCAR (c
)))
3078 /* Don't wipe echo area for select window events: These might
3079 get delayed via `mouse-autoselect-window' (Bug#11304). */
3080 && !(EQ (Qselect_window
, XCAR (c
)))))
3082 if (!NILP (echo_area_buffer
[0]))
3084 safe_run_hooks (Qecho_area_clear_hook
);
3085 clear_message (1, 0);
3089 reread_for_input_method
:
3091 /* Pass this to the input method, if appropriate. */
3093 && ! NILP (Vinput_method_function
)
3094 /* Don't run the input method within a key sequence,
3095 after the first event of the key sequence. */
3096 && NILP (prev_event
)
3097 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3100 ptrdiff_t key_count
;
3101 bool key_count_reset
;
3102 struct gcpro gcpro1
;
3104 /* Save the echo status. */
3105 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3106 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3107 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3108 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3113 if (before_command_restore_flag
)
3115 this_command_key_count
= before_command_key_count_1
;
3116 if (this_command_key_count
< this_single_command_key_start
)
3117 this_single_command_key_start
= this_command_key_count
;
3118 echo_truncate (before_command_echo_length_1
);
3119 before_command_restore_flag
= 0;
3123 /* Save the this_command_keys status. */
3124 key_count
= this_command_key_count
;
3125 key_count_reset
= this_command_key_count_reset
;
3128 keys
= Fcopy_sequence (this_command_keys
);
3133 /* Clear out this_command_keys. */
3134 this_command_key_count
= 0;
3135 this_command_key_count_reset
= 0;
3137 /* Now wipe the echo area. */
3138 if (!NILP (echo_area_buffer
[0]))
3139 safe_run_hooks (Qecho_area_clear_hook
);
3140 clear_message (1, 0);
3143 /* If we are not reading a key sequence,
3144 never use the echo area. */
3147 specbind (Qinput_method_use_echo_area
, Qt
);
3150 /* Call the input method. */
3151 tem
= call1 (Vinput_method_function
, c
);
3155 /* Restore the saved echoing state
3156 and this_command_keys state. */
3157 this_command_key_count
= key_count
;
3158 this_command_key_count_reset
= key_count_reset
;
3160 this_command_keys
= keys
;
3163 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3164 kset_echo_string (current_kboard
, saved_echo_string
);
3165 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3166 if (saved_immediate_echo
)
3171 /* The input method can return no events. */
3174 /* Bring back the previous message, if any. */
3175 if (! NILP (previous_echo_area_message
))
3176 message_with_string ("%s", previous_echo_area_message
, 0);
3179 /* It returned one event or more. */
3181 Vunread_post_input_method_events
3182 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3187 /* Display help if not echoing. */
3188 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3190 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3191 Lisp_Object help
, object
, position
, window
, htem
;
3193 htem
= Fcdr (XCDR (c
));
3196 window
= Fcar (htem
);
3198 object
= Fcar (htem
);
3200 position
= Fcar (htem
);
3202 show_help_echo (help
, window
, object
, position
);
3204 /* We stopped being idle for this event; undo that. */
3206 timer_resume_idle ();
3210 if ((! reread
|| this_command_key_count
== 0
3211 || this_command_key_count_reset
)
3215 /* Don't echo mouse motion events. */
3216 if (echo_keystrokes_p ()
3217 && ! (EVENT_HAS_PARAMETERS (c
)
3218 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3221 if (! NILP (also_record
))
3222 echo_char (also_record
);
3223 /* Once we reread a character, echoing can happen
3224 the next time we pause to read a new one. */
3225 ok_to_echo_at_next_pause
= current_kboard
;
3228 /* Record this character as part of the current key. */
3229 add_command_key (c
);
3230 if (! NILP (also_record
))
3231 add_command_key (also_record
);
3234 last_input_event
= c
;
3237 /* Process the help character specially if enabled. */
3238 if (!NILP (Vhelp_form
) && help_char_p (c
))
3242 help_form_saved_window_configs
3243 = Fcons (Fcurrent_window_configuration (Qnil
),
3244 help_form_saved_window_configs
);
3245 record_unwind_protect_void (read_char_help_form_unwind
);
3246 call0 (Qhelp_form_show
);
3251 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3252 if (EVENT_HAS_PARAMETERS (c
)
3253 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3254 XSETCAR (help_form_saved_window_configs
, Qnil
);
3256 while (BUFFERP (c
));
3257 /* Remove the help from the frame. */
3261 if (EQ (c
, make_number (040)))
3265 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3266 while (BUFFERP (c
));
3276 #undef used_mouse_menu
3280 #undef local_getcjmp
3282 #undef previous_echo_area_message
3285 #undef polling_stopped_here
3288 /* {{coccinelle:skip_end}} */
3290 /* Record a key that came from a mouse menu.
3291 Record it for echoing, for this-command-keys, and so on. */
3294 record_menu_key (Lisp_Object c
)
3296 /* Wipe the echo area. */
3297 clear_message (1, 0);
3302 before_command_key_count
= this_command_key_count
;
3303 before_command_echo_length
= echo_length ();
3306 /* Don't echo mouse motion events. */
3307 if (echo_keystrokes_p ())
3311 /* Once we reread a character, echoing can happen
3312 the next time we pause to read a new one. */
3313 ok_to_echo_at_next_pause
= 0;
3316 /* Record this character as part of the current key. */
3317 add_command_key (c
);
3319 /* Re-reading in the middle of a command. */
3320 last_input_event
= c
;
3324 /* Return true if should recognize C as "the help character". */
3327 help_char_p (Lisp_Object c
)
3331 if (EQ (c
, Vhelp_char
))
3333 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3334 if (EQ (c
, XCAR (tail
)))
3339 /* Record the input event C in various ways. */
3342 record_char (Lisp_Object c
)
3346 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3348 /* To avoid filling recent_keys with help-echo and mouse-movement
3349 events, we filter out repeated help-echo events, only store the
3350 first and last in a series of mouse-movement events, and don't
3351 store repeated help-echo events which are only separated by
3352 mouse-movement events. */
3354 Lisp_Object ev1
, ev2
, ev3
;
3357 if ((ix1
= recent_keys_index
- 1) < 0)
3358 ix1
= NUM_RECENT_KEYS
- 1;
3359 ev1
= AREF (recent_keys
, ix1
);
3361 if ((ix2
= ix1
- 1) < 0)
3362 ix2
= NUM_RECENT_KEYS
- 1;
3363 ev2
= AREF (recent_keys
, ix2
);
3365 if ((ix3
= ix2
- 1) < 0)
3366 ix3
= NUM_RECENT_KEYS
- 1;
3367 ev3
= AREF (recent_keys
, ix3
);
3369 if (EQ (XCAR (c
), Qhelp_echo
))
3371 /* Don't record `help-echo' in recent_keys unless it shows some help
3372 message, and a different help than the previously recorded
3374 Lisp_Object help
, last_help
;
3376 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3377 if (!STRINGP (help
))
3379 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3380 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3382 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3383 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3384 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3386 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3387 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3388 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3389 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3392 else if (EQ (XCAR (c
), Qmouse_movement
))
3394 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3395 So additional mouse movement events replace the last element. */
3396 Lisp_Object last_window
, window
;
3398 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3399 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3400 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3401 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3402 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3404 ASET (recent_keys
, ix1
, c
);
3410 store_kbd_macro_char (c
);
3414 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3415 ASET (recent_keys
, recent_keys_index
, c
);
3416 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3417 recent_keys_index
= 0;
3419 else if (recorded
< 0)
3421 /* We need to remove one or two events from recent_keys.
3422 To do this, we simply put nil at those events and move the
3423 recent_keys_index backwards over those events. Usually,
3424 users will never see those nil events, as they will be
3425 overwritten by the command keys entered to see recent_keys
3428 while (recorded
++ < 0 && total_keys
> 0)
3430 if (total_keys
< NUM_RECENT_KEYS
)
3432 if (--recent_keys_index
< 0)
3433 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3434 ASET (recent_keys
, recent_keys_index
, Qnil
);
3438 num_nonmacro_input_events
++;
3440 /* Write c to the dribble file. If c is a lispy event, write
3441 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3442 If you, dear reader, have a better idea, you've got the source. :-) */
3448 if (XUINT (c
) < 0x100)
3449 putc (XUINT (c
), dribble
);
3451 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3455 Lisp_Object dribblee
;
3457 /* If it's a structured event, take the event header. */
3458 dribblee
= EVENT_HEAD (c
);
3460 if (SYMBOLP (dribblee
))
3462 putc ('<', dribble
);
3463 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3464 SBYTES (SYMBOL_NAME (dribblee
)),
3466 putc ('>', dribble
);
3475 /* Copy out or in the info on where C-g should throw to.
3476 This is used when running Lisp code from within get_char,
3477 in case get_char is called recursively.
3478 See read_process_output. */
3481 save_getcjmp (sys_jmp_buf
*temp
)
3483 memcpy (*temp
, getcjmp
, sizeof getcjmp
);
3487 restore_getcjmp (sys_jmp_buf
*temp
)
3489 memcpy (getcjmp
, *temp
, sizeof getcjmp
);
3492 /* Low level keyboard/mouse input.
3493 kbd_buffer_store_event places events in kbd_buffer, and
3494 kbd_buffer_get_event retrieves them. */
3496 /* Return true if there are any events in the queue that read-char
3497 would return. If this returns false, a read-char would block. */
3499 readable_events (int flags
)
3501 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3504 /* If the buffer contains only FOCUS_IN_EVENT events, and
3505 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3506 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3508 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3509 #ifdef USE_TOOLKIT_SCROLL_BARS
3510 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3514 struct input_event
*event
;
3516 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3523 #ifdef USE_TOOLKIT_SCROLL_BARS
3524 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3526 event
->kind
== FOCUS_IN_EVENT
)
3527 #ifdef USE_TOOLKIT_SCROLL_BARS
3528 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3529 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3530 && event
->part
== scroll_bar_handle
3531 && event
->modifiers
== 0)
3536 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3539 while (event
!= kbd_store_ptr
);
3545 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3546 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3550 if (current_kboard
->kbd_queue_has_data
)
3556 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3557 if (kb
->kbd_queue_has_data
)
3563 /* Set this for debugging, to have a way to get out */
3564 int stop_character EXTERNALLY_VISIBLE
;
3567 event_to_kboard (struct input_event
*event
)
3569 /* Not applicable for these special events. */
3570 if (event
->kind
== SELECTION_REQUEST_EVENT
3571 || event
->kind
== SELECTION_CLEAR_EVENT
)
3575 Lisp_Object obj
= event
->frame_or_window
;
3576 /* There are some events that set this field to nil or string. */
3578 obj
= WINDOW_FRAME (XWINDOW (obj
));
3579 /* Also ignore dead frames here. */
3580 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3581 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3586 /* Return the number of slots occupied in kbd_buffer. */
3589 kbd_buffer_nr_stored (void)
3591 return kbd_fetch_ptr
== kbd_store_ptr
3593 : (kbd_fetch_ptr
< kbd_store_ptr
3594 ? kbd_store_ptr
- kbd_fetch_ptr
3595 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3596 + (kbd_store_ptr
- kbd_buffer
)));
3598 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3601 kbd_buffer_store_event (register struct input_event
*event
)
3603 kbd_buffer_store_event_hold (event
, 0);
3606 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3608 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3609 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3610 Else, if EVENT is a quit event, store the quit event
3611 in HOLD_QUIT, and return (thus ignoring further events).
3613 This is used to postpone the processing of the quit event until all
3614 subsequent input events have been parsed (and discarded). */
3617 kbd_buffer_store_event_hold (register struct input_event
*event
,
3618 struct input_event
*hold_quit
)
3620 if (event
->kind
== NO_EVENT
)
3623 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3626 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3628 register int c
= event
->code
& 0377;
3630 if (event
->modifiers
& ctrl_modifier
)
3631 c
= make_ctrl_char (c
);
3633 c
|= (event
->modifiers
3634 & (meta_modifier
| alt_modifier
3635 | hyper_modifier
| super_modifier
));
3639 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3640 struct input_event
*sp
;
3642 if (single_kboard
&& kb
!= current_kboard
)
3645 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3647 kb
->kbd_queue_has_data
= 1;
3648 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3650 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3653 if (event_to_kboard (sp
) == kb
)
3655 sp
->kind
= NO_EVENT
;
3656 sp
->frame_or_window
= Qnil
;
3665 *hold_quit
= *event
;
3669 /* If this results in a quit_char being returned to Emacs as
3670 input, set Vlast_event_frame properly. If this doesn't
3671 get returned to Emacs as an event, the next event read
3672 will set Vlast_event_frame again, so this is safe to do. */
3676 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3678 focus
= event
->frame_or_window
;
3679 internal_last_event_frame
= focus
;
3680 Vlast_event_frame
= focus
;
3683 handle_interrupt (0);
3687 if (c
&& c
== stop_character
)
3693 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3694 Just ignore the second one. */
3695 else if (event
->kind
== BUFFER_SWITCH_EVENT
3696 && kbd_fetch_ptr
!= kbd_store_ptr
3697 && ((kbd_store_ptr
== kbd_buffer
3698 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3699 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3702 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3703 kbd_store_ptr
= kbd_buffer
;
3705 /* Don't let the very last slot in the buffer become full,
3706 since that would make the two pointers equal,
3707 and that is indistinguishable from an empty buffer.
3708 Discard the event if it would fill the last slot. */
3709 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3711 *kbd_store_ptr
= *event
;
3714 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3715 && ! kbd_on_hold_p ())
3717 /* Don't read keyboard input until we have processed kbd_buffer.
3718 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3719 hold_keyboard_input ();
3720 if (!noninteractive
)
3724 #endif /* subprocesses */
3727 /* If we're inside while-no-input, and this event qualifies
3728 as input, set quit-flag to cause an interrupt. */
3729 if (!NILP (Vthrow_on_input
)
3730 && event
->kind
!= FOCUS_IN_EVENT
3731 && event
->kind
!= HELP_EVENT
3732 && event
->kind
!= DEICONIFY_EVENT
)
3734 Vquit_flag
= Vthrow_on_input
;
3735 /* If we're inside a function that wants immediate quits,
3737 if (immediate_quit
&& NILP (Vinhibit_quit
))
3746 /* Put an input event back in the head of the event queue. */
3749 kbd_buffer_unget_event (register struct input_event
*event
)
3751 if (kbd_fetch_ptr
== kbd_buffer
)
3752 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3754 /* Don't let the very last slot in the buffer become full, */
3755 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3758 *kbd_fetch_ptr
= *event
;
3763 /* Generate a HELP_EVENT input_event and store it in the keyboard
3766 HELP is the help form.
3768 FRAME and WINDOW are the frame and window where the help is
3769 generated. OBJECT is the Lisp object where the help was found (a
3770 buffer, a string, an overlay, or nil if neither from a string nor
3771 from a buffer). POS is the position within OBJECT where the help
3775 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3776 Lisp_Object object
, ptrdiff_t pos
)
3778 struct input_event event
;
3782 event
.kind
= HELP_EVENT
;
3783 event
.frame_or_window
= frame
;
3785 event
.x
= WINDOWP (window
) ? window
: frame
;
3788 kbd_buffer_store_event (&event
);
3792 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3795 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3797 struct input_event event
;
3799 event
.kind
= HELP_EVENT
;
3800 event
.frame_or_window
= frame
;
3805 kbd_buffer_store_event (&event
);
3809 /* Discard any mouse events in the event buffer by setting them to
3812 discard_mouse_events (void)
3814 struct input_event
*sp
;
3815 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3817 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3820 if (sp
->kind
== MOUSE_CLICK_EVENT
3821 || sp
->kind
== WHEEL_EVENT
3822 || sp
->kind
== HORIZ_WHEEL_EVENT
3824 || sp
->kind
== GPM_CLICK_EVENT
3826 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3828 sp
->kind
= NO_EVENT
;
3834 /* Return true if there are any real events waiting in the event
3835 buffer, not counting `NO_EVENT's.
3837 Discard NO_EVENT events at the front of the input queue, possibly
3838 leaving the input queue empty if there are no real input events. */
3841 kbd_buffer_events_waiting (void)
3843 struct input_event
*sp
;
3845 for (sp
= kbd_fetch_ptr
;
3846 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3849 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3854 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3858 /* Clear input event EVENT. */
3861 clear_event (struct input_event
*event
)
3863 event
->kind
= NO_EVENT
;
3867 /* Read one event from the event buffer, waiting if necessary.
3868 The value is a Lisp object representing the event.
3869 The value is nil for an event that should be ignored,
3870 or that was handled here.
3871 We always read and discard one event. */
3874 kbd_buffer_get_event (KBOARD
**kbp
,
3875 bool *used_mouse_menu
,
3876 struct timespec
*end_time
)
3881 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3883 /* Start reading input again because we have processed enough to
3884 be able to accept new events again. */
3885 unhold_keyboard_input ();
3888 #endif /* subprocesses */
3890 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3892 /* In case we are running as a daemon, only do this before
3893 detaching from the terminal. */
3894 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3898 *kbp
= current_kboard
;
3901 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3903 /* Wait until there is input available. */
3906 /* Break loop if there's an unread command event. Needed in
3907 moused window autoselection which uses a timer to insert such
3909 if (CONSP (Vunread_command_events
))
3912 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3914 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3917 /* If the quit flag is set, then read_char will return
3918 quit_char, so that counts as "available input." */
3919 if (!NILP (Vquit_flag
))
3920 quit_throw_to_read_char (0);
3922 /* One way or another, wait until input is available; then, if
3923 interrupt handlers have not read it, read it now. */
3928 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3930 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3934 struct timespec now
= current_timespec ();
3935 if (timespec_cmp (*end_time
, now
) <= 0)
3936 return Qnil
; /* Finished waiting. */
3939 struct timespec duration
= timespec_sub (*end_time
, now
);
3940 wait_reading_process_output (min (duration
.tv_sec
,
3943 -1, 1, Qnil
, NULL
, 0);
3948 bool do_display
= true;
3950 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3952 struct tty_display_info
*tty
= CURTTY ();
3954 /* When this TTY is displaying a menu, we must prevent
3955 any redisplay, because we modify the frame's glyph
3956 matrix behind the back of the display engine. */
3957 if (tty
->showing_menu
)
3961 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3964 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3968 if (CONSP (Vunread_command_events
))
3971 first
= XCAR (Vunread_command_events
);
3972 Vunread_command_events
= XCDR (Vunread_command_events
);
3973 *kbp
= current_kboard
;
3977 /* At this point, we know that there is a readable event available
3978 somewhere. If the event queue is empty, then there must be a
3979 mouse movement enabled and available. */
3980 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3982 struct input_event
*event
;
3984 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3988 *kbp
= event_to_kboard (event
);
3990 *kbp
= current_kboard
; /* Better than returning null ptr? */
3994 /* These two kinds of events get special handling
3995 and don't actually appear to the command loop.
3996 We return nil for them. */
3997 if (event
->kind
== SELECTION_REQUEST_EVENT
3998 || event
->kind
== SELECTION_CLEAR_EVENT
)
4001 struct input_event copy
;
4003 /* Remove it from the buffer before processing it,
4004 since otherwise swallow_events will see it
4005 and process it again. */
4007 kbd_fetch_ptr
= event
+ 1;
4008 input_pending
= readable_events (0);
4009 x_handle_selection_event (©
);
4011 /* We're getting selection request events, but we don't have
4017 #if defined (HAVE_NS)
4018 else if (event
->kind
== NS_TEXT_EVENT
)
4020 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4021 obj
= list1 (intern ("ns-put-working-text"));
4023 obj
= list1 (intern ("ns-unput-working-text"));
4024 kbd_fetch_ptr
= event
+ 1;
4025 if (used_mouse_menu
)
4026 *used_mouse_menu
= 1;
4030 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4031 || defined (HAVE_NS)
4032 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4034 /* Make an event (delete-frame (FRAME)). */
4035 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4036 kbd_fetch_ptr
= event
+ 1;
4039 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4040 || defined (HAVE_NS)
4041 else if (event
->kind
== ICONIFY_EVENT
)
4043 /* Make an event (iconify-frame (FRAME)). */
4044 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4045 kbd_fetch_ptr
= event
+ 1;
4047 else if (event
->kind
== DEICONIFY_EVENT
)
4049 /* Make an event (make-frame-visible (FRAME)). */
4050 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4051 kbd_fetch_ptr
= event
+ 1;
4054 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4056 /* The value doesn't matter here; only the type is tested. */
4057 XSETBUFFER (obj
, current_buffer
);
4058 kbd_fetch_ptr
= event
+ 1;
4060 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4061 || defined (HAVE_NS) || defined (USE_GTK)
4062 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4064 kbd_fetch_ptr
= event
+ 1;
4065 input_pending
= readable_events (0);
4066 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4067 x_activate_menubar (XFRAME (event
->frame_or_window
));
4071 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4073 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4074 obj
= list4 (Qlanguage_change
,
4075 event
->frame_or_window
,
4076 make_number (event
->code
),
4077 make_number (event
->modifiers
));
4078 kbd_fetch_ptr
= event
+ 1;
4081 #ifdef USE_FILE_NOTIFY
4082 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4084 #ifdef HAVE_W32NOTIFY
4085 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4086 obj
= list3 (Qfile_notify
,
4087 list3 (make_number (event
->code
),
4090 event
->frame_or_window
);
4092 obj
= make_lispy_event (event
);
4094 kbd_fetch_ptr
= event
+ 1;
4096 #endif /* USE_FILE_NOTIFY */
4097 else if (event
->kind
== SAVE_SESSION_EVENT
)
4099 obj
= list2 (Qsave_session
, event
->arg
);
4100 kbd_fetch_ptr
= event
+ 1;
4102 /* Just discard these, by returning nil.
4103 With MULTI_KBOARD, these events are used as placeholders
4104 when we need to randomly delete events from the queue.
4105 (They shouldn't otherwise be found in the buffer,
4106 but on some machines it appears they do show up
4107 even without MULTI_KBOARD.) */
4108 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4109 mouse events during a popup-menu call. */
4110 else if (event
->kind
== NO_EVENT
)
4111 kbd_fetch_ptr
= event
+ 1;
4112 else if (event
->kind
== HELP_EVENT
)
4114 Lisp_Object object
, position
, help
, frame
, window
;
4116 frame
= event
->frame_or_window
;
4117 object
= event
->arg
;
4118 position
= make_number (event
->code
);
4121 clear_event (event
);
4123 kbd_fetch_ptr
= event
+ 1;
4124 if (!WINDOWP (window
))
4126 obj
= Fcons (Qhelp_echo
,
4127 list5 (frame
, help
, window
, object
, position
));
4129 else if (event
->kind
== FOCUS_IN_EVENT
)
4131 /* Notification of a FocusIn event. The frame receiving the
4132 focus is in event->frame_or_window. Generate a
4133 switch-frame event if necessary. */
4134 Lisp_Object frame
, focus
;
4136 frame
= event
->frame_or_window
;
4137 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4146 !EQ (frame
, internal_last_event_frame
)
4147 && !EQ (frame
, selected_frame
))
4148 obj
= make_lispy_switch_frame (frame
);
4150 obj
= make_lispy_focus_in (frame
);
4152 internal_last_event_frame
= frame
;
4153 kbd_fetch_ptr
= event
+ 1;
4155 else if (event
->kind
== FOCUS_OUT_EVENT
)
4157 #ifdef HAVE_WINDOW_SYSTEM
4160 Lisp_Object frame
= event
->frame_or_window
;
4161 bool focused
= false;
4163 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4164 focused
= di
->x_highlight_frame
!= 0;
4167 obj
= make_lispy_focus_out (frame
);
4169 #endif /* HAVE_WINDOW_SYSTEM */
4171 kbd_fetch_ptr
= event
+ 1;
4174 else if (event
->kind
== DBUS_EVENT
)
4176 obj
= make_lispy_event (event
);
4177 kbd_fetch_ptr
= event
+ 1;
4180 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4182 obj
= make_lispy_event (event
);
4183 kbd_fetch_ptr
= event
+ 1;
4187 /* If this event is on a different frame, return a switch-frame this
4188 time, and leave the event in the queue for next time. */
4192 frame
= event
->frame_or_window
;
4194 frame
= XCAR (frame
);
4195 else if (WINDOWP (frame
))
4196 frame
= WINDOW_FRAME (XWINDOW (frame
));
4198 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4202 if (! EQ (frame
, internal_last_event_frame
)
4203 && !EQ (frame
, selected_frame
))
4204 obj
= make_lispy_switch_frame (frame
);
4205 internal_last_event_frame
= frame
;
4207 /* If we didn't decide to make a switch-frame event, go ahead
4208 and build a real event from the queue entry. */
4212 obj
= make_lispy_event (event
);
4214 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4215 || defined (HAVE_NS) || defined (USE_GTK)
4216 /* If this was a menu selection, then set the flag to inhibit
4217 writing to last_nonmenu_event. Don't do this if the event
4218 we're returning is (menu-bar), though; that indicates the
4219 beginning of the menu sequence, and we might as well leave
4220 that as the `event with parameters' for this selection. */
4222 && !EQ (event
->frame_or_window
, event
->arg
)
4223 && (event
->kind
== MENU_BAR_EVENT
4224 || event
->kind
== TOOL_BAR_EVENT
))
4225 *used_mouse_menu
= 1;
4228 /* Certain system events are non-key events. */
4230 && event
->kind
== NS_NONKEY_EVENT
)
4231 *used_mouse_menu
= 1;
4234 /* Wipe out this event, to catch bugs. */
4235 clear_event (event
);
4236 kbd_fetch_ptr
= event
+ 1;
4240 /* Try generating a mouse motion event. */
4241 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4243 struct frame
*f
= some_mouse_moved ();
4244 Lisp_Object bar_window
;
4245 enum scroll_bar_part part
;
4249 *kbp
= current_kboard
;
4250 /* Note that this uses F to determine which terminal to look at.
4251 If there is no valid info, it does not store anything
4252 so x remains nil. */
4255 /* XXX Can f or mouse_position_hook be NULL here? */
4256 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4257 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4262 /* Decide if we should generate a switch-frame event. Don't
4263 generate switch-frame events for motion outside of all Emacs
4269 frame
= FRAME_FOCUS_FRAME (f
);
4271 XSETFRAME (frame
, f
);
4273 if (! EQ (frame
, internal_last_event_frame
)
4274 && !EQ (frame
, selected_frame
))
4275 obj
= make_lispy_switch_frame (frame
);
4276 internal_last_event_frame
= frame
;
4279 /* If we didn't decide to make a switch-frame event, go ahead and
4280 return a mouse-motion event. */
4281 if (!NILP (x
) && NILP (obj
))
4282 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4285 /* We were promised by the above while loop that there was
4286 something for us to read! */
4289 input_pending
= readable_events (0);
4291 Vlast_event_frame
= internal_last_event_frame
;
4296 /* Process any non-user-visible events (currently X selection events),
4297 without reading any user-visible events. */
4300 process_special_events (void)
4302 struct input_event
*event
;
4304 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4306 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4309 if (event
== kbd_store_ptr
)
4313 /* If we find a stored X selection request, handle it now. */
4314 if (event
->kind
== SELECTION_REQUEST_EVENT
4315 || event
->kind
== SELECTION_CLEAR_EVENT
)
4319 /* Remove the event from the fifo buffer before processing;
4320 otherwise swallow_events called recursively could see it
4321 and process it again. To do this, we move the events
4322 between kbd_fetch_ptr and EVENT one slot to the right,
4325 struct input_event copy
= *event
;
4326 struct input_event
*beg
4327 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4328 ? kbd_buffer
: kbd_fetch_ptr
;
4331 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4332 else if (event
< beg
)
4334 if (event
> kbd_buffer
)
4335 memmove (kbd_buffer
+ 1, kbd_buffer
,
4336 (event
- kbd_buffer
) * sizeof (struct input_event
));
4337 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4338 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4339 memmove (beg
+ 1, beg
,
4340 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4341 * sizeof (struct input_event
));
4344 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4345 kbd_fetch_ptr
= kbd_buffer
+ 1;
4349 input_pending
= readable_events (0);
4350 x_handle_selection_event (©
);
4352 /* We're getting selection request events, but we don't have
4360 /* Process any events that are not user-visible, run timer events that
4361 are ripe, and return, without reading any user-visible events. */
4364 swallow_events (bool do_display
)
4366 unsigned old_timers_run
;
4368 process_special_events ();
4370 old_timers_run
= timers_run
;
4371 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4373 if (timers_run
!= old_timers_run
&& do_display
)
4374 redisplay_preserve_echo_area (7);
4377 /* Record the start of when Emacs is idle,
4378 for the sake of running idle-time timers. */
4381 timer_start_idle (void)
4383 /* If we are already in the idle state, do nothing. */
4384 if (timespec_valid_p (timer_idleness_start_time
))
4387 timer_idleness_start_time
= current_timespec ();
4388 timer_last_idleness_start_time
= timer_idleness_start_time
;
4390 /* Mark all idle-time timers as once again candidates for running. */
4391 call0 (intern ("internal-timer-start-idle"));
4394 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4397 timer_stop_idle (void)
4399 timer_idleness_start_time
= invalid_timespec ();
4402 /* Resume idle timer from last idle start time. */
4405 timer_resume_idle (void)
4407 if (timespec_valid_p (timer_idleness_start_time
))
4410 timer_idleness_start_time
= timer_last_idleness_start_time
;
4413 /* This is only for debugging. */
4414 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4416 /* List of elisp functions to call, delayed because they were generated in
4417 a context where Elisp could not be safely run (e.g. redisplay, signal,
4418 ...). Each element has the form (FUN . ARGS). */
4419 Lisp_Object pending_funcalls
;
4421 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4423 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4425 Lisp_Object
*vector
;
4427 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4429 vector
= XVECTOR (timer
)->contents
;
4430 if (! NILP (vector
[0]))
4433 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4438 /* Check whether a timer has fired. To prevent larger problems we simply
4439 disregard elements that are not proper timers. Do not make a circular
4440 timer list for the time being.
4442 Returns the time to wait until the next timer fires. If a
4443 timer is triggering now, return zero.
4444 If no timer is active, return -1.
4446 If a timer is ripe, we run it, with quitting turned off.
4447 In that case we return 0 to indicate that a new timer_check_2 call
4450 static struct timespec
4451 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4453 struct timespec nexttime
;
4454 struct timespec now
;
4455 struct timespec idleness_now
;
4456 Lisp_Object chosen_timer
;
4457 struct gcpro gcpro1
;
4459 nexttime
= invalid_timespec ();
4461 chosen_timer
= Qnil
;
4462 GCPRO1 (chosen_timer
);
4464 /* First run the code that was delayed. */
4465 while (CONSP (pending_funcalls
))
4467 Lisp_Object funcall
= XCAR (pending_funcalls
);
4468 pending_funcalls
= XCDR (pending_funcalls
);
4469 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4472 if (CONSP (timers
) || CONSP (idle_timers
))
4474 now
= current_timespec ();
4475 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4476 ? timespec_sub (now
, timer_idleness_start_time
)
4477 : make_timespec (0, 0));
4480 while (CONSP (timers
) || CONSP (idle_timers
))
4482 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4483 struct timespec timer_time
, idle_timer_time
;
4484 struct timespec difference
;
4485 struct timespec timer_difference
= invalid_timespec ();
4486 struct timespec idle_timer_difference
= invalid_timespec ();
4487 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4489 /* Set TIMER and TIMER_DIFFERENCE
4490 based on the next ordinary timer.
4491 TIMER_DIFFERENCE is the distance in time from NOW to when
4492 this timer becomes ripe (negative if it's already ripe).
4493 Skip past invalid timers and timers already handled. */
4496 timer
= XCAR (timers
);
4497 if (! decode_timer (timer
, &timer_time
))
4499 timers
= XCDR (timers
);
4503 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4504 timer_difference
= (timer_ripe
4505 ? timespec_sub (now
, timer_time
)
4506 : timespec_sub (timer_time
, now
));
4509 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4510 based on the next idle timer. */
4511 if (CONSP (idle_timers
))
4513 idle_timer
= XCAR (idle_timers
);
4514 if (! decode_timer (idle_timer
, &idle_timer_time
))
4516 idle_timers
= XCDR (idle_timers
);
4520 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4521 idle_timer_difference
4523 ? timespec_sub (idleness_now
, idle_timer_time
)
4524 : timespec_sub (idle_timer_time
, idleness_now
));
4527 /* Decide which timer is the next timer,
4528 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4529 Also step down the list where we found that timer. */
4531 if (timespec_valid_p (timer_difference
)
4532 && (! timespec_valid_p (idle_timer_difference
)
4533 || idle_timer_ripe
< timer_ripe
4534 || (idle_timer_ripe
== timer_ripe
4536 ? timespec_cmp (idle_timer_difference
,
4538 : timespec_cmp (timer_difference
,
4539 idle_timer_difference
))
4542 chosen_timer
= timer
;
4543 timers
= XCDR (timers
);
4544 difference
= timer_difference
;
4549 chosen_timer
= idle_timer
;
4550 idle_timers
= XCDR (idle_timers
);
4551 difference
= idle_timer_difference
;
4552 ripe
= idle_timer_ripe
;
4555 /* If timer is ripe, run it if it hasn't been run. */
4558 if (NILP (AREF (chosen_timer
, 0)))
4561 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4563 /* Mark the timer as triggered to prevent problems if the lisp
4564 code fails to reschedule it right. */
4565 ASET (chosen_timer
, 0, Qt
);
4567 specbind (Qinhibit_quit
, Qt
);
4569 call1 (Qtimer_event_handler
, chosen_timer
);
4570 Vdeactivate_mark
= old_deactivate_mark
;
4574 /* Since we have handled the event,
4575 we don't need to tell the caller to wake up and do it. */
4576 /* But the caller must still wait for the next timer, so
4577 return 0 to indicate that. */
4580 nexttime
= make_timespec (0, 0);
4584 /* When we encounter a timer that is still waiting,
4585 return the amount of time to wait before it is ripe. */
4592 /* No timers are pending in the future. */
4593 /* Return 0 if we generated an event, and -1 if not. */
4599 /* Check whether a timer has fired. To prevent larger problems we simply
4600 disregard elements that are not proper timers. Do not make a circular
4601 timer list for the time being.
4603 Returns the time to wait until the next timer fires.
4604 If no timer is active, return an invalid value.
4606 As long as any timer is ripe, we run it. */
4611 struct timespec nexttime
;
4612 Lisp_Object timers
, idle_timers
;
4613 struct gcpro gcpro1
, gcpro2
;
4615 Lisp_Object tem
= Vinhibit_quit
;
4618 /* We use copies of the timers' lists to allow a timer to add itself
4619 again, without locking up Emacs if the newly added timer is
4620 already ripe when added. */
4622 /* Always consider the ordinary timers. */
4623 timers
= Fcopy_sequence (Vtimer_list
);
4624 /* Consider the idle timers only if Emacs is idle. */
4625 if (timespec_valid_p (timer_idleness_start_time
))
4626 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4630 Vinhibit_quit
= tem
;
4632 GCPRO2 (timers
, idle_timers
);
4636 nexttime
= timer_check_2 (timers
, idle_timers
);
4638 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4644 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4645 doc
: /* Return the current length of Emacs idleness, or nil.
4646 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4647 in the same style as (current-time).
4649 The value when Emacs is not idle is nil.
4651 PSEC is a multiple of the system clock resolution. */)
4654 if (timespec_valid_p (timer_idleness_start_time
))
4655 return make_lisp_time (timespec_sub (current_timespec (),
4656 timer_idleness_start_time
));
4661 /* Caches for modify_event_symbol. */
4662 static Lisp_Object accent_key_syms
;
4663 static Lisp_Object func_key_syms
;
4664 static Lisp_Object mouse_syms
;
4665 static Lisp_Object wheel_syms
;
4666 static Lisp_Object drag_n_drop_syms
;
4668 /* This is a list of keysym codes for special "accent" characters.
4669 It parallels lispy_accent_keys. */
4671 static const int lispy_accent_codes
[] =
4673 #ifdef XK_dead_circumflex
4678 #ifdef XK_dead_grave
4683 #ifdef XK_dead_tilde
4688 #ifdef XK_dead_diaeresis
4693 #ifdef XK_dead_macron
4698 #ifdef XK_dead_degree
4703 #ifdef XK_dead_acute
4708 #ifdef XK_dead_cedilla
4713 #ifdef XK_dead_breve
4718 #ifdef XK_dead_ogonek
4723 #ifdef XK_dead_caron
4728 #ifdef XK_dead_doubleacute
4729 XK_dead_doubleacute
,
4733 #ifdef XK_dead_abovedot
4738 #ifdef XK_dead_abovering
4748 #ifdef XK_dead_belowdot
4753 #ifdef XK_dead_voiced_sound
4754 XK_dead_voiced_sound
,
4758 #ifdef XK_dead_semivoiced_sound
4759 XK_dead_semivoiced_sound
,
4775 /* This is a list of Lisp names for special "accent" characters.
4776 It parallels lispy_accent_codes. */
4778 static const char *const lispy_accent_keys
[] =
4796 "dead-voiced-sound",
4797 "dead-semivoiced-sound",
4803 #define FUNCTION_KEY_OFFSET 0x0
4805 const char *const lispy_function_keys
[] =
4809 0, /* VK_LBUTTON 0x01 */
4810 0, /* VK_RBUTTON 0x02 */
4811 "cancel", /* VK_CANCEL 0x03 */
4812 0, /* VK_MBUTTON 0x04 */
4814 0, 0, 0, /* 0x05 .. 0x07 */
4816 "backspace", /* VK_BACK 0x08 */
4817 "tab", /* VK_TAB 0x09 */
4819 0, 0, /* 0x0A .. 0x0B */
4821 "clear", /* VK_CLEAR 0x0C */
4822 "return", /* VK_RETURN 0x0D */
4824 0, 0, /* 0x0E .. 0x0F */
4826 0, /* VK_SHIFT 0x10 */
4827 0, /* VK_CONTROL 0x11 */
4828 0, /* VK_MENU 0x12 */
4829 "pause", /* VK_PAUSE 0x13 */
4830 "capslock", /* VK_CAPITAL 0x14 */
4831 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4833 "junja", /* VK_JUNJA 0x17 */
4834 "final", /* VK_FINAL 0x18 */
4835 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4837 "escape", /* VK_ESCAPE 0x1B */
4838 "convert", /* VK_CONVERT 0x1C */
4839 "non-convert", /* VK_NONCONVERT 0x1D */
4840 "accept", /* VK_ACCEPT 0x1E */
4841 "mode-change", /* VK_MODECHANGE 0x1F */
4842 0, /* VK_SPACE 0x20 */
4843 "prior", /* VK_PRIOR 0x21 */
4844 "next", /* VK_NEXT 0x22 */
4845 "end", /* VK_END 0x23 */
4846 "home", /* VK_HOME 0x24 */
4847 "left", /* VK_LEFT 0x25 */
4848 "up", /* VK_UP 0x26 */
4849 "right", /* VK_RIGHT 0x27 */
4850 "down", /* VK_DOWN 0x28 */
4851 "select", /* VK_SELECT 0x29 */
4852 "print", /* VK_PRINT 0x2A */
4853 "execute", /* VK_EXECUTE 0x2B */
4854 "snapshot", /* VK_SNAPSHOT 0x2C */
4855 "insert", /* VK_INSERT 0x2D */
4856 "delete", /* VK_DELETE 0x2E */
4857 "help", /* VK_HELP 0x2F */
4859 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4861 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4863 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4865 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4867 0, 0, 0, 0, 0, 0, 0, 0, 0,
4868 0, 0, 0, 0, 0, 0, 0, 0, 0,
4869 0, 0, 0, 0, 0, 0, 0, 0,
4871 "lwindow", /* VK_LWIN 0x5B */
4872 "rwindow", /* VK_RWIN 0x5C */
4873 "apps", /* VK_APPS 0x5D */
4876 "kp-0", /* VK_NUMPAD0 0x60 */
4877 "kp-1", /* VK_NUMPAD1 0x61 */
4878 "kp-2", /* VK_NUMPAD2 0x62 */
4879 "kp-3", /* VK_NUMPAD3 0x63 */
4880 "kp-4", /* VK_NUMPAD4 0x64 */
4881 "kp-5", /* VK_NUMPAD5 0x65 */
4882 "kp-6", /* VK_NUMPAD6 0x66 */
4883 "kp-7", /* VK_NUMPAD7 0x67 */
4884 "kp-8", /* VK_NUMPAD8 0x68 */
4885 "kp-9", /* VK_NUMPAD9 0x69 */
4886 "kp-multiply", /* VK_MULTIPLY 0x6A */
4887 "kp-add", /* VK_ADD 0x6B */
4888 "kp-separator", /* VK_SEPARATOR 0x6C */
4889 "kp-subtract", /* VK_SUBTRACT 0x6D */
4890 "kp-decimal", /* VK_DECIMAL 0x6E */
4891 "kp-divide", /* VK_DIVIDE 0x6F */
4892 "f1", /* VK_F1 0x70 */
4893 "f2", /* VK_F2 0x71 */
4894 "f3", /* VK_F3 0x72 */
4895 "f4", /* VK_F4 0x73 */
4896 "f5", /* VK_F5 0x74 */
4897 "f6", /* VK_F6 0x75 */
4898 "f7", /* VK_F7 0x76 */
4899 "f8", /* VK_F8 0x77 */
4900 "f9", /* VK_F9 0x78 */
4901 "f10", /* VK_F10 0x79 */
4902 "f11", /* VK_F11 0x7A */
4903 "f12", /* VK_F12 0x7B */
4904 "f13", /* VK_F13 0x7C */
4905 "f14", /* VK_F14 0x7D */
4906 "f15", /* VK_F15 0x7E */
4907 "f16", /* VK_F16 0x7F */
4908 "f17", /* VK_F17 0x80 */
4909 "f18", /* VK_F18 0x81 */
4910 "f19", /* VK_F19 0x82 */
4911 "f20", /* VK_F20 0x83 */
4912 "f21", /* VK_F21 0x84 */
4913 "f22", /* VK_F22 0x85 */
4914 "f23", /* VK_F23 0x86 */
4915 "f24", /* VK_F24 0x87 */
4917 0, 0, 0, 0, /* 0x88 .. 0x8B */
4918 0, 0, 0, 0, /* 0x8C .. 0x8F */
4920 "kp-numlock", /* VK_NUMLOCK 0x90 */
4921 "scroll", /* VK_SCROLL 0x91 */
4922 /* Not sure where the following block comes from.
4923 Windows headers have NEC and Fujitsu specific keys in
4924 this block, but nothing generic. */
4925 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4926 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4927 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4928 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4929 "kp-end", /* VK_NUMPAD_END 0x96 */
4930 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4931 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4932 "kp-up", /* VK_NUMPAD_UP 0x99 */
4933 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4934 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4935 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4936 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4938 0, 0, /* 0x9E .. 0x9F */
4941 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4942 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4943 * No other API or message will distinguish left and right keys this way.
4948 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4949 to enable them selectively, and gives access to a few more functions.
4950 See lispy_multimedia_keys below. */
4951 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4952 0, 0, 0, /* 0xAD .. 0xAF Volume */
4953 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4954 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4956 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4957 0, 0, 0, 0, 0, 0, 0, 0, 0,
4959 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4960 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4961 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4964 "ax", /* VK_OEM_AX 0xE1 */
4965 0, /* VK_OEM_102 0xE2 */
4966 "ico-help", /* VK_ICO_HELP 0xE3 */
4967 "ico-00", /* VK_ICO_00 0xE4 */
4968 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4969 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4970 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4972 "reset", /* VK_OEM_RESET 0xE9 */
4973 "jump", /* VK_OEM_JUMP 0xEA */
4974 "oem-pa1", /* VK_OEM_PA1 0xEB */
4975 "oem-pa2", /* VK_OEM_PA2 0xEC */
4976 "oem-pa3", /* VK_OEM_PA3 0xED */
4977 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4978 "cusel", /* VK_OEM_CUSEL 0xEF */
4979 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4980 "finish", /* VK_OEM_FINISH 0xF1 */
4981 "copy", /* VK_OEM_COPY 0xF2 */
4982 "auto", /* VK_OEM_AUTO 0xF3 */
4983 "enlw", /* VK_OEM_ENLW 0xF4 */
4984 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4985 "attn", /* VK_ATTN 0xF6 */
4986 "crsel", /* VK_CRSEL 0xF7 */
4987 "exsel", /* VK_EXSEL 0xF8 */
4988 "ereof", /* VK_EREOF 0xF9 */
4989 "play", /* VK_PLAY 0xFA */
4990 "zoom", /* VK_ZOOM 0xFB */
4991 "noname", /* VK_NONAME 0xFC */
4992 "pa1", /* VK_PA1 0xFD */
4993 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4997 /* Some of these duplicate the "Media keys" on newer keyboards,
4998 but they are delivered to the application in a different way. */
4999 static const char *const lispy_multimedia_keys
[] =
5007 "browser-favorites",
5044 "toggle-dictate-command",
5050 "media-fast-forward",
5053 "media-channel-down"
5056 #else /* not HAVE_NTGUI */
5058 /* This should be dealt with in XTread_socket now, and that doesn't
5059 depend on the client system having the Kana syms defined. See also
5060 the XK_kana_A case below. */
5063 static const char *const lispy_kana_keys
[] =
5065 /* X Keysym value */
5066 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5069 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5070 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5071 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5072 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5073 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5074 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5075 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5076 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5077 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5078 "kana-i", "kana-u", "kana-e", "kana-o",
5079 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5080 "prolongedsound", "kana-A", "kana-I", "kana-U",
5081 "kana-E", "kana-O", "kana-KA", "kana-KI",
5082 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5083 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5084 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5085 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5086 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5087 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5088 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5089 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5090 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5091 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5092 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5093 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5095 #endif /* XK_kana_A */
5098 #define FUNCTION_KEY_OFFSET 0xff00
5100 /* You'll notice that this table is arranged to be conveniently
5101 indexed by X Windows keysym values. */
5102 static const char *const lispy_function_keys
[] =
5104 /* X Keysym value */
5106 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5107 "backspace", "tab", "linefeed", "clear",
5109 0, 0, 0, "pause", /* 0xff10...1f */
5110 0, 0, 0, 0, 0, 0, 0, "escape",
5112 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5113 "romaji", "hiragana", "katakana", "hiragana-katakana",
5114 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5115 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5116 "eisu-toggle", /* 0xff30...3f */
5117 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5118 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5120 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5121 "down", "prior", "next", "end",
5122 "begin", 0, 0, 0, 0, 0, 0, 0,
5123 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5134 "break", /* 0xff6b */
5137 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5138 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5139 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5140 0, 0, 0, 0, 0, 0, 0, 0,
5141 "kp-tab", /* 0xff89 */
5143 "kp-enter", /* 0xff8d */
5145 "kp-f1", /* 0xff91 */
5149 "kp-home", /* 0xff95 */
5154 "kp-prior", /* kp-page-up */
5155 "kp-next", /* kp-page-down */
5161 0, 0, 0, 0, 0, 0, 0, 0, 0,
5162 "kp-multiply", /* 0xffaa */
5167 "kp-divide", /* 0xffaf */
5168 "kp-0", /* 0xffb0 */
5169 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5172 "kp-equal", /* 0xffbd */
5173 "f1", /* 0xffbe */ /* IsFunctionKey */
5175 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5176 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5177 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5178 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5179 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5180 0, 0, 0, 0, 0, 0, 0, 0,
5181 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5182 0, 0, 0, 0, 0, 0, 0, "delete"
5185 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5186 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5188 static const char *const iso_lispy_function_keys
[] =
5190 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5191 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5192 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5193 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5194 "iso-lefttab", /* 0xfe20 */
5195 "iso-move-line-up", "iso-move-line-down",
5196 "iso-partial-line-up", "iso-partial-line-down",
5197 "iso-partial-space-left", "iso-partial-space-right",
5198 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5199 "iso-release-margin-left", "iso-release-margin-right",
5200 "iso-release-both-margins",
5201 "iso-fast-cursor-left", "iso-fast-cursor-right",
5202 "iso-fast-cursor-up", "iso-fast-cursor-down",
5203 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5204 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5207 #endif /* not HAVE_NTGUI */
5209 static Lisp_Object Vlispy_mouse_stem
;
5211 static const char *const lispy_wheel_names
[] =
5213 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5216 /* drag-n-drop events are generated when a set of selected files are
5217 dragged from another application and dropped onto an Emacs window. */
5218 static const char *const lispy_drag_n_drop_names
[] =
5223 /* Scroll bar parts. */
5224 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5225 Lisp_Object Qup
, Qdown
, Qbottom
;
5226 static Lisp_Object Qend_scroll
;
5228 static Lisp_Object Qratio
;
5230 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5231 static Lisp_Object
*const scroll_bar_parts
[] = {
5232 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5233 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5236 /* A vector, indexed by button number, giving the down-going location
5237 of currently depressed buttons, both scroll bar and non-scroll bar.
5239 The elements have the form
5240 (BUTTON-NUMBER MODIFIER-MASK . REST)
5241 where REST is the cdr of a position as it would be reported in the event.
5243 The make_lispy_event function stores positions here to tell the
5244 difference between click and drag events, and to store the starting
5245 location to be included in drag events. */
5247 static Lisp_Object button_down_location
;
5249 /* Information about the most recent up-going button event: Which
5250 button, what location, and what time. */
5252 static int last_mouse_button
;
5253 static int last_mouse_x
;
5254 static int last_mouse_y
;
5255 static Time button_down_time
;
5257 /* The number of clicks in this multiple-click. */
5259 static int double_click_count
;
5261 /* X and Y are frame-relative coordinates for a click or wheel event.
5262 Return a Lisp-style event list. */
5265 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5268 enum window_part part
;
5269 Lisp_Object posn
= Qnil
;
5270 Lisp_Object extra_info
= Qnil
;
5271 /* Coordinate pixel positions to return. */
5272 int xret
= 0, yret
= 0;
5273 /* The window under frame pixel coordinates (x,y) */
5274 Lisp_Object window
= f
5275 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5278 if (WINDOWP (window
))
5280 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5281 struct window
*w
= XWINDOW (window
);
5282 Lisp_Object string_info
= Qnil
;
5283 ptrdiff_t textpos
= 0;
5284 int col
= -1, row
= -1;
5285 int dx
= -1, dy
= -1;
5286 int width
= -1, height
= -1;
5287 Lisp_Object object
= Qnil
;
5289 /* Pixel coordinates relative to the window corner. */
5290 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5291 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5293 /* For text area clicks, return X, Y relative to the corner of
5294 this text area. Note that dX, dY etc are set below, by
5295 buffer_posn_from_coords. */
5296 if (part
== ON_TEXT
)
5298 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5299 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5301 /* For mode line and header line clicks, return X, Y relative to
5302 the left window edge. Use mode_line_string to look for a
5303 string on the click position. */
5304 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5309 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5310 /* Note that mode_line_string takes COL, ROW as pixels and
5311 converts them to characters. */
5314 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5315 &object
, &dx
, &dy
, &width
, &height
);
5316 if (STRINGP (string
))
5317 string_info
= Fcons (string
, make_number (charpos
));
5323 /* For fringes and margins, Y is relative to the area's (and the
5324 window's) top edge, while X is meaningless. */
5325 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5330 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5333 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5334 &object
, &dx
, &dy
, &width
, &height
);
5335 if (STRINGP (string
))
5336 string_info
= Fcons (string
, make_number (charpos
));
5337 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5339 else if (part
== ON_LEFT_FRINGE
)
5341 posn
= Qleft_fringe
;
5344 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5345 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5346 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5348 else if (part
== ON_RIGHT_FRINGE
)
5350 posn
= Qright_fringe
;
5353 - window_box_width (w
, LEFT_MARGIN_AREA
)
5354 - window_box_width (w
, TEXT_AREA
)
5355 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5356 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5358 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5360 else if (part
== ON_VERTICAL_BORDER
)
5362 posn
= Qvertical_line
;
5367 /* Nothing special for part == ON_SCROLL_BAR. */
5368 else if (part
== ON_RIGHT_DIVIDER
)
5370 posn
= Qright_divider
;
5371 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5375 else if (part
== ON_BOTTOM_DIVIDER
)
5377 posn
= Qbottom_divider
;
5378 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5383 /* For clicks in the text area, fringes, or margins, call
5384 buffer_posn_from_coords to extract TEXTPOS, the buffer
5385 position nearest to the click. */
5388 Lisp_Object string2
, object2
= Qnil
;
5389 struct display_pos p
;
5391 int width2
, height2
;
5392 /* The pixel X coordinate passed to buffer_posn_from_coords
5393 is the X coordinate relative to the text area for
5394 text-area and right-margin clicks, zero otherwise. */
5396 = (part
== ON_TEXT
) ? xret
5397 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5398 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5402 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5403 &object2
, &dx2
, &dy2
,
5405 textpos
= CHARPOS (p
.pos
);
5406 if (col
< 0) col
= x2
;
5407 if (row
< 0) row
= y2
;
5408 if (dx
< 0) dx
= dx2
;
5409 if (dy
< 0) dy
= dy2
;
5410 if (width
< 0) width
= width2
;
5411 if (height
< 0) height
= height2
;
5415 posn
= make_number (textpos
);
5416 if (STRINGP (string2
))
5417 string_info
= Fcons (string2
,
5418 make_number (CHARPOS (p
.string_pos
)));
5424 #ifdef HAVE_WINDOW_SYSTEM
5425 if (IMAGEP (object
))
5427 Lisp_Object image_map
, hotspot
;
5428 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5430 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5432 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5433 posn
= XCAR (hotspot
);
5440 Fcons (make_number (dx
), make_number (dy
)),
5441 Fcons (make_number (width
), make_number (height
)));
5444 extra_info
= Fcons (string_info
,
5445 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5446 Fcons (Fcons (make_number (col
),
5451 XSETFRAME (window
, f
);
5455 return Fcons (window
,
5457 Fcons (Fcons (make_number (xret
),
5458 make_number (yret
)),
5459 Fcons (make_number (t
),
5463 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5464 menu bar. This really means that Emacs draws and manages the menu
5465 bar as part of its normal display, and therefore can compute its
5468 toolkit_menubar_in_use (struct frame
*f
)
5470 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5471 return !(!FRAME_WINDOW_P (f
));
5477 /* Given a struct input_event, build the lisp event which represents
5478 it. If EVENT is 0, build a mouse movement event from the mouse
5479 movement buffer, which should have a movement event in it.
5481 Note that events must be passed to this function in the order they
5482 are received; this function stores the location of button presses
5483 in order to build drag events when the button is released. */
5486 make_lispy_event (struct input_event
*event
)
5490 switch (event
->kind
)
5492 /* A simple keystroke. */
5493 case ASCII_KEYSTROKE_EVENT
:
5494 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5496 Lisp_Object lispy_c
;
5497 EMACS_INT c
= event
->code
;
5498 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5501 eassert (c
== event
->code
);
5502 /* Turn ASCII characters into control characters
5504 if (event
->modifiers
& ctrl_modifier
)
5506 c
= make_ctrl_char (c
);
5507 event
->modifiers
&= ~ctrl_modifier
;
5511 /* Add in the other modifier bits. The shift key was taken care
5512 of by the X code. */
5513 c
|= (event
->modifiers
5514 & (meta_modifier
| alt_modifier
5515 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5516 /* Distinguish Shift-SPC from SPC. */
5517 if ((event
->code
) == 040
5518 && event
->modifiers
& shift_modifier
)
5519 c
|= shift_modifier
;
5520 button_down_time
= 0;
5521 XSETFASTINT (lispy_c
, c
);
5526 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5527 except that they are non-key events (last-nonmenu-event is nil). */
5528 case NS_NONKEY_EVENT
:
5531 /* A function key. The symbol may need to have modifier prefixes
5533 case NON_ASCII_KEYSTROKE_EVENT
:
5534 button_down_time
= 0;
5536 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5537 if (event
->code
== lispy_accent_codes
[i
])
5538 return modify_event_symbol (i
,
5540 Qfunction_key
, Qnil
,
5541 lispy_accent_keys
, &accent_key_syms
,
5542 ARRAYELTS (lispy_accent_keys
));
5546 if (event
->code
>= 0x400 && event
->code
< 0x500)
5547 return modify_event_symbol (event
->code
- 0x400,
5548 event
->modifiers
& ~shift_modifier
,
5549 Qfunction_key
, Qnil
,
5550 lispy_kana_keys
, &func_key_syms
,
5551 ARRAYELTS (lispy_kana_keys
));
5552 #endif /* XK_kana_A */
5555 #ifdef ISO_FUNCTION_KEY_OFFSET
5556 if (event
->code
< FUNCTION_KEY_OFFSET
5557 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5558 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5560 Qfunction_key
, Qnil
,
5561 iso_lispy_function_keys
, &func_key_syms
,
5562 ARRAYELTS (iso_lispy_function_keys
));
5565 /* Handle system-specific or unknown keysyms. */
5566 if (event
->code
& (1 << 28)
5567 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5568 || (event
->code
- FUNCTION_KEY_OFFSET
5569 >= ARRAYELTS (lispy_function_keys
))
5570 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5572 /* We need to use an alist rather than a vector as the cache
5573 since we can't make a vector long enough. */
5574 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5575 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5576 return modify_event_symbol (event
->code
,
5579 KVAR (current_kboard
, Vsystem_key_alist
),
5580 0, &KVAR (current_kboard
, system_key_syms
),
5584 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5586 Qfunction_key
, Qnil
,
5587 lispy_function_keys
, &func_key_syms
,
5588 ARRAYELTS (lispy_function_keys
));
5591 case MULTIMEDIA_KEY_EVENT
:
5592 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5593 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5595 return modify_event_symbol (event
->code
, event
->modifiers
,
5596 Qfunction_key
, Qnil
,
5597 lispy_multimedia_keys
, &func_key_syms
,
5598 ARRAYELTS (lispy_multimedia_keys
));
5603 /* A mouse click. Figure out where it is, decide whether it's
5604 a press, click or drag, and build the appropriate structure. */
5605 case MOUSE_CLICK_EVENT
:
5607 case GPM_CLICK_EVENT
:
5609 #ifndef USE_TOOLKIT_SCROLL_BARS
5610 case SCROLL_BAR_CLICK_EVENT
:
5613 int button
= event
->code
;
5615 Lisp_Object position
;
5616 Lisp_Object
*start_pos_ptr
;
5617 Lisp_Object start_pos
;
5621 /* Build the position as appropriate for this mouse click. */
5622 if (event
->kind
== MOUSE_CLICK_EVENT
5624 || event
->kind
== GPM_CLICK_EVENT
5628 struct frame
*f
= XFRAME (event
->frame_or_window
);
5631 /* Ignore mouse events that were made on frame that
5632 have been deleted. */
5633 if (! FRAME_LIVE_P (f
))
5636 /* EVENT->x and EVENT->y are frame-relative pixel
5637 coordinates at this place. Under old redisplay, COLUMN
5638 and ROW are set to frame relative glyph coordinates
5639 which are then used to determine whether this click is
5640 in a menu (non-toolkit version). */
5641 if (!toolkit_menubar_in_use (f
))
5643 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5644 &column
, &row
, NULL
, 1);
5646 /* In the non-toolkit version, clicks on the menu bar
5647 are ordinary button events in the event buffer.
5648 Distinguish them, and invoke the menu.
5650 (In the toolkit version, the toolkit handles the
5651 menu bar and Emacs doesn't know about it until
5652 after the user makes a selection.) */
5653 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5654 && (event
->modifiers
& down_modifier
))
5656 Lisp_Object items
, item
;
5658 /* Find the menu bar item under `column'. */
5660 items
= FRAME_MENU_BAR_ITEMS (f
);
5661 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5663 Lisp_Object pos
, string
;
5664 string
= AREF (items
, i
+ 1);
5665 pos
= AREF (items
, i
+ 3);
5668 if (column
>= XINT (pos
)
5669 && column
< XINT (pos
) + SCHARS (string
))
5671 item
= AREF (items
, i
);
5676 /* ELisp manual 2.4b says (x y) are window
5677 relative but code says they are
5679 position
= list4 (event
->frame_or_window
,
5681 Fcons (event
->x
, event
->y
),
5682 make_number (event
->timestamp
));
5684 return list2 (item
, position
);
5688 position
= make_lispy_position (f
, event
->x
, event
->y
,
5691 #ifndef USE_TOOLKIT_SCROLL_BARS
5694 /* It's a scrollbar click. */
5696 Lisp_Object portion_whole
;
5699 window
= event
->frame_or_window
;
5700 portion_whole
= Fcons (event
->x
, event
->y
);
5701 part
= *scroll_bar_parts
[(int) event
->part
];
5703 position
= list5 (window
, Qvertical_scroll_bar
,
5704 portion_whole
, make_number (event
->timestamp
),
5707 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5709 if (button
>= ASIZE (button_down_location
))
5711 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5712 button_down_location
= larger_vector (button_down_location
,
5714 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5717 start_pos_ptr
= aref_addr (button_down_location
, button
);
5718 start_pos
= *start_pos_ptr
;
5719 *start_pos_ptr
= Qnil
;
5722 /* On window-system frames, use the value of
5723 double-click-fuzz as is. On other frames, interpret it
5724 as a multiple of 1/8 characters. */
5728 if (WINDOWP (event
->frame_or_window
))
5729 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5730 else if (FRAMEP (event
->frame_or_window
))
5731 f
= XFRAME (event
->frame_or_window
);
5735 if (FRAME_WINDOW_P (f
))
5736 fuzz
= double_click_fuzz
;
5738 fuzz
= double_click_fuzz
/ 8;
5740 is_double
= (button
== last_mouse_button
5741 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5742 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5743 && button_down_time
!= 0
5744 && (EQ (Vdouble_click_time
, Qt
)
5745 || (NATNUMP (Vdouble_click_time
)
5746 && (event
->timestamp
- button_down_time
5747 < XFASTINT (Vdouble_click_time
)))));
5750 last_mouse_button
= button
;
5751 last_mouse_x
= XINT (event
->x
);
5752 last_mouse_y
= XINT (event
->y
);
5754 /* If this is a button press, squirrel away the location, so
5755 we can decide later whether it was a click or a drag. */
5756 if (event
->modifiers
& down_modifier
)
5760 double_click_count
++;
5761 event
->modifiers
|= ((double_click_count
> 2)
5766 double_click_count
= 1;
5767 button_down_time
= event
->timestamp
;
5768 *start_pos_ptr
= Fcopy_alist (position
);
5769 ignore_mouse_drag_p
= 0;
5772 /* Now we're releasing a button - check the co-ordinates to
5773 see if this was a click or a drag. */
5774 else if (event
->modifiers
& up_modifier
)
5776 /* If we did not see a down before this up, ignore the up.
5777 Probably this happened because the down event chose a
5778 menu item. It would be an annoyance to treat the
5779 release of the button that chose the menu item as a
5782 if (!CONSP (start_pos
))
5785 event
->modifiers
&= ~up_modifier
;
5788 Lisp_Object new_down
, down
;
5789 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5791 /* The third element of every position
5792 should be the (x,y) pair. */
5793 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5794 new_down
= Fcar (Fcdr (Fcdr (position
)));
5797 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5799 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5800 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5803 if (ignore_mouse_drag_p
)
5805 event
->modifiers
|= click_modifier
;
5806 ignore_mouse_drag_p
= 0;
5808 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5809 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5810 /* Maybe the mouse has moved a lot, caused scrolling, and
5811 eventually ended up at the same screen position (but
5812 not buffer position) in which case it is a drag, not
5814 /* FIXME: OTOH if the buffer position has changed
5815 because of a timer or process filter rather than
5816 because of mouse movement, it should be considered as
5817 a click. But mouse-drag-region completely ignores
5818 this case and it hasn't caused any real problem, so
5819 it's probably OK to ignore it as well. */
5820 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5821 /* Mouse hasn't moved (much). */
5822 event
->modifiers
|= click_modifier
;
5825 button_down_time
= 0;
5826 event
->modifiers
|= drag_modifier
;
5829 /* Don't check is_double; treat this as multiple
5830 if the down-event was multiple. */
5831 if (double_click_count
> 1)
5832 event
->modifiers
|= ((double_click_count
> 2)
5838 /* Every mouse event should either have the down_modifier or
5839 the up_modifier set. */
5843 /* Get the symbol we should use for the mouse click. */
5846 head
= modify_event_symbol (button
,
5848 Qmouse_click
, Vlispy_mouse_stem
,
5851 ASIZE (mouse_syms
));
5852 if (event
->modifiers
& drag_modifier
)
5853 return list3 (head
, start_pos
, position
);
5854 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5855 return list3 (head
, position
, make_number (double_click_count
));
5857 return list2 (head
, position
);
5862 case HORIZ_WHEEL_EVENT
:
5864 Lisp_Object position
;
5867 /* Build the position as appropriate for this mouse click. */
5868 struct frame
*f
= XFRAME (event
->frame_or_window
);
5870 /* Ignore wheel events that were made on frame that have been
5872 if (! FRAME_LIVE_P (f
))
5875 position
= make_lispy_position (f
, event
->x
, event
->y
,
5878 /* Set double or triple modifiers to indicate the wheel speed. */
5880 /* On window-system frames, use the value of
5881 double-click-fuzz as is. On other frames, interpret it
5882 as a multiple of 1/8 characters. */
5888 if (WINDOWP (event
->frame_or_window
))
5889 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5890 else if (FRAMEP (event
->frame_or_window
))
5891 fr
= XFRAME (event
->frame_or_window
);
5895 fuzz
= FRAME_WINDOW_P (fr
)
5896 ? double_click_fuzz
: double_click_fuzz
/ 8;
5898 if (event
->modifiers
& up_modifier
)
5900 /* Emit a wheel-up event. */
5901 event
->modifiers
&= ~up_modifier
;
5904 else if (event
->modifiers
& down_modifier
)
5906 /* Emit a wheel-down event. */
5907 event
->modifiers
&= ~down_modifier
;
5911 /* Every wheel event should either have the down_modifier or
5912 the up_modifier set. */
5915 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5918 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5919 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5920 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5921 && button_down_time
!= 0
5922 && (EQ (Vdouble_click_time
, Qt
)
5923 || (NATNUMP (Vdouble_click_time
)
5924 && (event
->timestamp
- button_down_time
5925 < XFASTINT (Vdouble_click_time
)))));
5928 double_click_count
++;
5929 event
->modifiers
|= ((double_click_count
> 2)
5935 double_click_count
= 1;
5936 event
->modifiers
|= click_modifier
;
5939 button_down_time
= event
->timestamp
;
5940 /* Use a negative value to distinguish wheel from mouse button. */
5941 last_mouse_button
= - (1 + symbol_num
);
5942 last_mouse_x
= XINT (event
->x
);
5943 last_mouse_y
= XINT (event
->y
);
5945 /* Get the symbol we should use for the wheel event. */
5946 head
= modify_event_symbol (symbol_num
,
5952 ASIZE (wheel_syms
));
5955 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5956 return list3 (head
, position
, make_number (double_click_count
));
5958 return list2 (head
, position
);
5962 #ifdef USE_TOOLKIT_SCROLL_BARS
5964 /* We don't have down and up events if using toolkit scroll bars,
5965 so make this always a click event. Store in the `part' of
5966 the Lisp event a symbol which maps to the following actions:
5968 `above_handle' page up
5969 `below_handle' page down
5973 `bottom' bottom of buffer
5974 `handle' thumb has been dragged.
5975 `end-scroll' end of interaction with scroll bar
5977 The incoming input_event contains in its `part' member an
5978 index of type `enum scroll_bar_part' which we can use as an
5979 index in scroll_bar_parts to get the appropriate symbol. */
5981 case SCROLL_BAR_CLICK_EVENT
:
5983 Lisp_Object position
, head
, window
, portion_whole
, part
;
5985 window
= event
->frame_or_window
;
5986 portion_whole
= Fcons (event
->x
, event
->y
);
5987 part
= *scroll_bar_parts
[(int) event
->part
];
5989 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5990 make_number (event
->timestamp
), part
);
5992 /* Always treat scroll bar events as clicks. */
5993 event
->modifiers
|= click_modifier
;
5994 event
->modifiers
&= ~up_modifier
;
5996 if (event
->code
>= ASIZE (mouse_syms
))
5997 mouse_syms
= larger_vector (mouse_syms
,
5998 event
->code
- ASIZE (mouse_syms
) + 1,
6001 /* Get the symbol we should use for the mouse click. */
6002 head
= modify_event_symbol (event
->code
,
6007 ASIZE (mouse_syms
));
6008 return list2 (head
, position
);
6011 #endif /* USE_TOOLKIT_SCROLL_BARS */
6013 case DRAG_N_DROP_EVENT
:
6016 Lisp_Object head
, position
;
6019 f
= XFRAME (event
->frame_or_window
);
6022 /* Ignore mouse events that were made on frames that
6023 have been deleted. */
6024 if (! FRAME_LIVE_P (f
))
6027 position
= make_lispy_position (f
, event
->x
, event
->y
,
6030 head
= modify_event_symbol (0, event
->modifiers
,
6032 lispy_drag_n_drop_names
,
6033 &drag_n_drop_syms
, 1);
6034 return list3 (head
, position
, files
);
6037 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6038 || defined (HAVE_NS) || defined (USE_GTK)
6039 case MENU_BAR_EVENT
:
6040 if (EQ (event
->arg
, event
->frame_or_window
))
6041 /* This is the prefix key. We translate this to
6042 `(menu_bar)' because the code in keyboard.c for menu
6043 events, which we use, relies on this. */
6044 return list1 (Qmenu_bar
);
6048 case SELECT_WINDOW_EVENT
:
6049 /* Make an event (select-window (WINDOW)). */
6050 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6052 case TOOL_BAR_EVENT
:
6053 if (EQ (event
->arg
, event
->frame_or_window
))
6054 /* This is the prefix key. We translate this to
6055 `(tool_bar)' because the code in keyboard.c for tool bar
6056 events, which we use, relies on this. */
6057 return list1 (Qtool_bar
);
6058 else if (SYMBOLP (event
->arg
))
6059 return apply_modifiers (event
->modifiers
, event
->arg
);
6062 case USER_SIGNAL_EVENT
:
6063 /* A user signal. */
6065 char *name
= find_user_signal_name (event
->code
);
6068 return intern (name
);
6071 case SAVE_SESSION_EVENT
:
6072 return Qsave_session
;
6077 return Fcons (Qdbus_event
, event
->arg
);
6079 #endif /* HAVE_DBUS */
6081 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6082 case FILE_NOTIFY_EVENT
:
6084 return Fcons (Qfile_notify
, event
->arg
);
6086 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6088 case CONFIG_CHANGED_EVENT
:
6089 return list3 (Qconfig_changed_event
,
6090 event
->arg
, event
->frame_or_window
);
6092 /* The 'kind' field of the event is something we don't recognize. */
6099 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6100 Lisp_Object x
, Lisp_Object y
, Time t
)
6102 /* Is it a scroll bar movement? */
6103 if (frame
&& ! NILP (bar_window
))
6105 Lisp_Object part_sym
;
6107 part_sym
= *scroll_bar_parts
[(int) part
];
6108 return list2 (Qscroll_bar_movement
,
6110 Qvertical_scroll_bar
,
6115 /* Or is it an ordinary mouse movement? */
6118 Lisp_Object position
;
6119 position
= make_lispy_position (frame
, x
, y
, t
);
6120 return list2 (Qmouse_movement
, position
);
6124 /* Construct a switch frame event. */
6126 make_lispy_switch_frame (Lisp_Object frame
)
6128 return list2 (Qswitch_frame
, frame
);
6132 make_lispy_focus_in (Lisp_Object frame
)
6134 return list2 (Qfocus_in
, frame
);
6137 #ifdef HAVE_WINDOW_SYSTEM
6140 make_lispy_focus_out (Lisp_Object frame
)
6142 return list2 (Qfocus_out
, frame
);
6145 #endif /* HAVE_WINDOW_SYSTEM */
6147 /* Manipulating modifiers. */
6149 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6151 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6152 SYMBOL's name of the end of the modifiers; the string from this
6153 position is the unmodified symbol name.
6155 This doesn't use any caches. */
6158 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6164 CHECK_SYMBOL (symbol
);
6167 name
= SYMBOL_NAME (symbol
);
6169 for (i
= 0; i
< SBYTES (name
) - 1; )
6171 ptrdiff_t this_mod_end
= 0;
6174 /* See if the name continues with a modifier word.
6175 Check that the word appears, but don't check what follows it.
6176 Set this_mod and this_mod_end to record what we find. */
6178 switch (SREF (name
, i
))
6180 #define SINGLE_LETTER_MOD(BIT) \
6181 (this_mod_end = i + 1, this_mod = BIT)
6184 SINGLE_LETTER_MOD (alt_modifier
);
6188 SINGLE_LETTER_MOD (ctrl_modifier
);
6192 SINGLE_LETTER_MOD (hyper_modifier
);
6196 SINGLE_LETTER_MOD (meta_modifier
);
6200 SINGLE_LETTER_MOD (shift_modifier
);
6204 SINGLE_LETTER_MOD (super_modifier
);
6207 #undef SINGLE_LETTER_MOD
6209 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6210 if (i + LEN + 1 <= SBYTES (name) \
6211 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6213 this_mod_end = i + LEN; \
6218 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6219 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6220 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6224 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6226 #undef MULTI_LETTER_MOD
6230 /* If we found no modifier, stop looking for them. */
6231 if (this_mod_end
== 0)
6234 /* Check there is a dash after the modifier, so that it
6235 really is a modifier. */
6236 if (this_mod_end
>= SBYTES (name
)
6237 || SREF (name
, this_mod_end
) != '-')
6240 /* This modifier is real; look for another. */
6241 modifiers
|= this_mod
;
6242 i
= this_mod_end
+ 1;
6245 /* Should we include the `click' modifier? */
6246 if (! (modifiers
& (down_modifier
| drag_modifier
6247 | double_modifier
| triple_modifier
))
6248 && i
+ 7 == SBYTES (name
)
6249 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6250 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6251 modifiers
|= click_modifier
;
6253 if (! (modifiers
& (double_modifier
| triple_modifier
))
6254 && i
+ 6 < SBYTES (name
)
6255 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6256 modifiers
|= click_modifier
;
6264 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6265 prepended to the string BASE[0..BASE_LEN-1].
6266 This doesn't use any caches. */
6268 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6270 /* Since BASE could contain nulls, we can't use intern here; we have
6271 to use Fintern, which expects a genuine Lisp_String, and keeps a
6273 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6279 /* Only the event queue may use the `up' modifier; it should always
6280 be turned into a click or drag event before presented to lisp code. */
6281 if (modifiers
& up_modifier
)
6284 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6285 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6286 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6287 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6288 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6289 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6290 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6291 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6292 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6293 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6294 /* The click modifier is denoted by the absence of other modifiers. */
6298 mod_len
= p
- new_mods
;
6302 Lisp_Object new_name
;
6304 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6305 mod_len
+ base_len_byte
);
6306 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6307 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6309 return Fintern (new_name
, Qnil
);
6314 static const char *const modifier_names
[] =
6316 "up", "down", "drag", "click", "double", "triple", 0, 0,
6317 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6318 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6320 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6322 static Lisp_Object modifier_symbols
;
6324 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6326 lispy_modifier_list (int modifiers
)
6328 Lisp_Object modifier_list
;
6331 modifier_list
= Qnil
;
6332 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6333 if (modifiers
& (1<<i
))
6334 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6337 return modifier_list
;
6341 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6342 where UNMODIFIED is the unmodified form of SYMBOL,
6343 MASK is the set of modifiers present in SYMBOL's name.
6344 This is similar to parse_modifiers_uncached, but uses the cache in
6345 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6346 Qevent_symbol_elements property. */
6348 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6351 parse_modifiers (Lisp_Object symbol
)
6353 Lisp_Object elements
;
6355 if (INTEGERP (symbol
))
6356 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6357 else if (!SYMBOLP (symbol
))
6360 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6361 if (CONSP (elements
))
6366 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6367 Lisp_Object unmodified
;
6370 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6371 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6374 if (modifiers
& ~INTMASK
)
6376 XSETFASTINT (mask
, modifiers
);
6377 elements
= list2 (unmodified
, mask
);
6379 /* Cache the parsing results on SYMBOL. */
6380 Fput (symbol
, Qevent_symbol_element_mask
,
6382 Fput (symbol
, Qevent_symbol_elements
,
6383 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6385 /* Since we know that SYMBOL is modifiers applied to unmodified,
6386 it would be nice to put that in unmodified's cache.
6387 But we can't, since we're not sure that parse_modifiers is
6394 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6395 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6396 doc
: /* Parse the event symbol. For internal use. */)
6397 (Lisp_Object symbol
)
6399 /* Fill the cache if needed. */
6400 parse_modifiers (symbol
);
6401 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6402 and use the Lispier representation stored on Qevent_symbol_elements
6404 return Fget (symbol
, Qevent_symbol_elements
);
6407 /* Apply the modifiers MODIFIERS to the symbol BASE.
6408 BASE must be unmodified.
6410 This is like apply_modifiers_uncached, but uses BASE's
6411 Qmodifier_cache property, if present. It also builds
6412 Qevent_symbol_elements properties, since it has that info anyway.
6414 apply_modifiers copies the value of BASE's Qevent_kind property to
6415 the modified symbol. */
6417 apply_modifiers (int modifiers
, Lisp_Object base
)
6419 Lisp_Object cache
, idx
, entry
, new_symbol
;
6421 /* Mask out upper bits. We don't know where this value's been. */
6422 modifiers
&= INTMASK
;
6424 if (INTEGERP (base
))
6425 return make_number (XINT (base
) | modifiers
);
6427 /* The click modifier never figures into cache indices. */
6428 cache
= Fget (base
, Qmodifier_cache
);
6429 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6430 entry
= assq_no_quit (idx
, cache
);
6433 new_symbol
= XCDR (entry
);
6436 /* We have to create the symbol ourselves. */
6437 new_symbol
= apply_modifiers_uncached (modifiers
,
6438 SSDATA (SYMBOL_NAME (base
)),
6439 SCHARS (SYMBOL_NAME (base
)),
6440 SBYTES (SYMBOL_NAME (base
)));
6442 /* Add the new symbol to the base's cache. */
6443 entry
= Fcons (idx
, new_symbol
);
6444 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6446 /* We have the parsing info now for free, so we could add it to
6448 XSETFASTINT (idx, modifiers);
6449 Fput (new_symbol, Qevent_symbol_element_mask,
6451 Fput (new_symbol, Qevent_symbol_elements,
6452 Fcons (base, lispy_modifier_list (modifiers)));
6453 Sadly, this is only correct if `base' is indeed a base event,
6454 which is not necessarily the case. -stef */
6457 /* Make sure this symbol is of the same kind as BASE.
6459 You'd think we could just set this once and for all when we
6460 intern the symbol above, but reorder_modifiers may call us when
6461 BASE's property isn't set right; we can't assume that just
6462 because it has a Qmodifier_cache property it must have its
6463 Qevent_kind set right as well. */
6464 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6468 kind
= Fget (base
, Qevent_kind
);
6470 Fput (new_symbol
, Qevent_kind
, kind
);
6477 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6478 return a symbol with the modifiers placed in the canonical order.
6479 Canonical order is alphabetical, except for down and drag, which
6480 always come last. The 'click' modifier is never written out.
6482 Fdefine_key calls this to make sure that (for example) C-M-foo
6483 and M-C-foo end up being equivalent in the keymap. */
6486 reorder_modifiers (Lisp_Object symbol
)
6488 /* It's hopefully okay to write the code this way, since everything
6489 will soon be in caches, and no consing will be done at all. */
6492 parsed
= parse_modifiers (symbol
);
6493 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6498 /* For handling events, we often want to produce a symbol whose name
6499 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6500 to some base, like the name of a function key or mouse button.
6501 modify_event_symbol produces symbols of this sort.
6503 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6504 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6507 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6508 into symbol names, or a string specifying a name stem used to
6509 construct a symbol name or the form `STEM-N', where N is the decimal
6510 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6511 non-nil; otherwise NAME_TABLE is used.
6513 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6514 persist between calls to modify_event_symbol that it can use to
6515 store a cache of the symbols it's generated for this NAME_TABLE
6516 before. The object stored there may be a vector or an alist.
6518 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6520 MODIFIERS is a set of modifier bits (as given in struct input_events)
6521 whose prefixes should be applied to the symbol name.
6523 SYMBOL_KIND is the value to be placed in the event_kind property of
6524 the returned symbol.
6526 The symbols we create are supposed to have an
6527 `event-symbol-elements' property, which lists the modifiers present
6528 in the symbol's name. */
6531 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6532 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6533 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6536 Lisp_Object symbol_int
;
6538 /* Get rid of the "vendor-specific" bit here. */
6539 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6541 /* Is this a request for a valid symbol? */
6542 if (symbol_num
< 0 || symbol_num
>= table_size
)
6545 if (CONSP (*symbol_table
))
6546 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6548 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6549 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6550 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6551 we've never used that symbol before. */
6554 if (! VECTORP (*symbol_table
)
6555 || ASIZE (*symbol_table
) != table_size
)
6559 XSETFASTINT (size
, table_size
);
6560 *symbol_table
= Fmake_vector (size
, Qnil
);
6563 value
= AREF (*symbol_table
, symbol_num
);
6566 /* Have we already used this symbol before? */
6569 /* No; let's create it. */
6570 if (CONSP (name_alist_or_stem
))
6571 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6572 else if (STRINGP (name_alist_or_stem
))
6575 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6576 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6578 buf
= SAFE_ALLOCA (len
);
6579 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6580 XINT (symbol_int
) + 1);
6581 value
= intern (buf
);
6584 else if (name_table
!= 0 && name_table
[symbol_num
])
6585 value
= intern (name_table
[symbol_num
]);
6587 #ifdef HAVE_WINDOW_SYSTEM
6590 char *name
= x_get_keysym_name (symbol_num
);
6592 value
= intern (name
);
6598 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6599 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6600 value
= intern (buf
);
6603 if (CONSP (*symbol_table
))
6604 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6606 ASET (*symbol_table
, symbol_num
, value
);
6608 /* Fill in the cache entries for this symbol; this also
6609 builds the Qevent_symbol_elements property, which the user
6611 apply_modifiers (modifiers
& click_modifier
, value
);
6612 Fput (value
, Qevent_kind
, symbol_kind
);
6615 /* Apply modifiers to that symbol. */
6616 return apply_modifiers (modifiers
, value
);
6619 /* Convert a list that represents an event type,
6620 such as (ctrl meta backspace), into the usual representation of that
6621 event type as a number or a symbol. */
6623 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6624 doc
: /* Convert the event description list EVENT-DESC to an event type.
6625 EVENT-DESC should contain one base event type (a character or symbol)
6626 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6627 drag, down, double or triple). The base must be last.
6628 The return value is an event type (a character or symbol) which
6629 has the same base event type and all the specified modifiers. */)
6630 (Lisp_Object event_desc
)
6638 while (CONSP (rest
))
6646 /* Given a symbol, see if it is a modifier name. */
6647 if (SYMBOLP (elt
) && CONSP (rest
))
6648 this = parse_solitary_modifier (elt
);
6652 else if (!NILP (base
))
6653 error ("Two bases given in one event");
6659 /* Let the symbol A refer to the character A. */
6660 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6661 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6663 if (INTEGERP (base
))
6665 /* Turn (shift a) into A. */
6666 if ((modifiers
& shift_modifier
) != 0
6667 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6669 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6670 modifiers
&= ~shift_modifier
;
6673 /* Turn (control a) into C-a. */
6674 if (modifiers
& ctrl_modifier
)
6675 return make_number ((modifiers
& ~ctrl_modifier
)
6676 | make_ctrl_char (XINT (base
)));
6678 return make_number (modifiers
| XINT (base
));
6680 else if (SYMBOLP (base
))
6681 return apply_modifiers (modifiers
, base
);
6683 error ("Invalid base event");
6686 /* Try to recognize SYMBOL as a modifier name.
6687 Return the modifier flag bit, or 0 if not recognized. */
6690 parse_solitary_modifier (Lisp_Object symbol
)
6692 Lisp_Object name
= SYMBOL_NAME (symbol
);
6694 switch (SREF (name
, 0))
6696 #define SINGLE_LETTER_MOD(BIT) \
6697 if (SBYTES (name) == 1) \
6700 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6701 if (LEN == SBYTES (name) \
6702 && ! memcmp (SDATA (name), NAME, LEN)) \
6706 SINGLE_LETTER_MOD (alt_modifier
);
6710 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6714 SINGLE_LETTER_MOD (ctrl_modifier
);
6718 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6719 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6723 SINGLE_LETTER_MOD (hyper_modifier
);
6727 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6731 SINGLE_LETTER_MOD (meta_modifier
);
6735 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6739 SINGLE_LETTER_MOD (shift_modifier
);
6743 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6744 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6745 SINGLE_LETTER_MOD (super_modifier
);
6749 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6750 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6751 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6755 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6758 #undef SINGLE_LETTER_MOD
6759 #undef MULTI_LETTER_MOD
6765 /* Return true if EVENT is a list whose elements are all integers or symbols.
6766 Such a list is not valid as an event,
6767 but it can be a Lucid-style event type list. */
6770 lucid_event_type_list_p (Lisp_Object object
)
6774 if (! CONSP (object
))
6777 if (EQ (XCAR (object
), Qhelp_echo
)
6778 || EQ (XCAR (object
), Qvertical_line
)
6779 || EQ (XCAR (object
), Qmode_line
)
6780 || EQ (XCAR (object
), Qheader_line
))
6783 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6787 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6794 /* Return true if terminal input chars are available.
6795 Also, store the return value into INPUT_PENDING.
6797 Serves the purpose of ioctl (0, FIONREAD, ...)
6798 but works even if FIONREAD does not exist.
6799 (In fact, this may actually read some input.)
6801 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6802 timer events that are ripe.
6803 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6804 events (FOCUS_IN_EVENT).
6805 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6806 movements and toolkit scroll bar thumb drags. */
6809 get_input_pending (int flags
)
6811 /* First of all, have we already counted some input? */
6812 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6814 /* If input is being read as it arrives, and we have none, there is none. */
6815 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6817 /* Try to read some input and see how much we get. */
6819 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6822 return input_pending
;
6825 /* Put a BUFFER_SWITCH_EVENT in the buffer
6826 so that read_key_sequence will notice the new current buffer. */
6829 record_asynch_buffer_change (void)
6831 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6832 The purpose of the event is to make read_key_sequence look up the
6833 keymaps again. If we aren't in read_key_sequence, we don't need one,
6834 and the event could cause trouble by messing up (input-pending-p).
6835 Note: Fwaiting_for_user_input_p always returns nil when async
6836 subprocesses aren't supported. */
6837 if (!NILP (Fwaiting_for_user_input_p ()))
6839 struct input_event event
;
6842 event
.kind
= BUFFER_SWITCH_EVENT
;
6843 event
.frame_or_window
= Qnil
;
6846 /* Make sure no interrupt happens while storing the event. */
6848 if (interrupt_input
)
6849 kbd_buffer_store_event (&event
);
6854 kbd_buffer_store_event (&event
);
6860 /* Read any terminal input already buffered up by the system
6861 into the kbd_buffer, but do not wait.
6863 Return the number of keyboard chars read, or -1 meaning
6864 this is a bad time to try to read input. */
6873 /* Store pending user signal events, if any. */
6874 store_user_signal_events ();
6876 /* Loop through the available terminals, and call their input hooks. */
6880 struct terminal
*next
= t
->next_terminal
;
6882 if (t
->read_socket_hook
)
6885 struct input_event hold_quit
;
6887 if (input_blocked_p ())
6889 pending_signals
= 1;
6893 EVENT_INIT (hold_quit
);
6894 hold_quit
.kind
= NO_EVENT
;
6896 /* No need for FIONREAD or fcntl; just say don't wait. */
6897 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6900 if (nr
== -1) /* Not OK to read input now. */
6904 else if (nr
== -2) /* Non-transient error. */
6906 /* The terminal device terminated; it should be closed. */
6908 /* Kill Emacs if this was our last terminal. */
6909 if (!terminal_list
->next_terminal
)
6910 /* Formerly simply reported no input, but that
6911 sometimes led to a failure of Emacs to terminate.
6912 SIGHUP seems appropriate if we can't reach the
6914 /* ??? Is it really right to send the signal just to
6915 this process rather than to the whole process
6916 group? Perhaps on systems with FIONREAD Emacs is
6917 alone in its group. */
6918 terminate_due_to_signal (SIGHUP
, 10);
6920 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6923 XSETTERMINAL (tmp
, t
);
6924 Fdelete_terminal (tmp
, Qnoelisp
);
6928 /* If there was no error, make sure the pointer
6929 is visible for all frames on this terminal. */
6932 Lisp_Object tail
, frame
;
6934 FOR_EACH_FRAME (tail
, frame
)
6936 struct frame
*f
= XFRAME (frame
);
6937 if (FRAME_TERMINAL (f
) == t
)
6938 frame_make_pointer_visible (f
);
6942 if (hold_quit
.kind
!= NO_EVENT
)
6943 kbd_buffer_store_event (&hold_quit
);
6955 /* This is the tty way of reading available input.
6957 Note that each terminal device has its own `struct terminal' object,
6958 and so this function is called once for each individual termcap
6959 terminal. The first parameter indicates which terminal to read from. */
6962 tty_read_avail_input (struct terminal
*terminal
,
6963 struct input_event
*hold_quit
)
6965 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6966 the kbd_buffer can really hold. That may prevent loss
6967 of characters on some systems when input is stuffed at us. */
6968 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6970 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6973 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6975 if (kbd_on_hold_p () || buffer_free
<= 0)
6977 #endif /* subprocesses */
6979 if (!terminal
->name
) /* Don't read from a dead terminal. */
6982 if (terminal
->type
!= output_termcap
6983 && terminal
->type
!= output_msdos_raw
)
6986 /* XXX I think the following code should be moved to separate hook
6987 functions in system-dependent files. */
6989 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6990 code sets read_socket_hook to w32_console_read_socket instead! */
6992 #else /* not WINDOWSNT */
6993 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6997 return 0; /* The terminal is suspended. */
7000 n_to_read
= dos_keysns ();
7004 cbuf
[0] = dos_keyread ();
7007 #else /* not MSDOS */
7012 struct input_event gpm_hold_quit
;
7013 int gpm
, fd
= gpm_fd
;
7015 EVENT_INIT (gpm_hold_quit
);
7016 gpm_hold_quit
.kind
= NO_EVENT
;
7018 /* gpm==1 if event received.
7019 gpm==0 if the GPM daemon has closed the connection, in which case
7020 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7021 we save it in `fd' so close_gpm can remove it from the
7023 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7024 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7025 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7028 /* Presumably the GPM daemon has closed the connection. */
7030 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7031 kbd_buffer_store_event (&gpm_hold_quit
);
7035 #endif /* HAVE_GPM */
7037 /* Determine how many characters we should *try* to read. */
7038 #ifdef USABLE_FIONREAD
7039 /* Find out how much input is available. */
7040 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7042 if (! noninteractive
)
7043 return -2; /* Close this terminal. */
7049 if (n_to_read
> sizeof cbuf
)
7050 n_to_read
= sizeof cbuf
;
7051 #elif defined USG || defined CYGWIN
7052 /* Read some input if available, but don't wait. */
7053 n_to_read
= sizeof cbuf
;
7054 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7056 # error "Cannot read without possibly delaying"
7060 /* Don't read more than we can store. */
7061 if (n_to_read
> buffer_free
)
7062 n_to_read
= buffer_free
;
7063 #endif /* subprocesses */
7065 /* Now read; for one reason or another, this will not block.
7066 NREAD is set to the number of chars read. */
7069 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7070 /* POSIX infers that processes which are not in the session leader's
7071 process group won't get SIGHUPs at logout time. BSDI adheres to
7072 this part standard and returns -1 from read (0) with errno==EIO
7073 when the control tty is taken away.
7074 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7075 if (nread
== -1 && errno
== EIO
)
7076 return -2; /* Close this terminal. */
7077 #if defined (AIX) && defined (_BSD)
7078 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7079 This looks incorrect, but it isn't, because _BSD causes
7080 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7081 and that causes a value other than 0 when there is no input. */
7083 return -2; /* Close this terminal. */
7087 /* We used to retry the read if it was interrupted.
7088 But this does the wrong thing when O_NONBLOCK causes
7089 an EAGAIN error. Does anybody know of a situation
7090 where a retry is actually needed? */
7092 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7102 #ifndef USABLE_FIONREAD
7103 #if defined (USG) || defined (CYGWIN)
7104 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7105 #endif /* USG or CYGWIN */
7106 #endif /* no FIONREAD */
7111 #endif /* not MSDOS */
7112 #endif /* not WINDOWSNT */
7114 for (i
= 0; i
< nread
; i
++)
7116 struct input_event buf
;
7118 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7120 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7121 buf
.modifiers
= meta_modifier
;
7122 if (tty
->meta_key
!= 2)
7126 /* Set the frame corresponding to the active tty. Note that the
7127 value of selected_frame is not reliable here, redisplay tends
7128 to temporarily change it. */
7129 buf
.frame_or_window
= tty
->top_frame
;
7132 kbd_buffer_store_event (&buf
);
7133 /* Don't look at input that follows a C-g too closely.
7134 This reduces lossage due to autorepeat on C-g. */
7135 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7136 && buf
.code
== quit_char
)
7144 handle_async_input (void)
7149 int nread
= gobble_input ();
7150 /* -1 means it's not ok to read the input now.
7151 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7152 0 means there was no keyboard input available. */
7160 process_pending_signals (void)
7162 pending_signals
= 0;
7163 handle_async_input ();
7164 do_pending_atimers ();
7167 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7168 and reinvoke any pending signal if the level is now 0 and
7169 a fatal error is not already in progress. */
7172 unblock_input_to (int level
)
7174 interrupt_input_blocked
= level
;
7177 if (pending_signals
&& !fatal_error_in_progress
)
7178 process_pending_signals ();
7184 /* End critical section.
7186 If doing signal-driven input, and a signal came in when input was
7187 blocked, reinvoke the signal handler now to deal with it.
7189 It will also process queued input, if it was not read before.
7190 When a longer code sequence does not use block/unblock input
7191 at all, the whole input gathered up to the next call to
7192 unblock_input will be processed inside that call. */
7195 unblock_input (void)
7197 unblock_input_to (interrupt_input_blocked
- 1);
7200 /* Undo any number of BLOCK_INPUT calls,
7201 and also reinvoke any pending signal. */
7204 totally_unblock_input (void)
7206 unblock_input_to (0);
7212 handle_input_available_signal (int sig
)
7214 pending_signals
= 1;
7216 if (input_available_clear_time
)
7217 *input_available_clear_time
= make_timespec (0, 0);
7221 deliver_input_available_signal (int sig
)
7223 deliver_process_signal (sig
, handle_input_available_signal
);
7225 #endif /* USABLE_SIGIO */
7228 /* User signal events. */
7230 struct user_signal_info
7232 /* Signal number. */
7235 /* Name of the signal. */
7238 /* Number of pending signals. */
7241 struct user_signal_info
*next
;
7244 /* List of user signals. */
7245 static struct user_signal_info
*user_signals
= NULL
;
7248 add_user_signal (int sig
, const char *name
)
7250 struct sigaction action
;
7251 struct user_signal_info
*p
;
7253 for (p
= user_signals
; p
; p
= p
->next
)
7255 /* Already added. */
7258 p
= xmalloc (sizeof *p
);
7260 p
->name
= xstrdup (name
);
7262 p
->next
= user_signals
;
7265 emacs_sigaction_init (&action
, deliver_user_signal
);
7266 sigaction (sig
, &action
, 0);
7270 handle_user_signal (int sig
)
7272 struct user_signal_info
*p
;
7273 const char *special_event_name
= NULL
;
7275 if (SYMBOLP (Vdebug_on_event
))
7276 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7278 for (p
= user_signals
; p
; p
= p
->next
)
7281 if (special_event_name
7282 && strcmp (special_event_name
, p
->name
) == 0)
7284 /* Enter the debugger in many ways. */
7285 debug_on_next_call
= 1;
7288 Vinhibit_quit
= Qnil
;
7290 /* Eat the event. */
7296 if (interrupt_input
)
7297 handle_input_available_signal (sig
);
7301 /* Tell wait_reading_process_output that it needs to wake
7302 up and look around. */
7303 if (input_available_clear_time
)
7304 *input_available_clear_time
= make_timespec (0, 0);
7311 deliver_user_signal (int sig
)
7313 deliver_process_signal (sig
, handle_user_signal
);
7317 find_user_signal_name (int sig
)
7319 struct user_signal_info
*p
;
7321 for (p
= user_signals
; p
; p
= p
->next
)
7329 store_user_signal_events (void)
7331 struct user_signal_info
*p
;
7332 struct input_event buf
;
7333 bool buf_initialized
= 0;
7335 for (p
= user_signals
; p
; p
= p
->next
)
7336 if (p
->npending
> 0)
7338 if (! buf_initialized
)
7340 memset (&buf
, 0, sizeof buf
);
7341 buf
.kind
= USER_SIGNAL_EVENT
;
7342 buf
.frame_or_window
= selected_frame
;
7343 buf_initialized
= 1;
7349 kbd_buffer_store_event (&buf
);
7352 while (p
->npending
> 0);
7357 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7358 static Lisp_Object menu_bar_one_keymap_changed_items
;
7360 /* These variables hold the vector under construction within
7361 menu_bar_items and its subroutines, and the current index
7362 for storing into that vector. */
7363 static Lisp_Object menu_bar_items_vector
;
7364 static int menu_bar_items_index
;
7367 static const char *separator_names
[] = {
7372 "single-dashed-line",
7373 "double-dashed-line",
7375 "shadow-etched-out",
7376 "shadow-etched-in-dash",
7377 "shadow-etched-out-dash",
7378 "shadow-double-etched-in",
7379 "shadow-double-etched-out",
7380 "shadow-double-etched-in-dash",
7381 "shadow-double-etched-out-dash",
7385 /* Return true if LABEL specifies a separator. */
7388 menu_separator_name_p (const char *label
)
7392 else if (strlen (label
) > 3
7393 && memcmp (label
, "--", 2) == 0
7398 for (i
= 0; separator_names
[i
]; ++i
)
7399 if (strcmp (label
, separator_names
[i
]) == 0)
7404 /* It's a separator if it contains only dashes. */
7405 while (*label
== '-')
7407 return (*label
== 0);
7414 /* Return a vector of menu items for a menu bar, appropriate
7415 to the current buffer. Each item has three elements in the vector:
7418 OLD is an old vector we can optionally reuse, or nil. */
7421 menu_bar_items (Lisp_Object old
)
7423 /* The number of keymaps we're scanning right now, and the number of
7424 keymaps we have allocated space for. */
7427 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7428 in the current keymaps, or nil where it is not a prefix. */
7431 Lisp_Object def
, tail
;
7436 /* In order to build the menus, we need to call the keymap
7437 accessors. They all call QUIT. But this function is called
7438 during redisplay, during which a quit is fatal. So inhibit
7439 quitting while building the menus.
7440 We do this instead of specbind because (1) errors will clear it anyway
7441 and (2) this avoids risk of specpdl overflow. */
7442 oquit
= Vinhibit_quit
;
7446 menu_bar_items_vector
= old
;
7448 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7449 menu_bar_items_index
= 0;
7451 /* Build our list of keymaps.
7452 If we recognize a function key and replace its escape sequence in
7453 keybuf with its symbol, or if the sequence starts with a mouse
7454 click and we need to switch buffers, we jump back here to rebuild
7455 the initial keymaps from the current buffer. */
7459 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7460 if (!NILP (Voverriding_local_map_menu_flag
)
7461 && !NILP (Voverriding_local_map
))
7463 /* Yes, use them (if non-nil) as well as the global map. */
7464 maps
= alloca (3 * sizeof (maps
[0]));
7466 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7467 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7468 if (!NILP (Voverriding_local_map
))
7469 maps
[nmaps
++] = Voverriding_local_map
;
7473 /* No, so use major and minor mode keymaps and keymap property.
7474 Note that menu-bar bindings in the local-map and keymap
7475 properties may not work reliable, as they are only
7476 recognized when the menu-bar (or mode-line) is updated,
7477 which does not normally happen after every command. */
7480 nminor
= current_minor_maps (NULL
, &tmaps
);
7481 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7483 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7484 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7485 maps
[nmaps
++] = tem
;
7486 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7487 maps
[nmaps
++] = tem
;
7488 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7490 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7492 maps
[nmaps
++] = current_global_map
;
7495 /* Look up in each map the dummy prefix key `menu-bar'. */
7497 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7498 if (!NILP (maps
[mapno
]))
7500 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7504 menu_bar_one_keymap_changed_items
= Qnil
;
7505 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7509 /* Move to the end those items that should be at the end. */
7511 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7514 int end
= menu_bar_items_index
;
7516 for (i
= 0; i
< end
; i
+= 4)
7517 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7519 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7520 /* Move the item at index I to the end,
7521 shifting all the others forward. */
7522 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7523 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7524 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7525 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7527 memmove (aref_addr (menu_bar_items_vector
, i
),
7528 aref_addr (menu_bar_items_vector
, i
+ 4),
7529 (end
- i
- 4) * word_size
);
7530 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7531 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7532 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7533 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7538 /* Add nil, nil, nil, nil at the end. */
7540 int i
= menu_bar_items_index
;
7541 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7542 menu_bar_items_vector
7543 = larger_vector (menu_bar_items_vector
, 4, -1);
7544 /* Add this item. */
7545 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7546 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7547 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7548 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7549 menu_bar_items_index
= i
;
7552 Vinhibit_quit
= oquit
;
7553 return menu_bar_items_vector
;
7556 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7557 If there's already an item for KEY, add this DEF to it. */
7559 Lisp_Object item_properties
;
7562 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7564 struct gcpro gcpro1
;
7569 if (EQ (item
, Qundefined
))
7571 /* If a map has an explicit `undefined' as definition,
7572 discard any previously made menu bar item. */
7574 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7575 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7577 if (menu_bar_items_index
> i
+ 4)
7578 memmove (aref_addr (menu_bar_items_vector
, i
),
7579 aref_addr (menu_bar_items_vector
, i
+ 4),
7580 (menu_bar_items_index
- i
- 4) * word_size
);
7581 menu_bar_items_index
-= 4;
7585 /* If this keymap has already contributed to this KEY,
7586 don't contribute to it a second time. */
7587 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7588 if (!NILP (tem
) || NILP (item
))
7591 menu_bar_one_keymap_changed_items
7592 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7594 /* We add to menu_bar_one_keymap_changed_items before doing the
7595 parse_menu_item, so that if it turns out it wasn't a menu item,
7596 it still correctly hides any further menu item. */
7598 parsed
= parse_menu_item (item
, 1);
7603 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7605 /* Find any existing item for this KEY. */
7606 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7607 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7610 /* If we did not find this KEY, add it at the end. */
7611 if (i
== menu_bar_items_index
)
7613 /* If vector is too small, get a bigger one. */
7614 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7615 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7616 /* Add this item. */
7617 ASET (menu_bar_items_vector
, i
, key
); i
++;
7618 ASET (menu_bar_items_vector
, i
,
7619 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7620 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7621 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7622 menu_bar_items_index
= i
;
7624 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7628 old
= AREF (menu_bar_items_vector
, i
+ 2);
7629 /* If the new and the old items are not both keymaps,
7630 the lookup will only find `item'. */
7631 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7632 ASET (menu_bar_items_vector
, i
+ 2, item
);
7636 /* This is used as the handler when calling menu_item_eval_property. */
7638 menu_item_eval_property_1 (Lisp_Object arg
)
7640 /* If we got a quit from within the menu computation,
7641 quit all the way out of it. This takes care of C-] in the debugger. */
7642 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7643 Fsignal (Qquit
, Qnil
);
7649 eval_dyn (Lisp_Object form
)
7651 return Feval (form
, Qnil
);
7654 /* Evaluate an expression and return the result (or nil if something
7655 went wrong). Used to evaluate dynamic parts of menu items. */
7657 menu_item_eval_property (Lisp_Object sexpr
)
7661 specbind (Qinhibit_redisplay
, Qt
);
7662 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7663 menu_item_eval_property_1
);
7668 /* This function parses a menu item and leaves the result in the
7669 vector item_properties.
7670 ITEM is a key binding, a possible menu item.
7671 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7673 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7674 parse_menu_item returns true if the item is a menu item and false
7678 parse_menu_item (Lisp_Object item
, int inmenubar
)
7680 Lisp_Object def
, tem
, item_string
, start
;
7682 Lisp_Object keyhint
;
7691 /* Create item_properties vector if necessary. */
7692 if (NILP (item_properties
))
7694 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7696 /* Initialize optional entries. */
7697 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7698 ASET (item_properties
, i
, Qnil
);
7699 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7701 /* Save the item here to protect it from GC. */
7702 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7704 item_string
= XCAR (item
);
7708 if (STRINGP (item_string
))
7710 /* Old format menu item. */
7711 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7713 /* Maybe help string. */
7714 if (CONSP (item
) && STRINGP (XCAR (item
)))
7716 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7721 /* Maybe an obsolete key binding cache. */
7722 if (CONSP (item
) && CONSP (XCAR (item
))
7723 && (NILP (XCAR (XCAR (item
)))
7724 || VECTORP (XCAR (XCAR (item
)))))
7727 /* This is the real definition--the function to run. */
7728 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7730 /* Get enable property, if any. */
7733 tem
= Fget (item
, Qmenu_enable
);
7734 if (!NILP (Venable_disabled_menus_and_buttons
))
7735 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7736 else if (!NILP (tem
))
7737 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7740 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7742 /* New format menu item. */
7743 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7744 start
= XCDR (item
);
7747 /* We have a real binding. */
7748 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7750 item
= XCDR (start
);
7751 /* Is there an obsolete cache list with key equivalences. */
7752 if (CONSP (item
) && CONSP (XCAR (item
)))
7755 /* Parse properties. */
7756 while (CONSP (item
) && CONSP (XCDR (item
)))
7761 if (EQ (tem
, QCenable
))
7763 if (!NILP (Venable_disabled_menus_and_buttons
))
7764 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7766 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7768 else if (EQ (tem
, QCvisible
))
7770 /* If got a visible property and that evaluates to nil
7771 then ignore this item. */
7772 tem
= menu_item_eval_property (XCAR (item
));
7776 else if (EQ (tem
, QChelp
))
7777 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7778 else if (EQ (tem
, QCfilter
))
7780 else if (EQ (tem
, QCkey_sequence
))
7783 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7784 /* Be GC protected. Set keyhint to item instead of tem. */
7787 else if (EQ (tem
, QCkeys
))
7790 if (CONSP (tem
) || STRINGP (tem
))
7791 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7793 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7798 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7800 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7802 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7808 else if (inmenubar
|| !NILP (start
))
7812 return 0; /* not a menu item */
7814 /* If item string is not a string, evaluate it to get string.
7815 If we don't get a string, skip this item. */
7816 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7817 if (!(STRINGP (item_string
)))
7819 item_string
= menu_item_eval_property (item_string
);
7820 if (!STRINGP (item_string
))
7822 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7825 /* If got a filter apply it on definition. */
7826 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7829 def
= menu_item_eval_property (list2 (XCAR (filter
),
7830 list2 (Qquote
, def
)));
7832 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7835 /* Enable or disable selection of item. */
7836 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7839 tem
= menu_item_eval_property (tem
);
7840 if (inmenubar
&& NILP (tem
))
7841 return 0; /* Ignore disabled items in menu bar. */
7842 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7845 /* If we got no definition, this item is just unselectable text which
7846 is OK in a submenu but not in the menubar. */
7848 return (!inmenubar
);
7850 /* See if this is a separate pane or a submenu. */
7851 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7852 tem
= get_keymap (def
, 0, 1);
7853 /* For a subkeymap, just record its details and exit. */
7856 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7857 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7861 /* At the top level in the menu bar, do likewise for commands also.
7862 The menu bar does not display equivalent key bindings anyway.
7863 ITEM_PROPERTY_DEF is already set up properly. */
7867 { /* This is a command. See if there is an equivalent key binding. */
7868 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7870 /* The previous code preferred :key-sequence to :keys, so we
7871 preserve this behavior. */
7872 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7873 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7876 Lisp_Object prefix
= keyeq
;
7877 Lisp_Object keys
= Qnil
;
7881 def
= XCAR (prefix
);
7882 prefix
= XCDR (prefix
);
7885 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7887 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7889 keys
= XCAR (keyhint
);
7890 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7892 /* We have a suggested key. Is it bound to the command? */
7895 /* If the command is an alias for another
7896 (such as lmenu.el set it up), check if the
7897 original command matches the cached command. */
7899 && EQ (tem
, XSYMBOL (def
)->function
))))
7904 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7908 tem
= Fkey_description (keys
, Qnil
);
7911 if (STRINGP (XCAR (prefix
)))
7912 tem
= concat2 (XCAR (prefix
), tem
);
7913 if (STRINGP (XCDR (prefix
)))
7914 tem
= concat2 (tem
, XCDR (prefix
));
7916 keyeq
= concat2 (build_string (" "), tem
);
7917 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7923 /* If we have an equivalent key binding, use that. */
7924 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7927 /* Include this when menu help is implemented.
7928 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7929 if (!(NILP (tem) || STRINGP (tem)))
7931 tem = menu_item_eval_property (tem);
7934 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7938 /* Handle radio buttons or toggle boxes. */
7939 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7941 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7942 menu_item_eval_property (tem
));
7949 /***********************************************************************
7951 ***********************************************************************/
7953 /* A vector holding tool bar items while they are parsed in function
7954 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7957 static Lisp_Object tool_bar_items_vector
;
7959 /* A vector holding the result of parse_tool_bar_item. Layout is like
7960 the one for a single item in tool_bar_items_vector. */
7962 static Lisp_Object tool_bar_item_properties
;
7964 /* Next free index in tool_bar_items_vector. */
7966 static int ntool_bar_items
;
7968 /* The symbols `:image' and `:rtl'. */
7970 static Lisp_Object QCimage
;
7971 static Lisp_Object QCrtl
;
7973 /* Function prototypes. */
7975 static void init_tool_bar_items (Lisp_Object
);
7976 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7978 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7979 static void append_tool_bar_item (void);
7982 /* Return a vector of tool bar items for keymaps currently in effect.
7983 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7984 tool bar items found. */
7987 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7996 /* In order to build the menus, we need to call the keymap
7997 accessors. They all call QUIT. But this function is called
7998 during redisplay, during which a quit is fatal. So inhibit
7999 quitting while building the menus. We do this instead of
8000 specbind because (1) errors will clear it anyway and (2) this
8001 avoids risk of specpdl overflow. */
8002 oquit
= Vinhibit_quit
;
8005 /* Initialize tool_bar_items_vector and protect it from GC. */
8006 init_tool_bar_items (reuse
);
8008 /* Build list of keymaps in maps. Set nmaps to the number of maps
8011 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8012 if (!NILP (Voverriding_local_map_menu_flag
)
8013 && !NILP (Voverriding_local_map
))
8015 /* Yes, use them (if non-nil) as well as the global map. */
8016 maps
= alloca (3 * sizeof *maps
);
8018 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8019 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8020 if (!NILP (Voverriding_local_map
))
8021 maps
[nmaps
++] = Voverriding_local_map
;
8025 /* No, so use major and minor mode keymaps and keymap property.
8026 Note that tool-bar bindings in the local-map and keymap
8027 properties may not work reliable, as they are only
8028 recognized when the tool-bar (or mode-line) is updated,
8029 which does not normally happen after every command. */
8032 nminor
= current_minor_maps (NULL
, &tmaps
);
8033 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8035 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8036 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8037 maps
[nmaps
++] = tem
;
8038 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8039 maps
[nmaps
++] = tem
;
8040 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8042 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8045 /* Add global keymap at the end. */
8046 maps
[nmaps
++] = current_global_map
;
8048 /* Process maps in reverse order and look up in each map the prefix
8050 for (i
= nmaps
- 1; i
>= 0; --i
)
8051 if (!NILP (maps
[i
]))
8055 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8057 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8060 Vinhibit_quit
= oquit
;
8061 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8062 return tool_bar_items_vector
;
8066 /* Process the definition of KEY which is DEF. */
8069 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8072 struct gcpro gcpro1
, gcpro2
;
8074 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8078 if (EQ (def
, Qundefined
))
8080 /* If a map has an explicit `undefined' as definition,
8081 discard any previously made item. */
8082 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8084 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8086 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8088 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8089 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8090 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8092 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8097 else if (parse_tool_bar_item (key
, def
))
8098 /* Append a new tool bar item to tool_bar_items_vector. Accept
8099 more than one definition for the same key. */
8100 append_tool_bar_item ();
8105 /* Access slot with index IDX of vector tool_bar_item_properties. */
8106 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8108 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8110 ASET (tool_bar_item_properties
, idx
, val
);
8114 /* Parse a tool bar item specification ITEM for key KEY and return the
8115 result in tool_bar_item_properties. Value is false if ITEM is
8118 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8120 CAPTION is the caption of the item, If it's not a string, it is
8121 evaluated to get a string.
8123 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8124 as binding are currently ignored.
8126 The following properties are recognized:
8130 FORM is evaluated and specifies whether the tool bar item is
8131 enabled or disabled.
8135 FORM is evaluated and specifies whether the tool bar item is visible.
8137 - `:filter FUNCTION'
8139 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8140 result is stored as the new binding.
8142 - `:button (TYPE SELECTED)'
8144 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8145 and specifies whether the button is selected (pressed) or not.
8149 IMAGES is either a single image specification or a vector of four
8150 image specifications. See enum tool_bar_item_images.
8152 - `:help HELP-STRING'.
8154 Gives a help string to display for the tool bar item.
8156 - `:label LABEL-STRING'.
8158 A text label to show with the tool bar button if labels are enabled. */
8161 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8163 Lisp_Object filter
= Qnil
;
8164 Lisp_Object caption
;
8166 bool have_label
= 0;
8168 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8169 Rule out items that aren't lists, don't start with
8170 `menu-item' or whose rest following `tool-bar-item' is not a
8175 /* As an exception, allow old-style menu separators. */
8176 if (STRINGP (XCAR (item
)))
8177 item
= list1 (XCAR (item
));
8178 else if (!EQ (XCAR (item
), Qmenu_item
)
8179 || (item
= XCDR (item
), !CONSP (item
)))
8182 /* Create tool_bar_item_properties vector if necessary. Reset it to
8184 if (VECTORP (tool_bar_item_properties
))
8186 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8190 tool_bar_item_properties
8191 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8194 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8195 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8197 /* Get the caption of the item. If the caption is not a string,
8198 evaluate it to get a string. If we don't get a string, skip this
8200 caption
= XCAR (item
);
8201 if (!STRINGP (caption
))
8203 caption
= menu_item_eval_property (caption
);
8204 if (!STRINGP (caption
))
8207 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8209 /* If the rest following the caption is not a list, the menu item is
8210 either a separator, or invalid. */
8214 if (menu_separator_name_p (SSDATA (caption
)))
8216 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8217 #if !defined (USE_GTK) && !defined (HAVE_NS)
8218 /* If we use build_desired_tool_bar_string to render the
8219 tool bar, the separator is rendered as an image. */
8220 set_prop (TOOL_BAR_ITEM_IMAGES
,
8221 (menu_item_eval_property
8222 (Vtool_bar_separator_image_expression
)));
8223 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8224 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8225 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8232 /* Store the binding. */
8233 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8236 /* Ignore cached key binding, if any. */
8237 if (CONSP (item
) && CONSP (XCAR (item
)))
8240 /* Process the rest of the properties. */
8241 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8243 Lisp_Object ikey
, value
;
8246 value
= XCAR (XCDR (item
));
8248 if (EQ (ikey
, QCenable
))
8250 /* `:enable FORM'. */
8251 if (!NILP (Venable_disabled_menus_and_buttons
))
8252 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8254 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8256 else if (EQ (ikey
, QCvisible
))
8258 /* `:visible FORM'. If got a visible property and that
8259 evaluates to nil then ignore this item. */
8260 if (NILP (menu_item_eval_property (value
)))
8263 else if (EQ (ikey
, QChelp
))
8264 /* `:help HELP-STRING'. */
8265 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8266 else if (EQ (ikey
, QCvert_only
))
8267 /* `:vert-only t/nil'. */
8268 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8269 else if (EQ (ikey
, QClabel
))
8271 const char *bad_label
= "!!?GARBLED ITEM?!!";
8272 /* `:label LABEL-STRING'. */
8273 set_prop (TOOL_BAR_ITEM_LABEL
,
8274 STRINGP (value
) ? value
: build_string (bad_label
));
8277 else if (EQ (ikey
, QCfilter
))
8278 /* ':filter FORM'. */
8280 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8282 /* `:button (TYPE . SELECTED)'. */
8283 Lisp_Object type
, selected
;
8285 type
= XCAR (value
);
8286 selected
= XCDR (value
);
8287 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8289 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8290 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8293 else if (EQ (ikey
, QCimage
)
8295 || (VECTORP (value
) && ASIZE (value
) == 4)))
8296 /* Value is either a single image specification or a vector
8297 of 4 such specifications for the different button states. */
8298 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8299 else if (EQ (ikey
, QCrtl
))
8301 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8307 /* Try to make one from caption and key. */
8308 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8309 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8310 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8311 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8313 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8314 char *buf
= xmalloc_atomic (max_lbl
+ 1);
8315 Lisp_Object new_lbl
;
8316 ptrdiff_t caption_len
= strlen (capt
);
8318 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8321 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8323 buf
[caption_len
] = '\0';
8327 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8331 strcpy (buf
, label
);
8333 for (j
= 0; buf
[j
] != '\0'; ++j
)
8341 new_lbl
= Fupcase_initials (build_string (label
));
8342 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8343 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8345 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8349 /* If got a filter apply it on binding. */
8351 set_prop (TOOL_BAR_ITEM_BINDING
,
8352 (menu_item_eval_property
8355 PROP (TOOL_BAR_ITEM_BINDING
))))));
8357 /* See if the binding is a keymap. Give up if it is. */
8358 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8361 /* Enable or disable selection of item. */
8362 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8363 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8364 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8366 /* Handle radio buttons or toggle boxes. */
8367 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8368 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8369 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8377 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8378 that can be reused. */
8381 init_tool_bar_items (Lisp_Object reuse
)
8383 if (VECTORP (reuse
))
8384 tool_bar_items_vector
= reuse
;
8386 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8387 ntool_bar_items
= 0;
8391 /* Append parsed tool bar item properties from
8392 tool_bar_item_properties */
8395 append_tool_bar_item (void)
8399 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8401 /* Enlarge tool_bar_items_vector if necessary. */
8403 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8405 /* Append entries from tool_bar_item_properties to the end of
8406 tool_bar_items_vector. */
8407 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8408 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8409 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8416 /* Read a character using menus based on the keymap MAP.
8417 Return nil if there are no menus in the maps.
8418 Return t if we displayed a menu but the user rejected it.
8420 PREV_EVENT is the previous input event, or nil if we are reading
8421 the first event of a key sequence.
8423 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8424 if we used a mouse menu to read the input, or false otherwise. If
8425 USED_MOUSE_MENU is null, don't dereference it.
8427 The prompting is done based on the prompt-string of the map
8428 and the strings associated with various map elements.
8430 This can be done with X menus or with menus put in the minibuf.
8431 These are done in different ways, depending on how the input will be read.
8432 Menus using X are done after auto-saving in read-char, getting the input
8433 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8434 and do auto-saving in the inner call of read_char. */
8437 read_char_x_menu_prompt (Lisp_Object map
,
8438 Lisp_Object prev_event
, bool *used_mouse_menu
)
8440 if (used_mouse_menu
)
8441 *used_mouse_menu
= 0;
8443 /* Use local over global Menu maps. */
8445 if (! menu_prompting
)
8448 /* If we got to this point via a mouse click,
8449 use a real menu for mouse selection. */
8450 if (EVENT_HAS_PARAMETERS (prev_event
)
8451 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8452 && !EQ (XCAR (prev_event
), Qtool_bar
))
8454 /* Display the menu and get the selection. */
8457 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8462 record_menu_key (XCAR (value
));
8464 /* If we got multiple events, unread all but
8466 There is no way to prevent those unread events
8467 from showing up later in last_nonmenu_event.
8468 So turn symbol and integer events into lists,
8469 to indicate that they came from a mouse menu,
8470 so that when present in last_nonmenu_event
8471 they won't confuse things. */
8472 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8474 record_menu_key (XCAR (tem
));
8475 if (SYMBOLP (XCAR (tem
))
8476 || INTEGERP (XCAR (tem
)))
8477 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8480 /* If we got more than one event, put all but the first
8481 onto this list to be read later.
8482 Return just the first event now. */
8483 Vunread_command_events
8484 = nconc2 (XCDR (value
), Vunread_command_events
);
8485 value
= XCAR (value
);
8487 else if (NILP (value
))
8489 if (used_mouse_menu
)
8490 *used_mouse_menu
= 1;
8497 read_char_minibuf_menu_prompt (int commandflag
,
8500 register Lisp_Object name
;
8502 /* FIXME: Use the minibuffer's frame width. */
8503 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8505 bool nobindings
= 1;
8506 Lisp_Object rest
, vector
;
8507 Lisp_Object prompt_strings
= Qnil
;
8511 if (! menu_prompting
)
8514 map
= get_keymap (map
, 0, 1);
8515 name
= Fkeymap_prompt (map
);
8517 /* If we don't have any menus, just read a character normally. */
8518 if (!STRINGP (name
))
8521 #define PUSH_C_STR(str, listvar) \
8522 listvar = Fcons (build_unibyte_string (str), listvar)
8524 /* Prompt string always starts with map's prompt, and a space. */
8525 prompt_strings
= Fcons (name
, prompt_strings
);
8526 PUSH_C_STR (": ", prompt_strings
);
8527 nlength
= SCHARS (name
) + 2;
8531 /* Present the documented bindings, a line at a time. */
8535 Lisp_Object menu_strings
= prompt_strings
;
8536 ptrdiff_t i
= nlength
;
8538 Lisp_Object orig_defn_macro
;
8540 /* Loop over elements of map. */
8545 /* FIXME: Use map_keymap to handle new keymap formats. */
8547 /* At end of map, wrap around if just starting,
8548 or end this line if already have something on it. */
8551 if (notfirst
|| nobindings
)
8557 /* Look at the next element of the map. */
8559 elt
= AREF (vector
, idx
);
8561 elt
= Fcar_safe (rest
);
8563 if (idx
< 0 && VECTORP (elt
))
8565 /* If we found a dense table in the keymap,
8566 advanced past it, but start scanning its contents. */
8567 rest
= Fcdr_safe (rest
);
8573 /* An ordinary element. */
8574 Lisp_Object event
, tem
;
8578 event
= Fcar_safe (elt
); /* alist */
8579 elt
= Fcdr_safe (elt
);
8583 XSETINT (event
, idx
); /* vector */
8586 /* Ignore the element if it has no prompt string. */
8587 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8589 /* True if the char to type matches the string. */
8591 Lisp_Object upcased_event
, downcased_event
;
8592 Lisp_Object desc
= Qnil
;
8594 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8596 upcased_event
= Fupcase (event
);
8597 downcased_event
= Fdowncase (event
);
8598 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8599 || XINT (downcased_event
) == SREF (s
, 0));
8601 desc
= Fsingle_key_description (event
, Qnil
);
8603 #if 0 /* It is redundant to list the equivalent key bindings because
8604 the prefix is what the user has already typed. */
8606 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8608 /* Insert equivalent keybinding. */
8609 s
= concat2 (s
, tem
);
8612 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8613 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8615 /* Insert button prefix. */
8616 Lisp_Object selected
8617 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8618 if (EQ (tem
, QCradio
))
8619 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8621 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8622 s
= concat2 (tem
, s
);
8626 /* If we have room for the prompt string, add it to this line.
8627 If this is the first on the line, always add it. */
8628 if ((SCHARS (s
) + i
+ 2
8629 + (char_matches
? 0 : SCHARS (desc
) + 3))
8633 ptrdiff_t thiswidth
;
8635 /* Punctuate between strings. */
8638 PUSH_C_STR (", ", menu_strings
);
8644 /* If the char to type doesn't match the string's
8645 first char, explicitly show what char to type. */
8648 /* Add as much of string as fits. */
8649 thiswidth
= min (SCHARS (desc
), width
- i
);
8651 = Fcons (Fsubstring (desc
, make_number (0),
8652 make_number (thiswidth
)),
8655 PUSH_C_STR (" = ", menu_strings
);
8659 /* Add as much of string as fits. */
8660 thiswidth
= min (SCHARS (s
), width
- i
);
8662 = Fcons (Fsubstring (s
, make_number (0),
8663 make_number (thiswidth
)),
8669 /* If this element does not fit, end the line now,
8670 and save the element for the next line. */
8671 PUSH_C_STR ("...", menu_strings
);
8676 /* Move past this element. */
8677 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8678 /* Handle reaching end of dense table. */
8683 rest
= Fcdr_safe (rest
);
8687 /* Prompt with that and read response. */
8688 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8690 /* Make believe it's not a keyboard macro in case the help char
8691 is pressed. Help characters are not recorded because menu prompting
8692 is not used on replay. */
8693 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8694 kset_defining_kbd_macro (current_kboard
, Qnil
);
8696 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8697 while (BUFFERP (obj
));
8698 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8700 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8703 if (! EQ (obj
, menu_prompt_more_char
)
8704 && (!INTEGERP (menu_prompt_more_char
)
8705 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8707 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8708 store_kbd_macro_char (obj
);
8711 /* Help char - go round again. */
8715 /* Reading key sequences. */
8718 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8720 return access_keymap (get_keymap (keymap
, 0, 1),
8725 active_maps (Lisp_Object first_event
)
8727 Lisp_Object position
8728 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8729 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8732 /* Structure used to keep track of partial application of key remapping
8733 such as Vfunction_key_map and Vkey_translation_map. */
8734 typedef struct keyremap
8736 /* This is the map originally specified for this use. */
8738 /* This is a submap reached by looking up, in PARENT,
8739 the events from START to END. */
8741 /* Positions [START, END) in the key sequence buffer
8742 are the key that we have scanned so far.
8743 Those events are the ones that we will replace
8744 if PARENT maps them into a key sequence. */
8748 /* Lookup KEY in MAP.
8749 MAP is a keymap mapping keys to key vectors or functions.
8750 If the mapping is a function and DO_FUNCALL is true,
8751 the function is called with PROMPT as parameter and its return
8752 value is used as the return value of this function (after checking
8753 that it is indeed a vector). */
8756 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8761 next
= access_keymap (map
, key
, 1, 0, 1);
8763 /* Handle a symbol whose function definition is a keymap
8765 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8766 && (ARRAYP (XSYMBOL (next
)->function
)
8767 || KEYMAPP (XSYMBOL (next
)->function
)))
8768 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8770 /* If the keymap gives a function, not an
8771 array, then call the function with one arg and use
8772 its value instead. */
8773 if (do_funcall
&& FUNCTIONP (next
))
8778 next
= call1 (next
, prompt
);
8779 /* If the function returned something invalid,
8780 barf--don't ignore it.
8781 (To ignore it safely, we would need to gcpro a bunch of
8782 other variables.) */
8783 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8784 error ("Function %s returns invalid key sequence",
8785 SSDATA (SYMBOL_NAME (tem
)));
8790 /* Do one step of the key remapping used for function-key-map and
8791 key-translation-map:
8792 KEYBUF is the buffer holding the input events.
8793 BUFSIZE is its maximum size.
8794 FKEY is a pointer to the keyremap structure to use.
8795 INPUT is the index of the last element in KEYBUF.
8796 DOIT if true says that the remapping can actually take place.
8797 DIFF is used to return the number of keys added/removed by the remapping.
8798 PARENT is the root of the keymap.
8799 PROMPT is the prompt to use if the remapping happens through a function.
8800 Return true if the remapping actually took place. */
8803 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8804 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8806 Lisp_Object next
, key
;
8808 key
= keybuf
[fkey
->end
++];
8810 if (KEYMAPP (fkey
->parent
))
8811 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8815 /* If keybuf[fkey->start..fkey->end] is bound in the
8816 map and we're in a position to do the key remapping, replace it with
8817 the binding and restart with fkey->start at the end. */
8818 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8820 int len
= XFASTINT (Flength (next
));
8823 *diff
= len
- (fkey
->end
- fkey
->start
);
8825 if (bufsize
- input
<= *diff
)
8826 error ("Key sequence too long");
8828 /* Shift the keys that follow fkey->end. */
8830 for (i
= fkey
->end
; i
< input
; i
++)
8831 keybuf
[i
+ *diff
] = keybuf
[i
];
8833 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8834 keybuf
[i
+ *diff
] = keybuf
[i
];
8835 /* Overwrite the old keys with the new ones. */
8836 for (i
= 0; i
< len
; i
++)
8837 keybuf
[fkey
->start
+ i
]
8838 = Faref (next
, make_number (i
));
8840 fkey
->start
= fkey
->end
+= *diff
;
8841 fkey
->map
= fkey
->parent
;
8846 fkey
->map
= get_keymap (next
, 0, 1);
8848 /* If we no longer have a bound suffix, try a new position for
8850 if (!CONSP (fkey
->map
))
8852 fkey
->end
= ++fkey
->start
;
8853 fkey
->map
= fkey
->parent
;
8859 test_undefined (Lisp_Object binding
)
8861 return (NILP (binding
)
8862 || EQ (binding
, Qundefined
)
8863 || (SYMBOLP (binding
)
8864 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8867 /* Read a sequence of keys that ends with a non prefix character,
8868 storing it in KEYBUF, a buffer of size BUFSIZE.
8870 Return the length of the key sequence stored.
8871 Return -1 if the user rejected a command menu.
8873 Echo starting immediately unless `prompt' is 0.
8875 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8876 read_char with a suitable COMMANDFLAG argument.
8878 Where a key sequence ends depends on the currently active keymaps.
8879 These include any minor mode keymaps active in the current buffer,
8880 the current buffer's local map, and the global map.
8882 If a key sequence has no other bindings, we check Vfunction_key_map
8883 to see if some trailing subsequence might be the beginning of a
8884 function key's sequence. If so, we try to read the whole function
8885 key, and substitute its symbolic name into the key sequence.
8887 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8888 `double-' events into similar click events, if that would make them
8889 bound. We try to turn `triple-' events first into `double-' events,
8892 If we get a mouse click in a mode line, vertical divider, or other
8893 non-text area, we treat the click as if it were prefixed by the
8894 symbol denoting that area - `mode-line', `vertical-line', or
8897 If the sequence starts with a mouse click, we read the key sequence
8898 with respect to the buffer clicked on, not the current buffer.
8900 If the user switches frames in the midst of a key sequence, we put
8901 off the switch-frame event until later; the next call to
8902 read_char will return it.
8904 If FIX_CURRENT_BUFFER, we restore current_buffer
8905 from the selected window's buffer. */
8908 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8909 bool dont_downcase_last
, bool can_return_switch_frame
,
8910 bool fix_current_buffer
, bool prevent_redisplay
)
8912 /* How many keys there are in the current key sequence. */
8915 /* The length of the echo buffer when we started reading, and
8916 the length of this_command_keys when we started reading. */
8917 ptrdiff_t echo_start
IF_LINT (= 0);
8918 ptrdiff_t keys_start
;
8920 Lisp_Object current_binding
= Qnil
;
8921 Lisp_Object first_event
= Qnil
;
8923 /* Index of the first key that has no binding.
8924 It is useless to try fkey.start larger than that. */
8927 /* If t < mock_input, then KEYBUF[t] should be read as the next
8930 We use this to recover after recognizing a function key. Once we
8931 realize that a suffix of the current key sequence is actually a
8932 function key's escape sequence, we replace the suffix with the
8933 function key's binding from Vfunction_key_map. Now keybuf
8934 contains a new and different key sequence, so the echo area,
8935 this_command_keys, and the submaps and defs arrays are wrong. In
8936 this situation, we set mock_input to t, set t to 0, and jump to
8937 restart_sequence; the loop will read keys from keybuf up until
8938 mock_input, thus rebuilding the state; and then it will resume
8939 reading characters from the keyboard. */
8942 /* If the sequence is unbound in submaps[], then
8943 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8944 and fkey.map is its binding.
8946 These might be > t, indicating that all function key scanning
8947 should hold off until t reaches them. We do this when we've just
8948 recognized a function key, to avoid searching for the function
8949 key's again in Vfunction_key_map. */
8952 /* Likewise, for key_translation_map and input-decode-map. */
8953 keyremap keytran
, indec
;
8955 /* True if we are trying to map a key by changing an upper-case
8956 letter to lower case, or a shifted function key to an unshifted
8958 bool shift_translated
= 0;
8960 /* If we receive a `switch-frame' or `select-window' event in the middle of
8961 a key sequence, we put it off for later.
8962 While we're reading, we keep the event here. */
8963 Lisp_Object delayed_switch_frame
;
8965 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8966 int original_uppercase_position
= -1;
8968 /* Gets around Microsoft compiler limitations. */
8971 struct buffer
*starting_buffer
;
8973 /* List of events for which a fake prefix key has been generated. */
8974 Lisp_Object fake_prefixed_keys
= Qnil
;
8976 struct gcpro gcpro1
;
8980 GCPRO1 (fake_prefixed_keys
);
8981 raw_keybuf_count
= 0;
8983 last_nonmenu_event
= Qnil
;
8985 delayed_switch_frame
= Qnil
;
8991 /* Install the string PROMPT as the beginning of the string
8992 of echoing, so that it serves as a prompt for the next
8994 kset_echo_string (current_kboard
, prompt
);
8995 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8998 else if (cursor_in_echo_area
8999 && echo_keystrokes_p ())
9000 /* This doesn't put in a dash if the echo buffer is empty, so
9001 you don't always see a dash hanging out in the minibuffer. */
9005 /* Record the initial state of the echo area and this_command_keys;
9006 we will need to restore them if we replay a key sequence. */
9008 echo_start
= echo_length ();
9009 keys_start
= this_command_key_count
;
9010 this_single_command_key_start
= keys_start
;
9012 /* We jump here when we need to reinitialize fkey and keytran; this
9013 happens if we switch keyboards between rescans. */
9014 replay_entire_sequence
:
9016 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9017 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9018 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9019 indec
.start
= indec
.end
= 0;
9020 fkey
.start
= fkey
.end
= 0;
9021 keytran
.start
= keytran
.end
= 0;
9023 /* We jump here when the key sequence has been thoroughly changed, and
9024 we need to rescan it starting from the beginning. When we jump here,
9025 keybuf[0..mock_input] holds the sequence we should reread. */
9028 starting_buffer
= current_buffer
;
9029 first_unbound
= bufsize
+ 1;
9031 /* Build our list of keymaps.
9032 If we recognize a function key and replace its escape sequence in
9033 keybuf with its symbol, or if the sequence starts with a mouse
9034 click and we need to switch buffers, we jump back here to rebuild
9035 the initial keymaps from the current buffer. */
9036 current_binding
= active_maps (first_event
);
9038 /* Start from the beginning in keybuf. */
9041 /* These are no-ops the first time through, but if we restart, they
9042 revert the echo area and this_command_keys to their original state. */
9043 this_command_key_count
= keys_start
;
9044 if (INTERACTIVE
&& t
< mock_input
)
9045 echo_truncate (echo_start
);
9047 /* If the best binding for the current key sequence is a keymap, or
9048 we may be looking at a function key's escape sequence, keep on
9050 while (!NILP (current_binding
)
9051 /* Keep reading as long as there's a prefix binding. */
9052 ? KEYMAPP (current_binding
)
9053 /* Don't return in the middle of a possible function key sequence,
9054 if the only bindings we found were via case conversion.
9055 Thus, if ESC O a has a function-key-map translation
9056 and ESC o has a binding, don't return after ESC O,
9057 so that we can translate ESC O plus the next character. */
9058 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9061 bool used_mouse_menu
= 0;
9063 /* Where the last real key started. If we need to throw away a
9064 key that has expanded into more than one element of keybuf
9065 (say, a mouse click on the mode line which is being treated
9066 as [mode-line (mouse-...)], then we backtrack to this point
9068 int last_real_key_start
;
9070 /* These variables are analogous to echo_start and keys_start;
9071 while those allow us to restart the entire key sequence,
9072 echo_local_start and keys_local_start allow us to throw away
9074 ptrdiff_t echo_local_start
IF_LINT (= 0);
9075 int keys_local_start
;
9076 Lisp_Object new_binding
;
9078 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9079 eassert (indec
.start
<= indec
.end
);
9080 eassert (fkey
.start
<= fkey
.end
);
9081 eassert (keytran
.start
<= keytran
.end
);
9082 /* key-translation-map is applied *after* function-key-map
9083 which is itself applied *after* input-decode-map. */
9084 eassert (fkey
.end
<= indec
.start
);
9085 eassert (keytran
.end
<= fkey
.start
);
9087 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9088 first_unbound
< keytran
.start
)
9089 { /* The prefix upto first_unbound has no binding and has
9090 no translation left to do either, so we know it's unbound.
9091 If we don't stop now, we risk staying here indefinitely
9092 (if the user keeps entering fkey or keytran prefixes
9093 like C-c ESC ESC ESC ESC ...) */
9095 for (i
= first_unbound
+ 1; i
< t
; i
++)
9096 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9097 mock_input
= t
- first_unbound
- 1;
9098 indec
.end
= indec
.start
-= first_unbound
+ 1;
9099 indec
.map
= indec
.parent
;
9100 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9101 fkey
.map
= fkey
.parent
;
9102 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9103 keytran
.map
= keytran
.parent
;
9104 goto replay_sequence
;
9108 error ("Key sequence too long");
9111 echo_local_start
= echo_length ();
9112 keys_local_start
= this_command_key_count
;
9115 /* These are no-ops, unless we throw away a keystroke below and
9116 jumped back up to replay_key; in that case, these restore the
9117 variables to their original state, allowing us to replay the
9119 if (INTERACTIVE
&& t
< mock_input
)
9120 echo_truncate (echo_local_start
);
9121 this_command_key_count
= keys_local_start
;
9123 /* By default, assume each event is "real". */
9124 last_real_key_start
= t
;
9126 /* Does mock_input indicate that we are re-reading a key sequence? */
9130 add_command_key (key
);
9131 if (echo_keystrokes_p ()
9132 && current_kboard
->immediate_echo
)
9139 /* If not, we should actually read a character. */
9143 KBOARD
*interrupted_kboard
= current_kboard
;
9144 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9145 /* Calling read_char with COMMANDFLAG = -2 avoids
9146 redisplay in read_char and its subroutines. */
9147 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9148 current_binding
, last_nonmenu_event
,
9149 &used_mouse_menu
, NULL
);
9150 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9151 /* When switching to a new tty (with a new keyboard),
9152 read_char returns the new buffer, rather than -2
9153 (Bug#5095). This is because `terminal-init-xterm'
9154 calls read-char, which eats the wrong_kboard_jmpbuf
9155 return. Any better way to fix this? -- cyd */
9156 || (interrupted_kboard
!= current_kboard
))
9161 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9162 if (k
== interrupted_kboard
)
9167 /* Don't touch interrupted_kboard when it's been
9169 delayed_switch_frame
= Qnil
;
9170 goto replay_entire_sequence
;
9173 if (!NILP (delayed_switch_frame
))
9176 (interrupted_kboard
,
9177 Fcons (delayed_switch_frame
,
9178 KVAR (interrupted_kboard
, kbd_queue
)));
9179 delayed_switch_frame
= Qnil
;
9184 (interrupted_kboard
,
9185 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9187 /* If the side queue is non-empty, ensure it begins with a
9188 switch-frame, so we'll replay it in the right context. */
9189 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9190 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9191 !(EVENT_HAS_PARAMETERS (key
)
9192 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9196 XSETFRAME (frame
, interrupted_frame
);
9198 (interrupted_kboard
,
9199 Fcons (make_lispy_switch_frame (frame
),
9200 KVAR (interrupted_kboard
, kbd_queue
)));
9203 goto replay_entire_sequence
;
9207 /* read_char returns t when it shows a menu and the user rejects it.
9216 /* read_char returns -1 at the end of a macro.
9217 Emacs 18 handles this by returning immediately with a
9218 zero, so that's what we'll do. */
9219 if (INTEGERP (key
) && XINT (key
) == -1)
9222 /* The Microsoft C compiler can't handle the goto that
9228 /* If the current buffer has been changed from under us, the
9229 keymap may have changed, so replay the sequence. */
9232 timer_resume_idle ();
9235 /* Reset the current buffer from the selected window
9236 in case something changed the former and not the latter.
9237 This is to be more consistent with the behavior
9238 of the command_loop_1. */
9239 if (fix_current_buffer
)
9241 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9243 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9245 Fset_buffer (XWINDOW (selected_window
)->contents
);
9248 goto replay_sequence
;
9251 /* If we have a quit that was typed in another frame, and
9252 quit_throw_to_read_char switched buffers,
9253 replay to get the right keymap. */
9255 && XINT (key
) == quit_char
9256 && current_buffer
!= starting_buffer
)
9259 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9264 goto replay_sequence
;
9269 if (EVENT_HAS_PARAMETERS (key
)
9270 /* Either a `switch-frame' or a `select-window' event. */
9271 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9273 /* If we're at the beginning of a key sequence, and the caller
9274 says it's okay, go ahead and return this event. If we're
9275 in the midst of a key sequence, delay it until the end. */
9276 if (t
> 0 || !can_return_switch_frame
)
9278 delayed_switch_frame
= key
;
9283 if (NILP (first_event
))
9286 /* Even if first_event does not specify a particular
9287 window/position, it's important to recompute the maps here
9288 since a long time might have passed since we entered
9289 read_key_sequence, and a timer (or process-filter or
9290 special-event-map, ...) might have switched the current buffer
9291 or the selected window from under us in the mean time. */
9292 if (fix_current_buffer
9293 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9295 Fset_buffer (XWINDOW (selected_window
)->contents
);
9296 current_binding
= active_maps (first_event
);
9300 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9304 /* Clicks in non-text areas get prefixed by the symbol
9305 in their CHAR-ADDRESS field. For example, a click on
9306 the mode line is prefixed by the symbol `mode-line'.
9308 Furthermore, key sequences beginning with mouse clicks
9309 are read using the keymaps of the buffer clicked on, not
9310 the current buffer. So we may have to switch the buffer
9313 When we turn one event into two events, we must make sure
9314 that neither of the two looks like the original--so that,
9315 if we replay the events, they won't be expanded again.
9316 If not for this, such reexpansion could happen either here
9317 or when user programs play with this-command-keys. */
9318 if (EVENT_HAS_PARAMETERS (key
))
9320 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9321 if (EQ (kind
, Qmouse_click
))
9323 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9324 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9327 || (!NILP (fake_prefixed_keys
)
9328 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9330 /* We're looking a second time at an event for which
9331 we generated a fake prefix key. Set
9332 last_real_key_start appropriately. */
9334 last_real_key_start
= t
- 1;
9337 if (last_real_key_start
== 0)
9339 /* Key sequences beginning with mouse clicks are
9340 read using the keymaps in the buffer clicked on,
9341 not the current buffer. If we're at the
9342 beginning of a key sequence, switch buffers. */
9343 if (WINDOWP (window
)
9344 && BUFFERP (XWINDOW (window
)->contents
)
9345 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9347 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9352 /* Arrange to go back to the original buffer once we're
9353 done reading the key sequence. Note that we can't
9354 use save_excursion_{save,restore} here, because they
9355 save point as well as the current buffer; we don't
9356 want to save point, because redisplay may change it,
9357 to accommodate a Fset_window_start or something. We
9358 don't want to do this at the top of the function,
9359 because we may get input from a subprocess which
9360 wants to change the selected window and stuff (say,
9362 record_unwind_current_buffer ();
9364 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9366 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9367 goto replay_sequence
;
9371 /* Expand mode-line and scroll-bar events into two events:
9372 use posn as a fake prefix key. */
9374 && (NILP (fake_prefixed_keys
)
9375 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9377 if (bufsize
- t
<= 1)
9378 error ("Key sequence too long");
9381 keybuf
[t
+ 1] = key
;
9384 /* Record that a fake prefix key has been generated
9385 for KEY. Don't modify the event; this would
9386 prevent proper action when the event is pushed
9387 back into unread-command-events. */
9388 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9392 else if (CONSP (XCDR (key
))
9393 && CONSP (EVENT_START (key
))
9394 && CONSP (XCDR (EVENT_START (key
))))
9398 posn
= POSN_POSN (EVENT_START (key
));
9399 /* Handle menu-bar events:
9400 insert the dummy prefix event `menu-bar'. */
9401 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9403 if (bufsize
- t
<= 1)
9404 error ("Key sequence too long");
9406 keybuf
[t
+ 1] = key
;
9408 /* Zap the position in key, so we know that we've
9409 expanded it, and don't try to do so again. */
9410 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9413 goto replay_sequence
;
9415 else if (CONSP (posn
))
9417 /* We're looking at the second event of a
9418 sequence which we expanded before. Set
9419 last_real_key_start appropriately. */
9420 if (last_real_key_start
== t
&& t
> 0)
9421 last_real_key_start
= t
- 1;
9426 /* We have finally decided that KEY is something we might want
9428 new_binding
= follow_key (current_binding
, key
);
9430 /* If KEY wasn't bound, we'll try some fallbacks. */
9431 if (!NILP (new_binding
))
9432 /* This is needed for the following scenario:
9433 event 0: a down-event that gets dropped by calling replay_key.
9434 event 1: some normal prefix like C-h.
9435 After event 0, first_unbound is 0, after event 1 indec.start,
9436 fkey.start, and keytran.start are all 1, so when we see that
9437 C-h is bound, we need to update first_unbound. */
9438 first_unbound
= max (t
+ 1, first_unbound
);
9443 /* Remember the position to put an upper bound on indec.start. */
9444 first_unbound
= min (t
, first_unbound
);
9446 head
= EVENT_HEAD (key
);
9450 Lisp_Object breakdown
;
9453 breakdown
= parse_modifiers (head
);
9454 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9455 /* Attempt to reduce an unbound mouse event to a simpler
9456 event that is bound:
9457 Drags reduce to clicks.
9458 Double-clicks reduce to clicks.
9459 Triple-clicks reduce to double-clicks, then to clicks.
9460 Down-clicks are eliminated.
9461 Double-downs reduce to downs, then are eliminated.
9462 Triple-downs reduce to double-downs, then to downs,
9463 then are eliminated. */
9464 if (modifiers
& (down_modifier
| drag_modifier
9465 | double_modifier
| triple_modifier
))
9467 while (modifiers
& (down_modifier
| drag_modifier
9468 | double_modifier
| triple_modifier
))
9470 Lisp_Object new_head
, new_click
;
9471 if (modifiers
& triple_modifier
)
9472 modifiers
^= (double_modifier
| triple_modifier
);
9473 else if (modifiers
& double_modifier
)
9474 modifiers
&= ~double_modifier
;
9475 else if (modifiers
& drag_modifier
)
9476 modifiers
&= ~drag_modifier
;
9479 /* Dispose of this `down' event by simply jumping
9480 back to replay_key, to get another event.
9482 Note that if this event came from mock input,
9483 then just jumping back to replay_key will just
9484 hand it to us again. So we have to wipe out any
9487 We could delete keybuf[t] and shift everything
9488 after that to the left by one spot, but we'd also
9489 have to fix up any variable that points into
9490 keybuf, and shifting isn't really necessary
9493 Adding prefixes for non-textual mouse clicks
9494 creates two characters of mock input, and both
9495 must be thrown away. If we're only looking at
9496 the prefix now, we can just jump back to
9497 replay_key. On the other hand, if we've already
9498 processed the prefix, and now the actual click
9499 itself is giving us trouble, then we've lost the
9500 state of the keymaps we want to backtrack to, and
9501 we need to replay the whole sequence to rebuild
9504 Beyond that, only function key expansion could
9505 create more than two keys, but that should never
9506 generate mouse events, so it's okay to zero
9507 mock_input in that case too.
9509 FIXME: The above paragraph seems just plain
9510 wrong, if you consider things like
9511 xterm-mouse-mode. -stef
9513 Isn't this just the most wonderful code ever? */
9515 /* If mock_input > t + 1, the above simplification
9516 will actually end up dropping keys on the floor.
9517 This is probably OK for now, but even
9518 if mock_input <= t + 1, we need to adjust indec,
9520 Typical case [header-line down-mouse-N]:
9521 mock_input = 2, t = 1, fkey.end = 1,
9522 last_real_key_start = 0. */
9523 if (indec
.end
> last_real_key_start
)
9525 indec
.end
= indec
.start
9526 = min (last_real_key_start
, indec
.start
);
9527 indec
.map
= indec
.parent
;
9528 if (fkey
.end
> last_real_key_start
)
9530 fkey
.end
= fkey
.start
9531 = min (last_real_key_start
, fkey
.start
);
9532 fkey
.map
= fkey
.parent
;
9533 if (keytran
.end
> last_real_key_start
)
9535 keytran
.end
= keytran
.start
9536 = min (last_real_key_start
, keytran
.start
);
9537 keytran
.map
= keytran
.parent
;
9541 if (t
== last_real_key_start
)
9548 mock_input
= last_real_key_start
;
9549 goto replay_sequence
;
9554 = apply_modifiers (modifiers
, XCAR (breakdown
));
9555 new_click
= list2 (new_head
, EVENT_START (key
));
9557 /* Look for a binding for this new key. */
9558 new_binding
= follow_key (current_binding
, new_click
);
9560 /* If that click is bound, go for it. */
9561 if (!NILP (new_binding
))
9563 current_binding
= new_binding
;
9567 /* Otherwise, we'll leave key set to the drag event. */
9572 current_binding
= new_binding
;
9575 /* Normally, last_nonmenu_event gets the previous key we read.
9576 But when a mouse popup menu is being used,
9577 we don't update last_nonmenu_event; it continues to hold the mouse
9578 event that preceded the first level of menu. */
9579 if (!used_mouse_menu
)
9580 last_nonmenu_event
= key
;
9582 /* Record what part of this_command_keys is the current key sequence. */
9583 this_single_command_key_start
= this_command_key_count
- t
;
9585 /* Look for this sequence in input-decode-map.
9586 Scan from indec.end until we find a bound suffix. */
9587 while (indec
.end
< t
)
9589 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9593 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9594 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9599 mock_input
= diff
+ max (t
, mock_input
);
9600 goto replay_sequence
;
9604 if (!KEYMAPP (current_binding
)
9605 && !test_undefined (current_binding
)
9606 && indec
.start
>= t
)
9607 /* There is a binding and it's not a prefix.
9608 (and it doesn't have any input-decode-map translation pending).
9609 There is thus no function-key in this sequence.
9610 Moving fkey.start is important in this case to allow keytran.start
9611 to go over the sequence before we return (since we keep the
9612 invariant that keytran.end <= fkey.start). */
9615 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9618 /* If the sequence is unbound, see if we can hang a function key
9619 off the end of it. */
9620 /* Continue scan from fkey.end until we find a bound suffix. */
9621 while (fkey
.end
< indec
.start
)
9623 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9627 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9628 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9629 max (t
, mock_input
),
9630 /* If there's a binding (i.e.
9631 first_binding >= nmaps) we don't want
9632 to apply this function-key-mapping. */
9634 && (test_undefined (current_binding
)),
9639 mock_input
= diff
+ max (t
, mock_input
);
9640 /* Adjust the input-decode-map counters. */
9642 indec
.start
+= diff
;
9644 goto replay_sequence
;
9648 /* Look for this sequence in key-translation-map.
9649 Scan from keytran.end until we find a bound suffix. */
9650 while (keytran
.end
< fkey
.start
)
9652 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9656 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9657 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9662 mock_input
= diff
+ max (t
, mock_input
);
9663 /* Adjust the function-key-map and input-decode-map counters. */
9665 indec
.start
+= diff
;
9669 goto replay_sequence
;
9673 /* If KEY is not defined in any of the keymaps,
9674 and cannot be part of a function key or translation,
9675 and is an upper case letter
9676 use the corresponding lower-case letter instead. */
9677 if (NILP (current_binding
)
9678 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9680 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9681 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9682 || (XINT (key
) & shift_modifier
)))
9684 Lisp_Object new_key
;
9686 original_uppercase
= key
;
9687 original_uppercase_position
= t
- 1;
9689 if (XINT (key
) & shift_modifier
)
9690 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9692 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9693 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9695 /* We have to do this unconditionally, regardless of whether
9696 the lower-case char is defined in the keymaps, because they
9697 might get translated through function-key-map. */
9698 keybuf
[t
- 1] = new_key
;
9699 mock_input
= max (t
, mock_input
);
9700 shift_translated
= 1;
9702 goto replay_sequence
;
9705 if (NILP (current_binding
)
9706 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9708 read_key_sequence_cmd
= Vprefix_help_command
;
9709 /* The Microsoft C compiler can't handle the goto that
9715 /* If KEY is not defined in any of the keymaps,
9716 and cannot be part of a function key or translation,
9717 and is a shifted function key,
9718 use the corresponding unshifted function key instead. */
9719 if (NILP (current_binding
)
9720 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9722 Lisp_Object breakdown
= parse_modifiers (key
);
9724 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9726 if (modifiers
& shift_modifier
9727 /* Treat uppercase keys as shifted. */
9729 && (KEY_TO_CHAR (key
)
9730 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9731 && uppercasep (KEY_TO_CHAR (key
))))
9734 = (modifiers
& shift_modifier
9735 ? apply_modifiers (modifiers
& ~shift_modifier
,
9737 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9739 original_uppercase
= key
;
9740 original_uppercase_position
= t
- 1;
9742 /* We have to do this unconditionally, regardless of whether
9743 the lower-case char is defined in the keymaps, because they
9744 might get translated through function-key-map. */
9745 keybuf
[t
- 1] = new_key
;
9746 mock_input
= max (t
, mock_input
);
9747 /* Reset fkey (and consequently keytran) to apply
9748 function-key-map on the result, so that S-backspace is
9749 correctly mapped to DEL (via backspace). OTOH,
9750 input-decode-map doesn't need to go through it again. */
9751 fkey
.start
= fkey
.end
= 0;
9752 keytran
.start
= keytran
.end
= 0;
9753 shift_translated
= 1;
9755 goto replay_sequence
;
9760 read_key_sequence_cmd
= current_binding
;
9761 read_key_sequence_remapped
9762 /* Remap command through active keymaps.
9763 Do the remapping here, before the unbind_to so it uses the keymaps
9764 of the appropriate buffer. */
9765 = SYMBOLP (read_key_sequence_cmd
)
9766 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9769 unread_switch_frame
= delayed_switch_frame
;
9772 /* Don't downcase the last character if the caller says don't.
9773 Don't downcase it if the result is undefined, either. */
9774 if ((dont_downcase_last
|| NILP (current_binding
))
9776 && t
- 1 == original_uppercase_position
)
9778 keybuf
[t
- 1] = original_uppercase
;
9779 shift_translated
= 0;
9782 if (shift_translated
)
9783 Vthis_command_keys_shift_translated
= Qt
;
9785 /* Occasionally we fabricate events, perhaps by expanding something
9786 according to function-key-map, or by adding a prefix symbol to a
9787 mouse click in the scroll bar or modeline. In this cases, return
9788 the entire generated key sequence, even if we hit an unbound
9789 prefix or a definition before the end. This means that you will
9790 be able to push back the event properly, and also means that
9791 read-key-sequence will always return a logical unit.
9794 for (; t
< mock_input
; t
++)
9796 if (echo_keystrokes_p ())
9797 echo_char (keybuf
[t
]);
9798 add_command_key (keybuf
[t
]);
9806 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9807 Lisp_Object dont_downcase_last
,
9808 Lisp_Object can_return_switch_frame
,
9809 Lisp_Object cmd_loop
, bool allow_string
)
9811 Lisp_Object keybuf
[30];
9813 struct gcpro gcpro1
;
9817 CHECK_STRING (prompt
);
9820 specbind (Qinput_method_exit_on_first_char
,
9821 (NILP (cmd_loop
) ? Qt
: Qnil
));
9822 specbind (Qinput_method_use_echo_area
,
9823 (NILP (cmd_loop
) ? Qt
: Qnil
));
9825 memset (keybuf
, 0, sizeof keybuf
);
9827 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9829 if (NILP (continue_echo
))
9831 this_command_key_count
= 0;
9832 this_command_key_count_reset
= 0;
9833 this_single_command_key_start
= 0;
9836 #ifdef HAVE_WINDOW_SYSTEM
9837 if (display_hourglass_p
)
9838 cancel_hourglass ();
9841 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9842 prompt
, ! NILP (dont_downcase_last
),
9843 ! NILP (can_return_switch_frame
), 0, 0);
9845 #if 0 /* The following is fine for code reading a key sequence and
9846 then proceeding with a lengthy computation, but it's not good
9847 for code reading keys in a loop, like an input method. */
9848 #ifdef HAVE_WINDOW_SYSTEM
9849 if (display_hourglass_p
)
9860 Lisp_Object tem0
= ((allow_string
? make_event_array
: Fvector
) (i
, keybuf
));
9865 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9866 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9867 The sequence is sufficient to specify a non-prefix command in the
9868 current local and global maps.
9870 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9871 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9872 as a continuation of the previous key.
9874 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9875 convert the last event to lower case. (Normally any upper case event
9876 is converted to lower case if the original event is undefined and the lower
9877 case equivalent is defined.) A non-nil value is appropriate for reading
9878 a key sequence to be defined.
9880 A C-g typed while in this function is treated like any other character,
9881 and `quit-flag' is not set.
9883 If the key sequence starts with a mouse click, then the sequence is read
9884 using the keymaps of the buffer of the window clicked in, not the buffer
9885 of the selected window as normal.
9887 `read-key-sequence' drops unbound button-down events, since you normally
9888 only care about the click or drag events which follow them. If a drag
9889 or multi-click event is unbound, but the corresponding click event would
9890 be bound, `read-key-sequence' turns the event into a click event at the
9891 drag's starting position. This means that you don't have to distinguish
9892 between click and drag, double, or triple events unless you want to.
9894 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9895 lines separating windows, and scroll bars with imaginary keys
9896 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9898 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9899 function will process a switch-frame event if the user switches frames
9900 before typing anything. If the user switches frames in the middle of a
9901 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9902 is nil, then the event will be put off until after the current key sequence.
9904 `read-key-sequence' checks `function-key-map' for function key
9905 sequences, where they wouldn't conflict with ordinary bindings. See
9906 `function-key-map' for more details.
9908 The optional fifth argument CMD-LOOP, if non-nil, means
9909 that this key sequence is being read by something that will
9910 read commands one after another. It should be nil if the caller
9911 will read just one key sequence. */)
9912 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9914 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9915 can_return_switch_frame
, cmd_loop
, true);
9918 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9919 Sread_key_sequence_vector
, 1, 5, 0,
9920 doc
: /* Like `read-key-sequence' but always return a vector. */)
9921 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9923 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9924 can_return_switch_frame
, cmd_loop
, false);
9927 /* Return true if input events are pending. */
9930 detect_input_pending (void)
9932 return input_pending
|| get_input_pending (0);
9935 /* Return true if input events other than mouse movements are
9939 detect_input_pending_ignore_squeezables (void)
9941 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9944 /* Return true if input events are pending, and run any pending timers. */
9947 detect_input_pending_run_timers (bool do_display
)
9949 unsigned old_timers_run
= timers_run
;
9952 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9954 if (old_timers_run
!= timers_run
&& do_display
)
9955 redisplay_preserve_echo_area (8);
9957 return input_pending
;
9960 /* This is called in some cases before a possible quit.
9961 It cases the next call to detect_input_pending to recompute input_pending.
9962 So calling this function unnecessarily can't do any harm. */
9965 clear_input_pending (void)
9970 /* Return true if there are pending requeued events.
9971 This isn't used yet. The hope is to make wait_reading_process_output
9972 call it, and return if it runs Lisp code that unreads something.
9973 The problem is, kbd_buffer_get_event needs to be fixed to know what
9974 to do in that case. It isn't trivial. */
9977 requeued_events_pending_p (void)
9979 return (!NILP (Vunread_command_events
));
9982 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9983 doc
: /* Return t if command input is currently available with no wait.
9984 Actually, the value is nil only if we can be sure that no input is available;
9985 if there is a doubt, the value is t.
9987 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9988 (Lisp_Object check_timers
)
9990 if (!NILP (Vunread_command_events
)
9991 || !NILP (Vunread_post_input_method_events
)
9992 || !NILP (Vunread_input_method_events
))
9995 /* Process non-user-visible events (Bug#10195). */
9996 process_special_events ();
9998 return (get_input_pending ((NILP (check_timers
)
9999 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10000 | READABLE_EVENTS_FILTER_EVENTS
)
10004 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10005 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10008 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10011 if (total_keys
< NUM_RECENT_KEYS
)
10012 return Fvector (total_keys
, keys
);
10015 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10016 vcopy (val
, 0, keys
+ recent_keys_index
,
10017 NUM_RECENT_KEYS
- recent_keys_index
);
10018 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10019 keys
, recent_keys_index
);
10024 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10025 doc
: /* Return the key sequence that invoked this command.
10026 However, if the command has called `read-key-sequence', it returns
10027 the last key sequence that has been read.
10028 The value is a string or a vector.
10030 See also `this-command-keys-vector'. */)
10033 return make_event_array (this_command_key_count
,
10034 XVECTOR (this_command_keys
)->contents
);
10037 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10038 doc
: /* Return the key sequence that invoked this command, as a vector.
10039 However, if the command has called `read-key-sequence', it returns
10040 the last key sequence that has been read.
10042 See also `this-command-keys'. */)
10045 return Fvector (this_command_key_count
,
10046 XVECTOR (this_command_keys
)->contents
);
10049 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10050 Sthis_single_command_keys
, 0, 0, 0,
10051 doc
: /* Return the key sequence that invoked this command.
10052 More generally, it returns the last key sequence read, either by
10053 the command loop or by `read-key-sequence'.
10054 Unlike `this-command-keys', this function's value
10055 does not include prefix arguments.
10056 The value is always a vector. */)
10059 return Fvector (this_command_key_count
10060 - this_single_command_key_start
,
10061 (XVECTOR (this_command_keys
)->contents
10062 + this_single_command_key_start
));
10065 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10066 Sthis_single_command_raw_keys
, 0, 0, 0,
10067 doc
: /* Return the raw events that were read for this command.
10068 More generally, it returns the last key sequence read, either by
10069 the command loop or by `read-key-sequence'.
10070 Unlike `this-single-command-keys', this function's value
10071 shows the events before all translations (except for input methods).
10072 The value is always a vector. */)
10075 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10078 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10079 Sreset_this_command_lengths
, 0, 0, 0,
10080 doc
: /* Make the unread events replace the last command and echo.
10081 Used in `universal-argument-other-key'.
10083 `universal-argument-other-key' rereads the event just typed.
10084 It then gets translated through `function-key-map'.
10085 The translated event has to replace the real events,
10086 both in the value of (this-command-keys) and in echoing.
10087 To achieve this, `universal-argument-other-key' calls
10088 `reset-this-command-lengths', which discards the record of reading
10089 these events the first time. */)
10092 this_command_key_count
= before_command_key_count
;
10093 if (this_command_key_count
< this_single_command_key_start
)
10094 this_single_command_key_start
= this_command_key_count
;
10096 echo_truncate (before_command_echo_length
);
10098 /* Cause whatever we put into unread-command-events
10099 to echo as if it were being freshly read from the keyboard. */
10100 this_command_key_count_reset
= 1;
10105 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10106 Sclear_this_command_keys
, 0, 1, 0,
10107 doc
: /* Clear out the vector that `this-command-keys' returns.
10108 Also clear the record of the last 100 events, unless optional arg
10109 KEEP-RECORD is non-nil. */)
10110 (Lisp_Object keep_record
)
10114 this_command_key_count
= 0;
10115 this_command_key_count_reset
= 0;
10117 if (NILP (keep_record
))
10119 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10120 ASET (recent_keys
, i
, Qnil
);
10122 recent_keys_index
= 0;
10127 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10128 doc
: /* Return the current depth in recursive edits. */)
10132 /* Wrap around reliably on integer overflow. */
10133 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10134 XSETINT (temp
, sum
);
10138 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10139 "FOpen dribble file: ",
10140 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10141 If FILE is nil, close any open dribble file.
10142 The file will be closed when Emacs exits.
10144 Be aware that this records ALL characters you type!
10145 This may include sensitive information such as passwords. */)
10158 Lisp_Object encfile
;
10160 file
= Fexpand_file_name (file
, Qnil
);
10161 encfile
= ENCODE_FILE (file
);
10162 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10163 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10164 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10165 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10167 report_file_error ("Opening dribble", file
);
10172 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10173 doc
: /* Discard the contents of the terminal input buffer.
10174 Also end any kbd macro being defined. */)
10177 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10179 /* Discard the last command from the macro. */
10180 Fcancel_kbd_macro_events ();
10184 Vunread_command_events
= Qnil
;
10186 discard_tty_input ();
10188 kbd_fetch_ptr
= kbd_store_ptr
;
10194 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10195 doc
: /* Stop Emacs and return to superior process. You can resume later.
10196 If `cannot-suspend' is non-nil, or if the system doesn't support job
10197 control, run a subshell instead.
10199 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10200 to be read as terminal input by Emacs's parent, after suspension.
10202 Before suspending, run the normal hook `suspend-hook'.
10203 After resumption run the normal hook `suspend-resume-hook'.
10205 Some operating systems cannot stop the Emacs process and resume it later.
10206 On such systems, Emacs starts a subshell instead of suspending. */)
10207 (Lisp_Object stuffstring
)
10210 int old_height
, old_width
;
10212 struct gcpro gcpro1
;
10215 if (tty_list
&& tty_list
->next
)
10216 error ("There are other tty frames open; close them before suspending Emacs");
10218 if (!NILP (stuffstring
))
10219 CHECK_STRING (stuffstring
);
10221 /* Run the functions in suspend-hook. */
10222 hook
= intern ("suspend-hook");
10223 Frun_hooks (1, &hook
);
10225 GCPRO1 (stuffstring
);
10226 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10227 reset_all_sys_modes ();
10228 /* sys_suspend can get an error if it tries to fork a subshell
10229 and the system resources aren't available for that. */
10230 record_unwind_protect_void (init_all_sys_modes
);
10231 stuff_buffered_input (stuffstring
);
10232 if (cannot_suspend
)
10238 /* Check if terminal/window size has changed.
10239 Note that this is not useful when we are running directly
10240 with a window system; but suspend should be disabled in that case. */
10241 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10242 if (width
!= old_width
|| height
!= old_height
)
10243 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10245 /* Run suspend-resume-hook. */
10246 hook
= intern ("suspend-resume-hook");
10247 Frun_hooks (1, &hook
);
10253 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10254 Then in any case stuff anything Emacs has read ahead and not used. */
10257 stuff_buffered_input (Lisp_Object stuffstring
)
10259 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10260 register unsigned char *p
;
10262 if (STRINGP (stuffstring
))
10264 register ptrdiff_t count
;
10266 p
= SDATA (stuffstring
);
10267 count
= SBYTES (stuffstring
);
10268 while (count
-- > 0)
10273 /* Anything we have read ahead, put back for the shell to read. */
10274 /* ?? What should this do when we have multiple keyboards??
10275 Should we ignore anything that was typed in at the "wrong" kboard?
10277 rms: we should stuff everything back into the kboard
10279 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10282 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10283 kbd_fetch_ptr
= kbd_buffer
;
10284 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10285 stuff_char (kbd_fetch_ptr
->code
);
10287 clear_event (kbd_fetch_ptr
);
10291 #endif /* SIGTSTP */
10295 set_waiting_for_input (struct timespec
*time_to_clear
)
10297 input_available_clear_time
= time_to_clear
;
10299 /* Tell handle_interrupt to throw back to read_char, */
10300 waiting_for_input
= 1;
10302 /* If handle_interrupt was called before and buffered a C-g,
10303 make it run again now, to avoid timing error. */
10304 if (!NILP (Vquit_flag
))
10305 quit_throw_to_read_char (0);
10309 clear_waiting_for_input (void)
10311 /* Tell handle_interrupt not to throw back to read_char, */
10312 waiting_for_input
= 0;
10313 input_available_clear_time
= 0;
10316 /* The SIGINT handler.
10318 If we have a frame on the controlling tty, we assume that the
10319 SIGINT was generated by C-g, so we call handle_interrupt.
10320 Otherwise, tell QUIT to kill Emacs. */
10323 handle_interrupt_signal (int sig
)
10325 /* See if we have an active terminal on our controlling tty. */
10326 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10329 /* If there are no frames there, let's pretend that we are a
10330 well-behaving UN*X program and quit. We must not call Lisp
10331 in a signal handler, so tell QUIT to exit when it is
10333 Vquit_flag
= Qkill_emacs
;
10337 /* Otherwise, the SIGINT was probably generated by C-g. */
10339 /* Set internal_last_event_frame to the top frame of the
10340 controlling tty, if we have a frame there. We disable the
10341 interrupt key on secondary ttys, so the SIGINT must have come
10342 from the controlling tty. */
10343 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10345 handle_interrupt (1);
10350 deliver_interrupt_signal (int sig
)
10352 deliver_process_signal (sig
, handle_interrupt_signal
);
10356 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10357 of the number of times C-g has been requested. If C-g is pressed
10358 enough times, then quit anyway. See bug#6585. */
10359 static int volatile force_quit_count
;
10361 /* This routine is called at interrupt level in response to C-g.
10363 It is called from the SIGINT handler or kbd_buffer_store_event.
10365 If `waiting_for_input' is non zero, then unless `echoing' is
10366 nonzero, immediately throw back to read_char.
10368 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10369 eval to throw, when it gets a chance. If quit-flag is already
10370 non-nil, it stops the job right away. */
10373 handle_interrupt (bool in_signal_handler
)
10379 /* XXX This code needs to be revised for multi-tty support. */
10380 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10382 if (! in_signal_handler
)
10384 /* If SIGINT isn't blocked, don't let us be interrupted by
10385 a SIGINT. It might be harmful due to non-reentrancy
10386 in I/O functions. */
10388 sigemptyset (&blocked
);
10389 sigaddset (&blocked
, SIGINT
);
10390 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10394 reset_all_sys_modes ();
10398 * On systems which can suspend the current process and return to the original
10399 * shell, this command causes the user to end up back at the shell.
10400 * The "Auto-save" and "Abort" questions are not asked until
10401 * the user elects to return to emacs, at which point he can save the current
10402 * job and either dump core or continue.
10406 /* Perhaps should really fork an inferior shell?
10407 But that would not provide any way to get back
10408 to the original shell, ever. */
10409 printf ("No support for stopping a process on this operating system;\n");
10410 printf ("you can continue or abort.\n");
10411 #endif /* not SIGTSTP */
10413 /* We must remain inside the screen area when the internal terminal
10414 is used. Note that [Enter] is not echoed by dos. */
10415 cursor_to (SELECTED_FRAME (), 0, 0);
10417 printf ("Auto-save? (y or n) ");
10419 if (((c
= getchar ()) & ~040) == 'Y')
10421 Fdo_auto_save (Qt
, Qnil
);
10423 printf ("\r\nAuto-save done");
10424 #else /* not MSDOS */
10425 printf ("Auto-save done\n");
10426 #endif /* not MSDOS */
10428 while (c
!= '\n') c
= getchar ();
10431 printf ("\r\nAbort? (y or n) ");
10432 #else /* not MSDOS */
10433 printf ("Abort (and dump core)? (y or n) ");
10434 #endif /* not MSDOS */
10436 if (((c
= getchar ()) & ~040) == 'Y')
10438 while (c
!= '\n') c
= getchar ();
10440 printf ("\r\nContinuing...\r\n");
10441 #else /* not MSDOS */
10442 printf ("Continuing...\n");
10443 #endif /* not MSDOS */
10445 init_all_sys_modes ();
10449 /* If executing a function that wants to be interrupted out of
10450 and the user has not deferred quitting by binding `inhibit-quit'
10451 then quit right away. */
10452 if (immediate_quit
&& NILP (Vinhibit_quit
))
10454 struct gl_state_s saved
;
10455 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10457 immediate_quit
= 0;
10458 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10460 GCPRO4 (saved
.object
, saved
.global_code
,
10461 saved
.current_syntax_table
, saved
.old_prop
);
10462 Fsignal (Qquit
, Qnil
);
10467 { /* Else request quit when it's safe. */
10468 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10469 force_quit_count
= count
;
10472 immediate_quit
= 1;
10473 Vinhibit_quit
= Qnil
;
10479 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10481 /* TODO: The longjmp in this call throws the NS event loop integration off,
10482 and it seems to do fine without this. Probably some attention
10483 needs to be paid to the setting of waiting_for_input in
10484 wait_reading_process_output() under HAVE_NS because of the call
10485 to ns_select there (needed because otherwise events aren't picked up
10486 outside of polling since we don't get SIGIO like X and we don't have a
10487 separate event loop thread like W32. */
10489 if (waiting_for_input
&& !echoing
)
10490 quit_throw_to_read_char (in_signal_handler
);
10494 /* Handle a C-g by making read_char return C-g. */
10497 quit_throw_to_read_char (bool from_signal
)
10499 /* When not called from a signal handler it is safe to call
10501 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10502 Fkill_emacs (Qnil
);
10504 /* Prevent another signal from doing this before we finish. */
10505 clear_waiting_for_input ();
10508 Vunread_command_events
= Qnil
;
10510 if (FRAMEP (internal_last_event_frame
)
10511 && !EQ (internal_last_event_frame
, selected_frame
))
10512 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10515 sys_longjmp (getcjmp
, 1);
10518 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10519 Sset_input_interrupt_mode
, 1, 1, 0,
10520 doc
: /* Set interrupt mode of reading keyboard input.
10521 If INTERRUPT is non-nil, Emacs will use input interrupts;
10522 otherwise Emacs uses CBREAK mode.
10524 See also `current-input-mode'. */)
10525 (Lisp_Object interrupt
)
10527 bool new_interrupt_input
;
10528 #ifdef USABLE_SIGIO
10529 #ifdef HAVE_X_WINDOWS
10530 if (x_display_list
!= NULL
)
10532 /* When using X, don't give the user a real choice,
10533 because we haven't implemented the mechanisms to support it. */
10534 new_interrupt_input
= 1;
10537 #endif /* HAVE_X_WINDOWS */
10538 new_interrupt_input
= !NILP (interrupt
);
10539 #else /* not USABLE_SIGIO */
10540 new_interrupt_input
= 0;
10541 #endif /* not USABLE_SIGIO */
10543 if (new_interrupt_input
!= interrupt_input
)
10545 #ifdef POLL_FOR_INPUT
10549 /* this causes startup screen to be restored and messes with the mouse */
10550 reset_all_sys_modes ();
10551 interrupt_input
= new_interrupt_input
;
10552 init_all_sys_modes ();
10554 interrupt_input
= new_interrupt_input
;
10557 #ifdef POLL_FOR_INPUT
10558 poll_suppress_count
= 1;
10565 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10566 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10567 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10568 C-q in key sequences.
10570 This setting only has an effect on tty terminals and only when
10571 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10573 See also `current-input-mode'. */)
10574 (Lisp_Object flow
, Lisp_Object terminal
)
10576 struct terminal
*t
= get_terminal (terminal
, 1);
10577 struct tty_display_info
*tty
;
10578 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10580 tty
= t
->display_info
.tty
;
10582 if (tty
->flow_control
!= !NILP (flow
))
10585 /* This causes startup screen to be restored and messes with the mouse. */
10586 reset_sys_modes (tty
);
10589 tty
->flow_control
= !NILP (flow
);
10592 init_sys_modes (tty
);
10598 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10599 doc
: /* Enable or disable 8-bit input on TERMINAL.
10600 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10601 bit as the Meta modifier.
10603 If META is nil, Emacs will ignore the top bit, on the assumption it is
10606 Otherwise, Emacs will accept and pass through 8-bit input without
10607 specially interpreting the top bit.
10609 This setting only has an effect on tty terminal devices.
10611 Optional parameter TERMINAL specifies the tty terminal device to use.
10612 It may be a terminal object, a frame, or nil for the terminal used by
10613 the currently selected frame.
10615 See also `current-input-mode'. */)
10616 (Lisp_Object meta
, Lisp_Object terminal
)
10618 struct terminal
*t
= get_terminal (terminal
, 1);
10619 struct tty_display_info
*tty
;
10622 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10624 tty
= t
->display_info
.tty
;
10628 else if (EQ (meta
, Qt
))
10633 if (tty
->meta_key
!= new_meta
)
10636 /* this causes startup screen to be restored and messes with the mouse */
10637 reset_sys_modes (tty
);
10640 tty
->meta_key
= new_meta
;
10643 init_sys_modes (tty
);
10649 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10650 doc
: /* Specify character used for quitting.
10651 QUIT must be an ASCII character.
10653 This function only has an effect on the controlling tty of the Emacs
10656 See also `current-input-mode'. */)
10659 struct terminal
*t
= get_named_tty ("/dev/tty");
10660 struct tty_display_info
*tty
;
10661 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10663 tty
= t
->display_info
.tty
;
10665 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10666 error ("QUIT must be an ASCII character");
10669 /* this causes startup screen to be restored and messes with the mouse */
10670 reset_sys_modes (tty
);
10673 /* Don't let this value be out of range. */
10674 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10677 init_sys_modes (tty
);
10683 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10684 doc
: /* Set mode of reading keyboard input.
10685 First arg INTERRUPT non-nil means use input interrupts;
10686 nil means use CBREAK mode.
10687 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10688 (no effect except in CBREAK mode).
10689 Third arg META t means accept 8-bit input (for a Meta key).
10690 META nil means ignore the top bit, on the assumption it is parity.
10691 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10692 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10693 See also `current-input-mode'. */)
10694 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10696 Fset_input_interrupt_mode (interrupt
);
10697 Fset_output_flow_control (flow
, Qnil
);
10698 Fset_input_meta_mode (meta
, Qnil
);
10700 Fset_quit_char (quit
);
10704 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10705 doc
: /* Return information about the way Emacs currently reads keyboard input.
10706 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10707 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10708 nil, Emacs is using CBREAK mode.
10709 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10710 terminal; this does not apply if Emacs uses interrupt-driven input.
10711 META is t if accepting 8-bit input with 8th bit as Meta flag.
10712 META nil means ignoring the top bit, on the assumption it is parity.
10713 META is neither t nor nil if accepting 8-bit input and using
10714 all 8 bits as the character code.
10715 QUIT is the character Emacs currently uses to quit.
10716 The elements of this list correspond to the arguments of
10717 `set-input-mode'. */)
10720 Lisp_Object val
[4];
10721 struct frame
*sf
= XFRAME (selected_frame
);
10723 val
[0] = interrupt_input
? Qt
: Qnil
;
10724 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10726 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10727 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10729 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10736 XSETFASTINT (val
[3], quit_char
);
10738 return Flist (ARRAYELTS (val
), val
);
10741 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10742 doc
: /* Return position information for pixel coordinates X and Y.
10743 By default, X and Y are relative to text area of the selected window.
10744 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10745 If optional fourth arg WHOLE is non-nil, X is relative to the left
10746 edge of the window.
10748 The return value is similar to a mouse click position:
10749 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10750 IMAGE (DX . DY) (WIDTH . HEIGHT))
10751 The `posn-' functions access elements of such lists. */)
10752 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10757 if (NILP (frame_or_window
))
10758 frame_or_window
= selected_window
;
10760 if (WINDOWP (frame_or_window
))
10762 struct window
*w
= decode_live_window (frame_or_window
);
10764 XSETINT (x
, (XINT (x
)
10765 + WINDOW_LEFT_EDGE_X (w
)
10767 ? window_box_left_offset (w
, TEXT_AREA
)
10769 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10770 frame_or_window
= w
->frame
;
10773 CHECK_LIVE_FRAME (frame_or_window
);
10775 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10778 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10779 doc
: /* Return position information for buffer POS in WINDOW.
10780 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10782 Return nil if position is not visible in window. Otherwise,
10783 the return value is similar to that returned by `event-start' for
10784 a mouse click at the upper left corner of the glyph corresponding
10785 to the given buffer position:
10786 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10787 IMAGE (DX . DY) (WIDTH . HEIGHT))
10788 The `posn-' functions access elements of such lists. */)
10789 (Lisp_Object pos
, Lisp_Object window
)
10794 window
= selected_window
;
10796 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10799 Lisp_Object x
= XCAR (tem
);
10800 Lisp_Object y
= XCAR (XCDR (tem
));
10802 /* Point invisible due to hscrolling? */
10805 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10811 /* Set up a new kboard object with reasonable initial values.
10812 TYPE is a window system for which this keyboard is used. */
10815 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10817 kset_overriding_terminal_local_map (kb
, Qnil
);
10818 kset_last_command (kb
, Qnil
);
10819 kset_real_last_command (kb
, Qnil
);
10820 kset_keyboard_translate_table (kb
, Qnil
);
10821 kset_last_repeatable_command (kb
, Qnil
);
10822 kset_prefix_arg (kb
, Qnil
);
10823 kset_last_prefix_arg (kb
, Qnil
);
10824 kset_kbd_queue (kb
, Qnil
);
10825 kb
->kbd_queue_has_data
= 0;
10826 kb
->immediate_echo
= 0;
10827 kset_echo_string (kb
, Qnil
);
10828 kb
->echo_after_prompt
= -1;
10829 kb
->kbd_macro_buffer
= 0;
10830 kb
->kbd_macro_bufsize
= 0;
10831 kset_defining_kbd_macro (kb
, Qnil
);
10832 kset_last_kbd_macro (kb
, Qnil
);
10833 kb
->reference_count
= 0;
10834 kset_system_key_alist (kb
, Qnil
);
10835 kset_system_key_syms (kb
, Qnil
);
10836 kset_window_system (kb
, type
);
10837 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10838 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10839 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10840 kset_default_minibuffer_frame (kb
, Qnil
);
10843 /* Allocate and basically initialize keyboard
10844 object to use with window system TYPE. */
10847 allocate_kboard (Lisp_Object type
)
10849 KBOARD
*kb
= xmalloc (sizeof *kb
);
10851 init_kboard (kb
, type
);
10852 kb
->next_kboard
= all_kboards
;
10858 * Destroy the contents of a kboard object, but not the object itself.
10859 * We use this just before deleting it, or if we're going to initialize
10860 * it a second time.
10863 wipe_kboard (KBOARD
*kb
)
10865 xfree (kb
->kbd_macro_buffer
);
10868 /* Free KB and memory referenced from it. */
10871 delete_kboard (KBOARD
*kb
)
10875 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10878 *kbp
= kb
->next_kboard
;
10880 /* Prevent a dangling reference to KB. */
10881 if (kb
== current_kboard
10882 && FRAMEP (selected_frame
)
10883 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10885 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10887 if (current_kboard
== kb
)
10896 init_keyboard (void)
10898 /* This is correct before outermost invocation of the editor loop. */
10899 command_loop_level
= -1;
10900 immediate_quit
= 0;
10901 quit_char
= Ctl ('g');
10902 Vunread_command_events
= Qnil
;
10903 timer_idleness_start_time
= invalid_timespec ();
10905 recent_keys_index
= 0;
10906 kbd_fetch_ptr
= kbd_buffer
;
10907 kbd_store_ptr
= kbd_buffer
;
10908 do_mouse_tracking
= Qnil
;
10910 interrupt_input_blocked
= 0;
10911 pending_signals
= 0;
10913 /* This means that command_loop_1 won't try to select anything the first
10915 internal_last_event_frame
= Qnil
;
10916 Vlast_event_frame
= internal_last_event_frame
;
10918 current_kboard
= initial_kboard
;
10919 /* Re-initialize the keyboard again. */
10920 wipe_kboard (current_kboard
);
10921 /* A value of nil for Vwindow_system normally means a tty, but we also use
10922 it for the initial terminal since there is no window system there. */
10923 init_kboard (current_kboard
, Qnil
);
10925 if (!noninteractive
)
10927 /* Before multi-tty support, these handlers used to be installed
10928 only if the current session was a tty session. Now an Emacs
10929 session may have multiple display types, so we always handle
10930 SIGINT. There is special code in handle_interrupt_signal to exit
10931 Emacs on SIGINT when there are no termcap frames on the
10932 controlling terminal. */
10933 struct sigaction action
;
10934 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10935 sigaction (SIGINT
, &action
, 0);
10937 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10938 SIGQUIT and we can't tell which one it will give us. */
10939 sigaction (SIGQUIT
, &action
, 0);
10940 #endif /* not DOS_NT */
10942 #ifdef USABLE_SIGIO
10943 if (!noninteractive
)
10945 struct sigaction action
;
10946 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10947 sigaction (SIGIO
, &action
, 0);
10951 /* Use interrupt input by default, if it works and noninterrupt input
10952 has deficiencies. */
10954 #ifdef INTERRUPT_INPUT
10955 interrupt_input
= 1;
10957 interrupt_input
= 0;
10960 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10963 if (keyboard_init_hook
)
10964 (*keyboard_init_hook
) ();
10966 #ifdef POLL_FOR_INPUT
10968 poll_suppress_count
= 1;
10973 /* This type's only use is in syms_of_keyboard, to initialize the
10974 event header symbols and put properties on them. */
10975 struct event_head
{
10981 static const struct event_head head_table
[] = {
10982 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10983 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10984 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10985 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10986 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10987 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10988 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10989 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10990 /* `select-window' should be handled just like `switch-frame'
10991 in read_key_sequence. */
10992 {&Qselect_window
, "select-window", &Qswitch_frame
}
10996 syms_of_keyboard (void)
10998 #include "keyboard.x"
11000 pending_funcalls
= Qnil
;
11001 staticpro (&pending_funcalls
);
11003 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11004 staticpro (&Vlispy_mouse_stem
);
11007 DEFSYM (QCimage
, ":image");
11008 DEFSYM (Qhelp_echo
, "help-echo");
11009 DEFSYM (QCrtl
, ":rtl");
11011 staticpro (&item_properties
);
11012 item_properties
= Qnil
;
11014 staticpro (&tool_bar_item_properties
);
11015 tool_bar_item_properties
= Qnil
;
11016 staticpro (&tool_bar_items_vector
);
11017 tool_bar_items_vector
= Qnil
;
11019 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11020 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11021 DEFSYM (Qself_insert_command
, "self-insert-command");
11022 DEFSYM (Qforward_char
, "forward-char");
11023 DEFSYM (Qbackward_char
, "backward-char");
11024 DEFSYM (Qdisabled
, "disabled");
11025 DEFSYM (Qundefined
, "undefined");
11026 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11027 DEFSYM (Qpost_command_hook
, "post-command-hook");
11028 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11029 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11030 DEFSYM (Qfunction_key
, "function-key");
11031 DEFSYM (Qmouse_click
, "mouse-click");
11032 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11033 DEFSYM (Qsave_session
, "save-session");
11034 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11035 DEFSYM (Qmenu_enable
, "menu-enable");
11038 DEFSYM (Qlanguage_change
, "language-change");
11042 DEFSYM (Qdbus_event
, "dbus-event");
11045 #ifdef USE_FILE_NOTIFY
11046 DEFSYM (Qfile_notify
, "file-notify");
11047 #endif /* USE_FILE_NOTIFY */
11049 DEFSYM (QCenable
, ":enable");
11050 DEFSYM (QCvisible
, ":visible");
11051 DEFSYM (QChelp
, ":help");
11052 DEFSYM (QCfilter
, ":filter");
11053 DEFSYM (QCbutton
, ":button");
11054 DEFSYM (QCkeys
, ":keys");
11055 DEFSYM (QCkey_sequence
, ":key-sequence");
11056 DEFSYM (QCtoggle
, ":toggle");
11057 DEFSYM (QCradio
, ":radio");
11058 DEFSYM (QClabel
, ":label");
11059 DEFSYM (QCvert_only
, ":vert-only");
11061 DEFSYM (Qmode_line
, "mode-line");
11062 DEFSYM (Qvertical_line
, "vertical-line");
11063 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11064 DEFSYM (Qmenu_bar
, "menu-bar");
11065 DEFSYM (Qright_divider
, "right-divider");
11066 DEFSYM (Qbottom_divider
, "bottom-divider");
11068 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11070 DEFSYM (Qabove_handle
, "above-handle");
11071 DEFSYM (Qhandle
, "handle");
11072 DEFSYM (Qbelow_handle
, "below-handle");
11073 DEFSYM (Qup
, "up");
11074 DEFSYM (Qdown
, "down");
11075 DEFSYM (Qtop
, "top");
11076 DEFSYM (Qbottom
, "bottom");
11077 DEFSYM (Qend_scroll
, "end-scroll");
11078 DEFSYM (Qratio
, "ratio");
11080 DEFSYM (Qevent_kind
, "event-kind");
11081 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11082 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11083 DEFSYM (Qmodifier_cache
, "modifier-cache");
11085 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11086 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11088 DEFSYM (Qpolling_period
, "polling-period");
11090 DEFSYM (Qx_set_selection
, "x-set-selection");
11091 DEFSYM (QPRIMARY
, "PRIMARY");
11092 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11093 DEFSYM (Qhandle_select_window
, "handle-select-window");
11095 DEFSYM (Qinput_method_function
, "input-method-function");
11096 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11097 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11099 DEFSYM (Qhelp_form_show
, "help-form-show");
11101 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11103 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11104 Fset (Qinput_method_use_echo_area
, Qnil
);
11108 int len
= ARRAYELTS (head_table
);
11110 for (i
= 0; i
< len
; i
++)
11112 const struct event_head
*p
= &head_table
[i
];
11113 *p
->var
= intern_c_string (p
->name
);
11114 staticpro (p
->var
);
11115 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11116 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11120 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11121 staticpro (&button_down_location
);
11122 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11123 staticpro (&mouse_syms
);
11124 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11126 staticpro (&wheel_syms
);
11130 int len
= ARRAYELTS (modifier_names
);
11132 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11133 for (i
= 0; i
< len
; i
++)
11134 if (modifier_names
[i
])
11135 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11136 staticpro (&modifier_symbols
);
11139 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11140 staticpro (&recent_keys
);
11142 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11143 staticpro (&this_command_keys
);
11145 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11146 staticpro (&raw_keybuf
);
11148 DEFSYM (Qcommand_execute
, "command-execute");
11150 accent_key_syms
= Qnil
;
11151 staticpro (&accent_key_syms
);
11153 func_key_syms
= Qnil
;
11154 staticpro (&func_key_syms
);
11156 drag_n_drop_syms
= Qnil
;
11157 staticpro (&drag_n_drop_syms
);
11159 unread_switch_frame
= Qnil
;
11160 staticpro (&unread_switch_frame
);
11162 internal_last_event_frame
= Qnil
;
11163 staticpro (&internal_last_event_frame
);
11165 read_key_sequence_cmd
= Qnil
;
11166 staticpro (&read_key_sequence_cmd
);
11167 read_key_sequence_remapped
= Qnil
;
11168 staticpro (&read_key_sequence_remapped
);
11170 menu_bar_one_keymap_changed_items
= Qnil
;
11171 staticpro (&menu_bar_one_keymap_changed_items
);
11173 menu_bar_items_vector
= Qnil
;
11174 staticpro (&menu_bar_items_vector
);
11176 help_form_saved_window_configs
= Qnil
;
11177 staticpro (&help_form_saved_window_configs
);
11179 DEFVAR_LISP ("last-command-event", last_command_event
,
11180 doc
: /* Last input event that was part of a command. */);
11182 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11183 doc
: /* Last input event in a command, except for mouse menu events.
11184 Mouse menus give back keys that don't look like mouse events;
11185 this variable holds the actual mouse event that led to the menu,
11186 so that you can determine whether the command was run by mouse or not. */);
11188 DEFVAR_LISP ("last-input-event", last_input_event
,
11189 doc
: /* Last input event. */);
11191 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11192 doc
: /* List of events to be read as the command input.
11193 These events are processed first, before actual keyboard input.
11194 Events read from this list are not normally added to `this-command-keys',
11195 as they will already have been added once as they were read for the first time.
11196 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11197 Vunread_command_events
= Qnil
;
11199 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11200 doc
: /* List of events to be processed as input by input methods.
11201 These events are processed before `unread-command-events'
11202 and actual keyboard input, but are not given to `input-method-function'. */);
11203 Vunread_post_input_method_events
= Qnil
;
11205 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11206 doc
: /* List of events to be processed as input by input methods.
11207 These events are processed after `unread-command-events', but
11208 before actual keyboard input.
11209 If there's an active input method, the events are given to
11210 `input-method-function'. */);
11211 Vunread_input_method_events
= Qnil
;
11213 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11214 doc
: /* Meta-prefix character code.
11215 Meta-foo as command input turns into this character followed by foo. */);
11216 XSETINT (meta_prefix_char
, 033);
11218 DEFVAR_KBOARD ("last-command", Vlast_command
,
11219 doc
: /* The last command executed.
11220 Normally a symbol with a function definition, but can be whatever was found
11221 in the keymap, or whatever the variable `this-command' was set to by that
11224 The value `mode-exit' is special; it means that the previous command
11225 read an event that told it to exit, and it did so and unread that event.
11226 In other words, the present command is the event that made the previous
11229 The value `kill-region' is special; it means that the previous command
11230 was a kill command.
11232 `last-command' has a separate binding for each terminal device.
11233 See Info node `(elisp)Multiple Terminals'. */);
11235 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11236 doc
: /* Same as `last-command', but never altered by Lisp code.
11237 Taken from the previous value of `real-this-command'. */);
11239 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11240 doc
: /* Last command that may be repeated.
11241 The last command executed that was not bound to an input event.
11242 This is the command `repeat' will try to repeat.
11243 Taken from a previous value of `real-this-command'. */);
11245 DEFVAR_LISP ("this-command", Vthis_command
,
11246 doc
: /* The command now being executed.
11247 The command can set this variable; whatever is put here
11248 will be in `last-command' during the following command. */);
11249 Vthis_command
= Qnil
;
11251 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11252 doc
: /* This is like `this-command', except that commands should never modify it. */);
11253 Vreal_this_command
= Qnil
;
11255 DEFVAR_LISP ("this-command-keys-shift-translated",
11256 Vthis_command_keys_shift_translated
,
11257 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11258 Shift-translation occurs when there is no binding for the key sequence
11259 as entered, but a binding was found by changing an upper-case letter
11260 to lower-case, or a shifted function key to an unshifted one. */);
11261 Vthis_command_keys_shift_translated
= Qnil
;
11263 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11264 doc
: /* The command bound to the current key sequence before remapping.
11265 It equals `this-command' if the original command was not remapped through
11266 any of the active keymaps. Otherwise, the value of `this-command' is the
11267 result of looking up the original command in the active keymaps. */);
11268 Vthis_original_command
= Qnil
;
11270 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11271 doc
: /* Number of input events between auto-saves.
11272 Zero means disable autosaving due to number of characters typed. */);
11273 auto_save_interval
= 300;
11275 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11276 doc
: /* Number of seconds idle time before auto-save.
11277 Zero or nil means disable auto-saving due to idleness.
11278 After auto-saving due to this many seconds of idle time,
11279 Emacs also does a garbage collection if that seems to be warranted. */);
11280 XSETFASTINT (Vauto_save_timeout
, 30);
11282 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11283 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11284 The value may be integer or floating point.
11285 If the value is zero, don't echo at all. */);
11286 Vecho_keystrokes
= make_number (1);
11288 DEFVAR_INT ("polling-period", polling_period
,
11289 doc
: /* Interval between polling for input during Lisp execution.
11290 The reason for polling is to make C-g work to stop a running program.
11291 Polling is needed only when using X windows and SIGIO does not work.
11292 Polling is automatically disabled in all other cases. */);
11293 polling_period
= 2;
11295 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11296 doc
: /* Maximum time between mouse clicks to make a double-click.
11297 Measured in milliseconds. The value nil means disable double-click
11298 recognition; t means double-clicks have no time limit and are detected
11299 by position only. */);
11300 Vdouble_click_time
= make_number (500);
11302 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11303 doc
: /* Maximum mouse movement between clicks to make a double-click.
11304 On window-system frames, value is the number of pixels the mouse may have
11305 moved horizontally or vertically between two clicks to make a double-click.
11306 On non window-system frames, value is interpreted in units of 1/8 characters
11309 This variable is also the threshold for motion of the mouse
11310 to count as a drag. */);
11311 double_click_fuzz
= 3;
11313 DEFVAR_INT ("num-input-keys", num_input_keys
,
11314 doc
: /* Number of complete key sequences read as input so far.
11315 This includes key sequences read from keyboard macros.
11316 The number is effectively the number of interactive command invocations. */);
11317 num_input_keys
= 0;
11319 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11320 doc
: /* Number of input events read from the keyboard so far.
11321 This does not include events generated by keyboard macros. */);
11322 num_nonmacro_input_events
= 0;
11324 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11325 doc
: /* The frame in which the most recently read event occurred.
11326 If the last event came from a keyboard macro, this is set to `macro'. */);
11327 Vlast_event_frame
= Qnil
;
11329 /* This variable is set up in sysdep.c. */
11330 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11331 doc
: /* The ERASE character as set by the user with stty. */);
11333 DEFVAR_LISP ("help-char", Vhelp_char
,
11334 doc
: /* Character to recognize as meaning Help.
11335 When it is read, do `(eval help-form)', and display result if it's a string.
11336 If the value of `help-form' is nil, this char can be read normally. */);
11337 XSETINT (Vhelp_char
, Ctl ('H'));
11339 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11340 doc
: /* List of input events to recognize as meaning Help.
11341 These work just like the value of `help-char' (see that). */);
11342 Vhelp_event_list
= Qnil
;
11344 DEFVAR_LISP ("help-form", Vhelp_form
,
11345 doc
: /* Form to execute when character `help-char' is read.
11346 If the form returns a string, that string is displayed.
11347 If `help-form' is nil, the help char is not recognized. */);
11350 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11351 doc
: /* Command to run when `help-char' character follows a prefix key.
11352 This command is used only when there is no actual binding
11353 for that character after that prefix key. */);
11354 Vprefix_help_command
= Qnil
;
11356 DEFVAR_LISP ("top-level", Vtop_level
,
11357 doc
: /* Form to evaluate when Emacs starts up.
11358 Useful to set before you dump a modified Emacs. */);
11361 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11362 doc
: /* Translate table for local keyboard input, or nil.
11363 If non-nil, the value should be a char-table. Each character read
11364 from the keyboard is looked up in this char-table. If the value found
11365 there is non-nil, then it is used instead of the actual input character.
11367 The value can also be a string or vector, but this is considered obsolete.
11368 If it is a string or vector of length N, character codes N and up are left
11369 untranslated. In a vector, an element which is nil means "no translation".
11371 This is applied to the characters supplied to input methods, not their
11372 output. See also `translation-table-for-input'.
11374 This variable has a separate binding for each terminal.
11375 See Info node `(elisp)Multiple Terminals'. */);
11377 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11378 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11379 \(Even if the operating system has support for stopping a process.\) */);
11380 cannot_suspend
= 0;
11382 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11383 doc
: /* Non-nil means prompt with menus when appropriate.
11384 This is done when reading from a keymap that has a prompt string,
11385 for elements that have prompt strings.
11386 The menu is displayed on the screen
11387 if X menus were enabled at configuration
11388 time and the previous event was a mouse click prefix key.
11389 Otherwise, menu prompting uses the echo area. */);
11390 menu_prompting
= 1;
11392 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11393 doc
: /* Character to see next line of menu prompt.
11394 Type this character while in a menu prompt to rotate around the lines of it. */);
11395 XSETINT (menu_prompt_more_char
, ' ');
11397 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11398 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11399 Emacs applies the modifiers of the character stored here to each keyboard
11400 character it reads. For example, after evaluating the expression
11401 (setq extra-keyboard-modifiers ?\\C-x)
11402 all input characters will have the control modifier applied to them.
11404 Note that the character ?\\C-@, equivalent to the integer zero, does
11405 not count as a control character; rather, it counts as a character
11406 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11407 cancels any modification. */);
11408 extra_keyboard_modifiers
= 0;
11410 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11411 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11412 The command loop sets this to nil before each command,
11413 and tests the value when the command returns.
11414 Buffer modification stores t in this variable. */);
11415 Vdeactivate_mark
= Qnil
;
11416 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11417 Fmake_variable_buffer_local (Qdeactivate_mark
);
11419 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11420 doc
: /* Normal hook run before each command is executed.
11421 If an unhandled error happens in running this hook,
11422 the function in which the error occurred is unconditionally removed, since
11423 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11424 Vpre_command_hook
= Qnil
;
11426 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11427 doc
: /* Normal hook run after each command is executed.
11428 If an unhandled error happens in running this hook,
11429 the function in which the error occurred is unconditionally removed, since
11430 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11431 Vpost_command_hook
= Qnil
;
11434 DEFVAR_LISP ("echo-area-clear-hook", ...,
11435 doc
: /* Normal hook run when clearing the echo area. */);
11437 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11438 Fset (Qecho_area_clear_hook
, Qnil
);
11440 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11441 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11442 Vlucid_menu_bar_dirty_flag
= Qnil
;
11444 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11445 doc
: /* List of menu bar items to move to the end of the menu bar.
11446 The elements of the list are event types that may have menu bar bindings. */);
11447 Vmenu_bar_final_items
= Qnil
;
11449 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11450 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11451 This is used internally by graphical displays that do not render
11452 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11453 Vtool_bar_separator_image_expression
= Qnil
;
11455 DEFVAR_KBOARD ("overriding-terminal-local-map",
11456 Voverriding_terminal_local_map
,
11457 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11458 This variable is intended to let commands such as `universal-argument'
11459 set up a different keymap for reading the next command.
11461 `overriding-terminal-local-map' has a separate binding for each
11462 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11464 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11465 doc
: /* Keymap that replaces (overrides) local keymaps.
11466 If this variable is non-nil, Emacs looks up key bindings in this
11467 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11468 buffer's local map. Hence, the only active keymaps would be
11469 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11470 order of precedence. */);
11471 Voverriding_local_map
= Qnil
;
11473 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11474 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11475 Otherwise, the menu bar continues to reflect the buffer's local map
11476 and the minor mode maps regardless of `overriding-local-map'. */);
11477 Voverriding_local_map_menu_flag
= Qnil
;
11479 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11480 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11481 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11483 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11484 doc
: /* Non-nil means generate motion events for mouse motion. */);
11486 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11487 doc
: /* Alist of system-specific X windows key symbols.
11488 Each element should have the form (N . SYMBOL) where N is the
11489 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11490 and SYMBOL is its name.
11492 `system-key-alist' has a separate binding for each terminal device.
11493 See Info node `(elisp)Multiple Terminals'. */);
11495 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11496 doc
: /* Keymap that translates key sequences to key sequences during input.
11497 This is used mainly for mapping key sequences into some preferred
11498 key events (symbols).
11500 The `read-key-sequence' function replaces any subsequence bound by
11501 `local-function-key-map' with its binding. More precisely, when the
11502 active keymaps have no binding for the current key sequence but
11503 `local-function-key-map' binds a suffix of the sequence to a vector or
11504 string, `read-key-sequence' replaces the matching suffix with its
11505 binding, and continues with the new sequence.
11507 If the binding is a function, it is called with one argument (the prompt)
11508 and its return value (a key sequence) is used.
11510 The events that come from bindings in `local-function-key-map' are not
11511 themselves looked up in `local-function-key-map'.
11513 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11514 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11515 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11516 typing `ESC O P x' would return [f1 x].
11518 `local-function-key-map' has a separate binding for each terminal
11519 device. See Info node `(elisp)Multiple Terminals'. If you need to
11520 define a binding on all terminals, change `function-key-map'
11521 instead. Initially, `local-function-key-map' is an empty keymap that
11522 has `function-key-map' as its parent on all terminal devices. */);
11524 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11525 doc
: /* Keymap that decodes input escape sequences.
11526 This is used mainly for mapping ASCII function key sequences into
11527 real Emacs function key events (symbols).
11529 The `read-key-sequence' function replaces any subsequence bound by
11530 `input-decode-map' with its binding. Contrary to `function-key-map',
11531 this map applies its rebinding regardless of the presence of an ordinary
11532 binding. So it is more like `key-translation-map' except that it applies
11533 before `function-key-map' rather than after.
11535 If the binding is a function, it is called with one argument (the prompt)
11536 and its return value (a key sequence) is used.
11538 The events that come from bindings in `input-decode-map' are not
11539 themselves looked up in `input-decode-map'. */);
11541 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11542 doc
: /* The parent keymap of all `local-function-key-map' instances.
11543 Function key definitions that apply to all terminal devices should go
11544 here. If a mapping is defined in both the current
11545 `local-function-key-map' binding and this variable, then the local
11546 definition will take precedence. */);
11547 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11549 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11550 doc
: /* Keymap of key translations that can override keymaps.
11551 This keymap works like `input-decode-map', but comes after `function-key-map'.
11552 Another difference is that it is global rather than terminal-local. */);
11553 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11555 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11556 doc
: /* List of deferred actions to be performed at a later time.
11557 The precise format isn't relevant here; we just check whether it is nil. */);
11558 Vdeferred_action_list
= Qnil
;
11560 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11561 doc
: /* Function to call to handle deferred actions, after each command.
11562 This function is called with no arguments after each command
11563 whenever `deferred-action-list' is non-nil. */);
11564 Vdeferred_action_function
= Qnil
;
11566 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11567 doc
: /* List of warnings to be displayed after this command.
11568 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11569 as per the args of `display-warning' (which see).
11570 If this variable is non-nil, `delayed-warnings-hook' will be run
11571 immediately after running `post-command-hook'. */);
11572 Vdelayed_warnings_list
= Qnil
;
11574 DEFVAR_LISP ("timer-list", Vtimer_list
,
11575 doc
: /* List of active absolute time timers in order of increasing time. */);
11576 Vtimer_list
= Qnil
;
11578 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11579 doc
: /* List of active idle-time timers in order of increasing time. */);
11580 Vtimer_idle_list
= Qnil
;
11582 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11583 doc
: /* If non-nil, the function that implements the current input method.
11584 It's called with one argument, a printing character that was just read.
11585 \(That means a character with code 040...0176.)
11586 Typically this function uses `read-event' to read additional events.
11587 When it does so, it should first bind `input-method-function' to nil
11588 so it will not be called recursively.
11590 The function should return a list of zero or more events
11591 to be used as input. If it wants to put back some events
11592 to be reconsidered, separately, by the input method,
11593 it can add them to the beginning of `unread-command-events'.
11595 The input method function can find in `input-method-previous-message'
11596 the previous echo area message.
11598 The input method function should refer to the variables
11599 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11600 for guidance on what to do. */);
11601 Vinput_method_function
= Qnil
;
11603 DEFVAR_LISP ("input-method-previous-message",
11604 Vinput_method_previous_message
,
11605 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11606 This variable exists because `read-event' clears the echo area
11607 before running the input method. It is nil if there was no message. */);
11608 Vinput_method_previous_message
= Qnil
;
11610 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11611 doc
: /* If non-nil, the function that implements the display of help.
11612 It's called with one argument, the help string to display. */);
11613 Vshow_help_function
= Qnil
;
11615 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11616 doc
: /* If non-nil, suppress point adjustment after executing a command.
11618 After a command is executed, if point is moved into a region that has
11619 special properties (e.g. composition, display), we adjust point to
11620 the boundary of the region. But, when a command sets this variable to
11621 non-nil, we suppress the point adjustment.
11623 This variable is set to nil before reading a command, and is checked
11624 just after executing the command. */);
11625 Vdisable_point_adjustment
= Qnil
;
11627 DEFVAR_LISP ("global-disable-point-adjustment",
11628 Vglobal_disable_point_adjustment
,
11629 doc
: /* If non-nil, always suppress point adjustment.
11631 The default value is nil, in which case, point adjustment are
11632 suppressed only after special commands that set
11633 `disable-point-adjustment' (which see) to non-nil. */);
11634 Vglobal_disable_point_adjustment
= Qnil
;
11636 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11637 doc
: /* How long to display an echo-area message when the minibuffer is active.
11638 If the value is not a number, such messages don't time out. */);
11639 Vminibuffer_message_timeout
= make_number (2);
11641 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11642 doc
: /* If non-nil, any keyboard input throws to this symbol.
11643 The value of that variable is passed to `quit-flag' and later causes a
11644 peculiar kind of quitting. */);
11645 Vthrow_on_input
= Qnil
;
11647 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11648 doc
: /* Function to output error messages.
11649 Called with three arguments:
11650 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11651 such as what `condition-case' would bind its variable to,
11652 - the context (a string which normally goes at the start of the message),
11653 - the Lisp function within which the error was signaled. */);
11654 Vcommand_error_function
= intern ("command-error-default-function");
11656 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11657 Venable_disabled_menus_and_buttons
,
11658 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11660 Help functions bind this to allow help on disabled menu items
11661 and tool-bar buttons. */);
11662 Venable_disabled_menus_and_buttons
= Qnil
;
11664 DEFVAR_LISP ("select-active-regions",
11665 Vselect_active_regions
,
11666 doc
: /* If non-nil, an active region automatically sets the primary selection.
11667 If the value is `only', only temporarily active regions (usually made
11668 by mouse-dragging or shift-selection) set the window selection.
11670 This takes effect only when Transient Mark mode is enabled. */);
11671 Vselect_active_regions
= Qt
;
11673 DEFVAR_LISP ("saved-region-selection",
11674 Vsaved_region_selection
,
11675 doc
: /* Contents of active region prior to buffer modification.
11676 If `select-active-regions' is non-nil, Emacs sets this to the
11677 text in the region before modifying the buffer. The next call to
11678 the function `deactivate-mark' uses this to set the window selection. */);
11679 Vsaved_region_selection
= Qnil
;
11681 DEFVAR_LISP ("selection-inhibit-update-commands",
11682 Vselection_inhibit_update_commands
,
11683 doc
: /* List of commands which should not update the selection.
11684 Normally, if `select-active-regions' is non-nil and the mark remains
11685 active after a command (i.e. the mark was not deactivated), the Emacs
11686 command loop sets the selection to the text in the region. However,
11687 if the command is in this list, the selection is not updated. */);
11688 Vselection_inhibit_update_commands
11689 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11691 DEFVAR_LISP ("debug-on-event",
11693 doc
: /* Enter debugger on this event. When Emacs
11694 receives the special event specified by this variable, it will try to
11695 break into the debugger as soon as possible instead of processing the
11696 event normally through `special-event-map'.
11698 Currently, the only supported values for this
11699 variable are `sigusr1' and `sigusr2'. */);
11700 Vdebug_on_event
= intern_c_string ("sigusr2");
11702 /* Create the initial keyboard. Qt means 'unset'. */
11703 initial_kboard
= allocate_kboard (Qt
);
11707 keys_of_keyboard (void)
11709 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11710 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11711 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11712 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11713 initial_define_key (meta_map
, 'x', "execute-extended-command");
11715 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11716 "handle-delete-frame");
11717 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11718 "ns-put-working-text");
11719 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11720 "ns-unput-working-text");
11721 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11722 current-prefix-arg, as is done in `handle-switch-frame'.
11723 But `handle-switch-frame is not run from the special-map.
11724 Commands from that map are run in a special way that automatically
11725 preserves the prefix-arg. Restoring the prefix arg here is not just
11726 redundant but harmful:
11728 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11729 - after the first prompt, the exit-minibuffer-hook is run which may
11730 iconify a frame and thus push a `iconify-frame' event.
11731 - after running exit-minibuffer-hook, current-prefix-arg is
11732 restored to the non-nil value it had before the prompt.
11733 - we enter the second prompt.
11734 current-prefix-arg is non-nil, prefix-arg is nil.
11735 - before running the first real event, we run the special iconify-frame
11736 event, but we pass the `special' arg to execute-command so
11737 current-prefix-arg and prefix-arg are left untouched.
11738 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11739 - the next key event will have a spuriously non-nil current-prefix-arg. */
11740 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11742 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11744 /* Handling it at such a low-level causes read_key_sequence to get
11745 * confused because it doesn't realize that the current_buffer was
11746 * changed by read_char.
11748 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11749 * "handle-select-window"); */
11750 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11751 "handle-save-session");
11754 /* Define a special event which is raised for dbus callback
11756 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11757 "dbus-handle-event");
11760 #ifdef USE_FILE_NOTIFY
11761 /* Define a special event which is raised for notification callback
11763 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11764 "file-notify-handle-event");
11765 #endif /* USE_FILE_NOTIFY */
11767 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11769 #if defined (WINDOWSNT)
11770 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11773 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11774 "handle-focus-in");
11775 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11776 "handle-focus-out");