1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 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/>. */
22 #define BLOCKINPUT_INLINE EXTERN_INLINE
23 #define KEYBOARD_INLINE EXTERN_INLINE
31 #include "termhooks.h"
36 #include "character.h"
39 #include "dispextern.h"
41 #include "intervals.h"
43 #include "blockinput.h"
57 #include <sys/ioctl.h>
58 #endif /* not MSDOS */
60 #if defined USABLE_FIONREAD && defined USG5_4
61 # include <sys/filio.h>
64 #include "syssignal.h"
66 #include <sys/types.h>
70 #ifdef HAVE_WINDOW_SYSTEM
72 #endif /* HAVE_WINDOW_SYSTEM */
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
;
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 buffer that was current when the last command was started. */
213 static Lisp_Object last_point_position_buffer
;
215 /* The window that was selected when the last command was started. */
216 static Lisp_Object last_point_position_window
;
218 /* The frame in which the last input event occurred, or Qmacro if the
219 last event came from a macro. We use this to determine when to
220 generate switch-frame events. This may be cleared by functions
221 like Fselect_frame, to make sure that a switch-frame event is
222 generated by the next character.
224 FIXME: This is modified by a signal handler so it should be volatile.
225 It's exported to Lisp, though, so it can't simply be marked
227 Lisp_Object internal_last_event_frame
;
229 /* The timestamp of the last input event we received from the X server.
230 X Windows wants this for selection ownership. */
231 Time last_event_timestamp
;
233 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
234 static Lisp_Object Qhandle_select_window
;
235 Lisp_Object QPRIMARY
;
237 static Lisp_Object Qself_insert_command
;
238 static Lisp_Object Qforward_char
;
239 static Lisp_Object Qbackward_char
;
240 Lisp_Object Qundefined
;
241 static Lisp_Object Qtimer_event_handler
;
243 /* read_key_sequence stores here the command definition of the
244 key sequence that it reads. */
245 static Lisp_Object read_key_sequence_cmd
;
246 static Lisp_Object read_key_sequence_remapped
;
248 static Lisp_Object Qinput_method_function
;
250 static Lisp_Object Qdeactivate_mark
;
252 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
254 static Lisp_Object Qecho_area_clear_hook
;
256 /* Hooks to run before and after each command. */
257 static Lisp_Object Qpre_command_hook
;
258 static Lisp_Object Qpost_command_hook
;
260 static Lisp_Object Qdeferred_action_function
;
262 static Lisp_Object Qdelayed_warnings_hook
;
264 static Lisp_Object Qinput_method_exit_on_first_char
;
265 static Lisp_Object Qinput_method_use_echo_area
;
267 static Lisp_Object Qhelp_form_show
;
269 /* File in which we write all commands we read. */
270 static FILE *dribble
;
272 /* Nonzero if input is available. */
275 /* Circular buffer for pre-read keyboard input. */
277 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
279 /* Pointer to next available character in kbd_buffer.
280 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
281 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
282 next available char is in kbd_buffer[0]. */
283 static struct input_event
*kbd_fetch_ptr
;
285 /* Pointer to next place to store character in kbd_buffer. This
286 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
287 character should go in kbd_buffer[0]. */
288 static struct input_event
* volatile kbd_store_ptr
;
290 /* The above pair of variables forms a "queue empty" flag. When we
291 enqueue a non-hook event, we increment kbd_store_ptr. When we
292 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
293 there is input available if the two pointers are not equal.
295 Why not just have a flag set and cleared by the enqueuing and
296 dequeuing functions? Such a flag could be screwed up by interrupts
297 at inopportune times. */
299 /* Symbols to head events. */
300 static Lisp_Object Qmouse_movement
;
301 static Lisp_Object Qscroll_bar_movement
;
302 Lisp_Object Qswitch_frame
;
303 static Lisp_Object Qdelete_frame
;
304 static Lisp_Object Qiconify_frame
;
305 static Lisp_Object Qmake_frame_visible
;
306 static Lisp_Object Qselect_window
;
307 Lisp_Object Qhelp_echo
;
309 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
310 static Lisp_Object Qmouse_fixup_help_message
;
313 /* Symbols to denote kinds of events. */
314 static Lisp_Object Qfunction_key
;
315 Lisp_Object Qmouse_click
;
317 Lisp_Object Qlanguage_change
;
319 Lisp_Object Qfile_notify
;
322 static Lisp_Object Qdrag_n_drop
;
323 static Lisp_Object Qsave_session
;
325 static Lisp_Object Qdbus_event
;
327 static Lisp_Object Qconfig_changed_event
;
329 /* Lisp_Object Qmouse_movement; - also an event header */
331 /* Properties of event headers. */
332 Lisp_Object Qevent_kind
;
333 static Lisp_Object Qevent_symbol_elements
;
335 /* Menu and tool bar item parts. */
336 static Lisp_Object Qmenu_enable
;
337 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
338 Lisp_Object QCfilter
;
340 /* Non-nil disable property on a command means
341 do not execute it; call disabled-command-function's value instead. */
342 Lisp_Object QCtoggle
, QCradio
;
343 static Lisp_Object QCbutton
, QClabel
;
345 static Lisp_Object QCvert_only
;
347 /* An event header symbol HEAD may have a property named
348 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
349 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
350 mask of modifiers applied to it. If present, this is used to help
351 speed up parse_modifiers. */
352 Lisp_Object Qevent_symbol_element_mask
;
354 /* An unmodified event header BASE may have a property named
355 Qmodifier_cache, which is an alist mapping modifier masks onto
356 modified versions of BASE. If present, this helps speed up
358 static Lisp_Object Qmodifier_cache
;
360 /* Symbols to use for parts of windows. */
361 Lisp_Object Qmode_line
;
362 Lisp_Object Qvertical_line
;
363 static Lisp_Object Qvertical_scroll_bar
;
364 Lisp_Object Qmenu_bar
;
366 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
367 static Lisp_Object
command_loop (void);
368 static Lisp_Object Qextended_command_history
;
369 EMACS_TIME
timer_check (void);
371 static void echo_now (void);
372 static ptrdiff_t echo_length (void);
374 static Lisp_Object Qpolling_period
;
376 /* Incremented whenever a timer is run. */
379 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
381 EMACS_TIME
*input_available_clear_time
;
383 /* True means use SIGIO interrupts; false means use CBREAK mode.
384 Default is true if INTERRUPT_INPUT is defined. */
385 bool interrupt_input
;
387 /* Nonzero while interrupts are temporarily deferred during redisplay. */
388 bool interrupts_deferred
;
390 /* If we support a window system, turn on the code to poll periodically
391 to detect C-g. It isn't actually used when doing interrupt input. */
392 #ifdef HAVE_WINDOW_SYSTEM
393 #define POLL_FOR_INPUT
396 /* The time when Emacs started being idle. */
398 static EMACS_TIME timer_idleness_start_time
;
400 /* After Emacs stops being idle, this saves the last value
401 of timer_idleness_start_time from when it was idle. */
403 static EMACS_TIME timer_last_idleness_start_time
;
406 /* Global variable declarations. */
408 /* Flags for readable_events. */
409 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
410 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
411 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
413 /* Function for init_keyboard to call with no args (if nonzero). */
414 static void (*keyboard_init_hook
) (void);
416 static bool get_input_pending (int);
417 static bool readable_events (int);
418 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
419 Lisp_Object
, bool *);
420 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
422 static Lisp_Object
make_lispy_event (struct input_event
*);
423 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
424 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
425 enum scroll_bar_part
,
426 Lisp_Object
, Lisp_Object
,
429 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
430 Lisp_Object
, const char *const *,
431 Lisp_Object
*, ptrdiff_t);
432 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
433 static bool help_char_p (Lisp_Object
);
434 static void save_getcjmp (sys_jmp_buf
);
435 static void restore_getcjmp (sys_jmp_buf
);
436 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
437 static void clear_event (struct input_event
*);
438 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
440 static void deliver_input_available_signal (int signo
);
442 static void handle_interrupt (bool);
443 static _Noreturn
void quit_throw_to_read_char (bool);
444 static void process_special_events (void);
445 static void timer_start_idle (void);
446 static void timer_stop_idle (void);
447 static void timer_resume_idle (void);
448 static void deliver_user_signal (int);
449 static char *find_user_signal_name (int);
450 static void store_user_signal_events (void);
452 /* These setters are used only in this file, so they can be private. */
454 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
456 kb
->INTERNAL_FIELD (echo_string
) = val
;
459 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
461 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
464 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
466 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
469 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
471 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
474 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
476 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
479 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
481 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
484 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
486 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
489 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
491 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
494 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
496 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
500 /* Add C to the echo string, if echoing is going on.
501 C can be a character, which is printed prettily ("M-C-x" and all that
502 jazz), or a symbol, whose name is printed. */
505 echo_char (Lisp_Object c
)
507 if (current_kboard
->immediate_echo
)
509 int size
= KEY_DESCRIPTION_SIZE
+ 100;
510 char *buffer
= alloca (size
);
512 Lisp_Object echo_string
;
514 echo_string
= KVAR (current_kboard
, echo_string
);
516 /* If someone has passed us a composite event, use its head symbol. */
521 ptr
= push_key_description (XINT (c
), ptr
);
523 else if (SYMBOLP (c
))
525 Lisp_Object name
= SYMBOL_NAME (c
);
526 int nbytes
= SBYTES (name
);
528 if (size
- (ptr
- buffer
) < nbytes
)
530 int offset
= ptr
- buffer
;
531 size
= max (2 * size
, size
+ nbytes
);
532 buffer
= alloca (size
);
533 ptr
= buffer
+ offset
;
536 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
537 STRING_MULTIBYTE (name
), 1);
540 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
543 const char *text
= " (Type ? for further options)";
544 int len
= strlen (text
);
546 if (size
- (ptr
- buffer
) < len
)
548 int offset
= ptr
- buffer
;
550 buffer
= alloca (size
);
551 ptr
= buffer
+ offset
;
554 memcpy (ptr
, text
, len
);
558 /* Replace a dash from echo_dash with a space, otherwise
559 add a space at the end as a separator between keys. */
560 if (STRINGP (echo_string
)
561 && SCHARS (echo_string
) > 1)
563 Lisp_Object last_char
, prev_char
, idx
;
565 idx
= make_number (SCHARS (echo_string
) - 2);
566 prev_char
= Faref (echo_string
, idx
);
568 idx
= make_number (SCHARS (echo_string
) - 1);
569 last_char
= Faref (echo_string
, idx
);
571 /* We test PREV_CHAR to make sure this isn't the echoing
573 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
574 Faset (echo_string
, idx
, make_number (' '));
576 echo_string
= concat2 (echo_string
, build_string (" "));
578 else if (STRINGP (echo_string
))
579 echo_string
= concat2 (echo_string
, build_string (" "));
583 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
589 /* Temporarily add a dash to the end of the echo string if it's not
590 empty, so that it serves as a mini-prompt for the very next character. */
595 /* Do nothing if not echoing at all. */
596 if (NILP (KVAR (current_kboard
, echo_string
)))
599 if (this_command_key_count
== 0)
602 if (!current_kboard
->immediate_echo
603 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
606 /* Do nothing if we just printed a prompt. */
607 if (current_kboard
->echo_after_prompt
608 == SCHARS (KVAR (current_kboard
, echo_string
)))
611 /* Do nothing if we have already put a dash at the end. */
612 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
614 Lisp_Object last_char
, prev_char
, idx
;
616 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
617 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
619 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
620 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
622 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
626 /* Put a dash at the end of the buffer temporarily,
627 but make it go away when the next character is added. */
630 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
634 /* Display the current echo string, and begin echoing if not already
640 if (!current_kboard
->immediate_echo
)
643 current_kboard
->immediate_echo
= 1;
645 for (i
= 0; i
< this_command_key_count
; i
++)
649 /* Set before_command_echo_length to the value that would
650 have been saved before the start of this subcommand in
651 command_loop_1, if we had already been echoing then. */
652 if (i
== this_single_command_key_start
)
653 before_command_echo_length
= echo_length ();
655 c
= AREF (this_command_keys
, i
);
656 if (! (EVENT_HAS_PARAMETERS (c
)
657 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
661 /* Set before_command_echo_length to the value that would
662 have been saved before the start of this subcommand in
663 command_loop_1, if we had already been echoing then. */
664 if (this_command_key_count
== this_single_command_key_start
)
665 before_command_echo_length
= echo_length ();
667 /* Put a dash at the end to invite the user to type more. */
672 message3_nolog (KVAR (current_kboard
, echo_string
),
673 SBYTES (KVAR (current_kboard
, echo_string
)),
674 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
677 /* Record in what buffer we echoed, and from which kboard. */
678 echo_message_buffer
= echo_area_buffer
[0];
679 echo_kboard
= current_kboard
;
681 if (waiting_for_input
&& !NILP (Vquit_flag
))
682 quit_throw_to_read_char (0);
685 /* Turn off echoing, for the start of a new command. */
688 cancel_echoing (void)
690 current_kboard
->immediate_echo
= 0;
691 current_kboard
->echo_after_prompt
= -1;
692 kset_echo_string (current_kboard
, Qnil
);
693 ok_to_echo_at_next_pause
= NULL
;
695 echo_message_buffer
= Qnil
;
698 /* Return the length of the current echo string. */
703 return (STRINGP (KVAR (current_kboard
, echo_string
))
704 ? SCHARS (KVAR (current_kboard
, echo_string
))
708 /* Truncate the current echo message to its first LEN chars.
709 This and echo_char get used by read_key_sequence when the user
710 switches frames while entering a key sequence. */
713 echo_truncate (ptrdiff_t nchars
)
715 if (STRINGP (KVAR (current_kboard
, echo_string
)))
716 kset_echo_string (current_kboard
,
717 Fsubstring (KVAR (current_kboard
, echo_string
),
718 make_number (0), make_number (nchars
)));
719 truncate_echo_area (nchars
);
723 /* Functions for manipulating this_command_keys. */
725 add_command_key (Lisp_Object key
)
727 #if 0 /* Not needed after we made Freset_this_command_lengths
728 do the job immediately. */
729 /* If reset-this-command-length was called recently, obey it now.
730 See the doc string of that function for an explanation of why. */
731 if (before_command_restore_flag
)
733 this_command_key_count
= before_command_key_count_1
;
734 if (this_command_key_count
< this_single_command_key_start
)
735 this_single_command_key_start
= this_command_key_count
;
736 echo_truncate (before_command_echo_length_1
);
737 before_command_restore_flag
= 0;
741 if (this_command_key_count
>= ASIZE (this_command_keys
))
742 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
744 ASET (this_command_keys
, this_command_key_count
, key
);
745 ++this_command_key_count
;
750 recursive_edit_1 (void)
752 ptrdiff_t count
= SPECPDL_INDEX ();
755 if (command_loop_level
> 0)
757 specbind (Qstandard_output
, Qt
);
758 specbind (Qstandard_input
, Qt
);
761 #ifdef HAVE_WINDOW_SYSTEM
762 /* The command loop has started an hourglass timer, so we have to
763 cancel it here, otherwise it will fire because the recursive edit
764 can take some time. Do not check for display_hourglass_p here,
765 because it could already be nil. */
769 /* This function may have been called from a debugger called from
770 within redisplay, for instance by Edebugging a function called
771 from fontification-functions. We want to allow redisplay in
772 the debugging session.
774 The recursive edit is left with a `(throw exit ...)'. The `exit'
775 tag is not caught anywhere in redisplay, i.e. when we leave the
776 recursive edit, the original redisplay leading to the recursive
777 edit will be unwound. The outcome should therefore be safe. */
778 specbind (Qinhibit_redisplay
, Qnil
);
781 val
= command_loop ();
783 Fsignal (Qquit
, Qnil
);
784 /* Handle throw from read_minibuf when using minibuffer
785 while it's active but we're in another window. */
787 xsignal1 (Qerror
, val
);
789 return unbind_to (count
, Qnil
);
792 /* When an auto-save happens, record the "time", and don't do again soon. */
795 record_auto_save (void)
797 last_auto_save
= num_nonmacro_input_events
;
800 /* Make an auto save happen as soon as possible at command level. */
804 force_auto_save_soon (void)
806 last_auto_save
= - auto_save_interval
- 1;
808 record_asynch_buffer_change ();
812 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
813 doc
: /* Invoke the editor command loop recursively.
814 To get out of the recursive edit, a command can do `(throw 'exit nil)';
815 that tells this function to return.
816 Alternatively, `(throw 'exit t)' makes this function signal an error.
817 This function is called by the editor initialization to begin editing. */)
820 ptrdiff_t count
= SPECPDL_INDEX ();
823 /* If we enter while input is blocked, don't lock up here.
824 This may happen through the debugger during redisplay. */
825 if (input_blocked_p ())
828 command_loop_level
++;
829 update_mode_lines
= 1;
831 if (command_loop_level
832 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
833 buffer
= Fcurrent_buffer ();
837 /* If we leave recursive_edit_1 below with a `throw' for instance,
838 like it is done in the splash screen display, we have to
839 make sure that we restore single_kboard as command_loop_1
840 would have done if it were left normally. */
841 if (command_loop_level
> 0)
842 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
843 record_unwind_protect (recursive_edit_unwind
, buffer
);
846 return unbind_to (count
, Qnil
);
850 recursive_edit_unwind (Lisp_Object buffer
)
852 if (BUFFERP (buffer
))
853 Fset_buffer (buffer
);
855 command_loop_level
--;
856 update_mode_lines
= 1;
861 #if 0 /* These two functions are now replaced with
862 temporarily_switch_to_single_kboard. */
866 #if 0 /* Theory: if there's anything in Vunread_command_events,
867 it will right away be read by read_key_sequence,
868 and then if we do switch KBOARDS, it will go into the side
869 queue then. So we don't need to do anything special here -- rms. */
870 if (CONSP (Vunread_command_events
))
872 current_kboard
->kbd_queue
873 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
874 current_kboard
->kbd_queue_has_data
= 1;
876 Vunread_command_events
= Qnil
;
881 /* Switch to the single-kboard state, making current_kboard
882 the only KBOARD from which further input is accepted. */
885 single_kboard_state ()
891 /* If we're in single_kboard state for kboard KBOARD,
895 not_single_kboard_state (KBOARD
*kboard
)
897 if (kboard
== current_kboard
)
901 /* Maintain a stack of kboards, so other parts of Emacs
902 can switch temporarily to the kboard of a given frame
903 and then revert to the previous status. */
908 struct kboard_stack
*next
;
911 static struct kboard_stack
*kboard_stack
;
914 push_kboard (struct kboard
*k
)
916 struct kboard_stack
*p
= xmalloc (sizeof *p
);
918 p
->next
= kboard_stack
;
919 p
->kboard
= current_kboard
;
929 struct kboard_stack
*p
= kboard_stack
;
931 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
933 if (t
->kboard
== p
->kboard
)
935 current_kboard
= p
->kboard
;
942 /* The terminal we remembered has been deleted. */
943 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
946 kboard_stack
= p
->next
;
950 /* Switch to single_kboard mode, making current_kboard the only KBOARD
951 from which further input is accepted. If F is non-nil, set its
952 KBOARD as the current keyboard.
954 This function uses record_unwind_protect to return to the previous
957 If Emacs is already in single_kboard mode, and F's keyboard is
958 locked, then this function will throw an error. */
961 temporarily_switch_to_single_kboard (struct frame
*f
)
963 bool was_locked
= single_kboard
;
966 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
967 /* We can not switch keyboards while in single_kboard mode.
968 In rare cases, Lisp code may call `recursive-edit' (or
969 `read-minibuffer' or `y-or-n-p') after it switched to a
970 locked frame. For example, this is likely to happen
971 when server.el connects to a new terminal while Emacs is in
972 single_kboard mode. It is best to throw an error instead
973 of presenting the user with a frozen screen. */
974 error ("Terminal %d is locked, cannot read from it",
975 FRAME_TERMINAL (f
)->id
);
977 /* This call is unnecessary, but helps
978 `restore_kboard_configuration' discover if somebody changed
979 `current_kboard' behind our back. */
980 push_kboard (current_kboard
);
983 current_kboard
= FRAME_KBOARD (f
);
985 record_unwind_protect (restore_kboard_configuration
,
986 (was_locked
? Qt
: Qnil
));
989 #if 0 /* This function is not needed anymore. */
991 record_single_kboard_state ()
994 push_kboard (current_kboard
);
995 record_unwind_protect (restore_kboard_configuration
,
996 (single_kboard
? Qt
: Qnil
));
1001 restore_kboard_configuration (Lisp_Object was_locked
)
1003 if (NILP (was_locked
))
1007 struct kboard
*prev
= current_kboard
;
1010 /* The pop should not change the kboard. */
1011 if (single_kboard
&& current_kboard
!= prev
)
1018 /* Handle errors that are not handled at inner levels
1019 by printing an error message and returning to the editor command loop. */
1022 cmd_error (Lisp_Object data
)
1024 Lisp_Object old_level
, old_length
;
1025 char macroerror
[sizeof "After..kbd macro iterations: "
1026 + INT_STRLEN_BOUND (EMACS_INT
)];
1028 #ifdef HAVE_WINDOW_SYSTEM
1029 if (display_hourglass_p
)
1030 cancel_hourglass ();
1033 if (!NILP (executing_kbd_macro
))
1035 if (executing_kbd_macro_iterations
== 1)
1036 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1038 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1039 executing_kbd_macro_iterations
);
1044 Vstandard_output
= Qt
;
1045 Vstandard_input
= Qt
;
1046 Vexecuting_kbd_macro
= Qnil
;
1047 executing_kbd_macro
= Qnil
;
1048 kset_prefix_arg (current_kboard
, Qnil
);
1049 kset_last_prefix_arg (current_kboard
, Qnil
);
1052 /* Avoid unquittable loop if data contains a circular list. */
1053 old_level
= Vprint_level
;
1054 old_length
= Vprint_length
;
1055 XSETFASTINT (Vprint_level
, 10);
1056 XSETFASTINT (Vprint_length
, 10);
1057 cmd_error_internal (data
, macroerror
);
1058 Vprint_level
= old_level
;
1059 Vprint_length
= old_length
;
1062 Vinhibit_quit
= Qnil
;
1064 return make_number (0);
1067 /* Take actions on handling an error. DATA is the data that describes
1070 CONTEXT is a C-string containing ASCII characters only which
1071 describes the context in which the error happened. If we need to
1072 generalize CONTEXT to allow multibyte characters, make it a Lisp
1076 cmd_error_internal (Lisp_Object data
, const char *context
)
1078 struct frame
*sf
= SELECTED_FRAME ();
1080 /* The immediate context is not interesting for Quits,
1081 since they are asynchronous. */
1082 if (EQ (XCAR (data
), Qquit
))
1083 Vsignaling_function
= Qnil
;
1088 /* Use user's specified output function if any. */
1089 if (!NILP (Vcommand_error_function
))
1090 call3 (Vcommand_error_function
, data
,
1091 context
? build_string (context
) : empty_unibyte_string
,
1092 Vsignaling_function
);
1093 /* If the window system or terminal frame hasn't been initialized
1094 yet, or we're not interactive, write the message to stderr and exit. */
1095 else if (!sf
->glyphs_initialized_p
1096 /* The initial frame is a special non-displaying frame. It
1097 will be current in daemon mode when there are no frames
1098 to display, and in non-daemon mode before the real frame
1099 has finished initializing. If an error is thrown in the
1100 latter case while creating the frame, then the frame
1101 will never be displayed, so the safest thing to do is
1102 write to stderr and quit. In daemon mode, there are
1103 many other potential errors that do not prevent frames
1104 from being created, so continuing as normal is better in
1106 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1109 print_error_message (data
, Qexternal_debugging_output
,
1110 context
, Vsignaling_function
);
1111 Fterpri (Qexternal_debugging_output
);
1112 Fkill_emacs (make_number (-1));
1116 clear_message (1, 0);
1118 message_log_maybe_newline ();
1121 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1124 Vsignaling_function
= Qnil
;
1127 Lisp_Object
command_loop_1 (void);
1128 static Lisp_Object
command_loop_2 (Lisp_Object
);
1129 static Lisp_Object
top_level_1 (Lisp_Object
);
1131 /* Entry to editor-command-loop.
1132 This level has the catches for exiting/returning to editor command loop.
1133 It returns nil to exit recursive edit, t to abort it. */
1138 if (command_loop_level
> 0 || minibuf_level
> 0)
1141 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1142 executing_kbd_macro
= Qnil
;
1148 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1149 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1150 executing_kbd_macro
= Qnil
;
1152 /* End of file in -batch run causes exit here. */
1158 /* Here we catch errors in execution of commands within the
1159 editing loop, and reenter the editing loop.
1160 When there is an error, cmd_error runs and returns a non-nil
1161 value to us. A value of nil means that command_loop_1 itself
1162 returned due to end of file (or end of kbd macro). */
1165 command_loop_2 (Lisp_Object ignore
)
1167 register Lisp_Object val
;
1170 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1171 while (!NILP (val
));
1179 return Feval (Vtop_level
, Qnil
);
1183 top_level_1 (Lisp_Object ignore
)
1185 /* On entry to the outer level, run the startup file */
1186 if (!NILP (Vtop_level
))
1187 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1188 else if (!NILP (Vpurify_flag
))
1189 message ("Bare impure Emacs (standard Lisp code not loaded)");
1191 message ("Bare Emacs (standard Lisp code not loaded)");
1195 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1196 doc
: /* Exit all recursive editing levels.
1197 This also exits all active minibuffers. */)
1200 #ifdef HAVE_WINDOW_SYSTEM
1201 if (display_hourglass_p
)
1202 cancel_hourglass ();
1205 /* Unblock input if we enter with input blocked. This may happen if
1206 redisplay traps e.g. during tool-bar update with input blocked. */
1207 totally_unblock_input ();
1209 Fthrow (Qtop_level
, Qnil
);
1212 static _Noreturn
void
1213 user_error (const char *msg
)
1215 xsignal1 (Quser_error
, build_string (msg
));
1219 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1220 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1223 if (command_loop_level
> 0 || minibuf_level
> 0)
1224 Fthrow (Qexit
, Qnil
);
1226 user_error ("No recursive edit is in progress");
1230 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1231 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1234 if (command_loop_level
> 0 || minibuf_level
> 0)
1237 user_error ("No recursive edit is in progress");
1240 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1242 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1243 of this function. */
1246 tracking_off (Lisp_Object old_value
)
1248 do_mouse_tracking
= old_value
;
1249 if (NILP (old_value
))
1251 /* Redisplay may have been preempted because there was input
1252 available, and it assumes it will be called again after the
1253 input has been processed. If the only input available was
1254 the sort that we have just disabled, then we need to call
1256 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1258 redisplay_preserve_echo_area (6);
1259 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1265 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1266 doc
: /* Evaluate BODY with mouse movement events enabled.
1267 Within a `track-mouse' form, mouse motion generates input events that
1268 you can read with `read-event'.
1269 Normally, mouse motion is ignored.
1270 usage: (track-mouse BODY...) */)
1273 ptrdiff_t count
= SPECPDL_INDEX ();
1276 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1278 do_mouse_tracking
= Qt
;
1280 val
= Fprogn (args
);
1281 return unbind_to (count
, val
);
1284 /* If mouse has moved on some frame, return one of those frames.
1288 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1289 after resizing the tool-bar window. */
1291 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1294 bool ignore_mouse_drag_p
;
1297 some_mouse_moved (void)
1299 Lisp_Object tail
, frame
;
1301 if (ignore_mouse_drag_p
)
1303 /* ignore_mouse_drag_p = 0; */
1307 FOR_EACH_FRAME (tail
, frame
)
1309 if (XFRAME (frame
)->mouse_moved
)
1310 return XFRAME (frame
);
1316 #endif /* HAVE_MOUSE || HAVE_GPM */
1318 /* This is the actual command reading loop,
1319 sans error-handling encapsulation. */
1321 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1323 void safe_run_hooks (Lisp_Object
);
1324 static void adjust_point_for_property (ptrdiff_t, bool);
1326 /* Cancel hourglass from protect_unwind.
1328 #ifdef HAVE_WINDOW_SYSTEM
1330 cancel_hourglass_unwind (Lisp_Object arg
)
1332 cancel_hourglass ();
1337 /* The last boundary auto-added to buffer-undo-list. */
1338 Lisp_Object last_undo_boundary
;
1340 /* FIXME: This is wrong rather than test window-system, we should call
1341 a new set-selection, which will then dispatch to x-set-selection, or
1342 tty-set-selection, or w32-set-selection, ... */
1345 command_loop_1 (void)
1348 Lisp_Object keybuf
[30];
1350 EMACS_INT prev_modiff
= 0;
1351 struct buffer
*prev_buffer
= NULL
;
1352 bool already_adjusted
= 0;
1354 kset_prefix_arg (current_kboard
, Qnil
);
1355 kset_last_prefix_arg (current_kboard
, Qnil
);
1356 Vdeactivate_mark
= Qnil
;
1357 waiting_for_input
= 0;
1360 this_command_key_count
= 0;
1361 this_command_key_count_reset
= 0;
1362 this_single_command_key_start
= 0;
1364 if (NILP (Vmemory_full
))
1366 /* Make sure this hook runs after commands that get errors and
1367 throw to top level. */
1368 /* Note that the value cell will never directly contain nil
1369 if the symbol is a local variable. */
1370 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1371 safe_run_hooks (Qpost_command_hook
);
1373 /* If displaying a message, resize the echo area window to fit
1374 that message's size exactly. */
1375 if (!NILP (echo_area_buffer
[0]))
1376 resize_echo_area_exactly ();
1378 /* If there are warnings waiting, process them. */
1379 if (!NILP (Vdelayed_warnings_list
))
1380 safe_run_hooks (Qdelayed_warnings_hook
);
1382 if (!NILP (Vdeferred_action_list
))
1383 safe_run_hooks (Qdeferred_action_function
);
1386 /* Do this after running Vpost_command_hook, for consistency. */
1387 kset_last_command (current_kboard
, Vthis_command
);
1388 kset_real_last_command (current_kboard
, Vreal_this_command
);
1389 if (!CONSP (last_command_event
))
1390 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1394 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1397 /* Make sure the current window's buffer is selected. */
1398 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1400 /* Display any malloc warning that just came out. Use while because
1401 displaying one warning can cause another. */
1403 while (pending_malloc_warning
)
1404 display_malloc_warning ();
1406 Vdeactivate_mark
= Qnil
;
1408 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1410 /* Don't ignore mouse movements for more than a single command
1411 loop. (This flag is set in xdisp.c whenever the tool bar is
1412 resized, because the resize moves text up or down, and would
1413 generate false mouse drag events if we don't ignore them.) */
1414 ignore_mouse_drag_p
= 0;
1417 /* If minibuffer on and echo area in use,
1418 wait a short time and redraw minibuffer. */
1421 && !NILP (echo_area_buffer
[0])
1422 && EQ (minibuf_window
, echo_area_window
)
1423 && NUMBERP (Vminibuffer_message_timeout
))
1425 /* Bind inhibit-quit to t so that C-g gets read in
1426 rather than quitting back to the minibuffer. */
1427 ptrdiff_t count
= SPECPDL_INDEX ();
1428 specbind (Qinhibit_quit
, Qt
);
1430 sit_for (Vminibuffer_message_timeout
, 0, 2);
1432 /* Clear the echo area. */
1434 safe_run_hooks (Qecho_area_clear_hook
);
1436 unbind_to (count
, Qnil
);
1438 /* If a C-g came in before, treat it as input now. */
1439 if (!NILP (Vquit_flag
))
1442 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1446 /* If it has changed current-menubar from previous value,
1447 really recompute the menubar from the value. */
1448 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1449 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1450 call0 (Qrecompute_lucid_menubar
);
1452 before_command_key_count
= this_command_key_count
;
1453 before_command_echo_length
= echo_length ();
1455 Vthis_command
= Qnil
;
1456 Vreal_this_command
= Qnil
;
1457 Vthis_original_command
= Qnil
;
1458 Vthis_command_keys_shift_translated
= Qnil
;
1460 /* Read next key sequence; i gets its length. */
1461 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1464 /* A filter may have run while we were reading the input. */
1465 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1467 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1471 /* Now we have read a key sequence of length I,
1472 or else I is 0 and we found end of file. */
1474 if (i
== 0) /* End of file -- happens only in */
1475 return Qnil
; /* a kbd macro, at the end. */
1476 /* -1 means read_key_sequence got a menu that was rejected.
1477 Just loop around and read another command. */
1481 this_command_key_count
= 0;
1482 this_command_key_count_reset
= 0;
1483 this_single_command_key_start
= 0;
1487 last_command_event
= keybuf
[i
- 1];
1489 /* If the previous command tried to force a specific window-start,
1490 forget about that, in case this command moves point far away
1491 from that position. But also throw away beg_unchanged and
1492 end_unchanged information in that case, so that redisplay will
1493 update the whole window properly. */
1494 if (XWINDOW (selected_window
)->force_start
)
1497 XWINDOW (selected_window
)->force_start
= 0;
1498 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1499 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1502 cmd
= read_key_sequence_cmd
;
1503 if (!NILP (Vexecuting_kbd_macro
))
1505 if (!NILP (Vquit_flag
))
1507 Vexecuting_kbd_macro
= Qt
;
1508 QUIT
; /* Make some noise. */
1509 /* Will return since macro now empty. */
1513 /* Do redisplay processing after this command except in special
1514 cases identified below. */
1515 prev_buffer
= current_buffer
;
1516 prev_modiff
= MODIFF
;
1517 last_point_position
= PT
;
1518 last_point_position_window
= selected_window
;
1519 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1521 /* By default, we adjust point to a boundary of a region that
1522 has such a property that should be treated intangible
1523 (e.g. composition, display). But, some commands will set
1524 this variable differently. */
1525 Vdisable_point_adjustment
= Qnil
;
1527 /* Process filters and timers may have messed with deactivate-mark.
1528 reset it before we execute the command. */
1529 Vdeactivate_mark
= Qnil
;
1531 /* Remap command through active keymaps. */
1532 Vthis_original_command
= cmd
;
1533 if (!NILP (read_key_sequence_remapped
))
1534 cmd
= read_key_sequence_remapped
;
1536 /* Execute the command. */
1538 Vthis_command
= cmd
;
1539 Vreal_this_command
= cmd
;
1540 safe_run_hooks (Qpre_command_hook
);
1542 already_adjusted
= 0;
1544 if (NILP (Vthis_command
))
1546 /* nil means key is undefined. */
1547 Lisp_Object keys
= Fvector (i
, keybuf
);
1548 keys
= Fkey_description (keys
, Qnil
);
1550 message_with_string ("%s is undefined", keys
, 0);
1551 kset_defining_kbd_macro (current_kboard
, Qnil
);
1552 update_mode_lines
= 1;
1553 /* If this is a down-mouse event, don't reset prefix-arg;
1554 pass it to the command run by the up event. */
1555 if (EVENT_HAS_PARAMETERS (last_command_event
))
1557 Lisp_Object breakdown
1558 = parse_modifiers (EVENT_HEAD (last_command_event
));
1559 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1560 if (!(modifiers
& down_modifier
))
1561 kset_prefix_arg (current_kboard
, Qnil
);
1564 kset_prefix_arg (current_kboard
, Qnil
);
1568 /* Here for a command that isn't executed directly. */
1570 #ifdef HAVE_WINDOW_SYSTEM
1571 ptrdiff_t scount
= SPECPDL_INDEX ();
1573 if (display_hourglass_p
1574 && NILP (Vexecuting_kbd_macro
))
1576 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1581 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1583 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1586 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1587 ? Qnil
: BVAR (current_buffer
, undo_list
));
1589 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1591 #ifdef HAVE_WINDOW_SYSTEM
1592 /* Do not check display_hourglass_p here, because
1593 Fcommand_execute could change it, but we should cancel
1594 hourglass cursor anyway.
1595 But don't cancel the hourglass within a macro
1596 just because a command in the macro finishes. */
1597 if (NILP (Vexecuting_kbd_macro
))
1598 unbind_to (scount
, Qnil
);
1601 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1603 safe_run_hooks (Qpost_command_hook
);
1605 /* If displaying a message, resize the echo area window to fit
1606 that message's size exactly. */
1607 if (!NILP (echo_area_buffer
[0]))
1608 resize_echo_area_exactly ();
1610 /* If there are warnings waiting, process them. */
1611 if (!NILP (Vdelayed_warnings_list
))
1612 safe_run_hooks (Qdelayed_warnings_hook
);
1614 safe_run_hooks (Qdeferred_action_function
);
1616 /* If there is a prefix argument,
1617 1) We don't want Vlast_command to be ``universal-argument''
1618 (that would be dumb), so don't set Vlast_command,
1619 2) we want to leave echoing on so that the prefix will be
1620 echoed as part of this key sequence, so don't call
1622 3) we want to leave this_command_key_count non-zero, so that
1623 read_char will realize that it is re-reading a character, and
1624 not echo it a second time.
1626 If the command didn't actually create a prefix arg,
1627 but is merely a frame event that is transparent to prefix args,
1628 then the above doesn't apply. */
1629 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1630 || CONSP (last_command_event
))
1632 kset_last_command (current_kboard
, Vthis_command
);
1633 kset_real_last_command (current_kboard
, Vreal_this_command
);
1634 if (!CONSP (last_command_event
))
1635 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1637 this_command_key_count
= 0;
1638 this_command_key_count_reset
= 0;
1639 this_single_command_key_start
= 0;
1642 if (!NILP (BVAR (current_buffer
, mark_active
))
1643 && !NILP (Vrun_hooks
))
1645 /* In Emacs 22, setting transient-mark-mode to `only' was a
1646 way of turning it on for just one command. This usage is
1647 obsolete, but support it anyway. */
1648 if (EQ (Vtransient_mark_mode
, Qidentity
))
1649 Vtransient_mark_mode
= Qnil
;
1650 else if (EQ (Vtransient_mark_mode
, Qonly
))
1651 Vtransient_mark_mode
= Qidentity
;
1653 if (!NILP (Vdeactivate_mark
))
1654 /* If `select-active-regions' is non-nil, this call to
1655 `deactivate-mark' also sets the PRIMARY selection. */
1656 call0 (Qdeactivate_mark
);
1659 /* Even if not deactivating the mark, set PRIMARY if
1660 `select-active-regions' is non-nil. */
1661 if (!NILP (Fwindow_system (Qnil
))
1662 /* Even if mark_active is non-nil, the actual buffer
1663 marker may not have been set yet (Bug#7044). */
1664 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1665 && (EQ (Vselect_active_regions
, Qonly
)
1666 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1667 : (!NILP (Vselect_active_regions
)
1668 && !NILP (Vtransient_mark_mode
)))
1669 && NILP (Fmemq (Vthis_command
,
1670 Vselection_inhibit_update_commands
)))
1673 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1676 call2 (Qx_set_selection
, QPRIMARY
,
1677 make_buffer_string (beg
, end
, 0));
1679 call2 (Qx_set_selection
, QPRIMARY
,
1680 make_buffer_string (end
, beg
, 0));
1681 /* Don't set empty selections. */
1684 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1686 Lisp_Object hook
= intern ("activate-mark-hook");
1687 Frun_hooks (1, &hook
);
1691 Vsaved_region_selection
= Qnil
;
1696 if (current_buffer
== prev_buffer
1697 && last_point_position
!= PT
1698 && NILP (Vdisable_point_adjustment
)
1699 && NILP (Vglobal_disable_point_adjustment
))
1701 if (last_point_position
> BEGV
1702 && last_point_position
< ZV
1703 && (composition_adjust_point (last_point_position
,
1704 last_point_position
)
1705 != last_point_position
))
1706 /* The last point was temporarily set within a grapheme
1707 cluster to prevent automatic composition. To recover
1708 the automatic composition, we must update the
1710 windows_or_buffers_changed
++;
1711 if (!already_adjusted
)
1712 adjust_point_for_property (last_point_position
,
1713 MODIFF
!= prev_modiff
);
1716 /* Install chars successfully executed in kbd macro. */
1718 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1719 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1720 finalize_kbd_macro_chars ();
1724 /* Adjust point to a boundary of a region that has such a property
1725 that should be treated intangible. For the moment, we check
1726 `composition', `display' and `invisible' properties.
1727 LAST_PT is the last position of point. */
1730 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1733 Lisp_Object val
, overlay
, tmp
;
1734 /* When called after buffer modification, we should temporarily
1735 suppress the point adjustment for automatic composition so that a
1736 user can keep inserting another character at point or keep
1737 deleting characters around point. */
1738 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1739 ptrdiff_t orig_pt
= PT
;
1741 /* FIXME: cycling is probably not necessary because these properties
1742 can't be usefully combined anyway. */
1743 while (check_composition
|| check_display
|| check_invisible
)
1745 /* FIXME: check `intangible'. */
1746 if (check_composition
1747 && PT
> BEGV
&& PT
< ZV
1748 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1751 check_display
= check_invisible
= 1;
1753 check_composition
= 0;
1755 && PT
> BEGV
&& PT
< ZV
1756 && !NILP (val
= get_char_property_and_overlay
1757 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1758 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1759 && (!OVERLAYP (overlay
)
1760 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1761 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1762 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1763 && (beg
< PT
/* && end > PT <- It's always the case. */
1764 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1767 SET_PT (PT
< last_pt
1768 ? (STRINGP (val
) && SCHARS (val
) == 0
1769 ? max (beg
- 1, BEGV
)
1772 check_composition
= check_invisible
= 1;
1775 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1781 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1784 /* FIXME: We should stop if we find a spot between
1785 two runs of `invisible' where inserted text would
1786 be visible. This is important when we have two
1787 invisible boundaries that enclose an area: if the
1788 area is empty, we need this test in order to make
1789 it possible to place point in the middle rather
1790 than skip both boundaries. However, this code
1791 also stops anywhere in a non-sticky text-property,
1792 which breaks (e.g.) Org mode. */
1793 && (val
= get_pos_property (make_number (end
),
1795 TEXT_PROP_MEANS_INVISIBLE (val
))
1797 && !NILP (val
= get_char_property_and_overlay
1798 (make_number (end
), 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
= Fnext_single_char_property_change
1806 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1807 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1811 && (val
= get_pos_property (make_number (beg
),
1813 TEXT_PROP_MEANS_INVISIBLE (val
))
1815 && !NILP (val
= get_char_property_and_overlay
1816 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1817 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1819 ellipsis
= ellipsis
|| inv
> 1
1820 || (OVERLAYP (overlay
)
1821 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1822 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1823 tmp
= Fprevious_single_char_property_change
1824 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1825 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1828 /* Move away from the inside area. */
1829 if (beg
< PT
&& end
> PT
)
1831 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1832 /* We haven't moved yet (so we don't need to fear
1833 infinite-looping) and we were outside the range
1834 before (so either end of the range still corresponds
1835 to a move in the right direction): pretend we moved
1836 less than we actually did, so that we still have
1837 more freedom below in choosing which end of the range
1839 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1840 /* We either have moved already or the last point
1841 was already in the range: we don't get to choose
1842 which end of the range we have to go to. */
1843 : (PT
< last_pt
? beg
: end
));
1844 check_composition
= check_display
= 1;
1846 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1847 the point to something other than its argument, due to
1848 point-motion hooks, intangibility, etc. */
1849 eassert (PT
== beg
|| PT
== end
);
1852 /* Pretend the area doesn't exist if the buffer is not
1854 if (!modified
&& !ellipsis
&& beg
< end
)
1856 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1857 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1858 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1859 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1860 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1861 /* We've already moved as far as we can. Trying to go
1862 to the other end would mean moving backwards and thus
1863 could lead to an infinite loop. */
1865 else if (val
= get_pos_property (make_number (PT
),
1867 TEXT_PROP_MEANS_INVISIBLE (val
)
1868 && (val
= get_pos_property
1869 (make_number (PT
== beg
? end
: beg
),
1871 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1872 (check_composition
= check_display
= 1,
1873 SET_PT (PT
== beg
? end
: beg
));
1876 check_invisible
= 0;
1880 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1883 safe_run_hooks_1 (void)
1885 eassert (CONSP (Vinhibit_quit
));
1886 return call0 (XCDR (Vinhibit_quit
));
1889 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1893 safe_run_hooks_error (Lisp_Object error_data
)
1896 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1897 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1898 Lisp_Object args
[4];
1899 args
[0] = build_string ("Error in %s (%s): %S");
1902 args
[3] = error_data
;
1908 Lisp_Object newval
= Qnil
;
1909 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1910 if (EQ (fun
, XCAR (val
)))
1913 newval
= Fcons (XCAR (val
), newval
);
1915 return Fset (hook
, Fnreverse (newval
));
1916 /* Not found in the local part of the hook. Let's look at the global
1919 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1920 : Fdefault_value (hook
));
1921 CONSP (val
); val
= XCDR (val
))
1922 if (EQ (fun
, XCAR (val
)))
1925 newval
= Fcons (XCAR (val
), newval
);
1927 return Fset_default (hook
, Fnreverse (newval
));
1933 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1935 eassert (nargs
== 1);
1936 if (CONSP (Vinhibit_quit
))
1937 XSETCDR (Vinhibit_quit
, args
[0]);
1939 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1941 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1945 /* If we get an error while running the hook, cause the hook variable
1946 to be nil. Also inhibit quits, so that C-g won't cause the hook
1947 to mysteriously evaporate. */
1950 safe_run_hooks (Lisp_Object hook
)
1952 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1953 to its body or to its handlers other than via globals such as
1954 dynamically-bound variables ;-) */
1955 ptrdiff_t count
= SPECPDL_INDEX ();
1956 specbind (Qinhibit_quit
, hook
);
1958 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1960 unbind_to (count
, Qnil
);
1964 /* Nonzero means polling for input is temporarily suppressed. */
1966 int poll_suppress_count
;
1969 #ifdef POLL_FOR_INPUT
1971 /* Asynchronous timer for polling. */
1973 static struct atimer
*poll_timer
;
1975 /* Poll for input, so that we catch a C-g if it comes in. This
1976 function is called from x_make_frame_visible, see comment
1980 poll_for_input_1 (void)
1982 if (! input_blocked_p ()
1983 && !waiting_for_input
)
1987 /* Timer callback function for poll_timer. TIMER is equal to
1991 poll_for_input (struct atimer
*timer
)
1993 if (poll_suppress_count
== 0)
1994 pending_signals
= 1;
1997 #endif /* POLL_FOR_INPUT */
1999 /* Begin signals to poll for input, if they are appropriate.
2000 This function is called unconditionally from various places. */
2003 start_polling (void)
2005 #ifdef POLL_FOR_INPUT
2006 /* XXX This condition was (read_socket_hook && !interrupt_input),
2007 but read_socket_hook is not global anymore. Let's pretend that
2009 if (!interrupt_input
)
2011 /* Turn alarm handling on unconditionally. It might have
2012 been turned off in process.c. */
2013 turn_on_atimers (1);
2015 /* If poll timer doesn't exist, are we need one with
2016 a different interval, start a new one. */
2017 if (poll_timer
== NULL
2018 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2020 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2021 EMACS_TIME interval
= make_emacs_time (period
, 0);
2024 cancel_atimer (poll_timer
);
2026 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2027 poll_for_input
, NULL
);
2030 /* Let the timer's callback function poll for input
2031 if this becomes zero. */
2032 --poll_suppress_count
;
2037 /* True if we are using polling to handle input asynchronously. */
2040 input_polling_used (void)
2042 #ifdef POLL_FOR_INPUT
2043 /* XXX This condition was (read_socket_hook && !interrupt_input),
2044 but read_socket_hook is not global anymore. Let's pretend that
2046 return !interrupt_input
;
2052 /* Turn off polling. */
2057 #ifdef POLL_FOR_INPUT
2058 /* XXX This condition was (read_socket_hook && !interrupt_input),
2059 but read_socket_hook is not global anymore. Let's pretend that
2061 if (!interrupt_input
)
2062 ++poll_suppress_count
;
2066 /* Set the value of poll_suppress_count to COUNT
2067 and start or stop polling accordingly. */
2070 set_poll_suppress_count (int count
)
2072 #ifdef POLL_FOR_INPUT
2073 if (count
== 0 && poll_suppress_count
!= 0)
2075 poll_suppress_count
= 1;
2078 else if (count
!= 0 && poll_suppress_count
== 0)
2082 poll_suppress_count
= count
;
2086 /* Bind polling_period to a value at least N.
2087 But don't decrease it. */
2090 bind_polling_period (int n
)
2092 #ifdef POLL_FOR_INPUT
2093 EMACS_INT
new = polling_period
;
2098 stop_other_atimers (poll_timer
);
2100 specbind (Qpolling_period
, make_number (new));
2101 /* Start a new alarm with the new period. */
2106 /* Apply the control modifier to CHARACTER. */
2109 make_ctrl_char (int c
)
2111 /* Save the upper bits here. */
2112 int upper
= c
& ~0177;
2114 if (! ASCII_BYTE_P (c
))
2115 return c
|= ctrl_modifier
;
2119 /* Everything in the columns containing the upper-case letters
2120 denotes a control character. */
2121 if (c
>= 0100 && c
< 0140)
2125 /* Set the shift modifier for a control char
2126 made from a shifted letter. But only for letters! */
2127 if (oc
>= 'A' && oc
<= 'Z')
2128 c
|= shift_modifier
;
2131 /* The lower-case letters denote control characters too. */
2132 else if (c
>= 'a' && c
<= 'z')
2135 /* Include the bits for control and shift
2136 only if the basic ASCII code can't indicate them. */
2140 /* Replace the high bits. */
2141 c
|= (upper
& ~ctrl_modifier
);
2146 /* Display the help-echo property of the character after the mouse pointer.
2147 Either show it in the echo area, or call show-help-function to display
2148 it by other means (maybe in a tooltip).
2150 If HELP is nil, that means clear the previous help echo.
2152 If HELP is a string, display that string. If HELP is a function,
2153 call it with OBJECT and POS as arguments; the function should
2154 return a help string or nil for none. For all other types of HELP,
2155 evaluate it to obtain a string.
2157 WINDOW is the window in which the help was generated, if any.
2158 It is nil if not in a window.
2160 If OBJECT is a buffer, POS is the position in the buffer where the
2161 `help-echo' text property was found.
2163 If OBJECT is an overlay, that overlay has a `help-echo' property,
2164 and POS is the position in the overlay's buffer under the mouse.
2166 If OBJECT is a string (an overlay string or a string displayed with
2167 the `display' property). POS is the position in that string under
2170 Note: this function may only be called with HELP nil or a string
2171 from X code running asynchronously. */
2174 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2177 if (!NILP (help
) && !STRINGP (help
))
2179 if (FUNCTIONP (help
))
2180 help
= safe_call (4, help
, window
, object
, pos
);
2182 help
= safe_eval (help
);
2184 if (!STRINGP (help
))
2188 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2189 if (!noninteractive
&& STRINGP (help
))
2191 /* The mouse-fixup-help-message Lisp function can call
2192 mouse_position_hook, which resets the mouse_moved flags.
2193 This causes trouble if we are trying to read a mouse motion
2194 event (i.e., if we are inside a `track-mouse' form), so we
2195 restore the mouse_moved flag. */
2196 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2197 help
= call1 (Qmouse_fixup_help_message
, help
);
2203 if (STRINGP (help
) || NILP (help
))
2205 if (!NILP (Vshow_help_function
))
2206 call1 (Vshow_help_function
, help
);
2207 help_echo_showing_p
= STRINGP (help
);
2213 /* Input of single characters from keyboard */
2215 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2216 EMACS_TIME
*end_time
);
2217 static void record_char (Lisp_Object c
);
2219 static Lisp_Object help_form_saved_window_configs
;
2221 read_char_help_form_unwind (Lisp_Object arg
)
2223 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2224 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2225 if (!NILP (window_config
))
2226 Fset_window_configuration (window_config
);
2230 #define STOP_POLLING \
2231 do { if (! polling_stopped_here) stop_polling (); \
2232 polling_stopped_here = 1; } while (0)
2234 #define RESUME_POLLING \
2235 do { if (polling_stopped_here) start_polling (); \
2236 polling_stopped_here = 0; } while (0)
2238 /* read a character from the keyboard; call the redisplay if needed */
2239 /* commandflag 0 means do not autosave, but do redisplay.
2240 -1 means do not redisplay, but do autosave.
2243 /* The arguments MAPS and NMAPS are for menu prompting.
2244 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2246 PREV_EVENT is the previous input event, or nil if we are reading
2247 the first event of a key sequence (or not reading a key sequence).
2248 If PREV_EVENT is t, that is a "magic" value that says
2249 not to run input methods, but in other respects to act as if
2250 not reading a key sequence.
2252 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2253 if we used a mouse menu to read the input, or false otherwise. If
2254 USED_MOUSE_MENU is null, don't dereference it.
2256 Value is -2 when we find input on another keyboard. A second call
2257 to read_char will read it.
2259 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2260 specifying the maximum time to wait until. If no input arrives by
2261 that time, stop waiting and return nil.
2263 Value is t if we showed a menu and the user rejected it. */
2266 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2267 Lisp_Object prev_event
,
2268 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2272 sys_jmp_buf local_getcjmp
;
2273 sys_jmp_buf save_jump
;
2274 Lisp_Object tem
, save
;
2275 volatile Lisp_Object previous_echo_area_message
;
2276 volatile Lisp_Object also_record
;
2277 volatile bool reread
;
2278 struct gcpro gcpro1
, gcpro2
;
2279 bool volatile polling_stopped_here
= 0;
2280 struct kboard
*orig_kboard
= current_kboard
;
2284 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2285 before_command_key_count
= this_command_key_count
;
2286 before_command_echo_length
= echo_length ();
2289 previous_echo_area_message
= Qnil
;
2291 GCPRO2 (c
, previous_echo_area_message
);
2296 if (CONSP (Vunread_post_input_method_events
))
2298 c
= XCAR (Vunread_post_input_method_events
);
2299 Vunread_post_input_method_events
2300 = XCDR (Vunread_post_input_method_events
);
2302 /* Undo what read_char_x_menu_prompt did when it unread
2303 additional keys returned by Fx_popup_menu. */
2305 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2313 if (CONSP (Vunread_command_events
))
2315 bool was_disabled
= 0;
2317 c
= XCAR (Vunread_command_events
);
2318 Vunread_command_events
= XCDR (Vunread_command_events
);
2322 /* Undo what sit-for did when it unread additional keys
2323 inside universal-argument. */
2326 && EQ (XCAR (c
), Qt
))
2332 /* Undo what read_char_x_menu_prompt did when it unread
2333 additional keys returned by Fx_popup_menu. */
2335 && EQ (XCDR (c
), Qdisabled
)
2336 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2342 /* If the queued event is something that used the mouse,
2343 set used_mouse_menu accordingly. */
2345 /* Also check was_disabled so last-nonmenu-event won't return
2346 a bad value when submenus are involved. (Bug#447) */
2347 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2348 *used_mouse_menu
= 1;
2350 goto reread_for_input_method
;
2353 if (CONSP (Vunread_input_method_events
))
2355 c
= XCAR (Vunread_input_method_events
);
2356 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2358 /* Undo what read_char_x_menu_prompt did when it unread
2359 additional keys returned by Fx_popup_menu. */
2361 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2365 goto reread_for_input_method
;
2368 this_command_key_count_reset
= 0;
2370 if (!NILP (Vexecuting_kbd_macro
))
2372 /* We set this to Qmacro; since that's not a frame, nobody will
2373 try to switch frames on us, and the selected window will
2376 Since this event came from a macro, it would be misleading to
2377 leave internal_last_event_frame set to wherever the last
2378 real event came from. Normally, a switch-frame event selects
2379 internal_last_event_frame after each command is read, but
2380 events read from a macro should never cause a new frame to be
2382 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2384 /* Exit the macro if we are at the end.
2385 Also, some things replace the macro with t
2386 to force an early exit. */
2387 if (EQ (Vexecuting_kbd_macro
, Qt
)
2388 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2394 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2395 if (STRINGP (Vexecuting_kbd_macro
)
2396 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2397 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2399 executing_kbd_macro_index
++;
2404 if (!NILP (unread_switch_frame
))
2406 c
= unread_switch_frame
;
2407 unread_switch_frame
= Qnil
;
2409 /* This event should make it into this_command_keys, and get echoed
2410 again, so we do not set `reread'. */
2414 /* if redisplay was requested */
2415 if (commandflag
>= 0)
2417 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2419 /* If there is pending input, process any events which are not
2420 user-visible, such as X selection_request events. */
2422 || detect_input_pending_run_timers (0))
2423 swallow_events (0); /* may clear input_pending */
2425 /* Redisplay if no pending input. */
2426 while (!input_pending
)
2428 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2429 redisplay_preserve_echo_area (5);
2434 /* Normal case: no input arrived during redisplay. */
2437 /* Input arrived and pre-empted redisplay.
2438 Process any events which are not user-visible. */
2440 /* If that cleared input_pending, try again to redisplay. */
2443 /* Prevent the redisplay we just did
2444 from messing up echoing of the input after the prompt. */
2445 if (commandflag
== 0 && echo_current
)
2446 echo_message_buffer
= echo_area_buffer
[0];
2450 /* Message turns off echoing unless more keystrokes turn it on again.
2452 The code in 20.x for the condition was
2454 1. echo_area_glyphs && *echo_area_glyphs
2455 2. && echo_area_glyphs != current_kboard->echobuf
2456 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2458 (1) means there's a current message displayed
2460 (2) means it's not the message from echoing from the current
2463 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2464 is set to a non-null value. This is done in read_char and it is
2465 set to echo_area_glyphs after a call to echo_char. That means
2466 ok_to_echo_at_next_pause is either null or
2467 current_kboard->echobuf with the appropriate current_kboard at
2470 So, condition (3) means in clear text ok_to_echo_at_next_pause
2471 must be either null, or the current message isn't from echoing at
2472 all, or it's from echoing from a different kboard than the
2475 if (/* There currently is something in the echo area. */
2476 !NILP (echo_area_buffer
[0])
2477 && (/* And it's either not from echoing. */
2478 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2479 /* Or it's an echo from a different kboard. */
2480 || echo_kboard
!= current_kboard
2481 /* Or we explicitly allow overwriting whatever there is. */
2482 || ok_to_echo_at_next_pause
== NULL
))
2487 /* Try reading a character via menu prompting in the minibuf.
2488 Try this before the sit-for, because the sit-for
2489 would do the wrong thing if we are supposed to do
2490 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2491 after a mouse event so don't try a minibuf menu. */
2493 if (nmaps
> 0 && INTERACTIVE
2494 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2495 /* Don't bring up a menu if we already have another event. */
2496 && NILP (Vunread_command_events
)
2497 && !detect_input_pending_run_timers (0))
2499 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2501 if (INTEGERP (c
) && XINT (c
) == -2)
2502 return c
; /* wrong_kboard_jmpbuf */
2508 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2509 We will do that below, temporarily for short sections of code,
2510 when appropriate. local_getcjmp must be in effect
2511 around any call to sit_for or kbd_buffer_get_event;
2512 it *must not* be in effect when we call redisplay. */
2514 jmpcount
= SPECPDL_INDEX ();
2515 if (sys_setjmp (local_getcjmp
))
2517 /* Handle quits while reading the keyboard. */
2518 /* We must have saved the outer value of getcjmp here,
2519 so restore it now. */
2520 restore_getcjmp (save_jump
);
2521 unbind_to (jmpcount
, Qnil
);
2522 XSETINT (c
, quit_char
);
2523 internal_last_event_frame
= selected_frame
;
2524 Vlast_event_frame
= internal_last_event_frame
;
2525 /* If we report the quit char as an event,
2526 don't do so more than once. */
2527 if (!NILP (Vinhibit_quit
))
2531 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2532 if (kb
!= current_kboard
)
2534 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2535 /* We shouldn't get here if we were in single-kboard mode! */
2540 while (CONSP (XCDR (last
)))
2542 if (!NILP (XCDR (last
)))
2546 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2548 XSETCDR (last
, Fcons (c
, Qnil
));
2549 kb
->kbd_queue_has_data
= 1;
2550 current_kboard
= kb
;
2551 /* This is going to exit from read_char
2552 so we had better get rid of this frame's stuff. */
2554 return make_number (-2); /* wrong_kboard_jmpbuf */
2560 /* Start idle timers if no time limit is supplied. We don't do it
2561 if a time limit is supplied to avoid an infinite recursion in the
2562 situation where an idle timer calls `sit-for'. */
2565 timer_start_idle ();
2567 /* If in middle of key sequence and minibuffer not active,
2568 start echoing if enough time elapses. */
2570 if (minibuf_level
== 0
2572 && !current_kboard
->immediate_echo
2573 && this_command_key_count
> 0
2575 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2576 && NILP (Fzerop (Vecho_keystrokes
))
2577 && (/* No message. */
2578 NILP (echo_area_buffer
[0])
2579 /* Or empty message. */
2580 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2581 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2582 /* Or already echoing from same kboard. */
2583 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2584 /* Or not echoing before and echoing allowed. */
2585 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2587 /* After a mouse event, start echoing right away.
2588 This is because we are probably about to display a menu,
2589 and we don't want to delay before doing so. */
2590 if (EVENT_HAS_PARAMETERS (prev_event
))
2596 save_getcjmp (save_jump
);
2597 restore_getcjmp (local_getcjmp
);
2598 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2599 restore_getcjmp (save_jump
);
2601 && ! CONSP (Vunread_command_events
))
2606 /* Maybe auto save due to number of keystrokes. */
2608 if (commandflag
!= 0
2609 && auto_save_interval
> 0
2610 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2611 && !detect_input_pending_run_timers (0))
2613 Fdo_auto_save (Qnil
, Qnil
);
2614 /* Hooks can actually change some buffers in auto save. */
2618 /* Try reading using an X menu.
2619 This is never confused with reading using the minibuf
2620 because the recursive call of read_char in read_char_minibuf_menu_prompt
2621 does not pass on any keymaps. */
2623 if (nmaps
> 0 && INTERACTIVE
2624 && !NILP (prev_event
)
2625 && EVENT_HAS_PARAMETERS (prev_event
)
2626 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2627 && !EQ (XCAR (prev_event
), Qtool_bar
)
2628 /* Don't bring up a menu if we already have another event. */
2629 && NILP (Vunread_command_events
))
2631 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2633 /* Now that we have read an event, Emacs is not idle. */
2640 /* Maybe autosave and/or garbage collect due to idleness. */
2642 if (INTERACTIVE
&& NILP (c
))
2645 ptrdiff_t buffer_size
;
2647 /* Slow down auto saves logarithmically in size of current buffer,
2648 and garbage collect while we're at it. */
2649 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2650 last_non_minibuf_size
= Z
- BEG
;
2651 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2653 while (buffer_size
> 64)
2654 delay_level
++, buffer_size
-= buffer_size
>> 2;
2655 if (delay_level
< 4) delay_level
= 4;
2656 /* delay_level is 4 for files under around 50k, 7 at 100k,
2657 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2659 /* Auto save if enough time goes by without input. */
2660 if (commandflag
!= 0
2661 && num_nonmacro_input_events
> last_auto_save
2662 && INTEGERP (Vauto_save_timeout
)
2663 && XINT (Vauto_save_timeout
) > 0)
2666 EMACS_INT timeout
= (delay_level
2667 * min (XFASTINT (Vauto_save_timeout
) / 4,
2668 MOST_POSITIVE_FIXNUM
/ delay_level
));
2669 save_getcjmp (save_jump
);
2670 restore_getcjmp (local_getcjmp
);
2671 tem0
= sit_for (make_number (timeout
), 1, 1);
2672 restore_getcjmp (save_jump
);
2675 && ! CONSP (Vunread_command_events
))
2677 Fdo_auto_save (Qnil
, Qnil
);
2682 /* If there is still no input available, ask for GC. */
2683 if (!detect_input_pending_run_timers (0))
2687 /* Notify the caller if an autosave hook, or a timer, sentinel or
2688 filter in the sit_for calls above have changed the current
2689 kboard. This could happen if they use the minibuffer or start a
2690 recursive edit, like the fancy splash screen in server.el's
2691 filter. If this longjmp wasn't here, read_key_sequence would
2692 interpret the next key sequence using the wrong translation
2693 tables and function keymaps. */
2694 if (NILP (c
) && current_kboard
!= orig_kboard
)
2697 return make_number (-2); /* wrong_kboard_jmpbuf */
2700 /* If this has become non-nil here, it has been set by a timer
2701 or sentinel or filter. */
2702 if (CONSP (Vunread_command_events
))
2704 c
= XCAR (Vunread_command_events
);
2705 Vunread_command_events
= XCDR (Vunread_command_events
);
2708 /* Read something from current KBOARD's side queue, if possible. */
2712 if (current_kboard
->kbd_queue_has_data
)
2714 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2716 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2717 kset_kbd_queue (current_kboard
,
2718 XCDR (KVAR (current_kboard
, kbd_queue
)));
2719 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2720 current_kboard
->kbd_queue_has_data
= 0;
2721 input_pending
= readable_events (0);
2722 if (EVENT_HAS_PARAMETERS (c
)
2723 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2724 internal_last_event_frame
= XCAR (XCDR (c
));
2725 Vlast_event_frame
= internal_last_event_frame
;
2729 /* If current_kboard's side queue is empty check the other kboards.
2730 If one of them has data that we have not yet seen here,
2731 switch to it and process the data waiting for it.
2733 Note: if the events queued up for another kboard
2734 have already been seen here, and therefore are not a complete command,
2735 the kbd_queue_has_data field is 0, so we skip that kboard here.
2736 That's to avoid an infinite loop switching between kboards here. */
2737 if (NILP (c
) && !single_kboard
)
2740 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2741 if (kb
->kbd_queue_has_data
)
2743 current_kboard
= kb
;
2744 /* This is going to exit from read_char
2745 so we had better get rid of this frame's stuff. */
2747 return make_number (-2); /* wrong_kboard_jmpbuf */
2755 /* Finally, we read from the main queue,
2756 and if that gives us something we can't use yet, we put it on the
2757 appropriate side queue and try again. */
2761 KBOARD
*kb
IF_LINT (= NULL
);
2763 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2766 /* Actually read a character, waiting if necessary. */
2767 save_getcjmp (save_jump
);
2768 restore_getcjmp (local_getcjmp
);
2770 timer_start_idle ();
2771 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2772 restore_getcjmp (save_jump
);
2774 if (! NILP (c
) && (kb
!= current_kboard
))
2776 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2779 while (CONSP (XCDR (last
)))
2781 if (!NILP (XCDR (last
)))
2785 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2787 XSETCDR (last
, Fcons (c
, Qnil
));
2788 kb
->kbd_queue_has_data
= 1;
2792 current_kboard
= kb
;
2793 /* This is going to exit from read_char
2794 so we had better get rid of this frame's stuff. */
2796 return make_number (-2);
2800 /* Terminate Emacs in batch mode if at eof. */
2801 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2802 Fkill_emacs (make_number (1));
2806 /* Add in any extra modifiers, where appropriate. */
2807 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2808 || ((extra_keyboard_modifiers
& 0177) < ' '
2809 && (extra_keyboard_modifiers
& 0177) != 0))
2810 XSETINT (c
, make_ctrl_char (XINT (c
)));
2812 /* Transfer any other modifier bits directly from
2813 extra_keyboard_modifiers to c. Ignore the actual character code
2814 in the low 16 bits of extra_keyboard_modifiers. */
2815 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2826 if (commandflag
>= 0
2827 && !input_pending
&& !detect_input_pending_run_timers (0))
2833 /* Buffer switch events are only for internal wakeups
2834 so don't show them to the user.
2835 Also, don't record a key if we already did. */
2839 /* Process special events within read_char
2840 and loop around to read another event. */
2843 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2848 struct buffer
*prev_buffer
= current_buffer
;
2849 last_input_event
= c
;
2850 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2852 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2853 /* We stopped being idle for this event; undo that. This
2854 prevents automatic window selection (under
2855 mouse_autoselect_window from acting as a real input event, for
2856 example banishing the mouse under mouse-avoidance-mode. */
2857 timer_resume_idle ();
2859 if (current_buffer
!= prev_buffer
)
2861 /* The command may have changed the keymaps. Pretend there
2862 is input in another keyboard and return. This will
2863 recalculate keymaps. */
2864 c
= make_number (-2);
2871 /* Handle things that only apply to characters. */
2874 /* If kbd_buffer_get_event gave us an EOF, return that. */
2878 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2879 && UNSIGNED_CMP (XFASTINT (c
), <,
2880 SCHARS (KVAR (current_kboard
,
2881 Vkeyboard_translate_table
))))
2882 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2883 && UNSIGNED_CMP (XFASTINT (c
), <,
2884 ASIZE (KVAR (current_kboard
,
2885 Vkeyboard_translate_table
))))
2886 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2890 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2891 /* nil in keyboard-translate-table means no translation. */
2897 /* If this event is a mouse click in the menu bar,
2898 return just menu-bar for now. Modify the mouse click event
2899 so we won't do this twice, then queue it up. */
2900 if (EVENT_HAS_PARAMETERS (c
)
2902 && CONSP (EVENT_START (c
))
2903 && CONSP (XCDR (EVENT_START (c
))))
2907 posn
= POSN_POSN (EVENT_START (c
));
2908 /* Handle menu-bar events:
2909 insert the dummy prefix event `menu-bar'. */
2910 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2912 /* Change menu-bar to (menu-bar) as the event "position". */
2913 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2916 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2921 /* Store these characters into recent_keys, the dribble file if any,
2922 and the keyboard macro being defined, if any. */
2924 if (! NILP (also_record
))
2925 record_char (also_record
);
2927 /* Wipe the echo area.
2928 But first, if we are about to use an input method,
2929 save the echo area contents for it to refer to. */
2931 && ! NILP (Vinput_method_function
)
2932 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2934 previous_echo_area_message
= Fcurrent_message ();
2935 Vinput_method_previous_message
= previous_echo_area_message
;
2938 /* Now wipe the echo area, except for help events which do their
2939 own stuff with the echo area. */
2941 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2942 && !(EQ (Qswitch_frame
, XCAR (c
)))
2943 /* Don't wipe echo area for select window events: These might
2944 get delayed via `mouse-autoselect-window' (Bug#11304). */
2945 && !(EQ (Qselect_window
, XCAR (c
)))))
2947 if (!NILP (echo_area_buffer
[0]))
2949 safe_run_hooks (Qecho_area_clear_hook
);
2950 clear_message (1, 0);
2954 reread_for_input_method
:
2956 /* Pass this to the input method, if appropriate. */
2958 && ! NILP (Vinput_method_function
)
2959 /* Don't run the input method within a key sequence,
2960 after the first event of the key sequence. */
2961 && NILP (prev_event
)
2962 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2965 ptrdiff_t key_count
;
2966 bool key_count_reset
;
2967 struct gcpro gcpro1
;
2968 ptrdiff_t count
= SPECPDL_INDEX ();
2970 /* Save the echo status. */
2971 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2972 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2973 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2974 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2977 if (before_command_restore_flag
)
2979 this_command_key_count
= before_command_key_count_1
;
2980 if (this_command_key_count
< this_single_command_key_start
)
2981 this_single_command_key_start
= this_command_key_count
;
2982 echo_truncate (before_command_echo_length_1
);
2983 before_command_restore_flag
= 0;
2987 /* Save the this_command_keys status. */
2988 key_count
= this_command_key_count
;
2989 key_count_reset
= this_command_key_count_reset
;
2992 keys
= Fcopy_sequence (this_command_keys
);
2997 /* Clear out this_command_keys. */
2998 this_command_key_count
= 0;
2999 this_command_key_count_reset
= 0;
3001 /* Now wipe the echo area. */
3002 if (!NILP (echo_area_buffer
[0]))
3003 safe_run_hooks (Qecho_area_clear_hook
);
3004 clear_message (1, 0);
3007 /* If we are not reading a key sequence,
3008 never use the echo area. */
3011 specbind (Qinput_method_use_echo_area
, Qt
);
3014 /* Call the input method. */
3015 tem
= call1 (Vinput_method_function
, c
);
3017 tem
= unbind_to (count
, tem
);
3019 /* Restore the saved echoing state
3020 and this_command_keys state. */
3021 this_command_key_count
= key_count
;
3022 this_command_key_count_reset
= key_count_reset
;
3024 this_command_keys
= keys
;
3027 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3028 kset_echo_string (current_kboard
, saved_echo_string
);
3029 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3030 if (saved_immediate_echo
)
3035 /* The input method can return no events. */
3038 /* Bring back the previous message, if any. */
3039 if (! NILP (previous_echo_area_message
))
3040 message_with_string ("%s", previous_echo_area_message
, 0);
3043 /* It returned one event or more. */
3045 Vunread_post_input_method_events
3046 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3051 /* Display help if not echoing. */
3052 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3054 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3055 Lisp_Object help
, object
, position
, window
, htem
;
3057 htem
= Fcdr (XCDR (c
));
3060 window
= Fcar (htem
);
3062 object
= Fcar (htem
);
3064 position
= Fcar (htem
);
3066 show_help_echo (help
, window
, object
, position
);
3068 /* We stopped being idle for this event; undo that. */
3070 timer_resume_idle ();
3074 if ((! reread
|| this_command_key_count
== 0
3075 || this_command_key_count_reset
)
3079 /* Don't echo mouse motion events. */
3080 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3081 && NILP (Fzerop (Vecho_keystrokes
))
3082 && ! (EVENT_HAS_PARAMETERS (c
)
3083 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3086 if (! NILP (also_record
))
3087 echo_char (also_record
);
3088 /* Once we reread a character, echoing can happen
3089 the next time we pause to read a new one. */
3090 ok_to_echo_at_next_pause
= current_kboard
;
3093 /* Record this character as part of the current key. */
3094 add_command_key (c
);
3095 if (! NILP (also_record
))
3096 add_command_key (also_record
);
3099 last_input_event
= c
;
3102 /* Process the help character specially if enabled */
3103 if (!NILP (Vhelp_form
) && help_char_p (c
))
3105 ptrdiff_t count
= SPECPDL_INDEX ();
3107 help_form_saved_window_configs
3108 = Fcons (Fcurrent_window_configuration (Qnil
),
3109 help_form_saved_window_configs
);
3110 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3111 call0 (Qhelp_form_show
);
3116 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3117 if (EVENT_HAS_PARAMETERS (c
)
3118 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3119 XSETCAR (help_form_saved_window_configs
, Qnil
);
3121 while (BUFFERP (c
));
3122 /* Remove the help from the frame */
3123 unbind_to (count
, Qnil
);
3126 if (EQ (c
, make_number (040)))
3130 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3131 while (BUFFERP (c
));
3140 /* Record a key that came from a mouse menu.
3141 Record it for echoing, for this-command-keys, and so on. */
3144 record_menu_key (Lisp_Object c
)
3146 /* Wipe the echo area. */
3147 clear_message (1, 0);
3152 before_command_key_count
= this_command_key_count
;
3153 before_command_echo_length
= echo_length ();
3156 /* Don't echo mouse motion events. */
3157 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3158 && NILP (Fzerop (Vecho_keystrokes
)))
3162 /* Once we reread a character, echoing can happen
3163 the next time we pause to read a new one. */
3164 ok_to_echo_at_next_pause
= 0;
3167 /* Record this character as part of the current key. */
3168 add_command_key (c
);
3170 /* Re-reading in the middle of a command */
3171 last_input_event
= c
;
3175 /* Return true if should recognize C as "the help character". */
3178 help_char_p (Lisp_Object c
)
3182 if (EQ (c
, Vhelp_char
))
3184 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3185 if (EQ (c
, XCAR (tail
)))
3190 /* Record the input event C in various ways. */
3193 record_char (Lisp_Object c
)
3197 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3199 /* To avoid filling recent_keys with help-echo and mouse-movement
3200 events, we filter out repeated help-echo events, only store the
3201 first and last in a series of mouse-movement events, and don't
3202 store repeated help-echo events which are only separated by
3203 mouse-movement events. */
3205 Lisp_Object ev1
, ev2
, ev3
;
3208 if ((ix1
= recent_keys_index
- 1) < 0)
3209 ix1
= NUM_RECENT_KEYS
- 1;
3210 ev1
= AREF (recent_keys
, ix1
);
3212 if ((ix2
= ix1
- 1) < 0)
3213 ix2
= NUM_RECENT_KEYS
- 1;
3214 ev2
= AREF (recent_keys
, ix2
);
3216 if ((ix3
= ix2
- 1) < 0)
3217 ix3
= NUM_RECENT_KEYS
- 1;
3218 ev3
= AREF (recent_keys
, ix3
);
3220 if (EQ (XCAR (c
), Qhelp_echo
))
3222 /* Don't record `help-echo' in recent_keys unless it shows some help
3223 message, and a different help than the previously recorded
3225 Lisp_Object help
, last_help
;
3227 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3228 if (!STRINGP (help
))
3230 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3231 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3233 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3234 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3235 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3237 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3238 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3239 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3240 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3243 else if (EQ (XCAR (c
), Qmouse_movement
))
3245 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3246 So additional mouse movement events replace the last element. */
3247 Lisp_Object last_window
, window
;
3249 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3250 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3251 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3252 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3253 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3255 ASET (recent_keys
, ix1
, c
);
3261 store_kbd_macro_char (c
);
3265 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3266 ASET (recent_keys
, recent_keys_index
, c
);
3267 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3268 recent_keys_index
= 0;
3270 else if (recorded
< 0)
3272 /* We need to remove one or two events from recent_keys.
3273 To do this, we simply put nil at those events and move the
3274 recent_keys_index backwards over those events. Usually,
3275 users will never see those nil events, as they will be
3276 overwritten by the command keys entered to see recent_keys
3279 while (recorded
++ < 0 && total_keys
> 0)
3281 if (total_keys
< NUM_RECENT_KEYS
)
3283 if (--recent_keys_index
< 0)
3284 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3285 ASET (recent_keys
, recent_keys_index
, Qnil
);
3289 num_nonmacro_input_events
++;
3291 /* Write c to the dribble file. If c is a lispy event, write
3292 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3293 If you, dear reader, have a better idea, you've got the source. :-) */
3299 if (XUINT (c
) < 0x100)
3300 putc (XUINT (c
), dribble
);
3302 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3306 Lisp_Object dribblee
;
3308 /* If it's a structured event, take the event header. */
3309 dribblee
= EVENT_HEAD (c
);
3311 if (SYMBOLP (dribblee
))
3313 putc ('<', dribble
);
3314 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3315 SBYTES (SYMBOL_NAME (dribblee
)),
3317 putc ('>', dribble
);
3326 /* Copy out or in the info on where C-g should throw to.
3327 This is used when running Lisp code from within get_char,
3328 in case get_char is called recursively.
3329 See read_process_output. */
3332 save_getcjmp (sys_jmp_buf temp
)
3334 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3338 restore_getcjmp (sys_jmp_buf temp
)
3340 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3343 /* Low level keyboard/mouse input.
3344 kbd_buffer_store_event places events in kbd_buffer, and
3345 kbd_buffer_get_event retrieves them. */
3347 /* Return true if there are any events in the queue that read-char
3348 would return. If this returns false, a read-char would block. */
3350 readable_events (int flags
)
3352 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3355 /* If the buffer contains only FOCUS_IN_EVENT events, and
3356 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3357 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3359 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3360 #ifdef USE_TOOLKIT_SCROLL_BARS
3361 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3365 struct input_event
*event
;
3367 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3374 #ifdef USE_TOOLKIT_SCROLL_BARS
3375 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3377 event
->kind
== FOCUS_IN_EVENT
)
3378 #ifdef USE_TOOLKIT_SCROLL_BARS
3379 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3380 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3381 && event
->part
== scroll_bar_handle
3382 && event
->modifiers
== 0)
3387 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3390 while (event
!= kbd_store_ptr
);
3396 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3397 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3398 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3403 if (current_kboard
->kbd_queue_has_data
)
3409 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3410 if (kb
->kbd_queue_has_data
)
3416 /* Set this for debugging, to have a way to get out */
3417 int stop_character EXTERNALLY_VISIBLE
;
3420 event_to_kboard (struct input_event
*event
)
3422 /* Not applicable for these special events. */
3423 if (event
->kind
== SELECTION_REQUEST_EVENT
3424 || event
->kind
== SELECTION_CLEAR_EVENT
)
3428 Lisp_Object obj
= event
->frame_or_window
;
3429 /* There are some events that set this field to nil or string. */
3431 obj
= WINDOW_FRAME (XWINDOW (obj
));
3432 /* Also ignore dead frames here. */
3433 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3434 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3439 /* Return the number of slots occupied in kbd_buffer. */
3442 kbd_buffer_nr_stored (void)
3444 return kbd_fetch_ptr
== kbd_store_ptr
3446 : (kbd_fetch_ptr
< kbd_store_ptr
3447 ? kbd_store_ptr
- kbd_fetch_ptr
3448 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3449 + (kbd_store_ptr
- kbd_buffer
)));
3451 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3454 kbd_buffer_store_event (register struct input_event
*event
)
3456 kbd_buffer_store_event_hold (event
, 0);
3459 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3461 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3462 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3463 Else, if EVENT is a quit event, store the quit event
3464 in HOLD_QUIT, and return (thus ignoring further events).
3466 This is used to postpone the processing of the quit event until all
3467 subsequent input events have been parsed (and discarded). */
3470 kbd_buffer_store_event_hold (register struct input_event
*event
,
3471 struct input_event
*hold_quit
)
3473 if (event
->kind
== NO_EVENT
)
3476 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3479 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3481 register int c
= event
->code
& 0377;
3483 if (event
->modifiers
& ctrl_modifier
)
3484 c
= make_ctrl_char (c
);
3486 c
|= (event
->modifiers
3487 & (meta_modifier
| alt_modifier
3488 | hyper_modifier
| super_modifier
));
3492 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3493 struct input_event
*sp
;
3495 if (single_kboard
&& kb
!= current_kboard
)
3498 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3499 Fcons (make_number (c
), Qnil
)));
3500 kb
->kbd_queue_has_data
= 1;
3501 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3503 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3506 if (event_to_kboard (sp
) == kb
)
3508 sp
->kind
= NO_EVENT
;
3509 sp
->frame_or_window
= Qnil
;
3518 *hold_quit
= *event
;
3522 /* If this results in a quit_char being returned to Emacs as
3523 input, set Vlast_event_frame properly. If this doesn't
3524 get returned to Emacs as an event, the next event read
3525 will set Vlast_event_frame again, so this is safe to do. */
3529 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3531 focus
= event
->frame_or_window
;
3532 internal_last_event_frame
= focus
;
3533 Vlast_event_frame
= focus
;
3536 last_event_timestamp
= event
->timestamp
;
3538 handle_interrupt (0);
3542 if (c
&& c
== stop_character
)
3548 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3549 Just ignore the second one. */
3550 else if (event
->kind
== BUFFER_SWITCH_EVENT
3551 && kbd_fetch_ptr
!= kbd_store_ptr
3552 && ((kbd_store_ptr
== kbd_buffer
3553 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3554 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3557 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3558 kbd_store_ptr
= kbd_buffer
;
3560 /* Don't let the very last slot in the buffer become full,
3561 since that would make the two pointers equal,
3562 and that is indistinguishable from an empty buffer.
3563 Discard the event if it would fill the last slot. */
3564 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3566 *kbd_store_ptr
= *event
;
3569 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3571 /* Don't read keyboard input until we have processed kbd_buffer.
3572 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3573 hold_keyboard_input ();
3574 if (!noninteractive
)
3578 #endif /* subprocesses */
3581 /* If we're inside while-no-input, and this event qualifies
3582 as input, set quit-flag to cause an interrupt. */
3583 if (!NILP (Vthrow_on_input
)
3584 && event
->kind
!= FOCUS_IN_EVENT
3585 && event
->kind
!= HELP_EVENT
3586 && event
->kind
!= DEICONIFY_EVENT
)
3588 Vquit_flag
= Vthrow_on_input
;
3589 /* If we're inside a function that wants immediate quits,
3591 if (immediate_quit
&& NILP (Vinhibit_quit
))
3600 /* Put an input event back in the head of the event queue. */
3603 kbd_buffer_unget_event (register struct input_event
*event
)
3605 if (kbd_fetch_ptr
== kbd_buffer
)
3606 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3608 /* Don't let the very last slot in the buffer become full, */
3609 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3612 *kbd_fetch_ptr
= *event
;
3617 /* Generate a HELP_EVENT input_event and store it in the keyboard
3620 HELP is the help form.
3622 FRAME and WINDOW are the frame and window where the help is
3623 generated. OBJECT is the Lisp object where the help was found (a
3624 buffer, a string, an overlay, or nil if neither from a string nor
3625 from a buffer). POS is the position within OBJECT where the help
3629 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3630 Lisp_Object object
, ptrdiff_t pos
)
3632 struct input_event event
;
3636 event
.kind
= HELP_EVENT
;
3637 event
.frame_or_window
= frame
;
3639 event
.x
= WINDOWP (window
) ? window
: frame
;
3642 kbd_buffer_store_event (&event
);
3646 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3649 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3651 struct input_event event
;
3653 event
.kind
= HELP_EVENT
;
3654 event
.frame_or_window
= frame
;
3659 kbd_buffer_store_event (&event
);
3663 /* Discard any mouse events in the event buffer by setting them to
3666 discard_mouse_events (void)
3668 struct input_event
*sp
;
3669 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3671 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3674 if (sp
->kind
== MOUSE_CLICK_EVENT
3675 || sp
->kind
== WHEEL_EVENT
3676 || sp
->kind
== HORIZ_WHEEL_EVENT
3678 || sp
->kind
== GPM_CLICK_EVENT
3680 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3682 sp
->kind
= NO_EVENT
;
3688 /* Return true if there are any real events waiting in the event
3689 buffer, not counting `NO_EVENT's.
3691 Discard NO_EVENT events at the front of the input queue, possibly
3692 leaving the input queue empty if there are no real input events. */
3695 kbd_buffer_events_waiting (void)
3697 struct input_event
*sp
;
3699 for (sp
= kbd_fetch_ptr
;
3700 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3703 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3708 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3712 /* Clear input event EVENT. */
3715 clear_event (struct input_event
*event
)
3717 event
->kind
= NO_EVENT
;
3721 /* Read one event from the event buffer, waiting if necessary.
3722 The value is a Lisp object representing the event.
3723 The value is nil for an event that should be ignored,
3724 or that was handled here.
3725 We always read and discard one event. */
3728 kbd_buffer_get_event (KBOARD
**kbp
,
3729 bool *used_mouse_menu
,
3730 EMACS_TIME
*end_time
)
3735 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3737 /* Start reading input again because we have processed enough to
3738 be able to accept new events again. */
3739 unhold_keyboard_input ();
3742 #endif /* subprocesses */
3744 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3746 /* In case we are running as a daemon, only do this before
3747 detaching from the terminal. */
3748 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3752 *kbp
= current_kboard
;
3755 #endif /* ! HAVE_DBUS */
3757 /* Wait until there is input available. */
3760 /* Break loop if there's an unread command event. Needed in
3761 moused window autoselection which uses a timer to insert such
3763 if (CONSP (Vunread_command_events
))
3766 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3768 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3769 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3773 /* If the quit flag is set, then read_char will return
3774 quit_char, so that counts as "available input." */
3775 if (!NILP (Vquit_flag
))
3776 quit_throw_to_read_char (0);
3778 /* One way or another, wait until input is available; then, if
3779 interrupt handlers have not read it, read it now. */
3784 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3786 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3787 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3792 EMACS_TIME now
= current_emacs_time ();
3793 if (EMACS_TIME_LE (*end_time
, now
))
3794 return Qnil
; /* Finished waiting. */
3797 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3798 wait_reading_process_output (min (EMACS_SECS (duration
),
3800 EMACS_NSECS (duration
),
3801 -1, 1, Qnil
, NULL
, 0);
3805 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3807 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3811 if (CONSP (Vunread_command_events
))
3814 first
= XCAR (Vunread_command_events
);
3815 Vunread_command_events
= XCDR (Vunread_command_events
);
3816 *kbp
= current_kboard
;
3820 /* At this point, we know that there is a readable event available
3821 somewhere. If the event queue is empty, then there must be a
3822 mouse movement enabled and available. */
3823 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3825 struct input_event
*event
;
3827 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3831 last_event_timestamp
= event
->timestamp
;
3833 *kbp
= event_to_kboard (event
);
3835 *kbp
= current_kboard
; /* Better than returning null ptr? */
3839 /* These two kinds of events get special handling
3840 and don't actually appear to the command loop.
3841 We return nil for them. */
3842 if (event
->kind
== SELECTION_REQUEST_EVENT
3843 || event
->kind
== SELECTION_CLEAR_EVENT
)
3846 struct input_event copy
;
3848 /* Remove it from the buffer before processing it,
3849 since otherwise swallow_events will see it
3850 and process it again. */
3852 kbd_fetch_ptr
= event
+ 1;
3853 input_pending
= readable_events (0);
3854 x_handle_selection_event (©
);
3856 /* We're getting selection request events, but we don't have
3862 #if defined (HAVE_NS)
3863 else if (event
->kind
== NS_TEXT_EVENT
)
3865 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3866 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3868 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3869 kbd_fetch_ptr
= event
+ 1;
3870 if (used_mouse_menu
)
3871 *used_mouse_menu
= 1;
3875 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3876 || defined (HAVE_NS)
3877 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3879 /* Make an event (delete-frame (FRAME)). */
3880 obj
= Fcons (event
->frame_or_window
, Qnil
);
3881 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3882 kbd_fetch_ptr
= event
+ 1;
3885 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3886 || defined (HAVE_NS)
3887 else if (event
->kind
== ICONIFY_EVENT
)
3889 /* Make an event (iconify-frame (FRAME)). */
3890 obj
= Fcons (event
->frame_or_window
, Qnil
);
3891 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3892 kbd_fetch_ptr
= event
+ 1;
3894 else if (event
->kind
== DEICONIFY_EVENT
)
3896 /* Make an event (make-frame-visible (FRAME)). */
3897 obj
= Fcons (event
->frame_or_window
, Qnil
);
3898 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3899 kbd_fetch_ptr
= event
+ 1;
3902 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3904 /* The value doesn't matter here; only the type is tested. */
3905 XSETBUFFER (obj
, current_buffer
);
3906 kbd_fetch_ptr
= event
+ 1;
3908 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3909 || defined (HAVE_NS) || defined (USE_GTK)
3910 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3912 kbd_fetch_ptr
= event
+ 1;
3913 input_pending
= readable_events (0);
3914 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3915 x_activate_menubar (XFRAME (event
->frame_or_window
));
3919 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3921 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3922 obj
= Fcons (Qlanguage_change
,
3923 list3 (event
->frame_or_window
,
3924 make_number (event
->code
),
3925 make_number (event
->modifiers
)));
3926 kbd_fetch_ptr
= event
+ 1;
3928 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3930 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3931 obj
= Fcons (Qfile_notify
,
3932 list2 (list3 (make_number (event
->code
),
3935 event
->frame_or_window
));
3936 kbd_fetch_ptr
= event
+ 1;
3939 else if (event
->kind
== SAVE_SESSION_EVENT
)
3941 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3942 kbd_fetch_ptr
= event
+ 1;
3944 /* Just discard these, by returning nil.
3945 With MULTI_KBOARD, these events are used as placeholders
3946 when we need to randomly delete events from the queue.
3947 (They shouldn't otherwise be found in the buffer,
3948 but on some machines it appears they do show up
3949 even without MULTI_KBOARD.) */
3950 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3951 mouse events during a popup-menu call. */
3952 else if (event
->kind
== NO_EVENT
)
3953 kbd_fetch_ptr
= event
+ 1;
3954 else if (event
->kind
== HELP_EVENT
)
3956 Lisp_Object object
, position
, help
, frame
, window
;
3958 frame
= event
->frame_or_window
;
3959 object
= event
->arg
;
3960 position
= make_number (event
->code
);
3963 clear_event (event
);
3965 kbd_fetch_ptr
= event
+ 1;
3966 if (!WINDOWP (window
))
3968 obj
= Fcons (Qhelp_echo
,
3969 list5 (frame
, help
, window
, object
, position
));
3971 else if (event
->kind
== FOCUS_IN_EVENT
)
3973 /* Notification of a FocusIn event. The frame receiving the
3974 focus is in event->frame_or_window. Generate a
3975 switch-frame event if necessary. */
3976 Lisp_Object frame
, focus
;
3978 frame
= event
->frame_or_window
;
3979 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3983 if (!EQ (frame
, internal_last_event_frame
)
3984 && !EQ (frame
, selected_frame
))
3985 obj
= make_lispy_switch_frame (frame
);
3986 internal_last_event_frame
= frame
;
3987 kbd_fetch_ptr
= event
+ 1;
3990 else if (event
->kind
== DBUS_EVENT
)
3992 obj
= make_lispy_event (event
);
3993 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3998 obj
= make_lispy_event (event
);
3999 kbd_fetch_ptr
= event
+ 1;
4003 /* If this event is on a different frame, return a switch-frame this
4004 time, and leave the event in the queue for next time. */
4008 frame
= event
->frame_or_window
;
4010 frame
= XCAR (frame
);
4011 else if (WINDOWP (frame
))
4012 frame
= WINDOW_FRAME (XWINDOW (frame
));
4014 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4018 if (! EQ (frame
, internal_last_event_frame
)
4019 && !EQ (frame
, selected_frame
))
4020 obj
= make_lispy_switch_frame (frame
);
4021 internal_last_event_frame
= frame
;
4023 /* If we didn't decide to make a switch-frame event, go ahead
4024 and build a real event from the queue entry. */
4028 obj
= make_lispy_event (event
);
4030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4031 || defined (HAVE_NS) || defined (USE_GTK)
4032 /* If this was a menu selection, then set the flag to inhibit
4033 writing to last_nonmenu_event. Don't do this if the event
4034 we're returning is (menu-bar), though; that indicates the
4035 beginning of the menu sequence, and we might as well leave
4036 that as the `event with parameters' for this selection. */
4038 && !EQ (event
->frame_or_window
, event
->arg
)
4039 && (event
->kind
== MENU_BAR_EVENT
4040 || event
->kind
== TOOL_BAR_EVENT
))
4041 *used_mouse_menu
= 1;
4044 /* Certain system events are non-key events. */
4046 && event
->kind
== NS_NONKEY_EVENT
)
4047 *used_mouse_menu
= 1;
4050 /* Wipe out this event, to catch bugs. */
4051 clear_event (event
);
4052 kbd_fetch_ptr
= event
+ 1;
4056 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4057 /* Try generating a mouse motion event. */
4058 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4060 FRAME_PTR f
= some_mouse_moved ();
4061 Lisp_Object bar_window
;
4062 enum scroll_bar_part part
;
4066 *kbp
= current_kboard
;
4067 /* Note that this uses F to determine which terminal to look at.
4068 If there is no valid info, it does not store anything
4069 so x remains nil. */
4072 /* XXX Can f or mouse_position_hook be NULL here? */
4073 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4074 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4079 /* Decide if we should generate a switch-frame event. Don't
4080 generate switch-frame events for motion outside of all Emacs
4086 frame
= FRAME_FOCUS_FRAME (f
);
4088 XSETFRAME (frame
, f
);
4090 if (! EQ (frame
, internal_last_event_frame
)
4091 && !EQ (frame
, selected_frame
))
4092 obj
= make_lispy_switch_frame (frame
);
4093 internal_last_event_frame
= frame
;
4096 /* If we didn't decide to make a switch-frame event, go ahead and
4097 return a mouse-motion event. */
4098 if (!NILP (x
) && NILP (obj
))
4099 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4101 #endif /* HAVE_MOUSE || HAVE GPM */
4103 /* We were promised by the above while loop that there was
4104 something for us to read! */
4107 input_pending
= readable_events (0);
4109 Vlast_event_frame
= internal_last_event_frame
;
4114 /* Process any non-user-visible events (currently X selection events),
4115 without reading any user-visible events. */
4118 process_special_events (void)
4120 struct input_event
*event
;
4122 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4124 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4127 if (event
== kbd_store_ptr
)
4131 /* If we find a stored X selection request, handle it now. */
4132 if (event
->kind
== SELECTION_REQUEST_EVENT
4133 || event
->kind
== SELECTION_CLEAR_EVENT
)
4137 /* Remove the event from the fifo buffer before processing;
4138 otherwise swallow_events called recursively could see it
4139 and process it again. To do this, we move the events
4140 between kbd_fetch_ptr and EVENT one slot to the right,
4143 struct input_event copy
= *event
;
4144 struct input_event
*beg
4145 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4146 ? kbd_buffer
: kbd_fetch_ptr
;
4149 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4150 else if (event
< beg
)
4152 if (event
> kbd_buffer
)
4153 memmove (kbd_buffer
+ 1, kbd_buffer
,
4154 (event
- kbd_buffer
) * sizeof (struct input_event
));
4155 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4156 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4157 memmove (beg
+ 1, beg
,
4158 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4159 * sizeof (struct input_event
));
4162 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4163 kbd_fetch_ptr
= kbd_buffer
+ 1;
4167 /* X wants last_event_timestamp for selection ownership. */
4168 last_event_timestamp
= copy
.timestamp
;
4169 input_pending
= readable_events (0);
4170 x_handle_selection_event (©
);
4172 /* We're getting selection request events, but we don't have
4180 /* Process any events that are not user-visible, run timer events that
4181 are ripe, and return, without reading any user-visible events. */
4184 swallow_events (bool do_display
)
4186 unsigned old_timers_run
;
4188 process_special_events ();
4190 old_timers_run
= timers_run
;
4191 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4193 if (timers_run
!= old_timers_run
&& do_display
)
4194 redisplay_preserve_echo_area (7);
4197 /* Record the start of when Emacs is idle,
4198 for the sake of running idle-time timers. */
4201 timer_start_idle (void)
4205 /* If we are already in the idle state, do nothing. */
4206 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4209 timer_idleness_start_time
= current_emacs_time ();
4210 timer_last_idleness_start_time
= timer_idleness_start_time
;
4212 /* Mark all idle-time timers as once again candidates for running. */
4213 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4217 timer
= XCAR (timers
);
4219 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4221 ASET (timer
, 0, Qnil
);
4225 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4228 timer_stop_idle (void)
4230 timer_idleness_start_time
= invalid_emacs_time ();
4233 /* Resume idle timer from last idle start time. */
4236 timer_resume_idle (void)
4238 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4241 timer_idleness_start_time
= timer_last_idleness_start_time
;
4244 /* This is only for debugging. */
4245 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4247 /* List of elisp functions to call, delayed because they were generated in
4248 a context where Elisp could not be safely run (e.g. redisplay, signal,
4249 ...). Each element has the form (FUN . ARGS). */
4250 Lisp_Object pending_funcalls
;
4252 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4254 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4256 Lisp_Object
*vector
;
4258 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4260 vector
= XVECTOR (timer
)->contents
;
4261 if (! NILP (vector
[0]))
4264 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4269 /* Check whether a timer has fired. To prevent larger problems we simply
4270 disregard elements that are not proper timers. Do not make a circular
4271 timer list for the time being.
4273 Returns the time to wait until the next timer fires. If a
4274 timer is triggering now, return zero.
4275 If no timer is active, return -1.
4277 If a timer is ripe, we run it, with quitting turned off.
4278 In that case we return 0 to indicate that a new timer_check_2 call
4282 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4284 EMACS_TIME nexttime
;
4286 EMACS_TIME idleness_now
;
4287 Lisp_Object chosen_timer
;
4288 struct gcpro gcpro1
;
4290 nexttime
= invalid_emacs_time ();
4292 chosen_timer
= Qnil
;
4293 GCPRO1 (chosen_timer
);
4295 /* First run the code that was delayed. */
4296 while (CONSP (pending_funcalls
))
4298 Lisp_Object funcall
= XCAR (pending_funcalls
);
4299 pending_funcalls
= XCDR (pending_funcalls
);
4300 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4303 if (CONSP (timers
) || CONSP (idle_timers
))
4305 now
= current_emacs_time ();
4306 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4307 ? sub_emacs_time (now
, timer_idleness_start_time
)
4308 : make_emacs_time (0, 0));
4311 while (CONSP (timers
) || CONSP (idle_timers
))
4313 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4314 EMACS_TIME timer_time
, idle_timer_time
;
4315 EMACS_TIME difference
;
4316 EMACS_TIME timer_difference
= invalid_emacs_time ();
4317 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4318 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4320 /* Set TIMER and TIMER_DIFFERENCE
4321 based on the next ordinary timer.
4322 TIMER_DIFFERENCE is the distance in time from NOW to when
4323 this timer becomes ripe (negative if it's already ripe).
4324 Skip past invalid timers and timers already handled. */
4327 timer
= XCAR (timers
);
4328 if (! decode_timer (timer
, &timer_time
))
4330 timers
= XCDR (timers
);
4334 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4335 timer_difference
= (timer_ripe
4336 ? sub_emacs_time (now
, timer_time
)
4337 : sub_emacs_time (timer_time
, now
));
4340 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4341 based on the next idle timer. */
4342 if (CONSP (idle_timers
))
4344 idle_timer
= XCAR (idle_timers
);
4345 if (! decode_timer (idle_timer
, &idle_timer_time
))
4347 idle_timers
= XCDR (idle_timers
);
4351 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4352 idle_timer_difference
=
4354 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4355 : sub_emacs_time (idle_timer_time
, idleness_now
));
4358 /* Decide which timer is the next timer,
4359 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4360 Also step down the list where we found that timer. */
4362 if (EMACS_TIME_VALID_P (timer_difference
)
4363 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4364 || idle_timer_ripe
< timer_ripe
4365 || (idle_timer_ripe
== timer_ripe
4367 ? EMACS_TIME_LT (idle_timer_difference
,
4369 : EMACS_TIME_LT (timer_difference
,
4370 idle_timer_difference
)))))
4372 chosen_timer
= timer
;
4373 timers
= XCDR (timers
);
4374 difference
= timer_difference
;
4379 chosen_timer
= idle_timer
;
4380 idle_timers
= XCDR (idle_timers
);
4381 difference
= idle_timer_difference
;
4382 ripe
= idle_timer_ripe
;
4385 /* If timer is ripe, run it if it hasn't been run. */
4388 if (NILP (AREF (chosen_timer
, 0)))
4390 ptrdiff_t count
= SPECPDL_INDEX ();
4391 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4393 /* Mark the timer as triggered to prevent problems if the lisp
4394 code fails to reschedule it right. */
4395 ASET (chosen_timer
, 0, Qt
);
4397 specbind (Qinhibit_quit
, Qt
);
4399 call1 (Qtimer_event_handler
, chosen_timer
);
4400 Vdeactivate_mark
= old_deactivate_mark
;
4402 unbind_to (count
, Qnil
);
4404 /* Since we have handled the event,
4405 we don't need to tell the caller to wake up and do it. */
4406 /* But the caller must still wait for the next timer, so
4407 return 0 to indicate that. */
4410 nexttime
= make_emacs_time (0, 0);
4414 /* When we encounter a timer that is still waiting,
4415 return the amount of time to wait before it is ripe. */
4422 /* No timers are pending in the future. */
4423 /* Return 0 if we generated an event, and -1 if not. */
4429 /* Check whether a timer has fired. To prevent larger problems we simply
4430 disregard elements that are not proper timers. Do not make a circular
4431 timer list for the time being.
4433 Returns the time to wait until the next timer fires.
4434 If no timer is active, return an invalid value.
4436 As long as any timer is ripe, we run it. */
4441 EMACS_TIME nexttime
;
4442 Lisp_Object timers
, idle_timers
;
4443 struct gcpro gcpro1
, gcpro2
;
4445 Lisp_Object tem
= Vinhibit_quit
;
4448 /* We use copies of the timers' lists to allow a timer to add itself
4449 again, without locking up Emacs if the newly added timer is
4450 already ripe when added. */
4452 /* Always consider the ordinary timers. */
4453 timers
= Fcopy_sequence (Vtimer_list
);
4454 /* Consider the idle timers only if Emacs is idle. */
4455 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4456 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4460 Vinhibit_quit
= tem
;
4462 GCPRO2 (timers
, idle_timers
);
4466 nexttime
= timer_check_2 (timers
, idle_timers
);
4468 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4474 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4475 doc
: /* Return the current length of Emacs idleness, or nil.
4476 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4477 in the same style as (current-time).
4479 The value when Emacs is not idle is nil.
4481 PSEC is a multiple of the system clock resolution. */)
4484 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4485 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4486 timer_idleness_start_time
));
4491 /* Caches for modify_event_symbol. */
4492 static Lisp_Object accent_key_syms
;
4493 static Lisp_Object func_key_syms
;
4494 static Lisp_Object mouse_syms
;
4495 static Lisp_Object wheel_syms
;
4496 static Lisp_Object drag_n_drop_syms
;
4498 /* This is a list of keysym codes for special "accent" characters.
4499 It parallels lispy_accent_keys. */
4501 static const int lispy_accent_codes
[] =
4503 #ifdef XK_dead_circumflex
4508 #ifdef XK_dead_grave
4513 #ifdef XK_dead_tilde
4518 #ifdef XK_dead_diaeresis
4523 #ifdef XK_dead_macron
4528 #ifdef XK_dead_degree
4533 #ifdef XK_dead_acute
4538 #ifdef XK_dead_cedilla
4543 #ifdef XK_dead_breve
4548 #ifdef XK_dead_ogonek
4553 #ifdef XK_dead_caron
4558 #ifdef XK_dead_doubleacute
4559 XK_dead_doubleacute
,
4563 #ifdef XK_dead_abovedot
4568 #ifdef XK_dead_abovering
4578 #ifdef XK_dead_belowdot
4583 #ifdef XK_dead_voiced_sound
4584 XK_dead_voiced_sound
,
4588 #ifdef XK_dead_semivoiced_sound
4589 XK_dead_semivoiced_sound
,
4605 /* This is a list of Lisp names for special "accent" characters.
4606 It parallels lispy_accent_codes. */
4608 static const char *const lispy_accent_keys
[] =
4626 "dead-voiced-sound",
4627 "dead-semivoiced-sound",
4633 #define FUNCTION_KEY_OFFSET 0x0
4635 const char *const lispy_function_keys
[] =
4639 0, /* VK_LBUTTON 0x01 */
4640 0, /* VK_RBUTTON 0x02 */
4641 "cancel", /* VK_CANCEL 0x03 */
4642 0, /* VK_MBUTTON 0x04 */
4644 0, 0, 0, /* 0x05 .. 0x07 */
4646 "backspace", /* VK_BACK 0x08 */
4647 "tab", /* VK_TAB 0x09 */
4649 0, 0, /* 0x0A .. 0x0B */
4651 "clear", /* VK_CLEAR 0x0C */
4652 "return", /* VK_RETURN 0x0D */
4654 0, 0, /* 0x0E .. 0x0F */
4656 0, /* VK_SHIFT 0x10 */
4657 0, /* VK_CONTROL 0x11 */
4658 0, /* VK_MENU 0x12 */
4659 "pause", /* VK_PAUSE 0x13 */
4660 "capslock", /* VK_CAPITAL 0x14 */
4661 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4663 "junja", /* VK_JUNJA 0x17 */
4664 "final", /* VK_FINAL 0x18 */
4665 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4667 "escape", /* VK_ESCAPE 0x1B */
4668 "convert", /* VK_CONVERT 0x1C */
4669 "non-convert", /* VK_NONCONVERT 0x1D */
4670 "accept", /* VK_ACCEPT 0x1E */
4671 "mode-change", /* VK_MODECHANGE 0x1F */
4672 0, /* VK_SPACE 0x20 */
4673 "prior", /* VK_PRIOR 0x21 */
4674 "next", /* VK_NEXT 0x22 */
4675 "end", /* VK_END 0x23 */
4676 "home", /* VK_HOME 0x24 */
4677 "left", /* VK_LEFT 0x25 */
4678 "up", /* VK_UP 0x26 */
4679 "right", /* VK_RIGHT 0x27 */
4680 "down", /* VK_DOWN 0x28 */
4681 "select", /* VK_SELECT 0x29 */
4682 "print", /* VK_PRINT 0x2A */
4683 "execute", /* VK_EXECUTE 0x2B */
4684 "snapshot", /* VK_SNAPSHOT 0x2C */
4685 "insert", /* VK_INSERT 0x2D */
4686 "delete", /* VK_DELETE 0x2E */
4687 "help", /* VK_HELP 0x2F */
4689 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4691 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4693 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4695 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4697 0, 0, 0, 0, 0, 0, 0, 0, 0,
4698 0, 0, 0, 0, 0, 0, 0, 0, 0,
4699 0, 0, 0, 0, 0, 0, 0, 0,
4701 "lwindow", /* VK_LWIN 0x5B */
4702 "rwindow", /* VK_RWIN 0x5C */
4703 "apps", /* VK_APPS 0x5D */
4706 "kp-0", /* VK_NUMPAD0 0x60 */
4707 "kp-1", /* VK_NUMPAD1 0x61 */
4708 "kp-2", /* VK_NUMPAD2 0x62 */
4709 "kp-3", /* VK_NUMPAD3 0x63 */
4710 "kp-4", /* VK_NUMPAD4 0x64 */
4711 "kp-5", /* VK_NUMPAD5 0x65 */
4712 "kp-6", /* VK_NUMPAD6 0x66 */
4713 "kp-7", /* VK_NUMPAD7 0x67 */
4714 "kp-8", /* VK_NUMPAD8 0x68 */
4715 "kp-9", /* VK_NUMPAD9 0x69 */
4716 "kp-multiply", /* VK_MULTIPLY 0x6A */
4717 "kp-add", /* VK_ADD 0x6B */
4718 "kp-separator", /* VK_SEPARATOR 0x6C */
4719 "kp-subtract", /* VK_SUBTRACT 0x6D */
4720 "kp-decimal", /* VK_DECIMAL 0x6E */
4721 "kp-divide", /* VK_DIVIDE 0x6F */
4722 "f1", /* VK_F1 0x70 */
4723 "f2", /* VK_F2 0x71 */
4724 "f3", /* VK_F3 0x72 */
4725 "f4", /* VK_F4 0x73 */
4726 "f5", /* VK_F5 0x74 */
4727 "f6", /* VK_F6 0x75 */
4728 "f7", /* VK_F7 0x76 */
4729 "f8", /* VK_F8 0x77 */
4730 "f9", /* VK_F9 0x78 */
4731 "f10", /* VK_F10 0x79 */
4732 "f11", /* VK_F11 0x7A */
4733 "f12", /* VK_F12 0x7B */
4734 "f13", /* VK_F13 0x7C */
4735 "f14", /* VK_F14 0x7D */
4736 "f15", /* VK_F15 0x7E */
4737 "f16", /* VK_F16 0x7F */
4738 "f17", /* VK_F17 0x80 */
4739 "f18", /* VK_F18 0x81 */
4740 "f19", /* VK_F19 0x82 */
4741 "f20", /* VK_F20 0x83 */
4742 "f21", /* VK_F21 0x84 */
4743 "f22", /* VK_F22 0x85 */
4744 "f23", /* VK_F23 0x86 */
4745 "f24", /* VK_F24 0x87 */
4747 0, 0, 0, 0, /* 0x88 .. 0x8B */
4748 0, 0, 0, 0, /* 0x8C .. 0x8F */
4750 "kp-numlock", /* VK_NUMLOCK 0x90 */
4751 "scroll", /* VK_SCROLL 0x91 */
4752 /* Not sure where the following block comes from.
4753 Windows headers have NEC and Fujitsu specific keys in
4754 this block, but nothing generic. */
4755 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4756 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4757 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4758 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4759 "kp-end", /* VK_NUMPAD_END 0x96 */
4760 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4761 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4762 "kp-up", /* VK_NUMPAD_UP 0x99 */
4763 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4764 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4765 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4766 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4768 0, 0, /* 0x9E .. 0x9F */
4771 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4772 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4773 * No other API or message will distinguish left and right keys this way.
4778 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4779 to enable them selectively, and gives access to a few more functions.
4780 See lispy_multimedia_keys below. */
4781 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4782 0, 0, 0, /* 0xAD .. 0xAF Volume */
4783 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4784 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4786 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4787 0, 0, 0, 0, 0, 0, 0, 0, 0,
4789 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4790 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4794 "ax", /* VK_OEM_AX 0xE1 */
4795 0, /* VK_OEM_102 0xE2 */
4796 "ico-help", /* VK_ICO_HELP 0xE3 */
4797 "ico-00", /* VK_ICO_00 0xE4 */
4798 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4799 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4800 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4802 "reset", /* VK_OEM_RESET 0xE9 */
4803 "jump", /* VK_OEM_JUMP 0xEA */
4804 "oem-pa1", /* VK_OEM_PA1 0xEB */
4805 "oem-pa2", /* VK_OEM_PA2 0xEC */
4806 "oem-pa3", /* VK_OEM_PA3 0xED */
4807 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4808 "cusel", /* VK_OEM_CUSEL 0xEF */
4809 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4810 "finish", /* VK_OEM_FINISH 0xF1 */
4811 "copy", /* VK_OEM_COPY 0xF2 */
4812 "auto", /* VK_OEM_AUTO 0xF3 */
4813 "enlw", /* VK_OEM_ENLW 0xF4 */
4814 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4815 "attn", /* VK_ATTN 0xF6 */
4816 "crsel", /* VK_CRSEL 0xF7 */
4817 "exsel", /* VK_EXSEL 0xF8 */
4818 "ereof", /* VK_EREOF 0xF9 */
4819 "play", /* VK_PLAY 0xFA */
4820 "zoom", /* VK_ZOOM 0xFB */
4821 "noname", /* VK_NONAME 0xFC */
4822 "pa1", /* VK_PA1 0xFD */
4823 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4827 /* Some of these duplicate the "Media keys" on newer keyboards,
4828 but they are delivered to the application in a different way. */
4829 static const char *const lispy_multimedia_keys
[] =
4837 "browser-favorites",
4874 "toggle-dictate-command",
4880 "media-fast-forward",
4883 "media-channel-down"
4886 #else /* not HAVE_NTGUI */
4888 /* This should be dealt with in XTread_socket now, and that doesn't
4889 depend on the client system having the Kana syms defined. See also
4890 the XK_kana_A case below. */
4893 static const char *const lispy_kana_keys
[] =
4895 /* X Keysym value */
4896 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4906 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4907 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4908 "kana-i", "kana-u", "kana-e", "kana-o",
4909 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4910 "prolongedsound", "kana-A", "kana-I", "kana-U",
4911 "kana-E", "kana-O", "kana-KA", "kana-KI",
4912 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4913 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4914 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4915 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4916 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4917 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4918 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4919 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4920 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4921 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4922 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4925 #endif /* XK_kana_A */
4928 #define FUNCTION_KEY_OFFSET 0xff00
4930 /* You'll notice that this table is arranged to be conveniently
4931 indexed by X Windows keysym values. */
4932 static const char *const lispy_function_keys
[] =
4934 /* X Keysym value */
4936 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4937 "backspace", "tab", "linefeed", "clear",
4939 0, 0, 0, "pause", /* 0xff10...1f */
4940 0, 0, 0, 0, 0, 0, 0, "escape",
4942 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4943 "romaji", "hiragana", "katakana", "hiragana-katakana",
4944 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4945 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4946 "eisu-toggle", /* 0xff30...3f */
4947 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4948 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4950 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4951 "down", "prior", "next", "end",
4952 "begin", 0, 0, 0, 0, 0, 0, 0,
4953 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4964 "break", /* 0xff6b */
4967 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4968 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4969 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4970 0, 0, 0, 0, 0, 0, 0, 0,
4971 "kp-tab", /* 0xff89 */
4973 "kp-enter", /* 0xff8d */
4975 "kp-f1", /* 0xff91 */
4979 "kp-home", /* 0xff95 */
4984 "kp-prior", /* kp-page-up */
4985 "kp-next", /* kp-page-down */
4991 0, 0, 0, 0, 0, 0, 0, 0, 0,
4992 "kp-multiply", /* 0xffaa */
4997 "kp-divide", /* 0xffaf */
4998 "kp-0", /* 0xffb0 */
4999 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5002 "kp-equal", /* 0xffbd */
5003 "f1", /* 0xffbe */ /* IsFunctionKey */
5005 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5006 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5007 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5008 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5009 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5010 0, 0, 0, 0, 0, 0, 0, 0,
5011 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5012 0, 0, 0, 0, 0, 0, 0, "delete"
5015 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5016 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5018 static const char *const iso_lispy_function_keys
[] =
5020 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5021 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5022 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5023 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5024 "iso-lefttab", /* 0xfe20 */
5025 "iso-move-line-up", "iso-move-line-down",
5026 "iso-partial-line-up", "iso-partial-line-down",
5027 "iso-partial-space-left", "iso-partial-space-right",
5028 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5029 "iso-release-margin-left", "iso-release-margin-right",
5030 "iso-release-both-margins",
5031 "iso-fast-cursor-left", "iso-fast-cursor-right",
5032 "iso-fast-cursor-up", "iso-fast-cursor-down",
5033 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5034 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5037 #endif /* not HAVE_NTGUI */
5039 static Lisp_Object Vlispy_mouse_stem
;
5041 static const char *const lispy_wheel_names
[] =
5043 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5046 /* drag-n-drop events are generated when a set of selected files are
5047 dragged from another application and dropped onto an Emacs window. */
5048 static const char *const lispy_drag_n_drop_names
[] =
5053 /* Scroll bar parts. */
5054 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5055 Lisp_Object Qup
, Qdown
, Qbottom
;
5056 static Lisp_Object Qend_scroll
;
5058 static Lisp_Object Qratio
;
5060 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5061 static Lisp_Object
*const scroll_bar_parts
[] = {
5062 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5063 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5066 /* A vector, indexed by button number, giving the down-going location
5067 of currently depressed buttons, both scroll bar and non-scroll bar.
5069 The elements have the form
5070 (BUTTON-NUMBER MODIFIER-MASK . REST)
5071 where REST is the cdr of a position as it would be reported in the event.
5073 The make_lispy_event function stores positions here to tell the
5074 difference between click and drag events, and to store the starting
5075 location to be included in drag events. */
5077 static Lisp_Object button_down_location
;
5079 /* Information about the most recent up-going button event: Which
5080 button, what location, and what time. */
5082 static int last_mouse_button
;
5083 static int last_mouse_x
;
5084 static int last_mouse_y
;
5085 static Time button_down_time
;
5087 /* The number of clicks in this multiple-click. */
5089 static int double_click_count
;
5091 /* X and Y are frame-relative coordinates for a click or wheel event.
5092 Return a Lisp-style event list. */
5095 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5098 enum window_part part
;
5099 Lisp_Object posn
= Qnil
;
5100 Lisp_Object extra_info
= Qnil
;
5101 /* Coordinate pixel positions to return. */
5102 int xret
= 0, yret
= 0;
5103 /* The window under frame pixel coordinates (x,y) */
5104 Lisp_Object window
= f
5105 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5108 if (WINDOWP (window
))
5110 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5111 struct window
*w
= XWINDOW (window
);
5112 Lisp_Object string_info
= Qnil
;
5113 ptrdiff_t textpos
= -1;
5114 int col
= -1, row
= -1;
5115 int dx
= -1, dy
= -1;
5116 int width
= -1, height
= -1;
5117 Lisp_Object object
= Qnil
;
5119 /* Pixel coordinates relative to the window corner. */
5120 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5121 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5123 /* For text area clicks, return X, Y relative to the corner of
5124 this text area. Note that dX, dY etc are set below, by
5125 buffer_posn_from_coords. */
5126 if (part
== ON_TEXT
)
5128 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5129 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5131 /* For mode line and header line clicks, return X, Y relative to
5132 the left window edge. Use mode_line_string to look for a
5133 string on the click position. */
5134 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5139 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5140 /* Note that mode_line_string takes COL, ROW as pixels and
5141 converts them to characters. */
5144 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5145 &object
, &dx
, &dy
, &width
, &height
);
5146 if (STRINGP (string
))
5147 string_info
= Fcons (string
, make_number (charpos
));
5148 textpos
= (w
== XWINDOW (selected_window
)
5149 && current_buffer
== XBUFFER (w
->buffer
))
5150 ? PT
: XMARKER (w
->pointm
)->charpos
;
5155 /* For fringes and margins, Y is relative to the area's (and the
5156 window's) top edge, while X is meaningless. */
5157 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5162 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5165 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5166 &object
, &dx
, &dy
, &width
, &height
);
5167 if (STRINGP (string
))
5168 string_info
= Fcons (string
, make_number (charpos
));
5169 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5171 else if (part
== ON_LEFT_FRINGE
)
5173 posn
= Qleft_fringe
;
5176 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5177 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5178 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5180 else if (part
== ON_RIGHT_FRINGE
)
5182 posn
= Qright_fringe
;
5185 - window_box_width (w
, LEFT_MARGIN_AREA
)
5186 - window_box_width (w
, TEXT_AREA
)
5187 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5188 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5190 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5192 else if (part
== ON_VERTICAL_BORDER
)
5194 posn
= Qvertical_line
;
5199 /* Nothing special for part == ON_SCROLL_BAR. */
5201 /* For clicks in the text area, fringes, or margins, call
5202 buffer_posn_from_coords to extract TEXTPOS, the buffer
5203 position nearest to the click. */
5206 Lisp_Object string2
, object2
= Qnil
;
5207 struct display_pos p
;
5209 int width2
, height2
;
5210 /* The pixel X coordinate passed to buffer_posn_from_coords
5211 is the X coordinate relative to the text area for
5212 text-area and right-margin clicks, zero otherwise. */
5214 = (part
== ON_TEXT
) ? xret
5215 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5216 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5220 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5221 &object2
, &dx2
, &dy2
,
5223 textpos
= CHARPOS (p
.pos
);
5224 if (col
< 0) col
= x2
;
5225 if (row
< 0) row
= y2
;
5226 if (dx
< 0) dx
= dx2
;
5227 if (dy
< 0) dy
= dy2
;
5228 if (width
< 0) width
= width2
;
5229 if (height
< 0) height
= height2
;
5233 posn
= make_number (textpos
);
5234 if (STRINGP (string2
))
5235 string_info
= Fcons (string2
,
5236 make_number (CHARPOS (p
.string_pos
)));
5242 #ifdef HAVE_WINDOW_SYSTEM
5243 if (IMAGEP (object
))
5245 Lisp_Object image_map
, hotspot
;
5246 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5248 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5250 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5251 posn
= XCAR (hotspot
);
5258 Fcons (make_number (dx
), make_number (dy
)),
5259 Fcons (make_number (width
), make_number (height
)));
5262 extra_info
= Fcons (string_info
,
5263 Fcons (make_number (textpos
),
5264 Fcons (Fcons (make_number (col
),
5269 XSETFRAME (window
, f
);
5273 return Fcons (window
,
5275 Fcons (Fcons (make_number (xret
),
5276 make_number (yret
)),
5277 Fcons (make_number (t
),
5281 /* Given a struct input_event, build the lisp event which represents
5282 it. If EVENT is 0, build a mouse movement event from the mouse
5283 movement buffer, which should have a movement event in it.
5285 Note that events must be passed to this function in the order they
5286 are received; this function stores the location of button presses
5287 in order to build drag events when the button is released. */
5290 make_lispy_event (struct input_event
*event
)
5294 switch (event
->kind
)
5296 /* A simple keystroke. */
5297 case ASCII_KEYSTROKE_EVENT
:
5298 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5300 Lisp_Object lispy_c
;
5301 EMACS_INT c
= event
->code
;
5302 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5305 eassert (c
== event
->code
);
5306 /* Turn ASCII characters into control characters
5308 if (event
->modifiers
& ctrl_modifier
)
5310 c
= make_ctrl_char (c
);
5311 event
->modifiers
&= ~ctrl_modifier
;
5315 /* Add in the other modifier bits. The shift key was taken care
5316 of by the X code. */
5317 c
|= (event
->modifiers
5318 & (meta_modifier
| alt_modifier
5319 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5320 /* Distinguish Shift-SPC from SPC. */
5321 if ((event
->code
) == 040
5322 && event
->modifiers
& shift_modifier
)
5323 c
|= shift_modifier
;
5324 button_down_time
= 0;
5325 XSETFASTINT (lispy_c
, c
);
5330 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5331 except that they are non-key events (last-nonmenu-event is nil). */
5332 case NS_NONKEY_EVENT
:
5335 /* A function key. The symbol may need to have modifier prefixes
5337 case NON_ASCII_KEYSTROKE_EVENT
:
5338 button_down_time
= 0;
5340 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5341 if (event
->code
== lispy_accent_codes
[i
])
5342 return modify_event_symbol (i
,
5344 Qfunction_key
, Qnil
,
5345 lispy_accent_keys
, &accent_key_syms
,
5346 (sizeof (lispy_accent_keys
)
5347 / sizeof (lispy_accent_keys
[0])));
5351 if (event
->code
>= 0x400 && event
->code
< 0x500)
5352 return modify_event_symbol (event
->code
- 0x400,
5353 event
->modifiers
& ~shift_modifier
,
5354 Qfunction_key
, Qnil
,
5355 lispy_kana_keys
, &func_key_syms
,
5356 (sizeof (lispy_kana_keys
)
5357 / sizeof (lispy_kana_keys
[0])));
5358 #endif /* XK_kana_A */
5361 #ifdef ISO_FUNCTION_KEY_OFFSET
5362 if (event
->code
< FUNCTION_KEY_OFFSET
5363 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5364 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5366 Qfunction_key
, Qnil
,
5367 iso_lispy_function_keys
, &func_key_syms
,
5368 (sizeof (iso_lispy_function_keys
)
5369 / sizeof (iso_lispy_function_keys
[0])));
5372 /* Handle system-specific or unknown keysyms. */
5373 if (event
->code
& (1 << 28)
5374 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5375 || (event
->code
- FUNCTION_KEY_OFFSET
5376 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5377 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5379 /* We need to use an alist rather than a vector as the cache
5380 since we can't make a vector long enough. */
5381 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5382 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5383 return modify_event_symbol (event
->code
,
5386 KVAR (current_kboard
, Vsystem_key_alist
),
5387 0, &KVAR (current_kboard
, system_key_syms
),
5391 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5393 Qfunction_key
, Qnil
,
5394 lispy_function_keys
, &func_key_syms
,
5395 (sizeof (lispy_function_keys
)
5396 / sizeof (lispy_function_keys
[0])));
5399 case MULTIMEDIA_KEY_EVENT
:
5400 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5401 / sizeof (lispy_multimedia_keys
[0]))
5402 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5404 return modify_event_symbol (event
->code
, event
->modifiers
,
5405 Qfunction_key
, Qnil
,
5406 lispy_multimedia_keys
, &func_key_syms
,
5407 (sizeof (lispy_multimedia_keys
)
5408 / sizeof (lispy_multimedia_keys
[0])));
5414 /* A mouse click. Figure out where it is, decide whether it's
5415 a press, click or drag, and build the appropriate structure. */
5416 case MOUSE_CLICK_EVENT
:
5417 #ifndef USE_TOOLKIT_SCROLL_BARS
5418 case SCROLL_BAR_CLICK_EVENT
:
5421 int button
= event
->code
;
5423 Lisp_Object position
;
5424 Lisp_Object
*start_pos_ptr
;
5425 Lisp_Object start_pos
;
5429 /* Build the position as appropriate for this mouse click. */
5430 if (event
->kind
== MOUSE_CLICK_EVENT
)
5432 struct frame
*f
= XFRAME (event
->frame_or_window
);
5433 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5437 /* Ignore mouse events that were made on frame that
5438 have been deleted. */
5439 if (! FRAME_LIVE_P (f
))
5442 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5443 /* EVENT->x and EVENT->y are frame-relative pixel
5444 coordinates at this place. Under old redisplay, COLUMN
5445 and ROW are set to frame relative glyph coordinates
5446 which are then used to determine whether this click is
5447 in a menu (non-toolkit version). */
5448 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5449 &column
, &row
, NULL
, 1);
5451 /* In the non-toolkit version, clicks on the menu bar
5452 are ordinary button events in the event buffer.
5453 Distinguish them, and invoke the menu.
5455 (In the toolkit version, the toolkit handles the menu bar
5456 and Emacs doesn't know about it until after the user
5457 makes a selection.) */
5458 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5459 && (event
->modifiers
& down_modifier
))
5461 Lisp_Object items
, item
;
5463 /* Find the menu bar item under `column'. */
5465 items
= FRAME_MENU_BAR_ITEMS (f
);
5466 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5468 Lisp_Object pos
, string
;
5469 string
= AREF (items
, i
+ 1);
5470 pos
= AREF (items
, i
+ 3);
5473 if (column
>= XINT (pos
)
5474 && column
< XINT (pos
) + SCHARS (string
))
5476 item
= AREF (items
, i
);
5481 /* ELisp manual 2.4b says (x y) are window relative but
5482 code says they are frame-relative. */
5484 = Fcons (event
->frame_or_window
,
5486 Fcons (Fcons (event
->x
, event
->y
),
5487 Fcons (make_number (event
->timestamp
),
5490 return Fcons (item
, Fcons (position
, Qnil
));
5492 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5494 position
= make_lispy_position (f
, event
->x
, event
->y
,
5497 #ifndef USE_TOOLKIT_SCROLL_BARS
5500 /* It's a scrollbar click. */
5502 Lisp_Object portion_whole
;
5505 window
= event
->frame_or_window
;
5506 portion_whole
= Fcons (event
->x
, event
->y
);
5507 part
= *scroll_bar_parts
[(int) event
->part
];
5511 Fcons (Qvertical_scroll_bar
,
5512 Fcons (portion_whole
,
5513 Fcons (make_number (event
->timestamp
),
5514 Fcons (part
, Qnil
)))));
5516 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5518 if (button
>= ASIZE (button_down_location
))
5520 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5521 button_down_location
= larger_vector (button_down_location
,
5523 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5526 start_pos_ptr
= aref_addr (button_down_location
, button
);
5527 start_pos
= *start_pos_ptr
;
5528 *start_pos_ptr
= Qnil
;
5531 /* On window-system frames, use the value of
5532 double-click-fuzz as is. On other frames, interpret it
5533 as a multiple of 1/8 characters. */
5537 if (WINDOWP (event
->frame_or_window
))
5538 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5539 else if (FRAMEP (event
->frame_or_window
))
5540 f
= XFRAME (event
->frame_or_window
);
5544 if (FRAME_WINDOW_P (f
))
5545 fuzz
= double_click_fuzz
;
5547 fuzz
= double_click_fuzz
/ 8;
5549 is_double
= (button
== last_mouse_button
5550 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5551 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5552 && button_down_time
!= 0
5553 && (EQ (Vdouble_click_time
, Qt
)
5554 || (NATNUMP (Vdouble_click_time
)
5555 && (event
->timestamp
- button_down_time
5556 < XFASTINT (Vdouble_click_time
)))));
5559 last_mouse_button
= button
;
5560 last_mouse_x
= XINT (event
->x
);
5561 last_mouse_y
= XINT (event
->y
);
5563 /* If this is a button press, squirrel away the location, so
5564 we can decide later whether it was a click or a drag. */
5565 if (event
->modifiers
& down_modifier
)
5569 double_click_count
++;
5570 event
->modifiers
|= ((double_click_count
> 2)
5575 double_click_count
= 1;
5576 button_down_time
= event
->timestamp
;
5577 *start_pos_ptr
= Fcopy_alist (position
);
5578 ignore_mouse_drag_p
= 0;
5581 /* Now we're releasing a button - check the co-ordinates to
5582 see if this was a click or a drag. */
5583 else if (event
->modifiers
& up_modifier
)
5585 /* If we did not see a down before this up, ignore the up.
5586 Probably this happened because the down event chose a
5587 menu item. It would be an annoyance to treat the
5588 release of the button that chose the menu item as a
5591 if (!CONSP (start_pos
))
5594 event
->modifiers
&= ~up_modifier
;
5597 Lisp_Object new_down
, down
;
5598 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5600 /* The third element of every position
5601 should be the (x,y) pair. */
5602 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5603 new_down
= Fcar (Fcdr (Fcdr (position
)));
5606 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5608 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5609 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5612 if (ignore_mouse_drag_p
)
5614 event
->modifiers
|= click_modifier
;
5615 ignore_mouse_drag_p
= 0;
5617 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5618 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5619 /* Maybe the mouse has moved a lot, caused scrolling, and
5620 eventually ended up at the same screen position (but
5621 not buffer position) in which case it is a drag, not
5623 /* FIXME: OTOH if the buffer position has changed
5624 because of a timer or process filter rather than
5625 because of mouse movement, it should be considered as
5626 a click. But mouse-drag-region completely ignores
5627 this case and it hasn't caused any real problem, so
5628 it's probably OK to ignore it as well. */
5629 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5630 /* Mouse hasn't moved (much). */
5631 event
->modifiers
|= click_modifier
;
5634 button_down_time
= 0;
5635 event
->modifiers
|= drag_modifier
;
5638 /* Don't check is_double; treat this as multiple
5639 if the down-event was multiple. */
5640 if (double_click_count
> 1)
5641 event
->modifiers
|= ((double_click_count
> 2)
5647 /* Every mouse event should either have the down_modifier or
5648 the up_modifier set. */
5652 /* Get the symbol we should use for the mouse click. */
5655 head
= modify_event_symbol (button
,
5657 Qmouse_click
, Vlispy_mouse_stem
,
5660 ASIZE (mouse_syms
));
5661 if (event
->modifiers
& drag_modifier
)
5666 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5669 Fcons (make_number (double_click_count
),
5679 case HORIZ_WHEEL_EVENT
:
5681 Lisp_Object position
;
5684 /* Build the position as appropriate for this mouse click. */
5685 struct frame
*f
= XFRAME (event
->frame_or_window
);
5687 /* Ignore wheel events that were made on frame that have been
5689 if (! FRAME_LIVE_P (f
))
5692 position
= make_lispy_position (f
, event
->x
, event
->y
,
5695 /* Set double or triple modifiers to indicate the wheel speed. */
5697 /* On window-system frames, use the value of
5698 double-click-fuzz as is. On other frames, interpret it
5699 as a multiple of 1/8 characters. */
5705 if (WINDOWP (event
->frame_or_window
))
5706 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5707 else if (FRAMEP (event
->frame_or_window
))
5708 fr
= XFRAME (event
->frame_or_window
);
5712 fuzz
= FRAME_WINDOW_P (fr
)
5713 ? double_click_fuzz
: double_click_fuzz
/ 8;
5715 if (event
->modifiers
& up_modifier
)
5717 /* Emit a wheel-up event. */
5718 event
->modifiers
&= ~up_modifier
;
5721 else if (event
->modifiers
& down_modifier
)
5723 /* Emit a wheel-down event. */
5724 event
->modifiers
&= ~down_modifier
;
5728 /* Every wheel event should either have the down_modifier or
5729 the up_modifier set. */
5732 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5735 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5736 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5737 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5738 && button_down_time
!= 0
5739 && (EQ (Vdouble_click_time
, Qt
)
5740 || (NATNUMP (Vdouble_click_time
)
5741 && (event
->timestamp
- button_down_time
5742 < XFASTINT (Vdouble_click_time
)))));
5745 double_click_count
++;
5746 event
->modifiers
|= ((double_click_count
> 2)
5752 double_click_count
= 1;
5753 event
->modifiers
|= click_modifier
;
5756 button_down_time
= event
->timestamp
;
5757 /* Use a negative value to distinguish wheel from mouse button. */
5758 last_mouse_button
= - (1 + symbol_num
);
5759 last_mouse_x
= XINT (event
->x
);
5760 last_mouse_y
= XINT (event
->y
);
5762 /* Get the symbol we should use for the wheel event. */
5763 head
= modify_event_symbol (symbol_num
,
5769 ASIZE (wheel_syms
));
5772 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5775 Fcons (make_number (double_click_count
),
5784 #ifdef USE_TOOLKIT_SCROLL_BARS
5786 /* We don't have down and up events if using toolkit scroll bars,
5787 so make this always a click event. Store in the `part' of
5788 the Lisp event a symbol which maps to the following actions:
5790 `above_handle' page up
5791 `below_handle' page down
5795 `bottom' bottom of buffer
5796 `handle' thumb has been dragged.
5797 `end-scroll' end of interaction with scroll bar
5799 The incoming input_event contains in its `part' member an
5800 index of type `enum scroll_bar_part' which we can use as an
5801 index in scroll_bar_parts to get the appropriate symbol. */
5803 case SCROLL_BAR_CLICK_EVENT
:
5805 Lisp_Object position
, head
, window
, portion_whole
, part
;
5807 window
= event
->frame_or_window
;
5808 portion_whole
= Fcons (event
->x
, event
->y
);
5809 part
= *scroll_bar_parts
[(int) event
->part
];
5813 Fcons (Qvertical_scroll_bar
,
5814 Fcons (portion_whole
,
5815 Fcons (make_number (event
->timestamp
),
5816 Fcons (part
, Qnil
)))));
5818 /* Always treat scroll bar events as clicks. */
5819 event
->modifiers
|= click_modifier
;
5820 event
->modifiers
&= ~up_modifier
;
5822 if (event
->code
>= ASIZE (mouse_syms
))
5823 mouse_syms
= larger_vector (mouse_syms
,
5824 event
->code
- ASIZE (mouse_syms
) + 1,
5827 /* Get the symbol we should use for the mouse click. */
5828 head
= modify_event_symbol (event
->code
,
5833 ASIZE (mouse_syms
));
5834 return Fcons (head
, Fcons (position
, Qnil
));
5837 #endif /* USE_TOOLKIT_SCROLL_BARS */
5839 case DRAG_N_DROP_EVENT
:
5842 Lisp_Object head
, position
;
5845 f
= XFRAME (event
->frame_or_window
);
5848 /* Ignore mouse events that were made on frames that
5849 have been deleted. */
5850 if (! FRAME_LIVE_P (f
))
5853 position
= make_lispy_position (f
, event
->x
, event
->y
,
5856 head
= modify_event_symbol (0, event
->modifiers
,
5858 lispy_drag_n_drop_names
,
5859 &drag_n_drop_syms
, 1);
5865 #endif /* HAVE_MOUSE */
5867 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5868 || defined (HAVE_NS) || defined (USE_GTK)
5869 case MENU_BAR_EVENT
:
5870 if (EQ (event
->arg
, event
->frame_or_window
))
5871 /* This is the prefix key. We translate this to
5872 `(menu_bar)' because the code in keyboard.c for menu
5873 events, which we use, relies on this. */
5874 return Fcons (Qmenu_bar
, Qnil
);
5878 case SELECT_WINDOW_EVENT
:
5879 /* Make an event (select-window (WINDOW)). */
5880 return Fcons (Qselect_window
,
5881 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5884 case TOOL_BAR_EVENT
:
5885 if (EQ (event
->arg
, event
->frame_or_window
))
5886 /* This is the prefix key. We translate this to
5887 `(tool_bar)' because the code in keyboard.c for tool bar
5888 events, which we use, relies on this. */
5889 return Fcons (Qtool_bar
, Qnil
);
5890 else if (SYMBOLP (event
->arg
))
5891 return apply_modifiers (event
->modifiers
, event
->arg
);
5894 case USER_SIGNAL_EVENT
:
5895 /* A user signal. */
5897 char *name
= find_user_signal_name (event
->code
);
5900 return intern (name
);
5903 case SAVE_SESSION_EVENT
:
5904 return Qsave_session
;
5909 return Fcons (Qdbus_event
, event
->arg
);
5911 #endif /* HAVE_DBUS */
5913 case CONFIG_CHANGED_EVENT
:
5914 return Fcons (Qconfig_changed_event
,
5916 Fcons (event
->frame_or_window
, Qnil
)));
5918 case GPM_CLICK_EVENT
:
5920 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5921 Lisp_Object head
, position
;
5922 Lisp_Object
*start_pos_ptr
;
5923 Lisp_Object start_pos
;
5924 int button
= event
->code
;
5926 if (button
>= ASIZE (button_down_location
))
5928 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5929 button_down_location
= larger_vector (button_down_location
,
5931 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5934 start_pos_ptr
= aref_addr (button_down_location
, button
);
5935 start_pos
= *start_pos_ptr
;
5937 position
= make_lispy_position (f
, event
->x
, event
->y
,
5940 if (event
->modifiers
& down_modifier
)
5941 *start_pos_ptr
= Fcopy_alist (position
);
5942 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5944 if (!CONSP (start_pos
))
5946 event
->modifiers
&= ~up_modifier
;
5949 head
= modify_event_symbol (button
,
5951 Qmouse_click
, Vlispy_mouse_stem
,
5954 ASIZE (mouse_syms
));
5956 if (event
->modifiers
& drag_modifier
)
5961 else if (event
->modifiers
& double_modifier
)
5964 Fcons (make_number (2),
5966 else if (event
->modifiers
& triple_modifier
)
5969 Fcons (make_number (3),
5976 #endif /* HAVE_GPM */
5978 /* The 'kind' field of the event is something we don't recognize. */
5984 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
5987 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5988 Lisp_Object x
, Lisp_Object y
, Time t
)
5990 /* Is it a scroll bar movement? */
5991 if (frame
&& ! NILP (bar_window
))
5993 Lisp_Object part_sym
;
5995 part_sym
= *scroll_bar_parts
[(int) part
];
5996 return Fcons (Qscroll_bar_movement
,
5997 Fcons (list5 (bar_window
,
5998 Qvertical_scroll_bar
,
6004 /* Or is it an ordinary mouse movement? */
6007 Lisp_Object position
;
6008 position
= make_lispy_position (frame
, x
, y
, t
);
6009 return list2 (Qmouse_movement
, position
);
6013 #endif /* HAVE_MOUSE || HAVE GPM */
6015 /* Construct a switch frame event. */
6017 make_lispy_switch_frame (Lisp_Object frame
)
6019 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6022 /* Manipulating modifiers. */
6024 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6026 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6027 SYMBOL's name of the end of the modifiers; the string from this
6028 position is the unmodified symbol name.
6030 This doesn't use any caches. */
6033 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6039 CHECK_SYMBOL (symbol
);
6042 name
= SYMBOL_NAME (symbol
);
6044 for (i
= 0; i
< SBYTES (name
) - 1; )
6046 ptrdiff_t this_mod_end
= 0;
6049 /* See if the name continues with a modifier word.
6050 Check that the word appears, but don't check what follows it.
6051 Set this_mod and this_mod_end to record what we find. */
6053 switch (SREF (name
, i
))
6055 #define SINGLE_LETTER_MOD(BIT) \
6056 (this_mod_end = i + 1, this_mod = BIT)
6059 SINGLE_LETTER_MOD (alt_modifier
);
6063 SINGLE_LETTER_MOD (ctrl_modifier
);
6067 SINGLE_LETTER_MOD (hyper_modifier
);
6071 SINGLE_LETTER_MOD (meta_modifier
);
6075 SINGLE_LETTER_MOD (shift_modifier
);
6079 SINGLE_LETTER_MOD (super_modifier
);
6082 #undef SINGLE_LETTER_MOD
6084 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6085 if (i + LEN + 1 <= SBYTES (name) \
6086 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6088 this_mod_end = i + LEN; \
6093 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6094 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6095 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6099 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6101 #undef MULTI_LETTER_MOD
6105 /* If we found no modifier, stop looking for them. */
6106 if (this_mod_end
== 0)
6109 /* Check there is a dash after the modifier, so that it
6110 really is a modifier. */
6111 if (this_mod_end
>= SBYTES (name
)
6112 || SREF (name
, this_mod_end
) != '-')
6115 /* This modifier is real; look for another. */
6116 modifiers
|= this_mod
;
6117 i
= this_mod_end
+ 1;
6120 /* Should we include the `click' modifier? */
6121 if (! (modifiers
& (down_modifier
| drag_modifier
6122 | double_modifier
| triple_modifier
))
6123 && i
+ 7 == SBYTES (name
)
6124 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6125 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6126 modifiers
|= click_modifier
;
6128 if (! (modifiers
& (double_modifier
| triple_modifier
))
6129 && i
+ 6 < SBYTES (name
)
6130 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6131 modifiers
|= click_modifier
;
6139 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6140 prepended to the string BASE[0..BASE_LEN-1].
6141 This doesn't use any caches. */
6143 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6145 /* Since BASE could contain nulls, we can't use intern here; we have
6146 to use Fintern, which expects a genuine Lisp_String, and keeps a
6148 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6154 /* Only the event queue may use the `up' modifier; it should always
6155 be turned into a click or drag event before presented to lisp code. */
6156 if (modifiers
& up_modifier
)
6159 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6160 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6161 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6162 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6163 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6164 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6165 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6166 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6167 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6168 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6169 /* The click modifier is denoted by the absence of other modifiers. */
6173 mod_len
= p
- new_mods
;
6177 Lisp_Object new_name
;
6179 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6180 mod_len
+ base_len_byte
);
6181 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6182 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6184 return Fintern (new_name
, Qnil
);
6189 static const char *const modifier_names
[] =
6191 "up", "down", "drag", "click", "double", "triple", 0, 0,
6192 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6193 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6195 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6197 static Lisp_Object modifier_symbols
;
6199 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6201 lispy_modifier_list (int modifiers
)
6203 Lisp_Object modifier_list
;
6206 modifier_list
= Qnil
;
6207 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6208 if (modifiers
& (1<<i
))
6209 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6212 return modifier_list
;
6216 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6217 where UNMODIFIED is the unmodified form of SYMBOL,
6218 MASK is the set of modifiers present in SYMBOL's name.
6219 This is similar to parse_modifiers_uncached, but uses the cache in
6220 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6221 Qevent_symbol_elements property. */
6223 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6226 parse_modifiers (Lisp_Object symbol
)
6228 Lisp_Object elements
;
6230 if (INTEGERP (symbol
))
6231 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6232 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6234 else if (!SYMBOLP (symbol
))
6237 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6238 if (CONSP (elements
))
6243 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6244 Lisp_Object unmodified
;
6247 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6248 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6251 if (modifiers
& ~INTMASK
)
6253 XSETFASTINT (mask
, modifiers
);
6254 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6256 /* Cache the parsing results on SYMBOL. */
6257 Fput (symbol
, Qevent_symbol_element_mask
,
6259 Fput (symbol
, Qevent_symbol_elements
,
6260 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6262 /* Since we know that SYMBOL is modifiers applied to unmodified,
6263 it would be nice to put that in unmodified's cache.
6264 But we can't, since we're not sure that parse_modifiers is
6271 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6272 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6273 doc
: /* Parse the event symbol. For internal use. */)
6274 (Lisp_Object symbol
)
6276 /* Fill the cache if needed. */
6277 parse_modifiers (symbol
);
6278 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6279 and use the Lispier representation stored on Qevent_symbol_elements
6281 return Fget (symbol
, Qevent_symbol_elements
);
6284 /* Apply the modifiers MODIFIERS to the symbol BASE.
6285 BASE must be unmodified.
6287 This is like apply_modifiers_uncached, but uses BASE's
6288 Qmodifier_cache property, if present. It also builds
6289 Qevent_symbol_elements properties, since it has that info anyway.
6291 apply_modifiers copies the value of BASE's Qevent_kind property to
6292 the modified symbol. */
6294 apply_modifiers (int modifiers
, Lisp_Object base
)
6296 Lisp_Object cache
, idx
, entry
, new_symbol
;
6298 /* Mask out upper bits. We don't know where this value's been. */
6299 modifiers
&= INTMASK
;
6301 if (INTEGERP (base
))
6302 return make_number (XINT (base
) | modifiers
);
6304 /* The click modifier never figures into cache indices. */
6305 cache
= Fget (base
, Qmodifier_cache
);
6306 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6307 entry
= assq_no_quit (idx
, cache
);
6310 new_symbol
= XCDR (entry
);
6313 /* We have to create the symbol ourselves. */
6314 new_symbol
= apply_modifiers_uncached (modifiers
,
6315 SSDATA (SYMBOL_NAME (base
)),
6316 SCHARS (SYMBOL_NAME (base
)),
6317 SBYTES (SYMBOL_NAME (base
)));
6319 /* Add the new symbol to the base's cache. */
6320 entry
= Fcons (idx
, new_symbol
);
6321 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6323 /* We have the parsing info now for free, so we could add it to
6325 XSETFASTINT (idx, modifiers);
6326 Fput (new_symbol, Qevent_symbol_element_mask,
6327 Fcons (base, Fcons (idx, Qnil)));
6328 Fput (new_symbol, Qevent_symbol_elements,
6329 Fcons (base, lispy_modifier_list (modifiers)));
6330 Sadly, this is only correct if `base' is indeed a base event,
6331 which is not necessarily the case. -stef */
6334 /* Make sure this symbol is of the same kind as BASE.
6336 You'd think we could just set this once and for all when we
6337 intern the symbol above, but reorder_modifiers may call us when
6338 BASE's property isn't set right; we can't assume that just
6339 because it has a Qmodifier_cache property it must have its
6340 Qevent_kind set right as well. */
6341 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6345 kind
= Fget (base
, Qevent_kind
);
6347 Fput (new_symbol
, Qevent_kind
, kind
);
6354 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6355 return a symbol with the modifiers placed in the canonical order.
6356 Canonical order is alphabetical, except for down and drag, which
6357 always come last. The 'click' modifier is never written out.
6359 Fdefine_key calls this to make sure that (for example) C-M-foo
6360 and M-C-foo end up being equivalent in the keymap. */
6363 reorder_modifiers (Lisp_Object symbol
)
6365 /* It's hopefully okay to write the code this way, since everything
6366 will soon be in caches, and no consing will be done at all. */
6369 parsed
= parse_modifiers (symbol
);
6370 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6375 /* For handling events, we often want to produce a symbol whose name
6376 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6377 to some base, like the name of a function key or mouse button.
6378 modify_event_symbol produces symbols of this sort.
6380 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6381 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6384 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6385 into symbol names, or a string specifying a name stem used to
6386 construct a symbol name or the form `STEM-N', where N is the decimal
6387 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6388 non-nil; otherwise NAME_TABLE is used.
6390 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6391 persist between calls to modify_event_symbol that it can use to
6392 store a cache of the symbols it's generated for this NAME_TABLE
6393 before. The object stored there may be a vector or an alist.
6395 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6397 MODIFIERS is a set of modifier bits (as given in struct input_events)
6398 whose prefixes should be applied to the symbol name.
6400 SYMBOL_KIND is the value to be placed in the event_kind property of
6401 the returned symbol.
6403 The symbols we create are supposed to have an
6404 `event-symbol-elements' property, which lists the modifiers present
6405 in the symbol's name. */
6408 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6409 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6410 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6413 Lisp_Object symbol_int
;
6415 /* Get rid of the "vendor-specific" bit here. */
6416 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6418 /* Is this a request for a valid symbol? */
6419 if (symbol_num
< 0 || symbol_num
>= table_size
)
6422 if (CONSP (*symbol_table
))
6423 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6425 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6426 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6427 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6428 we've never used that symbol before. */
6431 if (! VECTORP (*symbol_table
)
6432 || ASIZE (*symbol_table
) != table_size
)
6436 XSETFASTINT (size
, table_size
);
6437 *symbol_table
= Fmake_vector (size
, Qnil
);
6440 value
= AREF (*symbol_table
, symbol_num
);
6443 /* Have we already used this symbol before? */
6446 /* No; let's create it. */
6447 if (CONSP (name_alist_or_stem
))
6448 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6449 else if (STRINGP (name_alist_or_stem
))
6452 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6453 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6455 buf
= SAFE_ALLOCA (len
);
6456 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6457 XINT (symbol_int
) + 1);
6458 value
= intern (buf
);
6461 else if (name_table
!= 0 && name_table
[symbol_num
])
6462 value
= intern (name_table
[symbol_num
]);
6464 #ifdef HAVE_WINDOW_SYSTEM
6467 char *name
= x_get_keysym_name (symbol_num
);
6469 value
= intern (name
);
6475 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6476 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6477 value
= intern (buf
);
6480 if (CONSP (*symbol_table
))
6481 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6483 ASET (*symbol_table
, symbol_num
, value
);
6485 /* Fill in the cache entries for this symbol; this also
6486 builds the Qevent_symbol_elements property, which the user
6488 apply_modifiers (modifiers
& click_modifier
, value
);
6489 Fput (value
, Qevent_kind
, symbol_kind
);
6492 /* Apply modifiers to that symbol. */
6493 return apply_modifiers (modifiers
, value
);
6496 /* Convert a list that represents an event type,
6497 such as (ctrl meta backspace), into the usual representation of that
6498 event type as a number or a symbol. */
6500 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6501 doc
: /* Convert the event description list EVENT-DESC to an event type.
6502 EVENT-DESC should contain one base event type (a character or symbol)
6503 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6504 drag, down, double or triple). The base must be last.
6505 The return value is an event type (a character or symbol) which
6506 has the same base event type and all the specified modifiers. */)
6507 (Lisp_Object event_desc
)
6515 while (CONSP (rest
))
6523 /* Given a symbol, see if it is a modifier name. */
6524 if (SYMBOLP (elt
) && CONSP (rest
))
6525 this = parse_solitary_modifier (elt
);
6529 else if (!NILP (base
))
6530 error ("Two bases given in one event");
6536 /* Let the symbol A refer to the character A. */
6537 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6538 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6540 if (INTEGERP (base
))
6542 /* Turn (shift a) into A. */
6543 if ((modifiers
& shift_modifier
) != 0
6544 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6546 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6547 modifiers
&= ~shift_modifier
;
6550 /* Turn (control a) into C-a. */
6551 if (modifiers
& ctrl_modifier
)
6552 return make_number ((modifiers
& ~ctrl_modifier
)
6553 | make_ctrl_char (XINT (base
)));
6555 return make_number (modifiers
| XINT (base
));
6557 else if (SYMBOLP (base
))
6558 return apply_modifiers (modifiers
, base
);
6561 error ("Invalid base event");
6566 /* Try to recognize SYMBOL as a modifier name.
6567 Return the modifier flag bit, or 0 if not recognized. */
6570 parse_solitary_modifier (Lisp_Object symbol
)
6572 Lisp_Object name
= SYMBOL_NAME (symbol
);
6574 switch (SREF (name
, 0))
6576 #define SINGLE_LETTER_MOD(BIT) \
6577 if (SBYTES (name) == 1) \
6580 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6581 if (LEN == SBYTES (name) \
6582 && ! memcmp (SDATA (name), NAME, LEN)) \
6586 SINGLE_LETTER_MOD (alt_modifier
);
6590 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6594 SINGLE_LETTER_MOD (ctrl_modifier
);
6598 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6599 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6603 SINGLE_LETTER_MOD (hyper_modifier
);
6607 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6611 SINGLE_LETTER_MOD (meta_modifier
);
6615 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6619 SINGLE_LETTER_MOD (shift_modifier
);
6623 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6624 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6625 SINGLE_LETTER_MOD (super_modifier
);
6629 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6630 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6631 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6635 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6638 #undef SINGLE_LETTER_MOD
6639 #undef MULTI_LETTER_MOD
6645 /* Return true if EVENT is a list whose elements are all integers or symbols.
6646 Such a list is not valid as an event,
6647 but it can be a Lucid-style event type list. */
6650 lucid_event_type_list_p (Lisp_Object object
)
6654 if (! CONSP (object
))
6657 if (EQ (XCAR (object
), Qhelp_echo
)
6658 || EQ (XCAR (object
), Qvertical_line
)
6659 || EQ (XCAR (object
), Qmode_line
)
6660 || EQ (XCAR (object
), Qheader_line
))
6663 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6667 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6674 /* Return true if terminal input chars are available.
6675 Also, store the return value into INPUT_PENDING.
6677 Serves the purpose of ioctl (0, FIONREAD, ...)
6678 but works even if FIONREAD does not exist.
6679 (In fact, this may actually read some input.)
6681 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6682 timer events that are ripe.
6683 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6684 events (FOCUS_IN_EVENT).
6685 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6686 movements and toolkit scroll bar thumb drags. */
6689 get_input_pending (int flags
)
6691 /* First of all, have we already counted some input? */
6692 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6694 /* If input is being read as it arrives, and we have none, there is none. */
6695 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6697 /* Try to read some input and see how much we get. */
6699 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6702 return input_pending
;
6705 /* Put a BUFFER_SWITCH_EVENT in the buffer
6706 so that read_key_sequence will notice the new current buffer. */
6709 record_asynch_buffer_change (void)
6711 struct input_event event
;
6715 event
.kind
= BUFFER_SWITCH_EVENT
;
6716 event
.frame_or_window
= Qnil
;
6719 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6720 The purpose of the event is to make read_key_sequence look up the
6721 keymaps again. If we aren't in read_key_sequence, we don't need one,
6722 and the event could cause trouble by messing up (input-pending-p).
6723 Note: Fwaiting_for_user_input_p always returns nil when async
6724 subprocesses aren't supported. */
6725 tem
= Fwaiting_for_user_input_p ();
6729 /* Make sure no interrupt happens while storing the event. */
6731 if (interrupt_input
)
6732 kbd_buffer_store_event (&event
);
6737 kbd_buffer_store_event (&event
);
6742 /* Read any terminal input already buffered up by the system
6743 into the kbd_buffer, but do not wait.
6745 Return the number of keyboard chars read, or -1 meaning
6746 this is a bad time to try to read input. */
6755 /* Store pending user signal events, if any. */
6756 store_user_signal_events ();
6758 /* Loop through the available terminals, and call their input hooks. */
6762 struct terminal
*next
= t
->next_terminal
;
6764 if (t
->read_socket_hook
)
6767 struct input_event hold_quit
;
6769 if (input_blocked_p ())
6771 pending_signals
= 1;
6775 EVENT_INIT (hold_quit
);
6776 hold_quit
.kind
= NO_EVENT
;
6778 /* No need for FIONREAD or fcntl; just say don't wait. */
6779 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6782 if (nr
== -1) /* Not OK to read input now. */
6786 else if (nr
== -2) /* Non-transient error. */
6788 /* The terminal device terminated; it should be closed. */
6790 /* Kill Emacs if this was our last terminal. */
6791 if (!terminal_list
->next_terminal
)
6792 /* Formerly simply reported no input, but that
6793 sometimes led to a failure of Emacs to terminate.
6794 SIGHUP seems appropriate if we can't reach the
6796 /* ??? Is it really right to send the signal just to
6797 this process rather than to the whole process
6798 group? Perhaps on systems with FIONREAD Emacs is
6799 alone in its group. */
6800 terminate_due_to_signal (SIGHUP
, 10);
6802 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6805 XSETTERMINAL (tmp
, t
);
6806 Fdelete_terminal (tmp
, Qnoelisp
);
6810 if (hold_quit
.kind
!= NO_EVENT
)
6811 kbd_buffer_store_event (&hold_quit
);
6820 frame_make_pointer_visible ();
6826 decode_keyboard_code (struct tty_display_info
*tty
,
6827 struct coding_system
*coding
,
6828 unsigned char *buf
, int nbytes
)
6830 unsigned char *src
= buf
;
6831 const unsigned char *p
;
6836 if (tty
->meta_key
!= 2)
6837 for (i
= 0; i
< nbytes
; i
++)
6839 if (coding
->carryover_bytes
> 0)
6841 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6842 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6843 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6844 nbytes
+= coding
->carryover_bytes
;
6846 coding
->destination
= alloca (nbytes
* 4);
6847 coding
->dst_bytes
= nbytes
* 4;
6848 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6849 if (coding
->produced_char
== 0)
6851 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6853 struct input_event event_buf
;
6855 EVENT_INIT (event_buf
);
6856 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6858 (ASCII_CHAR_P (event_buf
.code
)
6859 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6860 /* See the comment in tty_read_avail_input. */
6861 event_buf
.frame_or_window
= tty
->top_frame
;
6862 event_buf
.arg
= Qnil
;
6863 kbd_buffer_store_event (&event_buf
);
6867 /* This is the tty way of reading available input.
6869 Note that each terminal device has its own `struct terminal' object,
6870 and so this function is called once for each individual termcap
6871 terminal. The first parameter indicates which terminal to read from. */
6874 tty_read_avail_input (struct terminal
*terminal
,
6875 struct input_event
*hold_quit
)
6877 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6878 the kbd_buffer can really hold. That may prevent loss
6879 of characters on some systems when input is stuffed at us. */
6880 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6882 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6885 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6887 if (kbd_on_hold_p () || buffer_free
<= 0)
6889 #endif /* subprocesses */
6891 if (!terminal
->name
) /* Don't read from a dead terminal. */
6894 if (terminal
->type
!= output_termcap
6895 && terminal
->type
!= output_msdos_raw
)
6898 /* XXX I think the following code should be moved to separate hook
6899 functions in system-dependent files. */
6902 #else /* not WINDOWSNT */
6903 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6907 return 0; /* The terminal is suspended. */
6910 n_to_read
= dos_keysns ();
6914 cbuf
[0] = dos_keyread ();
6917 #else /* not MSDOS */
6922 struct input_event gpm_hold_quit
;
6923 int gpm
, fd
= gpm_fd
;
6925 EVENT_INIT (gpm_hold_quit
);
6926 gpm_hold_quit
.kind
= NO_EVENT
;
6928 /* gpm==1 if event received.
6929 gpm==0 if the GPM daemon has closed the connection, in which case
6930 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6931 we save it in `fd' so close_gpm can remove it from the
6933 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6934 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6935 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6938 /* Presumably the GPM daemon has closed the connection. */
6940 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6941 kbd_buffer_store_event (&gpm_hold_quit
);
6945 #endif /* HAVE_GPM */
6947 /* Determine how many characters we should *try* to read. */
6948 #ifdef USABLE_FIONREAD
6949 /* Find out how much input is available. */
6950 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6952 if (! noninteractive
)
6953 return -2; /* Close this terminal. */
6959 if (n_to_read
> sizeof cbuf
)
6960 n_to_read
= sizeof cbuf
;
6961 #elif defined USG || defined CYGWIN
6962 /* Read some input if available, but don't wait. */
6963 n_to_read
= sizeof cbuf
;
6964 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6966 # error "Cannot read without possibly delaying"
6970 /* Don't read more than we can store. */
6971 if (n_to_read
> buffer_free
)
6972 n_to_read
= buffer_free
;
6973 #endif /* subprocesses */
6975 /* Now read; for one reason or another, this will not block.
6976 NREAD is set to the number of chars read. */
6979 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6980 /* POSIX infers that processes which are not in the session leader's
6981 process group won't get SIGHUP's at logout time. BSDI adheres to
6982 this part standard and returns -1 from read (0) with errno==EIO
6983 when the control tty is taken away.
6984 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6985 if (nread
== -1 && errno
== EIO
)
6986 return -2; /* Close this terminal. */
6987 #if defined (AIX) && defined (_BSD)
6988 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6989 This looks incorrect, but it isn't, because _BSD causes
6990 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6991 and that causes a value other than 0 when there is no input. */
6993 return -2; /* Close this terminal. */
6997 /* We used to retry the read if it was interrupted.
6998 But this does the wrong thing when O_NDELAY causes
6999 an EAGAIN error. Does anybody know of a situation
7000 where a retry is actually needed? */
7002 nread
< 0 && (errno
== EAGAIN
7015 #ifndef USABLE_FIONREAD
7016 #if defined (USG) || defined (CYGWIN)
7017 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7018 #endif /* USG or CYGWIN */
7019 #endif /* no FIONREAD */
7024 #endif /* not MSDOS */
7025 #endif /* not WINDOWSNT */
7027 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7028 & CODING_REQUIRE_DECODING_MASK
)
7030 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7033 /* Decode the key sequence except for those with meta
7035 for (i
= from
= 0; ; i
++)
7036 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7038 struct input_event buf
;
7040 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7045 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7046 buf
.modifiers
= meta_modifier
;
7047 buf
.code
= cbuf
[i
] & ~0x80;
7048 /* See the comment below. */
7049 buf
.frame_or_window
= tty
->top_frame
;
7051 kbd_buffer_store_event (&buf
);
7057 for (i
= 0; i
< nread
; i
++)
7059 struct input_event buf
;
7061 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7063 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7064 buf
.modifiers
= meta_modifier
;
7065 if (tty
->meta_key
!= 2)
7069 /* Set the frame corresponding to the active tty. Note that the
7070 value of selected_frame is not reliable here, redisplay tends
7071 to temporarily change it. */
7072 buf
.frame_or_window
= tty
->top_frame
;
7075 kbd_buffer_store_event (&buf
);
7076 /* Don't look at input that follows a C-g too closely.
7077 This reduces lossage due to autorepeat on C-g. */
7078 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7079 && buf
.code
== quit_char
)
7087 handle_async_input (void)
7092 int nread
= gobble_input ();
7093 /* -1 means it's not ok to read the input now.
7094 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7095 0 means there was no keyboard input available. */
7103 process_pending_signals (void)
7105 pending_signals
= 0;
7106 handle_async_input ();
7107 do_pending_atimers ();
7110 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7111 and also (if the level is now 0) reinvoke any pending signal. */
7114 unblock_input_to (int level
)
7116 interrupt_input_blocked
= level
;
7119 if (pending_signals
)
7120 process_pending_signals ();
7126 /* End critical section.
7128 If doing signal-driven input, and a signal came in when input was
7129 blocked, reinvoke the signal handler now to deal with it. */
7132 unblock_input (void)
7134 unblock_input_to (interrupt_input_blocked
- 1);
7137 /* Undo any number of BLOCK_INPUT calls,
7138 and also reinvoke any pending signal. */
7141 totally_unblock_input (void)
7143 unblock_input_to (0);
7149 handle_input_available_signal (int sig
)
7151 pending_signals
= 1;
7153 if (input_available_clear_time
)
7154 *input_available_clear_time
= make_emacs_time (0, 0);
7158 deliver_input_available_signal (int sig
)
7160 deliver_process_signal (sig
, handle_input_available_signal
);
7162 #endif /* USABLE_SIGIO */
7165 /* User signal events. */
7167 struct user_signal_info
7169 /* Signal number. */
7172 /* Name of the signal. */
7175 /* Number of pending signals. */
7178 struct user_signal_info
*next
;
7181 /* List of user signals. */
7182 static struct user_signal_info
*user_signals
= NULL
;
7185 add_user_signal (int sig
, const char *name
)
7187 struct sigaction action
;
7188 struct user_signal_info
*p
;
7190 for (p
= user_signals
; p
; p
= p
->next
)
7192 /* Already added. */
7195 p
= xmalloc (sizeof *p
);
7197 p
->name
= xstrdup (name
);
7199 p
->next
= user_signals
;
7202 emacs_sigaction_init (&action
, deliver_user_signal
);
7203 sigaction (sig
, &action
, 0);
7207 handle_user_signal (int sig
)
7209 struct user_signal_info
*p
;
7210 const char *special_event_name
= NULL
;
7212 if (SYMBOLP (Vdebug_on_event
))
7213 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7215 for (p
= user_signals
; p
; p
= p
->next
)
7218 if (special_event_name
7219 && strcmp (special_event_name
, p
->name
) == 0)
7221 /* Enter the debugger in many ways. */
7222 debug_on_next_call
= 1;
7225 Vinhibit_quit
= Qnil
;
7227 /* Eat the event. */
7233 if (interrupt_input
)
7234 handle_input_available_signal (sig
);
7238 /* Tell wait_reading_process_output that it needs to wake
7239 up and look around. */
7240 if (input_available_clear_time
)
7241 *input_available_clear_time
= make_emacs_time (0, 0);
7248 deliver_user_signal (int sig
)
7250 deliver_process_signal (sig
, handle_user_signal
);
7254 find_user_signal_name (int sig
)
7256 struct user_signal_info
*p
;
7258 for (p
= user_signals
; p
; p
= p
->next
)
7266 store_user_signal_events (void)
7268 struct user_signal_info
*p
;
7269 struct input_event buf
;
7270 bool buf_initialized
= 0;
7272 for (p
= user_signals
; p
; p
= p
->next
)
7273 if (p
->npending
> 0)
7275 if (! buf_initialized
)
7277 memset (&buf
, 0, sizeof buf
);
7278 buf
.kind
= USER_SIGNAL_EVENT
;
7279 buf
.frame_or_window
= selected_frame
;
7280 buf_initialized
= 1;
7286 kbd_buffer_store_event (&buf
);
7289 while (p
->npending
> 0);
7294 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7295 static Lisp_Object menu_bar_one_keymap_changed_items
;
7297 /* These variables hold the vector under construction within
7298 menu_bar_items and its subroutines, and the current index
7299 for storing into that vector. */
7300 static Lisp_Object menu_bar_items_vector
;
7301 static int menu_bar_items_index
;
7304 static const char* separator_names
[] = {
7309 "single-dashed-line",
7310 "double-dashed-line",
7312 "shadow-etched-out",
7313 "shadow-etched-in-dash",
7314 "shadow-etched-out-dash",
7315 "shadow-double-etched-in",
7316 "shadow-double-etched-out",
7317 "shadow-double-etched-in-dash",
7318 "shadow-double-etched-out-dash",
7322 /* Return true if LABEL specifies a separator. */
7325 menu_separator_name_p (const char *label
)
7329 else if (strlen (label
) > 3
7330 && memcmp (label
, "--", 2) == 0
7335 for (i
= 0; separator_names
[i
]; ++i
)
7336 if (strcmp (label
, separator_names
[i
]) == 0)
7341 /* It's a separator if it contains only dashes. */
7342 while (*label
== '-')
7344 return (*label
== 0);
7351 /* Return a vector of menu items for a menu bar, appropriate
7352 to the current buffer. Each item has three elements in the vector:
7355 OLD is an old vector we can optionally reuse, or nil. */
7358 menu_bar_items (Lisp_Object old
)
7360 /* The number of keymaps we're scanning right now, and the number of
7361 keymaps we have allocated space for. */
7364 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7365 in the current keymaps, or nil where it is not a prefix. */
7368 Lisp_Object def
, tail
;
7373 /* In order to build the menus, we need to call the keymap
7374 accessors. They all call QUIT. But this function is called
7375 during redisplay, during which a quit is fatal. So inhibit
7376 quitting while building the menus.
7377 We do this instead of specbind because (1) errors will clear it anyway
7378 and (2) this avoids risk of specpdl overflow. */
7379 oquit
= Vinhibit_quit
;
7383 menu_bar_items_vector
= old
;
7385 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7386 menu_bar_items_index
= 0;
7388 /* Build our list of keymaps.
7389 If we recognize a function key and replace its escape sequence in
7390 keybuf with its symbol, or if the sequence starts with a mouse
7391 click and we need to switch buffers, we jump back here to rebuild
7392 the initial keymaps from the current buffer. */
7396 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7397 if (!NILP (Voverriding_local_map_menu_flag
))
7399 /* Yes, use them (if non-nil) as well as the global map. */
7400 maps
= alloca (3 * sizeof (maps
[0]));
7402 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7403 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7404 if (!NILP (Voverriding_local_map
))
7405 maps
[nmaps
++] = Voverriding_local_map
;
7409 /* No, so use major and minor mode keymaps and keymap property.
7410 Note that menu-bar bindings in the local-map and keymap
7411 properties may not work reliable, as they are only
7412 recognized when the menu-bar (or mode-line) is updated,
7413 which does not normally happen after every command. */
7416 nminor
= current_minor_maps (NULL
, &tmaps
);
7417 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7419 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7420 maps
[nmaps
++] = tem
;
7421 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7423 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7425 maps
[nmaps
++] = current_global_map
;
7428 /* Look up in each map the dummy prefix key `menu-bar'. */
7430 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7431 if (!NILP (maps
[mapno
]))
7433 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7437 menu_bar_one_keymap_changed_items
= Qnil
;
7438 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7442 /* Move to the end those items that should be at the end. */
7444 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7447 int end
= menu_bar_items_index
;
7449 for (i
= 0; i
< end
; i
+= 4)
7450 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7452 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7453 /* Move the item at index I to the end,
7454 shifting all the others forward. */
7455 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7456 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7457 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7458 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7460 memmove (aref_addr (menu_bar_items_vector
, i
),
7461 aref_addr (menu_bar_items_vector
, i
+ 4),
7462 (end
- i
- 4) * word_size
);
7463 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7464 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7465 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7466 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7471 /* Add nil, nil, nil, nil at the end. */
7473 int i
= menu_bar_items_index
;
7474 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7475 menu_bar_items_vector
=
7476 larger_vector (menu_bar_items_vector
, 4, -1);
7477 /* Add this item. */
7478 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7479 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7480 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7481 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7482 menu_bar_items_index
= i
;
7485 Vinhibit_quit
= oquit
;
7486 return menu_bar_items_vector
;
7489 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7490 If there's already an item for KEY, add this DEF to it. */
7492 Lisp_Object item_properties
;
7495 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7497 struct gcpro gcpro1
;
7502 if (EQ (item
, Qundefined
))
7504 /* If a map has an explicit `undefined' as definition,
7505 discard any previously made menu bar item. */
7507 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7508 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7510 if (menu_bar_items_index
> i
+ 4)
7511 memmove (aref_addr (menu_bar_items_vector
, i
),
7512 aref_addr (menu_bar_items_vector
, i
+ 4),
7513 (menu_bar_items_index
- i
- 4) * word_size
);
7514 menu_bar_items_index
-= 4;
7518 /* If this keymap has already contributed to this KEY,
7519 don't contribute to it a second time. */
7520 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7521 if (!NILP (tem
) || NILP (item
))
7524 menu_bar_one_keymap_changed_items
7525 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7527 /* We add to menu_bar_one_keymap_changed_items before doing the
7528 parse_menu_item, so that if it turns out it wasn't a menu item,
7529 it still correctly hides any further menu item. */
7531 parsed
= parse_menu_item (item
, 1);
7536 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7538 /* Find any existing item for this KEY. */
7539 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7540 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7543 /* If we did not find this KEY, add it at the end. */
7544 if (i
== menu_bar_items_index
)
7546 /* If vector is too small, get a bigger one. */
7547 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7548 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7549 /* Add this item. */
7550 ASET (menu_bar_items_vector
, i
, key
); i
++;
7551 ASET (menu_bar_items_vector
, i
,
7552 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7553 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7554 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7555 menu_bar_items_index
= i
;
7557 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7561 old
= AREF (menu_bar_items_vector
, i
+ 2);
7562 /* If the new and the old items are not both keymaps,
7563 the lookup will only find `item'. */
7564 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7565 ASET (menu_bar_items_vector
, i
+ 2, item
);
7569 /* This is used as the handler when calling menu_item_eval_property. */
7571 menu_item_eval_property_1 (Lisp_Object arg
)
7573 /* If we got a quit from within the menu computation,
7574 quit all the way out of it. This takes care of C-] in the debugger. */
7575 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7576 Fsignal (Qquit
, Qnil
);
7582 eval_dyn (Lisp_Object form
)
7584 return Feval (form
, Qnil
);
7587 /* Evaluate an expression and return the result (or nil if something
7588 went wrong). Used to evaluate dynamic parts of menu items. */
7590 menu_item_eval_property (Lisp_Object sexpr
)
7592 ptrdiff_t count
= SPECPDL_INDEX ();
7594 specbind (Qinhibit_redisplay
, Qt
);
7595 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7596 menu_item_eval_property_1
);
7597 return unbind_to (count
, val
);
7600 /* This function parses a menu item and leaves the result in the
7601 vector item_properties.
7602 ITEM is a key binding, a possible menu item.
7603 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7605 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7606 parse_menu_item returns true if the item is a menu item and false
7610 parse_menu_item (Lisp_Object item
, int inmenubar
)
7612 Lisp_Object def
, tem
, item_string
, start
;
7614 Lisp_Object keyhint
;
7623 /* Create item_properties vector if necessary. */
7624 if (NILP (item_properties
))
7626 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7628 /* Initialize optional entries. */
7629 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7630 ASET (item_properties
, i
, Qnil
);
7631 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7633 /* Save the item here to protect it from GC. */
7634 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7636 item_string
= XCAR (item
);
7640 if (STRINGP (item_string
))
7642 /* Old format menu item. */
7643 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7645 /* Maybe help string. */
7646 if (CONSP (item
) && STRINGP (XCAR (item
)))
7648 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7653 /* Maybe an obsolete key binding cache. */
7654 if (CONSP (item
) && CONSP (XCAR (item
))
7655 && (NILP (XCAR (XCAR (item
)))
7656 || VECTORP (XCAR (XCAR (item
)))))
7659 /* This is the real definition--the function to run. */
7660 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7662 /* Get enable property, if any. */
7665 tem
= Fget (item
, Qmenu_enable
);
7666 if (!NILP (Venable_disabled_menus_and_buttons
))
7667 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7668 else if (!NILP (tem
))
7669 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7672 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7674 /* New format menu item. */
7675 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7676 start
= XCDR (item
);
7679 /* We have a real binding. */
7680 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7682 item
= XCDR (start
);
7683 /* Is there an obsolete cache list with key equivalences. */
7684 if (CONSP (item
) && CONSP (XCAR (item
)))
7687 /* Parse properties. */
7688 while (CONSP (item
) && CONSP (XCDR (item
)))
7693 if (EQ (tem
, QCenable
))
7695 if (!NILP (Venable_disabled_menus_and_buttons
))
7696 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7698 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7700 else if (EQ (tem
, QCvisible
))
7702 /* If got a visible property and that evaluates to nil
7703 then ignore this item. */
7704 tem
= menu_item_eval_property (XCAR (item
));
7708 else if (EQ (tem
, QChelp
))
7709 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7710 else if (EQ (tem
, QCfilter
))
7712 else if (EQ (tem
, QCkey_sequence
))
7715 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7716 /* Be GC protected. Set keyhint to item instead of tem. */
7719 else if (EQ (tem
, QCkeys
))
7722 if (CONSP (tem
) || STRINGP (tem
))
7723 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7725 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7730 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7732 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7734 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7740 else if (inmenubar
|| !NILP (start
))
7744 return 0; /* not a menu item */
7746 /* If item string is not a string, evaluate it to get string.
7747 If we don't get a string, skip this item. */
7748 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7749 if (!(STRINGP (item_string
)))
7751 item_string
= menu_item_eval_property (item_string
);
7752 if (!STRINGP (item_string
))
7754 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7757 /* If got a filter apply it on definition. */
7758 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7761 def
= menu_item_eval_property (list2 (XCAR (filter
),
7762 list2 (Qquote
, def
)));
7764 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7767 /* Enable or disable selection of item. */
7768 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7771 tem
= menu_item_eval_property (tem
);
7772 if (inmenubar
&& NILP (tem
))
7773 return 0; /* Ignore disabled items in menu bar. */
7774 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7777 /* If we got no definition, this item is just unselectable text which
7778 is OK in a submenu but not in the menubar. */
7780 return (!inmenubar
);
7782 /* See if this is a separate pane or a submenu. */
7783 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7784 tem
= get_keymap (def
, 0, 1);
7785 /* For a subkeymap, just record its details and exit. */
7788 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7789 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7793 /* At the top level in the menu bar, do likewise for commands also.
7794 The menu bar does not display equivalent key bindings anyway.
7795 ITEM_PROPERTY_DEF is already set up properly. */
7799 { /* This is a command. See if there is an equivalent key binding. */
7800 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7802 /* The previous code preferred :key-sequence to :keys, so we
7803 preserve this behavior. */
7804 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7805 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7808 Lisp_Object prefix
= keyeq
;
7809 Lisp_Object keys
= Qnil
;
7813 def
= XCAR (prefix
);
7814 prefix
= XCDR (prefix
);
7817 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7819 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7821 keys
= XCAR (keyhint
);
7822 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7824 /* We have a suggested key. Is it bound to the command? */
7827 /* If the command is an alias for another
7828 (such as lmenu.el set it up), check if the
7829 original command matches the cached command. */
7831 && EQ (tem
, XSYMBOL (def
)->function
))))
7836 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7840 tem
= Fkey_description (keys
, Qnil
);
7843 if (STRINGP (XCAR (prefix
)))
7844 tem
= concat2 (XCAR (prefix
), tem
);
7845 if (STRINGP (XCDR (prefix
)))
7846 tem
= concat2 (tem
, XCDR (prefix
));
7848 keyeq
= concat2 (build_string (" "), tem
);
7849 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7855 /* If we have an equivalent key binding, use that. */
7856 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7859 /* Include this when menu help is implemented.
7860 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7861 if (!(NILP (tem) || STRINGP (tem)))
7863 tem = menu_item_eval_property (tem);
7866 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7870 /* Handle radio buttons or toggle boxes. */
7871 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7873 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7874 menu_item_eval_property (tem
));
7881 /***********************************************************************
7883 ***********************************************************************/
7885 /* A vector holding tool bar items while they are parsed in function
7886 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7889 static Lisp_Object tool_bar_items_vector
;
7891 /* A vector holding the result of parse_tool_bar_item. Layout is like
7892 the one for a single item in tool_bar_items_vector. */
7894 static Lisp_Object tool_bar_item_properties
;
7896 /* Next free index in tool_bar_items_vector. */
7898 static int ntool_bar_items
;
7900 /* The symbols `:image' and `:rtl'. */
7902 static Lisp_Object QCimage
;
7903 static Lisp_Object QCrtl
;
7905 /* Function prototypes. */
7907 static void init_tool_bar_items (Lisp_Object
);
7908 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7909 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7910 static void append_tool_bar_item (void);
7913 /* Return a vector of tool bar items for keymaps currently in effect.
7914 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7915 tool bar items found. */
7918 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7927 /* In order to build the menus, we need to call the keymap
7928 accessors. They all call QUIT. But this function is called
7929 during redisplay, during which a quit is fatal. So inhibit
7930 quitting while building the menus. We do this instead of
7931 specbind because (1) errors will clear it anyway and (2) this
7932 avoids risk of specpdl overflow. */
7933 oquit
= Vinhibit_quit
;
7936 /* Initialize tool_bar_items_vector and protect it from GC. */
7937 init_tool_bar_items (reuse
);
7939 /* Build list of keymaps in maps. Set nmaps to the number of maps
7942 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7943 if (!NILP (Voverriding_local_map_menu_flag
))
7945 /* Yes, use them (if non-nil) as well as the global map. */
7946 maps
= alloca (3 * sizeof *maps
);
7948 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7949 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7950 if (!NILP (Voverriding_local_map
))
7951 maps
[nmaps
++] = Voverriding_local_map
;
7955 /* No, so use major and minor mode keymaps and keymap property.
7956 Note that tool-bar bindings in the local-map and keymap
7957 properties may not work reliable, as they are only
7958 recognized when the tool-bar (or mode-line) is updated,
7959 which does not normally happen after every command. */
7962 nminor
= current_minor_maps (NULL
, &tmaps
);
7963 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7965 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7966 maps
[nmaps
++] = tem
;
7967 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7969 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7972 /* Add global keymap at the end. */
7973 maps
[nmaps
++] = current_global_map
;
7975 /* Process maps in reverse order and look up in each map the prefix
7977 for (i
= nmaps
- 1; i
>= 0; --i
)
7978 if (!NILP (maps
[i
]))
7982 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7984 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7987 Vinhibit_quit
= oquit
;
7988 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7989 return tool_bar_items_vector
;
7993 /* Process the definition of KEY which is DEF. */
7996 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7999 struct gcpro gcpro1
, gcpro2
;
8001 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8005 if (EQ (def
, Qundefined
))
8007 /* If a map has an explicit `undefined' as definition,
8008 discard any previously made item. */
8009 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8011 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8013 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8015 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8016 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8017 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8019 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8024 else if (parse_tool_bar_item (key
, def
))
8025 /* Append a new tool bar item to tool_bar_items_vector. Accept
8026 more than one definition for the same key. */
8027 append_tool_bar_item ();
8032 /* Access slot with index IDX of vector tool_bar_item_properties. */
8033 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8035 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8037 ASET (tool_bar_item_properties
, idx
, val
);
8041 /* Parse a tool bar item specification ITEM for key KEY and return the
8042 result in tool_bar_item_properties. Value is false if ITEM is
8045 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8047 CAPTION is the caption of the item, If it's not a string, it is
8048 evaluated to get a string.
8050 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8051 as binding are currently ignored.
8053 The following properties are recognized:
8057 FORM is evaluated and specifies whether the tool bar item is
8058 enabled or disabled.
8062 FORM is evaluated and specifies whether the tool bar item is visible.
8064 - `:filter FUNCTION'
8066 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8067 result is stored as the new binding.
8069 - `:button (TYPE SELECTED)'
8071 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8072 and specifies whether the button is selected (pressed) or not.
8076 IMAGES is either a single image specification or a vector of four
8077 image specifications. See enum tool_bar_item_images.
8079 - `:help HELP-STRING'.
8081 Gives a help string to display for the tool bar item.
8083 - `:label LABEL-STRING'.
8085 A text label to show with the tool bar button if labels are enabled. */
8088 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8090 Lisp_Object filter
= Qnil
;
8091 Lisp_Object caption
;
8093 bool have_label
= 0;
8095 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8096 Rule out items that aren't lists, don't start with
8097 `menu-item' or whose rest following `tool-bar-item' is not a
8102 /* As an exception, allow old-style menu separators. */
8103 if (STRINGP (XCAR (item
)))
8104 item
= Fcons (XCAR (item
), Qnil
);
8105 else if (!EQ (XCAR (item
), Qmenu_item
)
8106 || (item
= XCDR (item
), !CONSP (item
)))
8109 /* Create tool_bar_item_properties vector if necessary. Reset it to
8111 if (VECTORP (tool_bar_item_properties
))
8113 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8117 tool_bar_item_properties
8118 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8121 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8122 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8124 /* Get the caption of the item. If the caption is not a string,
8125 evaluate it to get a string. If we don't get a string, skip this
8127 caption
= XCAR (item
);
8128 if (!STRINGP (caption
))
8130 caption
= menu_item_eval_property (caption
);
8131 if (!STRINGP (caption
))
8134 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8136 /* If the rest following the caption is not a list, the menu item is
8137 either a separator, or invalid. */
8141 if (menu_separator_name_p (SSDATA (caption
)))
8143 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8144 #if !defined (USE_GTK) && !defined (HAVE_NS)
8145 /* If we use build_desired_tool_bar_string to render the
8146 tool bar, the separator is rendered as an image. */
8147 PROP (TOOL_BAR_ITEM_IMAGES
)
8148 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8149 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8150 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8151 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8158 /* Store the binding. */
8159 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8162 /* Ignore cached key binding, if any. */
8163 if (CONSP (item
) && CONSP (XCAR (item
)))
8166 /* Process the rest of the properties. */
8167 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8169 Lisp_Object ikey
, value
;
8172 value
= XCAR (XCDR (item
));
8174 if (EQ (ikey
, QCenable
))
8176 /* `:enable FORM'. */
8177 if (!NILP (Venable_disabled_menus_and_buttons
))
8178 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8180 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8182 else if (EQ (ikey
, QCvisible
))
8184 /* `:visible FORM'. If got a visible property and that
8185 evaluates to nil then ignore this item. */
8186 if (NILP (menu_item_eval_property (value
)))
8189 else if (EQ (ikey
, QChelp
))
8190 /* `:help HELP-STRING'. */
8191 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8192 else if (EQ (ikey
, QCvert_only
))
8193 /* `:vert-only t/nil'. */
8194 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8195 else if (EQ (ikey
, QClabel
))
8197 const char *bad_label
= "!!?GARBLED ITEM?!!";
8198 /* `:label LABEL-STRING'. */
8199 set_prop (TOOL_BAR_ITEM_LABEL
,
8200 STRINGP (value
) ? value
: build_string (bad_label
));
8203 else if (EQ (ikey
, QCfilter
))
8204 /* ':filter FORM'. */
8206 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8208 /* `:button (TYPE . SELECTED)'. */
8209 Lisp_Object type
, selected
;
8211 type
= XCAR (value
);
8212 selected
= XCDR (value
);
8213 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8215 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8216 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8219 else if (EQ (ikey
, QCimage
)
8221 || (VECTORP (value
) && ASIZE (value
) == 4)))
8222 /* Value is either a single image specification or a vector
8223 of 4 such specifications for the different button states. */
8224 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8225 else if (EQ (ikey
, QCrtl
))
8227 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8233 /* Try to make one from caption and key. */
8234 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8235 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8236 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8237 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8239 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8240 char *buf
= xmalloc (max_lbl
+ 1);
8241 Lisp_Object new_lbl
;
8242 ptrdiff_t caption_len
= strlen (capt
);
8244 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8247 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8249 buf
[caption_len
] = '\0';
8253 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8257 strcpy (buf
, label
);
8259 for (j
= 0; buf
[j
] != '\0'; ++j
)
8267 new_lbl
= Fupcase_initials (build_string (label
));
8268 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8269 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8271 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8275 /* If got a filter apply it on binding. */
8277 set_prop (TOOL_BAR_ITEM_BINDING
,
8278 (menu_item_eval_property
8281 PROP (TOOL_BAR_ITEM_BINDING
))))));
8283 /* See if the binding is a keymap. Give up if it is. */
8284 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8287 /* Enable or disable selection of item. */
8288 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8289 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8290 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8292 /* Handle radio buttons or toggle boxes. */
8293 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8294 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8295 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8303 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8304 that can be reused. */
8307 init_tool_bar_items (Lisp_Object reuse
)
8309 if (VECTORP (reuse
))
8310 tool_bar_items_vector
= reuse
;
8312 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8313 ntool_bar_items
= 0;
8317 /* Append parsed tool bar item properties from
8318 tool_bar_item_properties */
8321 append_tool_bar_item (void)
8325 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8327 /* Enlarge tool_bar_items_vector if necessary. */
8329 tool_bar_items_vector
8330 = larger_vector (tool_bar_items_vector
, incr
, -1);
8332 /* Append entries from tool_bar_item_properties to the end of
8333 tool_bar_items_vector. */
8334 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8335 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8336 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8343 /* Read a character using menus based on maps in the array MAPS.
8344 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8345 Return t if we displayed a menu but the user rejected it.
8347 PREV_EVENT is the previous input event, or nil if we are reading
8348 the first event of a key sequence.
8350 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8351 if we used a mouse menu to read the input, or false otherwise. If
8352 USED_MOUSE_MENU is null, don't dereference it.
8354 The prompting is done based on the prompt-string of the map
8355 and the strings associated with various map elements.
8357 This can be done with X menus or with menus put in the minibuf.
8358 These are done in different ways, depending on how the input will be read.
8359 Menus using X are done after auto-saving in read-char, getting the input
8360 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8361 and do auto-saving in the inner call of read_char. */
8364 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8365 Lisp_Object prev_event
, bool *used_mouse_menu
)
8371 if (used_mouse_menu
)
8372 *used_mouse_menu
= 0;
8374 /* Use local over global Menu maps */
8376 if (! menu_prompting
)
8379 /* Optionally disregard all but the global map. */
8380 if (inhibit_local_menu_bar_menus
)
8382 maps
+= (nmaps
- 1);
8387 /* If we got to this point via a mouse click,
8388 use a real menu for mouse selection. */
8389 if (EVENT_HAS_PARAMETERS (prev_event
)
8390 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8391 && !EQ (XCAR (prev_event
), Qtool_bar
))
8393 /* Display the menu and get the selection. */
8394 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8396 ptrdiff_t nmaps1
= 0;
8398 /* Use the maps that are not nil. */
8399 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8400 if (!NILP (maps
[mapno
]))
8401 realmaps
[nmaps1
++] = maps
[mapno
];
8403 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8408 record_menu_key (XCAR (value
));
8410 /* If we got multiple events, unread all but
8412 There is no way to prevent those unread events
8413 from showing up later in last_nonmenu_event.
8414 So turn symbol and integer events into lists,
8415 to indicate that they came from a mouse menu,
8416 so that when present in last_nonmenu_event
8417 they won't confuse things. */
8418 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8420 record_menu_key (XCAR (tem
));
8421 if (SYMBOLP (XCAR (tem
))
8422 || INTEGERP (XCAR (tem
)))
8423 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8426 /* If we got more than one event, put all but the first
8427 onto this list to be read later.
8428 Return just the first event now. */
8429 Vunread_command_events
8430 = nconc2 (XCDR (value
), Vunread_command_events
);
8431 value
= XCAR (value
);
8433 else if (NILP (value
))
8435 if (used_mouse_menu
)
8436 *used_mouse_menu
= 1;
8439 #endif /* HAVE_MENUS */
8443 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8444 We make this bigger when necessary, and never free it. */
8445 static char *read_char_minibuf_menu_text
;
8446 /* Size of that buffer. */
8447 static ptrdiff_t read_char_minibuf_menu_width
;
8450 read_char_minibuf_menu_prompt (int commandflag
,
8451 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8454 register Lisp_Object name
;
8456 /* FIXME: Use the minibuffer's frame width. */
8457 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8459 bool nobindings
= 1;
8460 Lisp_Object rest
, vector
;
8466 if (! menu_prompting
)
8469 /* Get the menu name from the first map that has one (a prompt string). */
8470 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8472 name
= Fkeymap_prompt (maps
[mapno
]);
8477 /* If we don't have any menus, just read a character normally. */
8478 if (!STRINGP (name
))
8481 /* Make sure we have a big enough buffer for the menu text. */
8482 width
= max (width
, SBYTES (name
));
8483 if (STRING_BYTES_BOUND
- 4 < width
)
8484 memory_full (SIZE_MAX
);
8485 if (width
+ 4 > read_char_minibuf_menu_width
)
8487 read_char_minibuf_menu_text
8488 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8489 read_char_minibuf_menu_width
= width
+ 4;
8491 menu
= read_char_minibuf_menu_text
;
8493 /* Prompt string always starts with map's prompt, and a space. */
8494 strcpy (menu
, SSDATA (name
));
8495 nlength
= SBYTES (name
);
8496 menu
[nlength
++] = ':';
8497 menu
[nlength
++] = ' ';
8500 /* Start prompting at start of first map. */
8504 /* Present the documented bindings, a line at a time. */
8508 ptrdiff_t i
= nlength
;
8510 Lisp_Object orig_defn_macro
;
8512 /* Loop over elements of map. */
8517 /* If reached end of map, start at beginning of next map. */
8521 /* At end of last map, wrap around to first map if just starting,
8522 or end this line if already have something on it. */
8526 if (notfirst
|| nobindings
) break;
8531 /* Look at the next element of the map. */
8533 elt
= AREF (vector
, idx
);
8535 elt
= Fcar_safe (rest
);
8537 if (idx
< 0 && VECTORP (elt
))
8539 /* If we found a dense table in the keymap,
8540 advanced past it, but start scanning its contents. */
8541 rest
= Fcdr_safe (rest
);
8547 /* An ordinary element. */
8548 Lisp_Object event
, tem
;
8552 event
= Fcar_safe (elt
); /* alist */
8553 elt
= Fcdr_safe (elt
);
8557 XSETINT (event
, idx
); /* vector */
8560 /* Ignore the element if it has no prompt string. */
8561 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8563 /* True if the char to type matches the string. */
8565 Lisp_Object upcased_event
, downcased_event
;
8566 Lisp_Object desc
= Qnil
;
8568 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8570 upcased_event
= Fupcase (event
);
8571 downcased_event
= Fdowncase (event
);
8572 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8573 || XINT (downcased_event
) == SREF (s
, 0));
8575 desc
= Fsingle_key_description (event
, Qnil
);
8577 #if 0 /* It is redundant to list the equivalent key bindings because
8578 the prefix is what the user has already typed. */
8580 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8582 /* Insert equivalent keybinding. */
8583 s
= concat2 (s
, tem
);
8586 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8587 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8589 /* Insert button prefix. */
8590 Lisp_Object selected
8591 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8592 if (EQ (tem
, QCradio
))
8593 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8595 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8596 s
= concat2 (tem
, s
);
8600 /* If we have room for the prompt string, add it to this line.
8601 If this is the first on the line, always add it. */
8602 if ((SCHARS (s
) + i
+ 2
8603 + (char_matches
? 0 : SCHARS (desc
) + 3))
8607 ptrdiff_t thiswidth
;
8609 /* Punctuate between strings. */
8612 strcpy (menu
+ i
, ", ");
8618 /* If the char to type doesn't match the string's
8619 first char, explicitly show what char to type. */
8622 /* Add as much of string as fits. */
8623 thiswidth
= min (SCHARS (desc
), width
- i
);
8624 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8626 strcpy (menu
+ i
, " = ");
8630 /* Add as much of string as fits. */
8631 thiswidth
= min (SCHARS (s
), width
- i
);
8632 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8638 /* If this element does not fit, end the line now,
8639 and save the element for the next line. */
8640 strcpy (menu
+ i
, "...");
8645 /* Move past this element. */
8646 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8647 /* Handle reaching end of dense table. */
8652 rest
= Fcdr_safe (rest
);
8656 /* Prompt with that and read response. */
8657 message2_nolog (menu
, strlen (menu
),
8658 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8660 /* Make believe its not a keyboard macro in case the help char
8661 is pressed. Help characters are not recorded because menu prompting
8662 is not used on replay.
8664 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8665 kset_defining_kbd_macro (current_kboard
, Qnil
);
8667 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8668 while (BUFFERP (obj
));
8669 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8671 if (!INTEGERP (obj
))
8673 else if (XINT (obj
) == -2)
8676 if (! EQ (obj
, menu_prompt_more_char
)
8677 && (!INTEGERP (menu_prompt_more_char
)
8678 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8680 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8681 store_kbd_macro_char (obj
);
8684 /* Help char - go round again */
8688 /* Reading key sequences. */
8690 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8691 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8692 keymap, or nil otherwise. Return the index of the first keymap in
8693 which KEY has any binding, or NMAPS if no map has a binding.
8695 If KEY is a meta ASCII character, treat it like meta-prefix-char
8696 followed by the corresponding non-meta character. Keymaps in
8697 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8700 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8703 NEXT may be the same array as CURRENT. */
8706 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8707 Lisp_Object
*defs
, Lisp_Object
*next
)
8709 ptrdiff_t i
, first_binding
;
8711 first_binding
= nmaps
;
8712 for (i
= nmaps
- 1; i
>= 0; i
--)
8714 if (! NILP (current
[i
]))
8716 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8717 if (! NILP (defs
[i
]))
8724 /* Given the set of bindings we've found, produce the next set of maps. */
8725 if (first_binding
< nmaps
)
8726 for (i
= 0; i
< nmaps
; i
++)
8727 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8729 return first_binding
;
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 (! (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 (EQ (binding
, Qundefined
)
8862 || (!NILP (binding
) && SYMBOLP (binding
)
8863 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8866 /* Read a sequence of keys that ends with a non prefix character,
8867 storing it in KEYBUF, a buffer of size BUFSIZE.
8869 Return the length of the key sequence stored.
8870 Return -1 if the user rejected a command menu.
8872 Echo starting immediately unless `prompt' is 0.
8874 Where a key sequence ends depends on the currently active keymaps.
8875 These include any minor mode keymaps active in the current buffer,
8876 the current buffer's local map, and the global map.
8878 If a key sequence has no other bindings, we check Vfunction_key_map
8879 to see if some trailing subsequence might be the beginning of a
8880 function key's sequence. If so, we try to read the whole function
8881 key, and substitute its symbolic name into the key sequence.
8883 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8884 `double-' events into similar click events, if that would make them
8885 bound. We try to turn `triple-' events first into `double-' events,
8888 If we get a mouse click in a mode line, vertical divider, or other
8889 non-text area, we treat the click as if it were prefixed by the
8890 symbol denoting that area - `mode-line', `vertical-line', or
8893 If the sequence starts with a mouse click, we read the key sequence
8894 with respect to the buffer clicked on, not the current buffer.
8896 If the user switches frames in the midst of a key sequence, we put
8897 off the switch-frame event until later; the next call to
8898 read_char will return it.
8900 If FIX_CURRENT_BUFFER, we restore current_buffer
8901 from the selected window's buffer. */
8904 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8905 bool dont_downcase_last
, bool can_return_switch_frame
,
8906 bool fix_current_buffer
)
8908 Lisp_Object from_string
;
8909 ptrdiff_t count
= SPECPDL_INDEX ();
8911 /* How many keys there are in the current key sequence. */
8914 /* The length of the echo buffer when we started reading, and
8915 the length of this_command_keys when we started reading. */
8916 ptrdiff_t echo_start
IF_LINT (= 0);
8917 ptrdiff_t keys_start
;
8919 /* The number of keymaps we're scanning right now, and the number of
8920 keymaps we have allocated space for. */
8922 ptrdiff_t nmaps_allocated
= 0;
8924 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8925 the current keymaps. */
8926 Lisp_Object
*defs
= NULL
;
8928 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8929 in the current keymaps, or nil where it is not a prefix. */
8930 Lisp_Object
*submaps
= NULL
;
8932 /* The local map to start out with at start of key sequence. */
8933 Lisp_Object orig_local_map
;
8935 /* The map from the `keymap' property to start out with at start of
8937 Lisp_Object orig_keymap
;
8939 /* Positive if we have already considered switching to the local-map property
8940 of the place where a mouse click occurred. */
8941 int localized_local_map
= 0;
8943 /* The index in submaps[] of the first keymap that has a binding for
8944 this key sequence. In other words, the lowest i such that
8945 submaps[i] is non-nil. */
8946 ptrdiff_t first_binding
;
8947 /* Index of the first key that has no binding.
8948 It is useless to try fkey.start larger than that. */
8951 /* If t < mock_input, then KEYBUF[t] should be read as the next
8954 We use this to recover after recognizing a function key. Once we
8955 realize that a suffix of the current key sequence is actually a
8956 function key's escape sequence, we replace the suffix with the
8957 function key's binding from Vfunction_key_map. Now keybuf
8958 contains a new and different key sequence, so the echo area,
8959 this_command_keys, and the submaps and defs arrays are wrong. In
8960 this situation, we set mock_input to t, set t to 0, and jump to
8961 restart_sequence; the loop will read keys from keybuf up until
8962 mock_input, thus rebuilding the state; and then it will resume
8963 reading characters from the keyboard. */
8966 /* If the sequence is unbound in submaps[], then
8967 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8968 and fkey.map is its binding.
8970 These might be > t, indicating that all function key scanning
8971 should hold off until t reaches them. We do this when we've just
8972 recognized a function key, to avoid searching for the function
8973 key's again in Vfunction_key_map. */
8976 /* Likewise, for key_translation_map and input-decode-map. */
8977 keyremap keytran
, indec
;
8979 /* True if we are trying to map a key by changing an upper-case
8980 letter to lower case, or a shifted function key to an unshifted
8982 bool shift_translated
= 0;
8984 /* If we receive a `switch-frame' or `select-window' event in the middle of
8985 a key sequence, we put it off for later.
8986 While we're reading, we keep the event here. */
8987 Lisp_Object delayed_switch_frame
;
8989 /* See the comment below... */
8990 #if defined (GOBBLE_FIRST_EVENT)
8991 Lisp_Object first_event
;
8994 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8995 int original_uppercase_position
= -1;
8997 /* Gets around Microsoft compiler limitations. */
9000 struct buffer
*starting_buffer
;
9002 /* List of events for which a fake prefix key has been generated. */
9003 Lisp_Object fake_prefixed_keys
= Qnil
;
9005 #if defined (GOBBLE_FIRST_EVENT)
9009 struct gcpro gcpro1
;
9011 GCPRO1 (fake_prefixed_keys
);
9012 raw_keybuf_count
= 0;
9014 last_nonmenu_event
= Qnil
;
9016 delayed_switch_frame
= Qnil
;
9022 /* Install the string STR as the beginning of the string of
9023 echoing, so that it serves as a prompt for the next
9025 kset_echo_string (current_kboard
, prompt
);
9026 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9029 else if (cursor_in_echo_area
9030 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9031 && NILP (Fzerop (Vecho_keystrokes
)))
9032 /* This doesn't put in a dash if the echo buffer is empty, so
9033 you don't always see a dash hanging out in the minibuffer. */
9037 /* Record the initial state of the echo area and this_command_keys;
9038 we will need to restore them if we replay a key sequence. */
9040 echo_start
= echo_length ();
9041 keys_start
= this_command_key_count
;
9042 this_single_command_key_start
= keys_start
;
9044 #if defined (GOBBLE_FIRST_EVENT)
9045 /* This doesn't quite work, because some of the things that read_char
9046 does cannot safely be bypassed. It seems too risky to try to make
9049 /* Read the first char of the sequence specially, before setting
9050 up any keymaps, in case a filter runs and switches buffers on us. */
9051 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9053 #endif /* GOBBLE_FIRST_EVENT */
9055 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9056 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9059 /* We jump here when we need to reinitialize fkey and keytran; this
9060 happens if we switch keyboards between rescans. */
9061 replay_entire_sequence
:
9063 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9064 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9065 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9066 indec
.start
= indec
.end
= 0;
9067 fkey
.start
= fkey
.end
= 0;
9068 keytran
.start
= keytran
.end
= 0;
9070 /* We jump here when the key sequence has been thoroughly changed, and
9071 we need to rescan it starting from the beginning. When we jump here,
9072 keybuf[0..mock_input] holds the sequence we should reread. */
9075 starting_buffer
= current_buffer
;
9076 first_unbound
= bufsize
+ 1;
9078 /* Build our list of keymaps.
9079 If we recognize a function key and replace its escape sequence in
9080 keybuf with its symbol, or if the sequence starts with a mouse
9081 click and we need to switch buffers, we jump back here to rebuild
9082 the initial keymaps from the current buffer. */
9085 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9087 if (2 > nmaps_allocated
)
9089 submaps
= alloca (2 * sizeof *submaps
);
9090 defs
= alloca (2 * sizeof *defs
);
9091 nmaps_allocated
= 2;
9093 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9095 else if (!NILP (Voverriding_local_map
))
9097 if (2 > nmaps_allocated
)
9099 submaps
= alloca (2 * sizeof *submaps
);
9100 defs
= alloca (2 * sizeof *defs
);
9101 nmaps_allocated
= 2;
9103 submaps
[nmaps
++] = Voverriding_local_map
;
9111 nminor
= current_minor_maps (0, &maps
);
9112 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9114 if (total
> nmaps_allocated
)
9116 submaps
= alloca (total
* sizeof *submaps
);
9117 defs
= alloca (total
* sizeof *defs
);
9118 nmaps_allocated
= total
;
9121 if (!NILP (orig_keymap
))
9122 submaps
[nmaps
++] = orig_keymap
;
9124 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9128 submaps
[nmaps
++] = orig_local_map
;
9130 submaps
[nmaps
++] = current_global_map
;
9132 /* Find an accurate initial value for first_binding. */
9133 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9134 if (! NILP (submaps
[first_binding
]))
9137 /* Start from the beginning in keybuf. */
9140 /* These are no-ops the first time through, but if we restart, they
9141 revert the echo area and this_command_keys to their original state. */
9142 this_command_key_count
= keys_start
;
9143 if (INTERACTIVE
&& t
< mock_input
)
9144 echo_truncate (echo_start
);
9146 /* If the best binding for the current key sequence is a keymap, or
9147 we may be looking at a function key's escape sequence, keep on
9149 while (first_binding
< nmaps
9150 /* Keep reading as long as there's a prefix binding. */
9151 ? !NILP (submaps
[first_binding
])
9152 /* Don't return in the middle of a possible function key sequence,
9153 if the only bindings we found were via case conversion.
9154 Thus, if ESC O a has a function-key-map translation
9155 and ESC o has a binding, don't return after ESC O,
9156 so that we can translate ESC O plus the next character. */
9157 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9160 bool used_mouse_menu
= 0;
9162 /* Where the last real key started. If we need to throw away a
9163 key that has expanded into more than one element of keybuf
9164 (say, a mouse click on the mode line which is being treated
9165 as [mode-line (mouse-...)], then we backtrack to this point
9167 int last_real_key_start
;
9169 /* These variables are analogous to echo_start and keys_start;
9170 while those allow us to restart the entire key sequence,
9171 echo_local_start and keys_local_start allow us to throw away
9173 ptrdiff_t echo_local_start
IF_LINT (= 0);
9174 int keys_local_start
;
9175 ptrdiff_t local_first_binding
;
9177 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9178 eassert (indec
.start
<= indec
.end
);
9179 eassert (fkey
.start
<= fkey
.end
);
9180 eassert (keytran
.start
<= keytran
.end
);
9181 /* key-translation-map is applied *after* function-key-map
9182 which is itself applied *after* input-decode-map. */
9183 eassert (fkey
.end
<= indec
.start
);
9184 eassert (keytran
.end
<= fkey
.start
);
9186 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9187 first_unbound
< keytran
.start
)
9188 { /* The prefix upto first_unbound has no binding and has
9189 no translation left to do either, so we know it's unbound.
9190 If we don't stop now, we risk staying here indefinitely
9191 (if the user keeps entering fkey or keytran prefixes
9192 like C-c ESC ESC ESC ESC ...) */
9194 for (i
= first_unbound
+ 1; i
< t
; i
++)
9195 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9196 mock_input
= t
- first_unbound
- 1;
9197 indec
.end
= indec
.start
-= first_unbound
+ 1;
9198 indec
.map
= indec
.parent
;
9199 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9200 fkey
.map
= fkey
.parent
;
9201 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9202 keytran
.map
= keytran
.parent
;
9203 goto replay_sequence
;
9207 error ("Key sequence too long");
9210 echo_local_start
= echo_length ();
9211 keys_local_start
= this_command_key_count
;
9212 local_first_binding
= first_binding
;
9215 /* These are no-ops, unless we throw away a keystroke below and
9216 jumped back up to replay_key; in that case, these restore the
9217 variables to their original state, allowing us to replay the
9219 if (INTERACTIVE
&& t
< mock_input
)
9220 echo_truncate (echo_local_start
);
9221 this_command_key_count
= keys_local_start
;
9222 first_binding
= local_first_binding
;
9224 /* By default, assume each event is "real". */
9225 last_real_key_start
= t
;
9227 /* Does mock_input indicate that we are re-reading a key sequence? */
9231 add_command_key (key
);
9232 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9233 && NILP (Fzerop (Vecho_keystrokes
)))
9237 /* If not, we should actually read a character. */
9241 KBOARD
*interrupted_kboard
= current_kboard
;
9242 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9243 key
= read_char (NILP (prompt
), nmaps
,
9244 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9245 &used_mouse_menu
, NULL
);
9246 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9247 /* When switching to a new tty (with a new keyboard),
9248 read_char returns the new buffer, rather than -2
9249 (Bug#5095). This is because `terminal-init-xterm'
9250 calls read-char, which eats the wrong_kboard_jmpbuf
9251 return. Any better way to fix this? -- cyd */
9252 || (interrupted_kboard
!= current_kboard
))
9257 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9258 if (k
== interrupted_kboard
)
9263 /* Don't touch interrupted_kboard when it's been
9265 delayed_switch_frame
= Qnil
;
9266 goto replay_entire_sequence
;
9269 if (!NILP (delayed_switch_frame
))
9272 (interrupted_kboard
,
9273 Fcons (delayed_switch_frame
,
9274 KVAR (interrupted_kboard
, kbd_queue
)));
9275 delayed_switch_frame
= Qnil
;
9280 (interrupted_kboard
,
9281 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9283 /* If the side queue is non-empty, ensure it begins with a
9284 switch-frame, so we'll replay it in the right context. */
9285 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9286 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9287 !(EVENT_HAS_PARAMETERS (key
)
9288 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9292 XSETFRAME (frame
, interrupted_frame
);
9294 (interrupted_kboard
,
9295 Fcons (make_lispy_switch_frame (frame
),
9296 KVAR (interrupted_kboard
, kbd_queue
)));
9299 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9300 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9301 goto replay_entire_sequence
;
9305 /* read_char returns t when it shows a menu and the user rejects it.
9309 unbind_to (count
, Qnil
);
9314 /* read_char returns -1 at the end of a macro.
9315 Emacs 18 handles this by returning immediately with a
9316 zero, so that's what we'll do. */
9317 if (INTEGERP (key
) && XINT (key
) == -1)
9320 /* The Microsoft C compiler can't handle the goto that
9326 /* If the current buffer has been changed from under us, the
9327 keymap may have changed, so replay the sequence. */
9330 timer_resume_idle ();
9333 /* Reset the current buffer from the selected window
9334 in case something changed the former and not the latter.
9335 This is to be more consistent with the behavior
9336 of the command_loop_1. */
9337 if (fix_current_buffer
)
9339 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9341 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9342 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9345 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9346 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9347 goto replay_sequence
;
9350 /* If we have a quit that was typed in another frame, and
9351 quit_throw_to_read_char switched buffers,
9352 replay to get the right keymap. */
9354 && XINT (key
) == quit_char
9355 && current_buffer
!= starting_buffer
)
9358 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9363 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9364 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9365 goto replay_sequence
;
9370 if (EVENT_HAS_PARAMETERS (key
)
9371 /* Either a `switch-frame' or a `select-window' event. */
9372 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9374 /* If we're at the beginning of a key sequence, and the caller
9375 says it's okay, go ahead and return this event. If we're
9376 in the midst of a key sequence, delay it until the end. */
9377 if (t
> 0 || !can_return_switch_frame
)
9379 delayed_switch_frame
= key
;
9385 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9389 /* Clicks in non-text areas get prefixed by the symbol
9390 in their CHAR-ADDRESS field. For example, a click on
9391 the mode line is prefixed by the symbol `mode-line'.
9393 Furthermore, key sequences beginning with mouse clicks
9394 are read using the keymaps of the buffer clicked on, not
9395 the current buffer. So we may have to switch the buffer
9398 When we turn one event into two events, we must make sure
9399 that neither of the two looks like the original--so that,
9400 if we replay the events, they won't be expanded again.
9401 If not for this, such reexpansion could happen either here
9402 or when user programs play with this-command-keys. */
9403 if (EVENT_HAS_PARAMETERS (key
))
9408 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9409 if (EQ (kind
, Qmouse_click
))
9411 Lisp_Object window
, posn
;
9413 window
= POSN_WINDOW (EVENT_START (key
));
9414 posn
= POSN_POSN (EVENT_START (key
));
9417 || (!NILP (fake_prefixed_keys
)
9418 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9420 /* We're looking a second time at an event for which
9421 we generated a fake prefix key. Set
9422 last_real_key_start appropriately. */
9424 last_real_key_start
= t
- 1;
9427 if (last_real_key_start
== 0)
9429 /* Key sequences beginning with mouse clicks are
9430 read using the keymaps in the buffer clicked on,
9431 not the current buffer. If we're at the
9432 beginning of a key sequence, switch buffers. */
9433 if (WINDOWP (window
)
9434 && BUFFERP (XWINDOW (window
)->buffer
)
9435 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9437 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9442 /* Arrange to go back to the original buffer once we're
9443 done reading the key sequence. Note that we can't
9444 use save_excursion_{save,restore} here, because they
9445 save point as well as the current buffer; we don't
9446 want to save point, because redisplay may change it,
9447 to accommodate a Fset_window_start or something. We
9448 don't want to do this at the top of the function,
9449 because we may get input from a subprocess which
9450 wants to change the selected window and stuff (say,
9452 record_unwind_current_buffer ();
9454 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9456 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9457 orig_local_map
= get_local_map (PT
, current_buffer
,
9459 orig_keymap
= get_local_map (PT
, current_buffer
,
9461 goto replay_sequence
;
9464 /* For a mouse click, get the local text-property keymap
9465 of the place clicked on, rather than point. */
9466 if (CONSP (XCDR (key
))
9467 && ! localized_local_map
)
9469 Lisp_Object map_here
, start
, pos
;
9471 localized_local_map
= 1;
9472 start
= EVENT_START (key
);
9474 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9476 pos
= POSN_BUFFER_POSN (start
);
9478 && XINT (pos
) >= BEGV
9479 && XINT (pos
) <= ZV
)
9481 map_here
= get_local_map (XINT (pos
),
9484 if (!EQ (map_here
, orig_local_map
))
9486 orig_local_map
= map_here
;
9487 ++localized_local_map
;
9490 map_here
= get_local_map (XINT (pos
),
9493 if (!EQ (map_here
, orig_keymap
))
9495 orig_keymap
= map_here
;
9496 ++localized_local_map
;
9499 if (localized_local_map
> 1)
9504 goto replay_sequence
;
9511 /* Expand mode-line and scroll-bar events into two events:
9512 use posn as a fake prefix key. */
9514 && (NILP (fake_prefixed_keys
)
9515 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9517 if (bufsize
- t
<= 1)
9518 error ("Key sequence too long");
9521 keybuf
[t
+ 1] = key
;
9524 /* Record that a fake prefix key has been generated
9525 for KEY. Don't modify the event; this would
9526 prevent proper action when the event is pushed
9527 back into unread-command-events. */
9528 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9530 /* If on a mode line string with a local keymap,
9531 reconsider the key sequence with that keymap. */
9532 if (string
= POSN_STRING (EVENT_START (key
)),
9533 (CONSP (string
) && STRINGP (XCAR (string
))))
9535 Lisp_Object pos
, map
, map2
;
9537 pos
= XCDR (string
);
9538 string
= XCAR (string
);
9540 && XINT (pos
) < SCHARS (string
))
9542 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9544 orig_local_map
= map
;
9545 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9548 if (!NILP (map
) || !NILP (map2
))
9549 goto replay_sequence
;
9555 else if (NILP (from_string
)
9556 && (string
= POSN_STRING (EVENT_START (key
)),
9557 (CONSP (string
) && STRINGP (XCAR (string
)))))
9559 /* For a click on a string, i.e. overlay string or a
9560 string displayed via the `display' property,
9561 consider `local-map' and `keymap' properties of
9563 Lisp_Object pos
, map
, map2
;
9565 pos
= XCDR (string
);
9566 string
= XCAR (string
);
9568 && XINT (pos
) < SCHARS (string
))
9570 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9572 orig_local_map
= map
;
9573 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9577 if (!NILP (map
) || !NILP (map2
))
9579 from_string
= string
;
9582 goto replay_sequence
;
9587 else if (CONSP (XCDR (key
))
9588 && CONSP (EVENT_START (key
))
9589 && CONSP (XCDR (EVENT_START (key
))))
9593 posn
= POSN_POSN (EVENT_START (key
));
9594 /* Handle menu-bar events:
9595 insert the dummy prefix event `menu-bar'. */
9596 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9598 if (bufsize
- t
<= 1)
9599 error ("Key sequence too long");
9603 /* Zap the position in key, so we know that we've
9604 expanded it, and don't try to do so again. */
9605 POSN_SET_POSN (EVENT_START (key
),
9606 Fcons (posn
, Qnil
));
9609 goto replay_sequence
;
9611 else if (CONSP (posn
))
9613 /* We're looking at the second event of a
9614 sequence which we expanded before. Set
9615 last_real_key_start appropriately. */
9616 if (last_real_key_start
== t
&& t
> 0)
9617 last_real_key_start
= t
- 1;
9622 /* We have finally decided that KEY is something we might want
9624 first_binding
= (follow_key (key
,
9625 nmaps
- first_binding
,
9626 submaps
+ first_binding
,
9627 defs
+ first_binding
,
9628 submaps
+ first_binding
)
9631 /* If KEY wasn't bound, we'll try some fallbacks. */
9632 if (first_binding
< nmaps
)
9633 /* This is needed for the following scenario:
9634 event 0: a down-event that gets dropped by calling replay_key.
9635 event 1: some normal prefix like C-h.
9636 After event 0, first_unbound is 0, after event 1 indec.start,
9637 fkey.start, and keytran.start are all 1, so when we see that
9638 C-h is bound, we need to update first_unbound. */
9639 first_unbound
= max (t
+ 1, first_unbound
);
9644 /* Remember the position to put an upper bound on indec.start. */
9645 first_unbound
= min (t
, first_unbound
);
9647 head
= EVENT_HEAD (key
);
9648 if (help_char_p (head
) && t
> 0)
9650 read_key_sequence_cmd
= Vprefix_help_command
;
9652 last_nonmenu_event
= key
;
9653 /* The Microsoft C compiler can't handle the goto that
9661 Lisp_Object breakdown
;
9664 breakdown
= parse_modifiers (head
);
9665 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9666 /* Attempt to reduce an unbound mouse event to a simpler
9667 event that is bound:
9668 Drags reduce to clicks.
9669 Double-clicks reduce to clicks.
9670 Triple-clicks reduce to double-clicks, then to clicks.
9671 Down-clicks are eliminated.
9672 Double-downs reduce to downs, then are eliminated.
9673 Triple-downs reduce to double-downs, then to downs,
9674 then are eliminated. */
9675 if (modifiers
& (down_modifier
| drag_modifier
9676 | double_modifier
| triple_modifier
))
9678 while (modifiers
& (down_modifier
| drag_modifier
9679 | double_modifier
| triple_modifier
))
9681 Lisp_Object new_head
, new_click
;
9682 if (modifiers
& triple_modifier
)
9683 modifiers
^= (double_modifier
| triple_modifier
);
9684 else if (modifiers
& double_modifier
)
9685 modifiers
&= ~double_modifier
;
9686 else if (modifiers
& drag_modifier
)
9687 modifiers
&= ~drag_modifier
;
9690 /* Dispose of this `down' event by simply jumping
9691 back to replay_key, to get another event.
9693 Note that if this event came from mock input,
9694 then just jumping back to replay_key will just
9695 hand it to us again. So we have to wipe out any
9698 We could delete keybuf[t] and shift everything
9699 after that to the left by one spot, but we'd also
9700 have to fix up any variable that points into
9701 keybuf, and shifting isn't really necessary
9704 Adding prefixes for non-textual mouse clicks
9705 creates two characters of mock input, and both
9706 must be thrown away. If we're only looking at
9707 the prefix now, we can just jump back to
9708 replay_key. On the other hand, if we've already
9709 processed the prefix, and now the actual click
9710 itself is giving us trouble, then we've lost the
9711 state of the keymaps we want to backtrack to, and
9712 we need to replay the whole sequence to rebuild
9715 Beyond that, only function key expansion could
9716 create more than two keys, but that should never
9717 generate mouse events, so it's okay to zero
9718 mock_input in that case too.
9720 FIXME: The above paragraph seems just plain
9721 wrong, if you consider things like
9722 xterm-mouse-mode. -stef
9724 Isn't this just the most wonderful code ever? */
9726 /* If mock_input > t + 1, the above simplification
9727 will actually end up dropping keys on the floor.
9728 This is probably OK for now, but even
9729 if mock_input <= t + 1, we need to adjust indec,
9731 Typical case [header-line down-mouse-N]:
9732 mock_input = 2, t = 1, fkey.end = 1,
9733 last_real_key_start = 0. */
9734 if (indec
.end
> last_real_key_start
)
9736 indec
.end
= indec
.start
9737 = min (last_real_key_start
, indec
.start
);
9738 indec
.map
= indec
.parent
;
9739 if (fkey
.end
> last_real_key_start
)
9741 fkey
.end
= fkey
.start
9742 = min (last_real_key_start
, fkey
.start
);
9743 fkey
.map
= fkey
.parent
;
9744 if (keytran
.end
> last_real_key_start
)
9746 keytran
.end
= keytran
.start
9747 = min (last_real_key_start
, keytran
.start
);
9748 keytran
.map
= keytran
.parent
;
9752 if (t
== last_real_key_start
)
9759 mock_input
= last_real_key_start
;
9760 goto replay_sequence
;
9765 = apply_modifiers (modifiers
, XCAR (breakdown
));
9767 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9769 /* Look for a binding for this new key. follow_key
9770 promises that it didn't munge submaps the
9771 last time we called it, since key was unbound. */
9773 = (follow_key (new_click
,
9774 nmaps
- local_first_binding
,
9775 submaps
+ local_first_binding
,
9776 defs
+ local_first_binding
,
9777 submaps
+ local_first_binding
)
9778 + local_first_binding
);
9780 /* If that click is bound, go for it. */
9781 if (first_binding
< nmaps
)
9786 /* Otherwise, we'll leave key set to the drag event. */
9793 /* Normally, last_nonmenu_event gets the previous key we read.
9794 But when a mouse popup menu is being used,
9795 we don't update last_nonmenu_event; it continues to hold the mouse
9796 event that preceded the first level of menu. */
9797 if (!used_mouse_menu
)
9798 last_nonmenu_event
= key
;
9800 /* Record what part of this_command_keys is the current key sequence. */
9801 this_single_command_key_start
= this_command_key_count
- t
;
9803 /* Look for this sequence in input-decode-map.
9804 Scan from indec.end until we find a bound suffix. */
9805 while (indec
.end
< t
)
9807 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9811 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9812 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9817 mock_input
= diff
+ max (t
, mock_input
);
9818 goto replay_sequence
;
9822 if (first_binding
< nmaps
9823 && NILP (submaps
[first_binding
])
9824 && !test_undefined (defs
[first_binding
])
9825 && indec
.start
>= t
)
9826 /* There is a binding and it's not a prefix.
9827 (and it doesn't have any input-decode-map translation pending).
9828 There is thus no function-key in this sequence.
9829 Moving fkey.start is important in this case to allow keytran.start
9830 to go over the sequence before we return (since we keep the
9831 invariant that keytran.end <= fkey.start). */
9834 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9837 /* If the sequence is unbound, see if we can hang a function key
9838 off the end of it. */
9839 /* Continue scan from fkey.end until we find a bound suffix. */
9840 while (fkey
.end
< indec
.start
)
9842 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9846 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9847 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9848 max (t
, mock_input
),
9849 /* If there's a binding (i.e.
9850 first_binding >= nmaps) we don't want
9851 to apply this function-key-mapping. */
9853 && (first_binding
>= nmaps
9854 || test_undefined (defs
[first_binding
])),
9859 mock_input
= diff
+ max (t
, mock_input
);
9860 /* Adjust the input-decode-map counters. */
9862 indec
.start
+= diff
;
9864 goto replay_sequence
;
9868 /* Look for this sequence in key-translation-map.
9869 Scan from keytran.end until we find a bound suffix. */
9870 while (keytran
.end
< fkey
.start
)
9872 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9876 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9877 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9882 mock_input
= diff
+ max (t
, mock_input
);
9883 /* Adjust the function-key-map and input-decode-map counters. */
9885 indec
.start
+= diff
;
9889 goto replay_sequence
;
9893 /* If KEY is not defined in any of the keymaps,
9894 and cannot be part of a function key or translation,
9895 and is an upper case letter
9896 use the corresponding lower-case letter instead. */
9897 if (first_binding
>= nmaps
9898 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9900 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9901 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9902 || (XINT (key
) & shift_modifier
)))
9904 Lisp_Object new_key
;
9906 original_uppercase
= key
;
9907 original_uppercase_position
= t
- 1;
9909 if (XINT (key
) & shift_modifier
)
9910 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9912 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9913 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9915 /* We have to do this unconditionally, regardless of whether
9916 the lower-case char is defined in the keymaps, because they
9917 might get translated through function-key-map. */
9918 keybuf
[t
- 1] = new_key
;
9919 mock_input
= max (t
, mock_input
);
9920 shift_translated
= 1;
9922 goto replay_sequence
;
9924 /* If KEY is not defined in any of the keymaps,
9925 and cannot be part of a function key or translation,
9926 and is a shifted function key,
9927 use the corresponding unshifted function key instead. */
9928 if (first_binding
>= nmaps
9929 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9931 Lisp_Object breakdown
= parse_modifiers (key
);
9933 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9935 if (modifiers
& shift_modifier
9936 /* Treat uppercase keys as shifted. */
9938 && (KEY_TO_CHAR (key
)
9939 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9940 && uppercasep (KEY_TO_CHAR (key
))))
9943 = (modifiers
& shift_modifier
9944 ? apply_modifiers (modifiers
& ~shift_modifier
,
9946 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9948 original_uppercase
= key
;
9949 original_uppercase_position
= t
- 1;
9951 /* We have to do this unconditionally, regardless of whether
9952 the lower-case char is defined in the keymaps, because they
9953 might get translated through function-key-map. */
9954 keybuf
[t
- 1] = new_key
;
9955 mock_input
= max (t
, mock_input
);
9956 /* Reset fkey (and consequently keytran) to apply
9957 function-key-map on the result, so that S-backspace is
9958 correctly mapped to DEL (via backspace). OTOH,
9959 input-decode-map doesn't need to go through it again. */
9960 fkey
.start
= fkey
.end
= 0;
9961 keytran
.start
= keytran
.end
= 0;
9962 shift_translated
= 1;
9964 goto replay_sequence
;
9969 read_key_sequence_cmd
= (first_binding
< nmaps
9970 ? defs
[first_binding
]
9972 read_key_sequence_remapped
9973 /* Remap command through active keymaps.
9974 Do the remapping here, before the unbind_to so it uses the keymaps
9975 of the appropriate buffer. */
9976 = SYMBOLP (read_key_sequence_cmd
)
9977 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9980 unread_switch_frame
= delayed_switch_frame
;
9981 unbind_to (count
, Qnil
);
9983 /* Don't downcase the last character if the caller says don't.
9984 Don't downcase it if the result is undefined, either. */
9985 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9987 && t
- 1 == original_uppercase_position
)
9989 keybuf
[t
- 1] = original_uppercase
;
9990 shift_translated
= 0;
9993 if (shift_translated
)
9994 Vthis_command_keys_shift_translated
= Qt
;
9996 /* Occasionally we fabricate events, perhaps by expanding something
9997 according to function-key-map, or by adding a prefix symbol to a
9998 mouse click in the scroll bar or modeline. In this cases, return
9999 the entire generated key sequence, even if we hit an unbound
10000 prefix or a definition before the end. This means that you will
10001 be able to push back the event properly, and also means that
10002 read-key-sequence will always return a logical unit.
10005 for (; t
< mock_input
; t
++)
10007 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10008 && NILP (Fzerop (Vecho_keystrokes
)))
10009 echo_char (keybuf
[t
]);
10010 add_command_key (keybuf
[t
]);
10017 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10018 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10019 The sequence is sufficient to specify a non-prefix command in the
10020 current local and global maps.
10022 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10023 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10024 as a continuation of the previous key.
10026 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10027 convert the last event to lower case. (Normally any upper case event
10028 is converted to lower case if the original event is undefined and the lower
10029 case equivalent is defined.) A non-nil value is appropriate for reading
10030 a key sequence to be defined.
10032 A C-g typed while in this function is treated like any other character,
10033 and `quit-flag' is not set.
10035 If the key sequence starts with a mouse click, then the sequence is read
10036 using the keymaps of the buffer of the window clicked in, not the buffer
10037 of the selected window as normal.
10039 `read-key-sequence' drops unbound button-down events, since you normally
10040 only care about the click or drag events which follow them. If a drag
10041 or multi-click event is unbound, but the corresponding click event would
10042 be bound, `read-key-sequence' turns the event into a click event at the
10043 drag's starting position. This means that you don't have to distinguish
10044 between click and drag, double, or triple events unless you want to.
10046 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10047 lines separating windows, and scroll bars with imaginary keys
10048 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10050 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10051 function will process a switch-frame event if the user switches frames
10052 before typing anything. If the user switches frames in the middle of a
10053 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10054 is nil, then the event will be put off until after the current key sequence.
10056 `read-key-sequence' checks `function-key-map' for function key
10057 sequences, where they wouldn't conflict with ordinary bindings. See
10058 `function-key-map' for more details.
10060 The optional fifth argument CMD-LOOP, if non-nil, means
10061 that this key sequence is being read by something that will
10062 read commands one after another. It should be nil if the caller
10063 will read just one key sequence. */)
10064 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10066 Lisp_Object keybuf
[30];
10068 struct gcpro gcpro1
;
10069 ptrdiff_t count
= SPECPDL_INDEX ();
10071 if (!NILP (prompt
))
10072 CHECK_STRING (prompt
);
10075 specbind (Qinput_method_exit_on_first_char
,
10076 (NILP (cmd_loop
) ? Qt
: Qnil
));
10077 specbind (Qinput_method_use_echo_area
,
10078 (NILP (cmd_loop
) ? Qt
: Qnil
));
10080 memset (keybuf
, 0, sizeof keybuf
);
10081 GCPRO1 (keybuf
[0]);
10082 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10084 if (NILP (continue_echo
))
10086 this_command_key_count
= 0;
10087 this_command_key_count_reset
= 0;
10088 this_single_command_key_start
= 0;
10091 #ifdef HAVE_WINDOW_SYSTEM
10092 if (display_hourglass_p
)
10093 cancel_hourglass ();
10096 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10097 prompt
, ! NILP (dont_downcase_last
),
10098 ! NILP (can_return_switch_frame
), 0);
10100 #if 0 /* The following is fine for code reading a key sequence and
10101 then proceeding with a lengthy computation, but it's not good
10102 for code reading keys in a loop, like an input method. */
10103 #ifdef HAVE_WINDOW_SYSTEM
10104 if (display_hourglass_p
)
10105 start_hourglass ();
10115 return unbind_to (count
, make_event_array (i
, keybuf
));
10118 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10119 Sread_key_sequence_vector
, 1, 5, 0,
10120 doc
: /* Like `read-key-sequence' but always return a vector. */)
10121 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10123 Lisp_Object keybuf
[30];
10125 struct gcpro gcpro1
;
10126 ptrdiff_t count
= SPECPDL_INDEX ();
10128 if (!NILP (prompt
))
10129 CHECK_STRING (prompt
);
10132 specbind (Qinput_method_exit_on_first_char
,
10133 (NILP (cmd_loop
) ? Qt
: Qnil
));
10134 specbind (Qinput_method_use_echo_area
,
10135 (NILP (cmd_loop
) ? Qt
: Qnil
));
10137 memset (keybuf
, 0, sizeof keybuf
);
10138 GCPRO1 (keybuf
[0]);
10139 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10141 if (NILP (continue_echo
))
10143 this_command_key_count
= 0;
10144 this_command_key_count_reset
= 0;
10145 this_single_command_key_start
= 0;
10148 #ifdef HAVE_WINDOW_SYSTEM
10149 if (display_hourglass_p
)
10150 cancel_hourglass ();
10153 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10154 prompt
, ! NILP (dont_downcase_last
),
10155 ! NILP (can_return_switch_frame
), 0);
10157 #ifdef HAVE_WINDOW_SYSTEM
10158 if (display_hourglass_p
)
10159 start_hourglass ();
10168 return unbind_to (count
, Fvector (i
, keybuf
));
10171 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10172 doc
: /* Execute CMD as an editor command.
10173 CMD must be a symbol that satisfies the `commandp' predicate.
10174 Optional second arg RECORD-FLAG non-nil
10175 means unconditionally put this command in `command-history'.
10176 Otherwise, that is done only if an arg is read using the minibuffer.
10177 The argument KEYS specifies the value to use instead of (this-command-keys)
10178 when reading the arguments; if it is nil, (this-command-keys) is used.
10179 The argument SPECIAL, if non-nil, means that this command is executing
10180 a special event, so ignore the prefix argument and don't clear it. */)
10181 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10183 register Lisp_Object final
;
10184 register Lisp_Object tem
;
10185 Lisp_Object prefixarg
;
10187 debug_on_next_call
= 0;
10189 if (NILP (special
))
10191 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10192 Vcurrent_prefix_arg
= prefixarg
;
10193 kset_prefix_arg (current_kboard
, Qnil
);
10200 tem
= Fget (cmd
, Qdisabled
);
10203 tem
= Fsymbol_value (Qdisabled_command_function
);
10205 return Frun_hooks (1, &Qdisabled_command_function
);
10211 final
= Findirect_function (cmd
, Qnil
);
10213 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10215 struct gcpro gcpro1
, gcpro2
;
10217 GCPRO2 (cmd
, prefixarg
);
10218 Fautoload_do_load (final
, cmd
, Qnil
);
10225 if (STRINGP (final
) || VECTORP (final
))
10227 /* If requested, place the macro in the command history. For
10228 other sorts of commands, call-interactively takes care of
10230 if (!NILP (record_flag
))
10233 = Fcons (Fcons (Qexecute_kbd_macro
,
10234 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10237 /* Don't keep command history around forever. */
10238 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10240 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10242 XSETCDR (tem
, Qnil
);
10246 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10249 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10250 /* Don't call Fcall_interactively directly because we want to make
10251 sure the backtrace has an entry for `call-interactively'.
10252 For the same reason, pass `cmd' rather than `final'. */
10253 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10260 /* Return true if input events are pending. */
10263 detect_input_pending (void)
10265 return input_pending
|| get_input_pending (0);
10268 /* Return true if input events other than mouse movements are
10272 detect_input_pending_ignore_squeezables (void)
10274 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10277 /* Return true if input events are pending, and run any pending timers. */
10280 detect_input_pending_run_timers (bool do_display
)
10282 unsigned old_timers_run
= timers_run
;
10284 if (!input_pending
)
10285 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10287 if (old_timers_run
!= timers_run
&& do_display
)
10289 redisplay_preserve_echo_area (8);
10290 /* The following fixes a bug when using lazy-lock with
10291 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10292 from an idle timer function. The symptom of the bug is that
10293 the cursor sometimes doesn't become visible until the next X
10294 event is processed. --gerd. */
10296 Lisp_Object tail
, frame
;
10297 FOR_EACH_FRAME (tail
, frame
)
10298 if (FRAME_RIF (XFRAME (frame
)))
10299 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10303 return input_pending
;
10306 /* This is called in some cases before a possible quit.
10307 It cases the next call to detect_input_pending to recompute input_pending.
10308 So calling this function unnecessarily can't do any harm. */
10311 clear_input_pending (void)
10316 /* Return true if there are pending requeued events.
10317 This isn't used yet. The hope is to make wait_reading_process_output
10318 call it, and return if it runs Lisp code that unreads something.
10319 The problem is, kbd_buffer_get_event needs to be fixed to know what
10320 to do in that case. It isn't trivial. */
10323 requeued_events_pending_p (void)
10325 return (!NILP (Vunread_command_events
));
10329 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10330 doc
: /* Return t if command input is currently available with no wait.
10331 Actually, the value is nil only if we can be sure that no input is available;
10332 if there is a doubt, the value is t. */)
10335 if (!NILP (Vunread_command_events
)
10336 || !NILP (Vunread_post_input_method_events
)
10337 || !NILP (Vunread_input_method_events
))
10340 /* Process non-user-visible events (Bug#10195). */
10341 process_special_events ();
10343 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10344 | READABLE_EVENTS_FILTER_EVENTS
)
10348 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10349 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10352 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10355 if (total_keys
< NUM_RECENT_KEYS
)
10356 return Fvector (total_keys
, keys
);
10359 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10360 vcopy (val
, 0, keys
+ recent_keys_index
,
10361 NUM_RECENT_KEYS
- recent_keys_index
);
10362 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10363 keys
, recent_keys_index
);
10368 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10369 doc
: /* Return the key sequence that invoked this command.
10370 However, if the command has called `read-key-sequence', it returns
10371 the last key sequence that has been read.
10372 The value is a string or a vector.
10374 See also `this-command-keys-vector'. */)
10377 return make_event_array (this_command_key_count
,
10378 XVECTOR (this_command_keys
)->contents
);
10381 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10382 doc
: /* Return the key sequence that invoked this command, as a vector.
10383 However, if the command has called `read-key-sequence', it returns
10384 the last key sequence that has been read.
10386 See also `this-command-keys'. */)
10389 return Fvector (this_command_key_count
,
10390 XVECTOR (this_command_keys
)->contents
);
10393 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10394 Sthis_single_command_keys
, 0, 0, 0,
10395 doc
: /* Return the key sequence that invoked this command.
10396 More generally, it returns the last key sequence read, either by
10397 the command loop or by `read-key-sequence'.
10398 Unlike `this-command-keys', this function's value
10399 does not include prefix arguments.
10400 The value is always a vector. */)
10403 return Fvector (this_command_key_count
10404 - this_single_command_key_start
,
10405 (XVECTOR (this_command_keys
)->contents
10406 + this_single_command_key_start
));
10409 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10410 Sthis_single_command_raw_keys
, 0, 0, 0,
10411 doc
: /* Return the raw events that were read for this command.
10412 More generally, it returns the last key sequence read, either by
10413 the command loop or by `read-key-sequence'.
10414 Unlike `this-single-command-keys', this function's value
10415 shows the events before all translations (except for input methods).
10416 The value is always a vector. */)
10419 return Fvector (raw_keybuf_count
,
10420 (XVECTOR (raw_keybuf
)->contents
));
10423 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10424 Sreset_this_command_lengths
, 0, 0, 0,
10425 doc
: /* Make the unread events replace the last command and echo.
10426 Used in `universal-argument-other-key'.
10428 `universal-argument-other-key' rereads the event just typed.
10429 It then gets translated through `function-key-map'.
10430 The translated event has to replace the real events,
10431 both in the value of (this-command-keys) and in echoing.
10432 To achieve this, `universal-argument-other-key' calls
10433 `reset-this-command-lengths', which discards the record of reading
10434 these events the first time. */)
10437 this_command_key_count
= before_command_key_count
;
10438 if (this_command_key_count
< this_single_command_key_start
)
10439 this_single_command_key_start
= this_command_key_count
;
10441 echo_truncate (before_command_echo_length
);
10443 /* Cause whatever we put into unread-command-events
10444 to echo as if it were being freshly read from the keyboard. */
10445 this_command_key_count_reset
= 1;
10450 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10451 Sclear_this_command_keys
, 0, 1, 0,
10452 doc
: /* Clear out the vector that `this-command-keys' returns.
10453 Also clear the record of the last 100 events, unless optional arg
10454 KEEP-RECORD is non-nil. */)
10455 (Lisp_Object keep_record
)
10459 this_command_key_count
= 0;
10460 this_command_key_count_reset
= 0;
10462 if (NILP (keep_record
))
10464 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10465 ASET (recent_keys
, i
, Qnil
);
10467 recent_keys_index
= 0;
10472 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10473 doc
: /* Return the current depth in recursive edits. */)
10477 /* Wrap around reliably on integer overflow. */
10478 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10479 XSETINT (temp
, sum
);
10483 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10484 "FOpen dribble file: ",
10485 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10486 If FILE is nil, close any open dribble file.
10487 The file will be closed when Emacs exits. */)
10499 file
= Fexpand_file_name (file
, Qnil
);
10500 dribble
= fopen (SSDATA (file
), "w");
10502 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10507 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10508 doc
: /* Discard the contents of the terminal input buffer.
10509 Also end any kbd macro being defined. */)
10512 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10514 /* Discard the last command from the macro. */
10515 Fcancel_kbd_macro_events ();
10519 update_mode_lines
++;
10521 Vunread_command_events
= Qnil
;
10523 discard_tty_input ();
10525 kbd_fetch_ptr
= kbd_store_ptr
;
10531 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10532 doc
: /* Stop Emacs and return to superior process. You can resume later.
10533 If `cannot-suspend' is non-nil, or if the system doesn't support job
10534 control, run a subshell instead.
10536 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10537 to be read as terminal input by Emacs's parent, after suspension.
10539 Before suspending, run the normal hook `suspend-hook'.
10540 After resumption run the normal hook `suspend-resume-hook'.
10542 Some operating systems cannot stop the Emacs process and resume it later.
10543 On such systems, Emacs starts a subshell instead of suspending. */)
10544 (Lisp_Object stuffstring
)
10546 ptrdiff_t count
= SPECPDL_INDEX ();
10547 int old_height
, old_width
;
10549 struct gcpro gcpro1
;
10552 if (tty_list
&& tty_list
->next
)
10553 error ("There are other tty frames open; close them before suspending Emacs");
10555 if (!NILP (stuffstring
))
10556 CHECK_STRING (stuffstring
);
10558 /* Run the functions in suspend-hook. */
10559 hook
= intern ("suspend-hook");
10560 Frun_hooks (1, &hook
);
10562 GCPRO1 (stuffstring
);
10563 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10564 reset_all_sys_modes ();
10565 /* sys_suspend can get an error if it tries to fork a subshell
10566 and the system resources aren't available for that. */
10567 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10569 stuff_buffered_input (stuffstring
);
10570 if (cannot_suspend
)
10574 unbind_to (count
, Qnil
);
10576 /* Check if terminal/window size has changed.
10577 Note that this is not useful when we are running directly
10578 with a window system; but suspend should be disabled in that case. */
10579 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10580 if (width
!= old_width
|| height
!= old_height
)
10581 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10583 /* Run suspend-resume-hook. */
10584 hook
= intern ("suspend-resume-hook");
10585 Frun_hooks (1, &hook
);
10591 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10592 Then in any case stuff anything Emacs has read ahead and not used. */
10595 stuff_buffered_input (Lisp_Object stuffstring
)
10597 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10598 register unsigned char *p
;
10600 if (STRINGP (stuffstring
))
10602 register ptrdiff_t count
;
10604 p
= SDATA (stuffstring
);
10605 count
= SBYTES (stuffstring
);
10606 while (count
-- > 0)
10611 /* Anything we have read ahead, put back for the shell to read. */
10612 /* ?? What should this do when we have multiple keyboards??
10613 Should we ignore anything that was typed in at the "wrong" kboard?
10615 rms: we should stuff everything back into the kboard
10617 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10620 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10621 kbd_fetch_ptr
= kbd_buffer
;
10622 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10623 stuff_char (kbd_fetch_ptr
->code
);
10625 clear_event (kbd_fetch_ptr
);
10629 #endif /* SIGTSTP */
10633 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10635 input_available_clear_time
= time_to_clear
;
10637 /* Tell handle_interrupt to throw back to read_char, */
10638 waiting_for_input
= 1;
10640 /* If handle_interrupt was called before and buffered a C-g,
10641 make it run again now, to avoid timing error. */
10642 if (!NILP (Vquit_flag
))
10643 quit_throw_to_read_char (0);
10647 clear_waiting_for_input (void)
10649 /* Tell handle_interrupt not to throw back to read_char, */
10650 waiting_for_input
= 0;
10651 input_available_clear_time
= 0;
10654 /* The SIGINT handler.
10656 If we have a frame on the controlling tty, we assume that the
10657 SIGINT was generated by C-g, so we call handle_interrupt.
10658 Otherwise, tell QUIT to kill Emacs. */
10661 handle_interrupt_signal (int sig
)
10663 /* See if we have an active terminal on our controlling tty. */
10664 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10667 /* If there are no frames there, let's pretend that we are a
10668 well-behaving UN*X program and quit. We must not call Lisp
10669 in a signal handler, so tell QUIT to exit when it is
10671 Vquit_flag
= Qkill_emacs
;
10675 /* Otherwise, the SIGINT was probably generated by C-g. */
10677 /* Set internal_last_event_frame to the top frame of the
10678 controlling tty, if we have a frame there. We disable the
10679 interrupt key on secondary ttys, so the SIGINT must have come
10680 from the controlling tty. */
10681 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10683 handle_interrupt (1);
10688 deliver_interrupt_signal (int sig
)
10690 deliver_process_signal (sig
, handle_interrupt_signal
);
10694 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10695 of the number of times C-g has been requested. If C-g is pressed
10696 enough times, then quit anyway. See bug#6585. */
10697 static int volatile force_quit_count
;
10699 /* This routine is called at interrupt level in response to C-g.
10701 It is called from the SIGINT handler or kbd_buffer_store_event.
10703 If `waiting_for_input' is non zero, then unless `echoing' is
10704 nonzero, immediately throw back to read_char.
10706 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10707 eval to throw, when it gets a chance. If quit-flag is already
10708 non-nil, it stops the job right away. */
10711 handle_interrupt (bool in_signal_handler
)
10717 /* XXX This code needs to be revised for multi-tty support. */
10718 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10720 if (! in_signal_handler
)
10722 /* If SIGINT isn't blocked, don't let us be interrupted by
10723 a SIGINT. It might be harmful due to non-reentrancy
10724 in I/O functions. */
10726 sigemptyset (&blocked
);
10727 sigaddset (&blocked
, SIGINT
);
10728 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10732 reset_all_sys_modes ();
10734 #ifdef SIGTSTP /* Support possible in later USG versions */
10736 * On systems which can suspend the current process and return to the original
10737 * shell, this command causes the user to end up back at the shell.
10738 * The "Auto-save" and "Abort" questions are not asked until
10739 * the user elects to return to emacs, at which point he can save the current
10740 * job and either dump core or continue.
10744 /* Perhaps should really fork an inferior shell?
10745 But that would not provide any way to get back
10746 to the original shell, ever. */
10747 printf ("No support for stopping a process on this operating system;\n");
10748 printf ("you can continue or abort.\n");
10749 #endif /* not SIGTSTP */
10751 /* We must remain inside the screen area when the internal terminal
10752 is used. Note that [Enter] is not echoed by dos. */
10753 cursor_to (SELECTED_FRAME (), 0, 0);
10755 /* It doesn't work to autosave while GC is in progress;
10756 the code used for auto-saving doesn't cope with the mark bit. */
10757 if (!gc_in_progress
)
10759 printf ("Auto-save? (y or n) ");
10761 if (((c
= getchar ()) & ~040) == 'Y')
10763 Fdo_auto_save (Qt
, Qnil
);
10765 printf ("\r\nAuto-save done");
10766 #else /* not MSDOS */
10767 printf ("Auto-save done\n");
10768 #endif /* not MSDOS */
10770 while (c
!= '\n') c
= getchar ();
10774 /* During GC, it must be safe to reenable quitting again. */
10775 Vinhibit_quit
= Qnil
;
10778 #endif /* not MSDOS */
10779 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10780 printf ("but will instead do a real quit after garbage collection ends\r\n");
10785 printf ("\r\nAbort? (y or n) ");
10786 #else /* not MSDOS */
10787 printf ("Abort (and dump core)? (y or n) ");
10788 #endif /* not MSDOS */
10790 if (((c
= getchar ()) & ~040) == 'Y')
10792 while (c
!= '\n') c
= getchar ();
10794 printf ("\r\nContinuing...\r\n");
10795 #else /* not MSDOS */
10796 printf ("Continuing...\n");
10797 #endif /* not MSDOS */
10799 init_all_sys_modes ();
10803 /* If executing a function that wants to be interrupted out of
10804 and the user has not deferred quitting by binding `inhibit-quit'
10805 then quit right away. */
10806 if (immediate_quit
&& NILP (Vinhibit_quit
))
10808 struct gl_state_s saved
;
10809 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10811 immediate_quit
= 0;
10812 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10814 GCPRO4 (saved
.object
, saved
.global_code
,
10815 saved
.current_syntax_table
, saved
.old_prop
);
10816 Fsignal (Qquit
, Qnil
);
10821 { /* Else request quit when it's safe. */
10822 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10823 force_quit_count
= count
;
10826 immediate_quit
= 1;
10827 Vinhibit_quit
= Qnil
;
10833 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10835 /* TODO: The longjmp in this call throws the NS event loop integration off,
10836 and it seems to do fine without this. Probably some attention
10837 needs to be paid to the setting of waiting_for_input in
10838 wait_reading_process_output() under HAVE_NS because of the call
10839 to ns_select there (needed because otherwise events aren't picked up
10840 outside of polling since we don't get SIGIO like X and we don't have a
10841 separate event loop thread like W32. */
10843 if (waiting_for_input
&& !echoing
)
10844 quit_throw_to_read_char (in_signal_handler
);
10848 /* Handle a C-g by making read_char return C-g. */
10851 quit_throw_to_read_char (bool from_signal
)
10853 /* When not called from a signal handler it is safe to call
10855 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10856 Fkill_emacs (Qnil
);
10858 /* Prevent another signal from doing this before we finish. */
10859 clear_waiting_for_input ();
10862 Vunread_command_events
= Qnil
;
10864 if (FRAMEP (internal_last_event_frame
)
10865 && !EQ (internal_last_event_frame
, selected_frame
))
10866 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10869 sys_longjmp (getcjmp
, 1);
10872 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10873 Sset_input_interrupt_mode
, 1, 1, 0,
10874 doc
: /* Set interrupt mode of reading keyboard input.
10875 If INTERRUPT is non-nil, Emacs will use input interrupts;
10876 otherwise Emacs uses CBREAK mode.
10878 See also `current-input-mode'. */)
10879 (Lisp_Object interrupt
)
10881 bool new_interrupt_input
;
10882 #ifdef USABLE_SIGIO
10883 #ifdef HAVE_X_WINDOWS
10884 if (x_display_list
!= NULL
)
10886 /* When using X, don't give the user a real choice,
10887 because we haven't implemented the mechanisms to support it. */
10888 new_interrupt_input
= 1;
10891 #endif /* HAVE_X_WINDOWS */
10892 new_interrupt_input
= !NILP (interrupt
);
10893 #else /* not USABLE_SIGIO */
10894 new_interrupt_input
= 0;
10895 #endif /* not USABLE_SIGIO */
10897 if (new_interrupt_input
!= interrupt_input
)
10899 #ifdef POLL_FOR_INPUT
10903 /* this causes startup screen to be restored and messes with the mouse */
10904 reset_all_sys_modes ();
10905 interrupt_input
= new_interrupt_input
;
10906 init_all_sys_modes ();
10908 interrupt_input
= new_interrupt_input
;
10911 #ifdef POLL_FOR_INPUT
10912 poll_suppress_count
= 1;
10919 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10920 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10921 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10922 C-q in key sequences.
10924 This setting only has an effect on tty terminals and only when
10925 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10927 See also `current-input-mode'. */)
10928 (Lisp_Object flow
, Lisp_Object terminal
)
10930 struct terminal
*t
= get_terminal (terminal
, 1);
10931 struct tty_display_info
*tty
;
10932 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10934 tty
= t
->display_info
.tty
;
10936 if (tty
->flow_control
!= !NILP (flow
))
10939 /* this causes startup screen to be restored and messes with the mouse */
10940 reset_sys_modes (tty
);
10943 tty
->flow_control
= !NILP (flow
);
10946 init_sys_modes (tty
);
10952 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10953 doc
: /* Enable or disable 8-bit input on TERMINAL.
10954 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10955 bit as the Meta modifier.
10957 If META is nil, Emacs will ignore the top bit, on the assumption it is
10960 Otherwise, Emacs will accept and pass through 8-bit input without
10961 specially interpreting the top bit.
10963 This setting only has an effect on tty terminal devices.
10965 Optional parameter TERMINAL specifies the tty terminal device to use.
10966 It may be a terminal object, a frame, or nil for the terminal used by
10967 the currently selected frame.
10969 See also `current-input-mode'. */)
10970 (Lisp_Object meta
, Lisp_Object terminal
)
10972 struct terminal
*t
= get_terminal (terminal
, 1);
10973 struct tty_display_info
*tty
;
10976 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10978 tty
= t
->display_info
.tty
;
10982 else if (EQ (meta
, Qt
))
10987 if (tty
->meta_key
!= new_meta
)
10990 /* this causes startup screen to be restored and messes with the mouse */
10991 reset_sys_modes (tty
);
10994 tty
->meta_key
= new_meta
;
10997 init_sys_modes (tty
);
11003 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11004 doc
: /* Specify character used for quitting.
11005 QUIT must be an ASCII character.
11007 This function only has an effect on the controlling tty of the Emacs
11010 See also `current-input-mode'. */)
11013 struct terminal
*t
= get_named_tty ("/dev/tty");
11014 struct tty_display_info
*tty
;
11015 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11017 tty
= t
->display_info
.tty
;
11019 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11020 error ("QUIT must be an ASCII character");
11023 /* this causes startup screen to be restored and messes with the mouse */
11024 reset_sys_modes (tty
);
11027 /* Don't let this value be out of range. */
11028 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11031 init_sys_modes (tty
);
11037 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11038 doc
: /* Set mode of reading keyboard input.
11039 First arg INTERRUPT non-nil means use input interrupts;
11040 nil means use CBREAK mode.
11041 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11042 (no effect except in CBREAK mode).
11043 Third arg META t means accept 8-bit input (for a Meta key).
11044 META nil means ignore the top bit, on the assumption it is parity.
11045 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11046 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11047 See also `current-input-mode'. */)
11048 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11050 Fset_input_interrupt_mode (interrupt
);
11051 Fset_output_flow_control (flow
, Qnil
);
11052 Fset_input_meta_mode (meta
, Qnil
);
11054 Fset_quit_char (quit
);
11058 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11059 doc
: /* Return information about the way Emacs currently reads keyboard input.
11060 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11061 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11062 nil, Emacs is using CBREAK mode.
11063 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11064 terminal; this does not apply if Emacs uses interrupt-driven input.
11065 META is t if accepting 8-bit input with 8th bit as Meta flag.
11066 META nil means ignoring the top bit, on the assumption it is parity.
11067 META is neither t nor nil if accepting 8-bit input and using
11068 all 8 bits as the character code.
11069 QUIT is the character Emacs currently uses to quit.
11070 The elements of this list correspond to the arguments of
11071 `set-input-mode'. */)
11074 Lisp_Object val
[4];
11075 struct frame
*sf
= XFRAME (selected_frame
);
11077 val
[0] = interrupt_input
? Qt
: Qnil
;
11078 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11080 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11081 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11083 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11090 XSETFASTINT (val
[3], quit_char
);
11092 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11095 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11096 doc
: /* Return position information for pixel coordinates X and Y.
11097 By default, X and Y are relative to text area of the selected window.
11098 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11099 If optional fourth arg WHOLE is non-nil, X is relative to the left
11100 edge of the window.
11102 The return value is similar to a mouse click position:
11103 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11104 IMAGE (DX . DY) (WIDTH . HEIGHT))
11105 The `posn-' functions access elements of such lists. */)
11106 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11111 if (NILP (frame_or_window
))
11112 frame_or_window
= selected_window
;
11114 if (WINDOWP (frame_or_window
))
11116 struct window
*w
= decode_live_window (frame_or_window
);
11118 XSETINT (x
, (XINT (x
)
11119 + WINDOW_LEFT_EDGE_X (w
)
11121 ? window_box_left_offset (w
, TEXT_AREA
)
11123 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11124 frame_or_window
= w
->frame
;
11127 CHECK_LIVE_FRAME (frame_or_window
);
11129 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11132 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11133 doc
: /* Return position information for buffer POS in WINDOW.
11134 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11136 Return nil if position is not visible in window. Otherwise,
11137 the return value is similar to that returned by `event-start' for
11138 a mouse click at the upper left corner of the glyph corresponding
11139 to the given buffer position:
11140 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11141 IMAGE (DX . DY) (WIDTH . HEIGHT))
11142 The `posn-' functions access elements of such lists. */)
11143 (Lisp_Object pos
, Lisp_Object window
)
11148 window
= selected_window
;
11150 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11153 Lisp_Object x
= XCAR (tem
);
11154 Lisp_Object y
= XCAR (XCDR (tem
));
11156 /* Point invisible due to hscrolling? */
11159 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11167 * Set up a new kboard object with reasonable initial values.
11170 init_kboard (KBOARD
*kb
)
11172 kset_overriding_terminal_local_map (kb
, Qnil
);
11173 kset_last_command (kb
, Qnil
);
11174 kset_real_last_command (kb
, Qnil
);
11175 kset_keyboard_translate_table (kb
, Qnil
);
11176 kset_last_repeatable_command (kb
, Qnil
);
11177 kset_prefix_arg (kb
, Qnil
);
11178 kset_last_prefix_arg (kb
, Qnil
);
11179 kset_kbd_queue (kb
, Qnil
);
11180 kb
->kbd_queue_has_data
= 0;
11181 kb
->immediate_echo
= 0;
11182 kset_echo_string (kb
, Qnil
);
11183 kb
->echo_after_prompt
= -1;
11184 kb
->kbd_macro_buffer
= 0;
11185 kb
->kbd_macro_bufsize
= 0;
11186 kset_defining_kbd_macro (kb
, Qnil
);
11187 kset_last_kbd_macro (kb
, Qnil
);
11188 kb
->reference_count
= 0;
11189 kset_system_key_alist (kb
, Qnil
);
11190 kset_system_key_syms (kb
, Qnil
);
11191 kset_window_system (kb
, Qt
); /* Unset. */
11192 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11193 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11194 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11195 kset_default_minibuffer_frame (kb
, Qnil
);
11199 * Destroy the contents of a kboard object, but not the object itself.
11200 * We use this just before deleting it, or if we're going to initialize
11201 * it a second time.
11204 wipe_kboard (KBOARD
*kb
)
11206 xfree (kb
->kbd_macro_buffer
);
11209 /* Free KB and memory referenced from it. */
11212 delete_kboard (KBOARD
*kb
)
11216 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11219 *kbp
= kb
->next_kboard
;
11221 /* Prevent a dangling reference to KB. */
11222 if (kb
== current_kboard
11223 && FRAMEP (selected_frame
)
11224 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11226 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11228 if (current_kboard
== kb
)
11237 init_keyboard (void)
11239 /* This is correct before outermost invocation of the editor loop. */
11240 command_loop_level
= -1;
11241 immediate_quit
= 0;
11242 quit_char
= Ctl ('g');
11243 Vunread_command_events
= Qnil
;
11244 timer_idleness_start_time
= invalid_emacs_time ();
11246 recent_keys_index
= 0;
11247 kbd_fetch_ptr
= kbd_buffer
;
11248 kbd_store_ptr
= kbd_buffer
;
11249 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11250 do_mouse_tracking
= Qnil
;
11253 interrupt_input_blocked
= 0;
11254 pending_signals
= 0;
11256 /* This means that command_loop_1 won't try to select anything the first
11258 internal_last_event_frame
= Qnil
;
11259 Vlast_event_frame
= internal_last_event_frame
;
11261 current_kboard
= initial_kboard
;
11262 /* Re-initialize the keyboard again. */
11263 wipe_kboard (current_kboard
);
11264 init_kboard (current_kboard
);
11265 /* A value of nil for Vwindow_system normally means a tty, but we also use
11266 it for the initial terminal since there is no window system there. */
11267 kset_window_system (current_kboard
, Qnil
);
11269 if (!noninteractive
)
11271 /* Before multi-tty support, these handlers used to be installed
11272 only if the current session was a tty session. Now an Emacs
11273 session may have multiple display types, so we always handle
11274 SIGINT. There is special code in handle_interrupt_signal to exit
11275 Emacs on SIGINT when there are no termcap frames on the
11276 controlling terminal. */
11277 struct sigaction action
;
11278 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11279 sigaction (SIGINT
, &action
, 0);
11281 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11282 SIGQUIT and we can't tell which one it will give us. */
11283 sigaction (SIGQUIT
, &action
, 0);
11284 #endif /* not DOS_NT */
11286 #ifdef USABLE_SIGIO
11287 if (!noninteractive
)
11289 struct sigaction action
;
11290 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11291 sigaction (SIGIO
, &action
, 0);
11295 /* Use interrupt input by default, if it works and noninterrupt input
11296 has deficiencies. */
11298 #ifdef INTERRUPT_INPUT
11299 interrupt_input
= 1;
11301 interrupt_input
= 0;
11304 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11307 if (keyboard_init_hook
)
11308 (*keyboard_init_hook
) ();
11310 #ifdef POLL_FOR_INPUT
11312 poll_suppress_count
= 1;
11317 /* This type's only use is in syms_of_keyboard, to initialize the
11318 event header symbols and put properties on them. */
11319 struct event_head
{
11325 static const struct event_head head_table
[] = {
11326 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11327 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11328 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11329 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11330 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11331 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11332 /* `select-window' should be handled just like `switch-frame'
11333 in read_key_sequence. */
11334 {&Qselect_window
, "select-window", &Qswitch_frame
}
11338 syms_of_keyboard (void)
11340 pending_funcalls
= Qnil
;
11341 staticpro (&pending_funcalls
);
11343 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11344 staticpro (&Vlispy_mouse_stem
);
11347 DEFSYM (QCimage
, ":image");
11348 DEFSYM (Qhelp_echo
, "help-echo");
11349 DEFSYM (QCrtl
, ":rtl");
11351 staticpro (&item_properties
);
11352 item_properties
= Qnil
;
11354 staticpro (&tool_bar_item_properties
);
11355 tool_bar_item_properties
= Qnil
;
11356 staticpro (&tool_bar_items_vector
);
11357 tool_bar_items_vector
= Qnil
;
11359 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11360 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11361 DEFSYM (Qself_insert_command
, "self-insert-command");
11362 DEFSYM (Qforward_char
, "forward-char");
11363 DEFSYM (Qbackward_char
, "backward-char");
11364 DEFSYM (Qdisabled
, "disabled");
11365 DEFSYM (Qundefined
, "undefined");
11366 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11367 DEFSYM (Qpost_command_hook
, "post-command-hook");
11368 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11369 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11370 DEFSYM (Qfunction_key
, "function-key");
11371 DEFSYM (Qmouse_click
, "mouse-click");
11372 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11373 DEFSYM (Qsave_session
, "save-session");
11374 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11375 DEFSYM (Qmenu_enable
, "menu-enable");
11378 DEFSYM (Qlanguage_change
, "language-change");
11379 DEFSYM (Qfile_notify
, "file-notify");
11383 DEFSYM (Qdbus_event
, "dbus-event");
11386 DEFSYM (QCenable
, ":enable");
11387 DEFSYM (QCvisible
, ":visible");
11388 DEFSYM (QChelp
, ":help");
11389 DEFSYM (QCfilter
, ":filter");
11390 DEFSYM (QCbutton
, ":button");
11391 DEFSYM (QCkeys
, ":keys");
11392 DEFSYM (QCkey_sequence
, ":key-sequence");
11393 DEFSYM (QCtoggle
, ":toggle");
11394 DEFSYM (QCradio
, ":radio");
11395 DEFSYM (QClabel
, ":label");
11396 DEFSYM (QCvert_only
, ":vert-only");
11398 DEFSYM (Qmode_line
, "mode-line");
11399 DEFSYM (Qvertical_line
, "vertical-line");
11400 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11401 DEFSYM (Qmenu_bar
, "menu-bar");
11403 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11404 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11407 DEFSYM (Qabove_handle
, "above-handle");
11408 DEFSYM (Qhandle
, "handle");
11409 DEFSYM (Qbelow_handle
, "below-handle");
11410 DEFSYM (Qup
, "up");
11411 DEFSYM (Qdown
, "down");
11412 DEFSYM (Qtop
, "top");
11413 DEFSYM (Qbottom
, "bottom");
11414 DEFSYM (Qend_scroll
, "end-scroll");
11415 DEFSYM (Qratio
, "ratio");
11417 DEFSYM (Qevent_kind
, "event-kind");
11418 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11419 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11420 DEFSYM (Qmodifier_cache
, "modifier-cache");
11422 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11423 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11425 DEFSYM (Qpolling_period
, "polling-period");
11427 DEFSYM (Qx_set_selection
, "x-set-selection");
11428 DEFSYM (QPRIMARY
, "PRIMARY");
11429 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11430 DEFSYM (Qhandle_select_window
, "handle-select-window");
11432 DEFSYM (Qinput_method_function
, "input-method-function");
11433 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11434 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11436 DEFSYM (Qhelp_form_show
, "help-form-show");
11438 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11439 Fset (Qinput_method_use_echo_area
, Qnil
);
11441 last_point_position_buffer
= Qnil
;
11442 last_point_position_window
= Qnil
;
11446 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11448 for (i
= 0; i
< len
; i
++)
11450 const struct event_head
*p
= &head_table
[i
];
11451 *p
->var
= intern_c_string (p
->name
);
11452 staticpro (p
->var
);
11453 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11454 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11458 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11459 staticpro (&button_down_location
);
11460 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11461 staticpro (&mouse_syms
);
11462 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11463 / sizeof (lispy_wheel_names
[0])),
11465 staticpro (&wheel_syms
);
11469 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11471 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11472 for (i
= 0; i
< len
; i
++)
11473 if (modifier_names
[i
])
11474 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11475 staticpro (&modifier_symbols
);
11478 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11479 staticpro (&recent_keys
);
11481 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11482 staticpro (&this_command_keys
);
11484 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11485 staticpro (&raw_keybuf
);
11487 DEFSYM (Qextended_command_history
, "extended-command-history");
11488 Fset (Qextended_command_history
, Qnil
);
11490 accent_key_syms
= Qnil
;
11491 staticpro (&accent_key_syms
);
11493 func_key_syms
= Qnil
;
11494 staticpro (&func_key_syms
);
11496 drag_n_drop_syms
= Qnil
;
11497 staticpro (&drag_n_drop_syms
);
11499 unread_switch_frame
= Qnil
;
11500 staticpro (&unread_switch_frame
);
11502 internal_last_event_frame
= Qnil
;
11503 staticpro (&internal_last_event_frame
);
11505 read_key_sequence_cmd
= Qnil
;
11506 staticpro (&read_key_sequence_cmd
);
11507 read_key_sequence_remapped
= Qnil
;
11508 staticpro (&read_key_sequence_remapped
);
11510 menu_bar_one_keymap_changed_items
= Qnil
;
11511 staticpro (&menu_bar_one_keymap_changed_items
);
11513 menu_bar_items_vector
= Qnil
;
11514 staticpro (&menu_bar_items_vector
);
11516 help_form_saved_window_configs
= Qnil
;
11517 staticpro (&help_form_saved_window_configs
);
11519 defsubr (&Scurrent_idle_time
);
11520 defsubr (&Sevent_symbol_parse_modifiers
);
11521 defsubr (&Sevent_convert_list
);
11522 defsubr (&Sread_key_sequence
);
11523 defsubr (&Sread_key_sequence_vector
);
11524 defsubr (&Srecursive_edit
);
11525 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11526 defsubr (&Strack_mouse
);
11528 defsubr (&Sinput_pending_p
);
11529 defsubr (&Scommand_execute
);
11530 defsubr (&Srecent_keys
);
11531 defsubr (&Sthis_command_keys
);
11532 defsubr (&Sthis_command_keys_vector
);
11533 defsubr (&Sthis_single_command_keys
);
11534 defsubr (&Sthis_single_command_raw_keys
);
11535 defsubr (&Sreset_this_command_lengths
);
11536 defsubr (&Sclear_this_command_keys
);
11537 defsubr (&Ssuspend_emacs
);
11538 defsubr (&Sabort_recursive_edit
);
11539 defsubr (&Sexit_recursive_edit
);
11540 defsubr (&Srecursion_depth
);
11541 defsubr (&Stop_level
);
11542 defsubr (&Sdiscard_input
);
11543 defsubr (&Sopen_dribble_file
);
11544 defsubr (&Sset_input_interrupt_mode
);
11545 defsubr (&Sset_output_flow_control
);
11546 defsubr (&Sset_input_meta_mode
);
11547 defsubr (&Sset_quit_char
);
11548 defsubr (&Sset_input_mode
);
11549 defsubr (&Scurrent_input_mode
);
11550 defsubr (&Sposn_at_point
);
11551 defsubr (&Sposn_at_x_y
);
11553 DEFVAR_LISP ("last-command-event", last_command_event
,
11554 doc
: /* Last input event that was part of a command. */);
11556 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11557 doc
: /* Last input event in a command, except for mouse menu events.
11558 Mouse menus give back keys that don't look like mouse events;
11559 this variable holds the actual mouse event that led to the menu,
11560 so that you can determine whether the command was run by mouse or not. */);
11562 DEFVAR_LISP ("last-input-event", last_input_event
,
11563 doc
: /* Last input event. */);
11565 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11566 doc
: /* List of events to be read as the command input.
11567 These events are processed first, before actual keyboard input.
11568 Events read from this list are not normally added to `this-command-keys',
11569 as they will already have been added once as they were read for the first time.
11570 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11571 Vunread_command_events
= Qnil
;
11573 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11574 doc
: /* List of events to be processed as input by input methods.
11575 These events are processed before `unread-command-events'
11576 and actual keyboard input, but are not given to `input-method-function'. */);
11577 Vunread_post_input_method_events
= Qnil
;
11579 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11580 doc
: /* List of events to be processed as input by input methods.
11581 These events are processed after `unread-command-events', but
11582 before actual keyboard input.
11583 If there's an active input method, the events are given to
11584 `input-method-function'. */);
11585 Vunread_input_method_events
= Qnil
;
11587 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11588 doc
: /* Meta-prefix character code.
11589 Meta-foo as command input turns into this character followed by foo. */);
11590 XSETINT (meta_prefix_char
, 033);
11592 DEFVAR_KBOARD ("last-command", Vlast_command
,
11593 doc
: /* The last command executed.
11594 Normally a symbol with a function definition, but can be whatever was found
11595 in the keymap, or whatever the variable `this-command' was set to by that
11598 The value `mode-exit' is special; it means that the previous command
11599 read an event that told it to exit, and it did so and unread that event.
11600 In other words, the present command is the event that made the previous
11603 The value `kill-region' is special; it means that the previous command
11604 was a kill command.
11606 `last-command' has a separate binding for each terminal device.
11607 See Info node `(elisp)Multiple Terminals'. */);
11609 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11610 doc
: /* Same as `last-command', but never altered by Lisp code.
11611 Taken from the previous value of `real-this-command'. */);
11613 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11614 doc
: /* Last command that may be repeated.
11615 The last command executed that was not bound to an input event.
11616 This is the command `repeat' will try to repeat.
11617 Taken from a previous value of `real-this-command'. */);
11619 DEFVAR_LISP ("this-command", Vthis_command
,
11620 doc
: /* The command now being executed.
11621 The command can set this variable; whatever is put here
11622 will be in `last-command' during the following command. */);
11623 Vthis_command
= Qnil
;
11625 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11626 doc
: /* This is like `this-command', except that commands should never modify it. */);
11627 Vreal_this_command
= Qnil
;
11629 DEFVAR_LISP ("this-command-keys-shift-translated",
11630 Vthis_command_keys_shift_translated
,
11631 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11632 Shift-translation occurs when there is no binding for the key sequence
11633 as entered, but a binding was found by changing an upper-case letter
11634 to lower-case, or a shifted function key to an unshifted one. */);
11635 Vthis_command_keys_shift_translated
= Qnil
;
11637 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11638 doc
: /* The command bound to the current key sequence before remapping.
11639 It equals `this-command' if the original command was not remapped through
11640 any of the active keymaps. Otherwise, the value of `this-command' is the
11641 result of looking up the original command in the active keymaps. */);
11642 Vthis_original_command
= Qnil
;
11644 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11645 doc
: /* Number of input events between auto-saves.
11646 Zero means disable autosaving due to number of characters typed. */);
11647 auto_save_interval
= 300;
11649 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11650 doc
: /* Number of seconds idle time before auto-save.
11651 Zero or nil means disable auto-saving due to idleness.
11652 After auto-saving due to this many seconds of idle time,
11653 Emacs also does a garbage collection if that seems to be warranted. */);
11654 XSETFASTINT (Vauto_save_timeout
, 30);
11656 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11657 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11658 The value may be integer or floating point.
11659 If the value is zero, don't echo at all. */);
11660 Vecho_keystrokes
= make_number (1);
11662 DEFVAR_INT ("polling-period", polling_period
,
11663 doc
: /* Interval between polling for input during Lisp execution.
11664 The reason for polling is to make C-g work to stop a running program.
11665 Polling is needed only when using X windows and SIGIO does not work.
11666 Polling is automatically disabled in all other cases. */);
11667 polling_period
= 2;
11669 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11670 doc
: /* Maximum time between mouse clicks to make a double-click.
11671 Measured in milliseconds. The value nil means disable double-click
11672 recognition; t means double-clicks have no time limit and are detected
11673 by position only. */);
11674 Vdouble_click_time
= make_number (500);
11676 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11677 doc
: /* Maximum mouse movement between clicks to make a double-click.
11678 On window-system frames, value is the number of pixels the mouse may have
11679 moved horizontally or vertically between two clicks to make a double-click.
11680 On non window-system frames, value is interpreted in units of 1/8 characters
11683 This variable is also the threshold for motion of the mouse
11684 to count as a drag. */);
11685 double_click_fuzz
= 3;
11687 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11688 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11689 inhibit_local_menu_bar_menus
= 0;
11691 DEFVAR_INT ("num-input-keys", num_input_keys
,
11692 doc
: /* Number of complete key sequences read as input so far.
11693 This includes key sequences read from keyboard macros.
11694 The number is effectively the number of interactive command invocations. */);
11695 num_input_keys
= 0;
11697 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11698 doc
: /* Number of input events read from the keyboard so far.
11699 This does not include events generated by keyboard macros. */);
11700 num_nonmacro_input_events
= 0;
11702 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11703 doc
: /* The frame in which the most recently read event occurred.
11704 If the last event came from a keyboard macro, this is set to `macro'. */);
11705 Vlast_event_frame
= Qnil
;
11707 /* This variable is set up in sysdep.c. */
11708 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11709 doc
: /* The ERASE character as set by the user with stty. */);
11711 DEFVAR_LISP ("help-char", Vhelp_char
,
11712 doc
: /* Character to recognize as meaning Help.
11713 When it is read, do `(eval help-form)', and display result if it's a string.
11714 If the value of `help-form' is nil, this char can be read normally. */);
11715 XSETINT (Vhelp_char
, Ctl ('H'));
11717 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11718 doc
: /* List of input events to recognize as meaning Help.
11719 These work just like the value of `help-char' (see that). */);
11720 Vhelp_event_list
= Qnil
;
11722 DEFVAR_LISP ("help-form", Vhelp_form
,
11723 doc
: /* Form to execute when character `help-char' is read.
11724 If the form returns a string, that string is displayed.
11725 If `help-form' is nil, the help char is not recognized. */);
11728 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11729 doc
: /* Command to run when `help-char' character follows a prefix key.
11730 This command is used only when there is no actual binding
11731 for that character after that prefix key. */);
11732 Vprefix_help_command
= Qnil
;
11734 DEFVAR_LISP ("top-level", Vtop_level
,
11735 doc
: /* Form to evaluate when Emacs starts up.
11736 Useful to set before you dump a modified Emacs. */);
11739 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11740 doc
: /* Translate table for local keyboard input, or nil.
11741 If non-nil, the value should be a char-table. Each character read
11742 from the keyboard is looked up in this char-table. If the value found
11743 there is non-nil, then it is used instead of the actual input character.
11745 The value can also be a string or vector, but this is considered obsolete.
11746 If it is a string or vector of length N, character codes N and up are left
11747 untranslated. In a vector, an element which is nil means "no translation".
11749 This is applied to the characters supplied to input methods, not their
11750 output. See also `translation-table-for-input'.
11752 This variable has a separate binding for each terminal.
11753 See Info node `(elisp)Multiple Terminals'. */);
11755 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11756 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11757 \(Even if the operating system has support for stopping a process.\) */);
11758 cannot_suspend
= 0;
11760 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11761 doc
: /* Non-nil means prompt with menus when appropriate.
11762 This is done when reading from a keymap that has a prompt string,
11763 for elements that have prompt strings.
11764 The menu is displayed on the screen
11765 if X menus were enabled at configuration
11766 time and the previous event was a mouse click prefix key.
11767 Otherwise, menu prompting uses the echo area. */);
11768 menu_prompting
= 1;
11770 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11771 doc
: /* Character to see next line of menu prompt.
11772 Type this character while in a menu prompt to rotate around the lines of it. */);
11773 XSETINT (menu_prompt_more_char
, ' ');
11775 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11776 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11777 Emacs applies the modifiers of the character stored here to each keyboard
11778 character it reads. For example, after evaluating the expression
11779 (setq extra-keyboard-modifiers ?\\C-x)
11780 all input characters will have the control modifier applied to them.
11782 Note that the character ?\\C-@, equivalent to the integer zero, does
11783 not count as a control character; rather, it counts as a character
11784 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11785 cancels any modification. */);
11786 extra_keyboard_modifiers
= 0;
11788 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11789 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11790 The command loop sets this to nil before each command,
11791 and tests the value when the command returns.
11792 Buffer modification stores t in this variable. */);
11793 Vdeactivate_mark
= Qnil
;
11794 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11796 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11797 doc
: /* Normal hook run before each command is executed.
11798 If an unhandled error happens in running this hook,
11799 the function in which the error occurred is unconditionally removed, since
11800 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11801 Vpre_command_hook
= Qnil
;
11803 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11804 doc
: /* Normal hook run after each command is executed.
11805 If an unhandled error happens in running this hook,
11806 the function in which the error occurred is unconditionally removed, since
11807 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11808 Vpost_command_hook
= Qnil
;
11811 DEFVAR_LISP ("echo-area-clear-hook", ...,
11812 doc
: /* Normal hook run when clearing the echo area. */);
11814 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11815 Fset (Qecho_area_clear_hook
, Qnil
);
11817 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11818 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11819 Vlucid_menu_bar_dirty_flag
= Qnil
;
11821 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11822 doc
: /* List of menu bar items to move to the end of the menu bar.
11823 The elements of the list are event types that may have menu bar bindings. */);
11824 Vmenu_bar_final_items
= Qnil
;
11826 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11827 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11828 This is used internally by graphical displays that do not render
11829 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11830 Vtool_bar_separator_image_expression
= Qnil
;
11832 DEFVAR_KBOARD ("overriding-terminal-local-map",
11833 Voverriding_terminal_local_map
,
11834 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11835 If this variable is non-nil, it is used as a keymap instead of the
11836 buffer's local map, and the minor mode keymaps and text property keymaps.
11837 It also replaces `overriding-local-map'.
11839 This variable is intended to let commands such as `universal-argument'
11840 set up a different keymap for reading the next command.
11842 `overriding-terminal-local-map' has a separate binding for each
11844 See Info node `(elisp)Multiple Terminals'. */);
11846 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11847 doc
: /* Keymap that overrides all other local keymaps.
11848 If this variable is non-nil, it is used as a keymap--replacing the
11849 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11850 Voverriding_local_map
= Qnil
;
11852 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11853 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11854 Otherwise, the menu bar continues to reflect the buffer's local map
11855 and the minor mode maps regardless of `overriding-local-map'. */);
11856 Voverriding_local_map_menu_flag
= Qnil
;
11858 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11859 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11860 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11862 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11863 doc
: /* Non-nil means generate motion events for mouse motion. */);
11865 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11866 doc
: /* Alist of system-specific X windows key symbols.
11867 Each element should have the form (N . SYMBOL) where N is the
11868 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11869 and SYMBOL is its name.
11871 `system-key-alist' has a separate binding for each terminal device.
11872 See Info node `(elisp)Multiple Terminals'. */);
11874 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11875 doc
: /* Keymap that translates key sequences to key sequences during input.
11876 This is used mainly for mapping key sequences into some preferred
11877 key events (symbols).
11879 The `read-key-sequence' function replaces any subsequence bound by
11880 `local-function-key-map' with its binding. More precisely, when the
11881 active keymaps have no binding for the current key sequence but
11882 `local-function-key-map' binds a suffix of the sequence to a vector or
11883 string, `read-key-sequence' replaces the matching suffix with its
11884 binding, and continues with the new sequence.
11886 If the binding is a function, it is called with one argument (the prompt)
11887 and its return value (a key sequence) is used.
11889 The events that come from bindings in `local-function-key-map' are not
11890 themselves looked up in `local-function-key-map'.
11892 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11893 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11894 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11895 typing `ESC O P x' would return [f1 x].
11897 `local-function-key-map' has a separate binding for each terminal
11898 device. See Info node `(elisp)Multiple Terminals'. If you need to
11899 define a binding on all terminals, change `function-key-map'
11900 instead. Initially, `local-function-key-map' is an empty keymap that
11901 has `function-key-map' as its parent on all terminal devices. */);
11903 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11904 doc
: /* Keymap that decodes input escape sequences.
11905 This is used mainly for mapping ASCII function key sequences into
11906 real Emacs function key events (symbols).
11908 The `read-key-sequence' function replaces any subsequence bound by
11909 `input-decode-map' with its binding. Contrary to `function-key-map',
11910 this map applies its rebinding regardless of the presence of an ordinary
11911 binding. So it is more like `key-translation-map' except that it applies
11912 before `function-key-map' rather than after.
11914 If the binding is a function, it is called with one argument (the prompt)
11915 and its return value (a key sequence) is used.
11917 The events that come from bindings in `input-decode-map' are not
11918 themselves looked up in `input-decode-map'.
11920 This variable is keyboard-local. */);
11922 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11923 doc
: /* The parent keymap of all `local-function-key-map' instances.
11924 Function key definitions that apply to all terminal devices should go
11925 here. If a mapping is defined in both the current
11926 `local-function-key-map' binding and this variable, then the local
11927 definition will take precedence. */);
11928 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11930 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11931 doc
: /* Keymap of key translations that can override keymaps.
11932 This keymap works like `function-key-map', but comes after that,
11933 and its non-prefix bindings override ordinary bindings.
11934 Another difference is that it is global rather than keyboard-local. */);
11935 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11937 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11938 doc
: /* List of deferred actions to be performed at a later time.
11939 The precise format isn't relevant here; we just check whether it is nil. */);
11940 Vdeferred_action_list
= Qnil
;
11942 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11943 doc
: /* Function to call to handle deferred actions, after each command.
11944 This function is called with no arguments after each command
11945 whenever `deferred-action-list' is non-nil. */);
11946 Vdeferred_action_function
= Qnil
;
11948 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11949 doc
: /* List of warnings to be displayed after this command.
11950 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11951 as per the args of `display-warning' (which see).
11952 If this variable is non-nil, `delayed-warnings-hook' will be run
11953 immediately after running `post-command-hook'. */);
11954 Vdelayed_warnings_list
= Qnil
;
11956 DEFVAR_LISP ("timer-list", Vtimer_list
,
11957 doc
: /* List of active absolute time timers in order of increasing time. */);
11958 Vtimer_list
= Qnil
;
11960 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11961 doc
: /* List of active idle-time timers in order of increasing time. */);
11962 Vtimer_idle_list
= Qnil
;
11964 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11965 doc
: /* If non-nil, the function that implements the current input method.
11966 It's called with one argument, a printing character that was just read.
11967 \(That means a character with code 040...0176.)
11968 Typically this function uses `read-event' to read additional events.
11969 When it does so, it should first bind `input-method-function' to nil
11970 so it will not be called recursively.
11972 The function should return a list of zero or more events
11973 to be used as input. If it wants to put back some events
11974 to be reconsidered, separately, by the input method,
11975 it can add them to the beginning of `unread-command-events'.
11977 The input method function can find in `input-method-previous-message'
11978 the previous echo area message.
11980 The input method function should refer to the variables
11981 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11982 for guidance on what to do. */);
11983 Vinput_method_function
= Qnil
;
11985 DEFVAR_LISP ("input-method-previous-message",
11986 Vinput_method_previous_message
,
11987 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11988 This variable exists because `read-event' clears the echo area
11989 before running the input method. It is nil if there was no message. */);
11990 Vinput_method_previous_message
= Qnil
;
11992 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11993 doc
: /* If non-nil, the function that implements the display of help.
11994 It's called with one argument, the help string to display. */);
11995 Vshow_help_function
= Qnil
;
11997 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11998 doc
: /* If non-nil, suppress point adjustment after executing a command.
12000 After a command is executed, if point is moved into a region that has
12001 special properties (e.g. composition, display), we adjust point to
12002 the boundary of the region. But, when a command sets this variable to
12003 non-nil, we suppress the point adjustment.
12005 This variable is set to nil before reading a command, and is checked
12006 just after executing the command. */);
12007 Vdisable_point_adjustment
= Qnil
;
12009 DEFVAR_LISP ("global-disable-point-adjustment",
12010 Vglobal_disable_point_adjustment
,
12011 doc
: /* If non-nil, always suppress point adjustment.
12013 The default value is nil, in which case, point adjustment are
12014 suppressed only after special commands that set
12015 `disable-point-adjustment' (which see) to non-nil. */);
12016 Vglobal_disable_point_adjustment
= Qnil
;
12018 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12019 doc
: /* How long to display an echo-area message when the minibuffer is active.
12020 If the value is not a number, such messages don't time out. */);
12021 Vminibuffer_message_timeout
= make_number (2);
12023 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12024 doc
: /* If non-nil, any keyboard input throws to this symbol.
12025 The value of that variable is passed to `quit-flag' and later causes a
12026 peculiar kind of quitting. */);
12027 Vthrow_on_input
= Qnil
;
12029 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12030 doc
: /* If non-nil, function to output error messages.
12031 The arguments are the error data, a list of the form
12032 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12033 such as just as `condition-case' would bind its variable to,
12034 the context (a string which normally goes at the start of the message),
12035 and the Lisp function within which the error was signaled. */);
12036 Vcommand_error_function
= Qnil
;
12038 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12039 Venable_disabled_menus_and_buttons
,
12040 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12042 Help functions bind this to allow help on disabled menu items
12043 and tool-bar buttons. */);
12044 Venable_disabled_menus_and_buttons
= Qnil
;
12046 DEFVAR_LISP ("select-active-regions",
12047 Vselect_active_regions
,
12048 doc
: /* If non-nil, an active region automatically sets the primary selection.
12049 If the value is `only', only temporarily active regions (usually made
12050 by mouse-dragging or shift-selection) set the window selection.
12052 This takes effect only when Transient Mark mode is enabled. */);
12053 Vselect_active_regions
= Qt
;
12055 DEFVAR_LISP ("saved-region-selection",
12056 Vsaved_region_selection
,
12057 doc
: /* Contents of active region prior to buffer modification.
12058 If `select-active-regions' is non-nil, Emacs sets this to the
12059 text in the region before modifying the buffer. The next
12060 `deactivate-mark' call uses this to set the window selection. */);
12061 Vsaved_region_selection
= Qnil
;
12063 DEFVAR_LISP ("selection-inhibit-update-commands",
12064 Vselection_inhibit_update_commands
,
12065 doc
: /* List of commands which should not update the selection.
12066 Normally, if `select-active-regions' is non-nil and the mark remains
12067 active after a command (i.e. the mark was not deactivated), the Emacs
12068 command loop sets the selection to the text in the region. However,
12069 if the command is in this list, the selection is not updated. */);
12070 Vselection_inhibit_update_commands
12071 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12073 DEFVAR_LISP ("debug-on-event",
12075 doc
: /* Enter debugger on this event. When Emacs
12076 receives the special event specified by this variable, it will try to
12077 break into the debugger as soon as possible instead of processing the
12078 event normally through `special-event-map'.
12080 Currently, the only supported values for this
12081 variable are `sigusr1' and `sigusr2'. */);
12082 Vdebug_on_event
= intern_c_string ("sigusr2");
12084 /* Create the initial keyboard. */
12085 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12086 init_kboard (initial_kboard
);
12087 /* Vwindow_system is left at t for now. */
12088 initial_kboard
->next_kboard
= all_kboards
;
12089 all_kboards
= initial_kboard
;
12093 keys_of_keyboard (void)
12095 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12096 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12097 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12098 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12099 initial_define_key (meta_map
, 'x', "execute-extended-command");
12101 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12102 "handle-delete-frame");
12103 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12104 "ns-put-working-text");
12105 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12106 "ns-unput-working-text");
12107 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12108 current-prefix-arg, as is done in `handle-switch-frame'.
12109 But `handle-switch-frame is not run from the special-map.
12110 Commands from that map are run in a special way that automatically
12111 preserves the prefix-arg. Restoring the prefix arg here is not just
12112 redundant but harmful:
12114 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12115 - after the first prompt, the exit-minibuffer-hook is run which may
12116 iconify a frame and thus push a `iconify-frame' event.
12117 - after running exit-minibuffer-hook, current-prefix-arg is
12118 restored to the non-nil value it had before the prompt.
12119 - we enter the second prompt.
12120 current-prefix-arg is non-nil, prefix-arg is nil.
12121 - before running the first real event, we run the special iconify-frame
12122 event, but we pass the `special' arg to execute-command so
12123 current-prefix-arg and prefix-arg are left untouched.
12124 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12125 - the next key event will have a spuriously non-nil current-prefix-arg. */
12126 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12128 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12130 /* Handling it at such a low-level causes read_key_sequence to get
12131 * confused because it doesn't realize that the current_buffer was
12132 * changed by read_char.
12134 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12135 * "handle-select-window"); */
12136 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12137 "handle-save-session");
12140 /* Define a special event which is raised for dbus callback
12142 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12143 "dbus-handle-event");
12146 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12148 #if defined (WINDOWSNT)
12149 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12151 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
12152 "w32notify-handle-event");
12156 /* Mark the pointers in the kboard objects.
12157 Called by Fgarbage_collect. */
12159 mark_kboards (void)
12163 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12165 if (kb
->kbd_macro_buffer
)
12166 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12168 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12169 mark_object (KVAR (kb
, Vlast_command
));
12170 mark_object (KVAR (kb
, Vreal_last_command
));
12171 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12172 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12173 mark_object (KVAR (kb
, Vprefix_arg
));
12174 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12175 mark_object (KVAR (kb
, kbd_queue
));
12176 mark_object (KVAR (kb
, defining_kbd_macro
));
12177 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12178 mark_object (KVAR (kb
, Vsystem_key_alist
));
12179 mark_object (KVAR (kb
, system_key_syms
));
12180 mark_object (KVAR (kb
, Vwindow_system
));
12181 mark_object (KVAR (kb
, Vinput_decode_map
));
12182 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12183 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12184 mark_object (KVAR (kb
, echo_string
));
12187 struct input_event
*event
;
12188 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12190 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12191 event
= kbd_buffer
;
12192 /* These two special event types has no Lisp_Objects to mark. */
12193 if (event
->kind
!= SELECTION_REQUEST_EVENT
12194 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12196 mark_object (event
->x
);
12197 mark_object (event
->y
);
12198 mark_object (event
->frame_or_window
);
12199 mark_object (event
->arg
);