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 static Lisp_Object Qdrag_n_drop
;
320 static Lisp_Object Qsave_session
;
322 static Lisp_Object Qdbus_event
;
325 Lisp_Object Qxwidget_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;
3929 else if (event
->kind
== SAVE_SESSION_EVENT
)
3931 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3932 kbd_fetch_ptr
= event
+ 1;
3934 /* Just discard these, by returning nil.
3935 With MULTI_KBOARD, these events are used as placeholders
3936 when we need to randomly delete events from the queue.
3937 (They shouldn't otherwise be found in the buffer,
3938 but on some machines it appears they do show up
3939 even without MULTI_KBOARD.) */
3940 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3941 mouse events during a popup-menu call. */
3942 else if (event
->kind
== NO_EVENT
)
3943 kbd_fetch_ptr
= event
+ 1;
3944 else if (event
->kind
== HELP_EVENT
)
3946 Lisp_Object object
, position
, help
, frame
, window
;
3948 frame
= event
->frame_or_window
;
3949 object
= event
->arg
;
3950 position
= make_number (event
->code
);
3953 clear_event (event
);
3955 kbd_fetch_ptr
= event
+ 1;
3956 if (!WINDOWP (window
))
3958 obj
= Fcons (Qhelp_echo
,
3959 list5 (frame
, help
, window
, object
, position
));
3961 else if (event
->kind
== FOCUS_IN_EVENT
)
3963 /* Notification of a FocusIn event. The frame receiving the
3964 focus is in event->frame_or_window. Generate a
3965 switch-frame event if necessary. */
3966 Lisp_Object frame
, focus
;
3968 frame
= event
->frame_or_window
;
3969 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3973 if (!EQ (frame
, internal_last_event_frame
)
3974 && !EQ (frame
, selected_frame
))
3975 obj
= make_lispy_switch_frame (frame
);
3976 internal_last_event_frame
= frame
;
3977 kbd_fetch_ptr
= event
+ 1;
3980 else if (event
->kind
== DBUS_EVENT
)
3982 obj
= make_lispy_event (event
);
3983 kbd_fetch_ptr
= event
+ 1;
3986 #ifdef HAVE_XWIDGETS
3987 else if (event
->kind
== XWIDGET_EVENT
)
3989 obj
= make_lispy_event (event
);
3990 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3995 obj
= make_lispy_event (event
);
3996 kbd_fetch_ptr
= event
+ 1;
4000 /* If this event is on a different frame, return a switch-frame this
4001 time, and leave the event in the queue for next time. */
4005 frame
= event
->frame_or_window
;
4007 frame
= XCAR (frame
);
4008 else if (WINDOWP (frame
))
4009 frame
= WINDOW_FRAME (XWINDOW (frame
));
4011 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4015 if (! EQ (frame
, internal_last_event_frame
)
4016 && !EQ (frame
, selected_frame
))
4017 obj
= make_lispy_switch_frame (frame
);
4018 internal_last_event_frame
= frame
;
4020 /* If we didn't decide to make a switch-frame event, go ahead
4021 and build a real event from the queue entry. */
4025 obj
= make_lispy_event (event
);
4027 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4028 || defined (HAVE_NS) || defined (USE_GTK)
4029 /* If this was a menu selection, then set the flag to inhibit
4030 writing to last_nonmenu_event. Don't do this if the event
4031 we're returning is (menu-bar), though; that indicates the
4032 beginning of the menu sequence, and we might as well leave
4033 that as the `event with parameters' for this selection. */
4035 && !EQ (event
->frame_or_window
, event
->arg
)
4036 && (event
->kind
== MENU_BAR_EVENT
4037 || event
->kind
== TOOL_BAR_EVENT
))
4038 *used_mouse_menu
= 1;
4041 /* Certain system events are non-key events. */
4043 && event
->kind
== NS_NONKEY_EVENT
)
4044 *used_mouse_menu
= 1;
4047 /* Wipe out this event, to catch bugs. */
4048 clear_event (event
);
4049 kbd_fetch_ptr
= event
+ 1;
4053 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4054 /* Try generating a mouse motion event. */
4055 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4057 FRAME_PTR f
= some_mouse_moved ();
4058 Lisp_Object bar_window
;
4059 enum scroll_bar_part part
;
4063 *kbp
= current_kboard
;
4064 /* Note that this uses F to determine which terminal to look at.
4065 If there is no valid info, it does not store anything
4066 so x remains nil. */
4069 /* XXX Can f or mouse_position_hook be NULL here? */
4070 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4071 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4076 /* Decide if we should generate a switch-frame event. Don't
4077 generate switch-frame events for motion outside of all Emacs
4083 frame
= FRAME_FOCUS_FRAME (f
);
4085 XSETFRAME (frame
, f
);
4087 if (! EQ (frame
, internal_last_event_frame
)
4088 && !EQ (frame
, selected_frame
))
4089 obj
= make_lispy_switch_frame (frame
);
4090 internal_last_event_frame
= frame
;
4093 /* If we didn't decide to make a switch-frame event, go ahead and
4094 return a mouse-motion event. */
4095 if (!NILP (x
) && NILP (obj
))
4096 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4098 #endif /* HAVE_MOUSE || HAVE GPM */
4100 /* We were promised by the above while loop that there was
4101 something for us to read! */
4104 input_pending
= readable_events (0);
4106 Vlast_event_frame
= internal_last_event_frame
;
4111 /* Process any non-user-visible events (currently X selection events),
4112 without reading any user-visible events. */
4115 process_special_events (void)
4117 struct input_event
*event
;
4119 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4121 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4124 if (event
== kbd_store_ptr
)
4128 /* If we find a stored X selection request, handle it now. */
4129 if (event
->kind
== SELECTION_REQUEST_EVENT
4130 || event
->kind
== SELECTION_CLEAR_EVENT
)
4134 /* Remove the event from the fifo buffer before processing;
4135 otherwise swallow_events called recursively could see it
4136 and process it again. To do this, we move the events
4137 between kbd_fetch_ptr and EVENT one slot to the right,
4140 struct input_event copy
= *event
;
4141 struct input_event
*beg
4142 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4143 ? kbd_buffer
: kbd_fetch_ptr
;
4146 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4147 else if (event
< beg
)
4149 if (event
> kbd_buffer
)
4150 memmove (kbd_buffer
+ 1, kbd_buffer
,
4151 (event
- kbd_buffer
) * sizeof (struct input_event
));
4152 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4153 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4154 memmove (beg
+ 1, beg
,
4155 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4156 * sizeof (struct input_event
));
4159 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4160 kbd_fetch_ptr
= kbd_buffer
+ 1;
4164 /* X wants last_event_timestamp for selection ownership. */
4165 last_event_timestamp
= copy
.timestamp
;
4166 input_pending
= readable_events (0);
4167 x_handle_selection_event (©
);
4169 /* We're getting selection request events, but we don't have
4177 /* Process any events that are not user-visible, run timer events that
4178 are ripe, and return, without reading any user-visible events. */
4181 swallow_events (bool do_display
)
4183 unsigned old_timers_run
;
4185 process_special_events ();
4187 old_timers_run
= timers_run
;
4188 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4190 if (timers_run
!= old_timers_run
&& do_display
)
4191 redisplay_preserve_echo_area (7);
4194 /* Record the start of when Emacs is idle,
4195 for the sake of running idle-time timers. */
4198 timer_start_idle (void)
4202 /* If we are already in the idle state, do nothing. */
4203 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4206 timer_idleness_start_time
= current_emacs_time ();
4207 timer_last_idleness_start_time
= timer_idleness_start_time
;
4209 /* Mark all idle-time timers as once again candidates for running. */
4210 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4214 timer
= XCAR (timers
);
4216 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4218 ASET (timer
, 0, Qnil
);
4222 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4225 timer_stop_idle (void)
4227 timer_idleness_start_time
= invalid_emacs_time ();
4230 /* Resume idle timer from last idle start time. */
4233 timer_resume_idle (void)
4235 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4238 timer_idleness_start_time
= timer_last_idleness_start_time
;
4241 /* This is only for debugging. */
4242 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4244 /* List of elisp functions to call, delayed because they were generated in
4245 a context where Elisp could not be safely run (e.g. redisplay, signal,
4246 ...). Each element has the form (FUN . ARGS). */
4247 Lisp_Object pending_funcalls
;
4249 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4251 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4253 Lisp_Object
*vector
;
4255 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4257 vector
= XVECTOR (timer
)->contents
;
4258 if (! NILP (vector
[0]))
4261 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4266 /* Check whether a timer has fired. To prevent larger problems we simply
4267 disregard elements that are not proper timers. Do not make a circular
4268 timer list for the time being.
4270 Returns the time to wait until the next timer fires. If a
4271 timer is triggering now, return zero.
4272 If no timer is active, return -1.
4274 If a timer is ripe, we run it, with quitting turned off.
4275 In that case we return 0 to indicate that a new timer_check_2 call
4279 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4281 EMACS_TIME nexttime
;
4283 EMACS_TIME idleness_now
;
4284 Lisp_Object chosen_timer
;
4285 struct gcpro gcpro1
;
4287 nexttime
= invalid_emacs_time ();
4289 chosen_timer
= Qnil
;
4290 GCPRO1 (chosen_timer
);
4292 /* First run the code that was delayed. */
4293 while (CONSP (pending_funcalls
))
4295 Lisp_Object funcall
= XCAR (pending_funcalls
);
4296 pending_funcalls
= XCDR (pending_funcalls
);
4297 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4300 if (CONSP (timers
) || CONSP (idle_timers
))
4302 now
= current_emacs_time ();
4303 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4304 ? sub_emacs_time (now
, timer_idleness_start_time
)
4305 : make_emacs_time (0, 0));
4308 while (CONSP (timers
) || CONSP (idle_timers
))
4310 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4311 EMACS_TIME timer_time
, idle_timer_time
;
4312 EMACS_TIME difference
;
4313 EMACS_TIME timer_difference
= invalid_emacs_time ();
4314 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4315 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4317 /* Set TIMER and TIMER_DIFFERENCE
4318 based on the next ordinary timer.
4319 TIMER_DIFFERENCE is the distance in time from NOW to when
4320 this timer becomes ripe (negative if it's already ripe).
4321 Skip past invalid timers and timers already handled. */
4324 timer
= XCAR (timers
);
4325 if (! decode_timer (timer
, &timer_time
))
4327 timers
= XCDR (timers
);
4331 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4332 timer_difference
= (timer_ripe
4333 ? sub_emacs_time (now
, timer_time
)
4334 : sub_emacs_time (timer_time
, now
));
4337 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4338 based on the next idle timer. */
4339 if (CONSP (idle_timers
))
4341 idle_timer
= XCAR (idle_timers
);
4342 if (! decode_timer (idle_timer
, &idle_timer_time
))
4344 idle_timers
= XCDR (idle_timers
);
4348 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4349 idle_timer_difference
=
4351 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4352 : sub_emacs_time (idle_timer_time
, idleness_now
));
4355 /* Decide which timer is the next timer,
4356 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4357 Also step down the list where we found that timer. */
4359 if (EMACS_TIME_VALID_P (timer_difference
)
4360 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4361 || idle_timer_ripe
< timer_ripe
4362 || (idle_timer_ripe
== timer_ripe
4364 ? EMACS_TIME_LT (idle_timer_difference
,
4366 : EMACS_TIME_LT (timer_difference
,
4367 idle_timer_difference
)))))
4369 chosen_timer
= timer
;
4370 timers
= XCDR (timers
);
4371 difference
= timer_difference
;
4376 chosen_timer
= idle_timer
;
4377 idle_timers
= XCDR (idle_timers
);
4378 difference
= idle_timer_difference
;
4379 ripe
= idle_timer_ripe
;
4382 /* If timer is ripe, run it if it hasn't been run. */
4385 if (NILP (AREF (chosen_timer
, 0)))
4387 ptrdiff_t count
= SPECPDL_INDEX ();
4388 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4390 /* Mark the timer as triggered to prevent problems if the lisp
4391 code fails to reschedule it right. */
4392 ASET (chosen_timer
, 0, Qt
);
4394 specbind (Qinhibit_quit
, Qt
);
4396 call1 (Qtimer_event_handler
, chosen_timer
);
4397 Vdeactivate_mark
= old_deactivate_mark
;
4399 unbind_to (count
, Qnil
);
4401 /* Since we have handled the event,
4402 we don't need to tell the caller to wake up and do it. */
4403 /* But the caller must still wait for the next timer, so
4404 return 0 to indicate that. */
4407 nexttime
= make_emacs_time (0, 0);
4411 /* When we encounter a timer that is still waiting,
4412 return the amount of time to wait before it is ripe. */
4419 /* No timers are pending in the future. */
4420 /* Return 0 if we generated an event, and -1 if not. */
4426 /* Check whether a timer has fired. To prevent larger problems we simply
4427 disregard elements that are not proper timers. Do not make a circular
4428 timer list for the time being.
4430 Returns the time to wait until the next timer fires.
4431 If no timer is active, return an invalid value.
4433 As long as any timer is ripe, we run it. */
4438 EMACS_TIME nexttime
;
4439 Lisp_Object timers
, idle_timers
;
4440 struct gcpro gcpro1
, gcpro2
;
4442 Lisp_Object tem
= Vinhibit_quit
;
4445 /* We use copies of the timers' lists to allow a timer to add itself
4446 again, without locking up Emacs if the newly added timer is
4447 already ripe when added. */
4449 /* Always consider the ordinary timers. */
4450 timers
= Fcopy_sequence (Vtimer_list
);
4451 /* Consider the idle timers only if Emacs is idle. */
4452 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4453 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4457 Vinhibit_quit
= tem
;
4459 GCPRO2 (timers
, idle_timers
);
4463 nexttime
= timer_check_2 (timers
, idle_timers
);
4465 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4471 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4472 doc
: /* Return the current length of Emacs idleness, or nil.
4473 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4474 in the same style as (current-time).
4476 The value when Emacs is not idle is nil.
4478 PSEC is a multiple of the system clock resolution. */)
4481 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4482 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4483 timer_idleness_start_time
));
4488 /* Caches for modify_event_symbol. */
4489 static Lisp_Object accent_key_syms
;
4490 static Lisp_Object func_key_syms
;
4491 static Lisp_Object mouse_syms
;
4492 static Lisp_Object wheel_syms
;
4493 static Lisp_Object drag_n_drop_syms
;
4495 /* This is a list of keysym codes for special "accent" characters.
4496 It parallels lispy_accent_keys. */
4498 static const int lispy_accent_codes
[] =
4500 #ifdef XK_dead_circumflex
4505 #ifdef XK_dead_grave
4510 #ifdef XK_dead_tilde
4515 #ifdef XK_dead_diaeresis
4520 #ifdef XK_dead_macron
4525 #ifdef XK_dead_degree
4530 #ifdef XK_dead_acute
4535 #ifdef XK_dead_cedilla
4540 #ifdef XK_dead_breve
4545 #ifdef XK_dead_ogonek
4550 #ifdef XK_dead_caron
4555 #ifdef XK_dead_doubleacute
4556 XK_dead_doubleacute
,
4560 #ifdef XK_dead_abovedot
4565 #ifdef XK_dead_abovering
4575 #ifdef XK_dead_belowdot
4580 #ifdef XK_dead_voiced_sound
4581 XK_dead_voiced_sound
,
4585 #ifdef XK_dead_semivoiced_sound
4586 XK_dead_semivoiced_sound
,
4602 /* This is a list of Lisp names for special "accent" characters.
4603 It parallels lispy_accent_codes. */
4605 static const char *const lispy_accent_keys
[] =
4623 "dead-voiced-sound",
4624 "dead-semivoiced-sound",
4630 #define FUNCTION_KEY_OFFSET 0x0
4632 const char *const lispy_function_keys
[] =
4636 0, /* VK_LBUTTON 0x01 */
4637 0, /* VK_RBUTTON 0x02 */
4638 "cancel", /* VK_CANCEL 0x03 */
4639 0, /* VK_MBUTTON 0x04 */
4641 0, 0, 0, /* 0x05 .. 0x07 */
4643 "backspace", /* VK_BACK 0x08 */
4644 "tab", /* VK_TAB 0x09 */
4646 0, 0, /* 0x0A .. 0x0B */
4648 "clear", /* VK_CLEAR 0x0C */
4649 "return", /* VK_RETURN 0x0D */
4651 0, 0, /* 0x0E .. 0x0F */
4653 0, /* VK_SHIFT 0x10 */
4654 0, /* VK_CONTROL 0x11 */
4655 0, /* VK_MENU 0x12 */
4656 "pause", /* VK_PAUSE 0x13 */
4657 "capslock", /* VK_CAPITAL 0x14 */
4658 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4660 "junja", /* VK_JUNJA 0x17 */
4661 "final", /* VK_FINAL 0x18 */
4662 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4664 "escape", /* VK_ESCAPE 0x1B */
4665 "convert", /* VK_CONVERT 0x1C */
4666 "non-convert", /* VK_NONCONVERT 0x1D */
4667 "accept", /* VK_ACCEPT 0x1E */
4668 "mode-change", /* VK_MODECHANGE 0x1F */
4669 0, /* VK_SPACE 0x20 */
4670 "prior", /* VK_PRIOR 0x21 */
4671 "next", /* VK_NEXT 0x22 */
4672 "end", /* VK_END 0x23 */
4673 "home", /* VK_HOME 0x24 */
4674 "left", /* VK_LEFT 0x25 */
4675 "up", /* VK_UP 0x26 */
4676 "right", /* VK_RIGHT 0x27 */
4677 "down", /* VK_DOWN 0x28 */
4678 "select", /* VK_SELECT 0x29 */
4679 "print", /* VK_PRINT 0x2A */
4680 "execute", /* VK_EXECUTE 0x2B */
4681 "snapshot", /* VK_SNAPSHOT 0x2C */
4682 "insert", /* VK_INSERT 0x2D */
4683 "delete", /* VK_DELETE 0x2E */
4684 "help", /* VK_HELP 0x2F */
4686 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4688 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4690 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4692 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4694 0, 0, 0, 0, 0, 0, 0, 0, 0,
4695 0, 0, 0, 0, 0, 0, 0, 0, 0,
4696 0, 0, 0, 0, 0, 0, 0, 0,
4698 "lwindow", /* VK_LWIN 0x5B */
4699 "rwindow", /* VK_RWIN 0x5C */
4700 "apps", /* VK_APPS 0x5D */
4703 "kp-0", /* VK_NUMPAD0 0x60 */
4704 "kp-1", /* VK_NUMPAD1 0x61 */
4705 "kp-2", /* VK_NUMPAD2 0x62 */
4706 "kp-3", /* VK_NUMPAD3 0x63 */
4707 "kp-4", /* VK_NUMPAD4 0x64 */
4708 "kp-5", /* VK_NUMPAD5 0x65 */
4709 "kp-6", /* VK_NUMPAD6 0x66 */
4710 "kp-7", /* VK_NUMPAD7 0x67 */
4711 "kp-8", /* VK_NUMPAD8 0x68 */
4712 "kp-9", /* VK_NUMPAD9 0x69 */
4713 "kp-multiply", /* VK_MULTIPLY 0x6A */
4714 "kp-add", /* VK_ADD 0x6B */
4715 "kp-separator", /* VK_SEPARATOR 0x6C */
4716 "kp-subtract", /* VK_SUBTRACT 0x6D */
4717 "kp-decimal", /* VK_DECIMAL 0x6E */
4718 "kp-divide", /* VK_DIVIDE 0x6F */
4719 "f1", /* VK_F1 0x70 */
4720 "f2", /* VK_F2 0x71 */
4721 "f3", /* VK_F3 0x72 */
4722 "f4", /* VK_F4 0x73 */
4723 "f5", /* VK_F5 0x74 */
4724 "f6", /* VK_F6 0x75 */
4725 "f7", /* VK_F7 0x76 */
4726 "f8", /* VK_F8 0x77 */
4727 "f9", /* VK_F9 0x78 */
4728 "f10", /* VK_F10 0x79 */
4729 "f11", /* VK_F11 0x7A */
4730 "f12", /* VK_F12 0x7B */
4731 "f13", /* VK_F13 0x7C */
4732 "f14", /* VK_F14 0x7D */
4733 "f15", /* VK_F15 0x7E */
4734 "f16", /* VK_F16 0x7F */
4735 "f17", /* VK_F17 0x80 */
4736 "f18", /* VK_F18 0x81 */
4737 "f19", /* VK_F19 0x82 */
4738 "f20", /* VK_F20 0x83 */
4739 "f21", /* VK_F21 0x84 */
4740 "f22", /* VK_F22 0x85 */
4741 "f23", /* VK_F23 0x86 */
4742 "f24", /* VK_F24 0x87 */
4744 0, 0, 0, 0, /* 0x88 .. 0x8B */
4745 0, 0, 0, 0, /* 0x8C .. 0x8F */
4747 "kp-numlock", /* VK_NUMLOCK 0x90 */
4748 "scroll", /* VK_SCROLL 0x91 */
4749 /* Not sure where the following block comes from.
4750 Windows headers have NEC and Fujitsu specific keys in
4751 this block, but nothing generic. */
4752 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4753 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4754 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4755 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4756 "kp-end", /* VK_NUMPAD_END 0x96 */
4757 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4758 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4759 "kp-up", /* VK_NUMPAD_UP 0x99 */
4760 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4761 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4762 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4763 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4765 0, 0, /* 0x9E .. 0x9F */
4768 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4769 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4770 * No other API or message will distinguish left and right keys this way.
4775 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4776 to enable them selectively, and gives access to a few more functions.
4777 See lispy_multimedia_keys below. */
4778 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4779 0, 0, 0, /* 0xAD .. 0xAF Volume */
4780 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4781 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4783 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4784 0, 0, 0, 0, 0, 0, 0, 0, 0,
4786 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4787 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4788 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4791 "ax", /* VK_OEM_AX 0xE1 */
4792 0, /* VK_OEM_102 0xE2 */
4793 "ico-help", /* VK_ICO_HELP 0xE3 */
4794 "ico-00", /* VK_ICO_00 0xE4 */
4795 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4796 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4797 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4799 "reset", /* VK_OEM_RESET 0xE9 */
4800 "jump", /* VK_OEM_JUMP 0xEA */
4801 "oem-pa1", /* VK_OEM_PA1 0xEB */
4802 "oem-pa2", /* VK_OEM_PA2 0xEC */
4803 "oem-pa3", /* VK_OEM_PA3 0xED */
4804 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4805 "cusel", /* VK_OEM_CUSEL 0xEF */
4806 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4807 "finish", /* VK_OEM_FINISH 0xF1 */
4808 "copy", /* VK_OEM_COPY 0xF2 */
4809 "auto", /* VK_OEM_AUTO 0xF3 */
4810 "enlw", /* VK_OEM_ENLW 0xF4 */
4811 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4812 "attn", /* VK_ATTN 0xF6 */
4813 "crsel", /* VK_CRSEL 0xF7 */
4814 "exsel", /* VK_EXSEL 0xF8 */
4815 "ereof", /* VK_EREOF 0xF9 */
4816 "play", /* VK_PLAY 0xFA */
4817 "zoom", /* VK_ZOOM 0xFB */
4818 "noname", /* VK_NONAME 0xFC */
4819 "pa1", /* VK_PA1 0xFD */
4820 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4824 /* Some of these duplicate the "Media keys" on newer keyboards,
4825 but they are delivered to the application in a different way. */
4826 static const char *const lispy_multimedia_keys
[] =
4834 "browser-favorites",
4871 "toggle-dictate-command",
4877 "media-fast-forward",
4880 "media-channel-down"
4883 #else /* not HAVE_NTGUI */
4885 /* This should be dealt with in XTread_socket now, and that doesn't
4886 depend on the client system having the Kana syms defined. See also
4887 the XK_kana_A case below. */
4890 static const char *const lispy_kana_keys
[] =
4892 /* X Keysym value */
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4894 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4895 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4896 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4903 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4904 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4905 "kana-i", "kana-u", "kana-e", "kana-o",
4906 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4907 "prolongedsound", "kana-A", "kana-I", "kana-U",
4908 "kana-E", "kana-O", "kana-KA", "kana-KI",
4909 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4910 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4911 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4912 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4913 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4914 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4915 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4916 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4917 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4918 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4919 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4920 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4922 #endif /* XK_kana_A */
4925 #define FUNCTION_KEY_OFFSET 0xff00
4927 /* You'll notice that this table is arranged to be conveniently
4928 indexed by X Windows keysym values. */
4929 static const char *const lispy_function_keys
[] =
4931 /* X Keysym value */
4933 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4934 "backspace", "tab", "linefeed", "clear",
4936 0, 0, 0, "pause", /* 0xff10...1f */
4937 0, 0, 0, 0, 0, 0, 0, "escape",
4939 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4940 "romaji", "hiragana", "katakana", "hiragana-katakana",
4941 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4942 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4943 "eisu-toggle", /* 0xff30...3f */
4944 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4945 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4947 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4948 "down", "prior", "next", "end",
4949 "begin", 0, 0, 0, 0, 0, 0, 0,
4950 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4961 "break", /* 0xff6b */
4964 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4965 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4966 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4967 0, 0, 0, 0, 0, 0, 0, 0,
4968 "kp-tab", /* 0xff89 */
4970 "kp-enter", /* 0xff8d */
4972 "kp-f1", /* 0xff91 */
4976 "kp-home", /* 0xff95 */
4981 "kp-prior", /* kp-page-up */
4982 "kp-next", /* kp-page-down */
4988 0, 0, 0, 0, 0, 0, 0, 0, 0,
4989 "kp-multiply", /* 0xffaa */
4994 "kp-divide", /* 0xffaf */
4995 "kp-0", /* 0xffb0 */
4996 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4999 "kp-equal", /* 0xffbd */
5000 "f1", /* 0xffbe */ /* IsFunctionKey */
5002 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5003 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5004 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5005 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5006 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5007 0, 0, 0, 0, 0, 0, 0, 0,
5008 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5009 0, 0, 0, 0, 0, 0, 0, "delete"
5012 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5013 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5015 static const char *const iso_lispy_function_keys
[] =
5017 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5018 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5019 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5020 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5021 "iso-lefttab", /* 0xfe20 */
5022 "iso-move-line-up", "iso-move-line-down",
5023 "iso-partial-line-up", "iso-partial-line-down",
5024 "iso-partial-space-left", "iso-partial-space-right",
5025 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5026 "iso-release-margin-left", "iso-release-margin-right",
5027 "iso-release-both-margins",
5028 "iso-fast-cursor-left", "iso-fast-cursor-right",
5029 "iso-fast-cursor-up", "iso-fast-cursor-down",
5030 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5031 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5034 #endif /* not HAVE_NTGUI */
5036 static Lisp_Object Vlispy_mouse_stem
;
5038 static const char *const lispy_wheel_names
[] =
5040 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5043 /* drag-n-drop events are generated when a set of selected files are
5044 dragged from another application and dropped onto an Emacs window. */
5045 static const char *const lispy_drag_n_drop_names
[] =
5050 /* Scroll bar parts. */
5051 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5052 Lisp_Object Qup
, Qdown
, Qbottom
;
5053 static Lisp_Object Qend_scroll
;
5055 static Lisp_Object Qratio
;
5057 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5058 static Lisp_Object
*const scroll_bar_parts
[] = {
5059 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5060 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5063 /* A vector, indexed by button number, giving the down-going location
5064 of currently depressed buttons, both scroll bar and non-scroll bar.
5066 The elements have the form
5067 (BUTTON-NUMBER MODIFIER-MASK . REST)
5068 where REST is the cdr of a position as it would be reported in the event.
5070 The make_lispy_event function stores positions here to tell the
5071 difference between click and drag events, and to store the starting
5072 location to be included in drag events. */
5074 static Lisp_Object button_down_location
;
5076 /* Information about the most recent up-going button event: Which
5077 button, what location, and what time. */
5079 static int last_mouse_button
;
5080 static int last_mouse_x
;
5081 static int last_mouse_y
;
5082 static Time button_down_time
;
5084 /* The number of clicks in this multiple-click. */
5086 static int double_click_count
;
5088 /* X and Y are frame-relative coordinates for a click or wheel event.
5089 Return a Lisp-style event list. */
5092 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5095 enum window_part part
;
5096 Lisp_Object posn
= Qnil
;
5097 Lisp_Object extra_info
= Qnil
;
5098 /* Coordinate pixel positions to return. */
5099 int xret
= 0, yret
= 0;
5100 /* The window under frame pixel coordinates (x,y) */
5101 Lisp_Object window
= f
5102 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5105 if (WINDOWP (window
))
5107 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5108 struct window
*w
= XWINDOW (window
);
5109 Lisp_Object string_info
= Qnil
;
5110 ptrdiff_t textpos
= -1;
5111 int col
= -1, row
= -1;
5112 int dx
= -1, dy
= -1;
5113 int width
= -1, height
= -1;
5114 Lisp_Object object
= Qnil
;
5116 /* Pixel coordinates relative to the window corner. */
5117 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5118 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5120 /* For text area clicks, return X, Y relative to the corner of
5121 this text area. Note that dX, dY etc are set below, by
5122 buffer_posn_from_coords. */
5123 if (part
== ON_TEXT
)
5125 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5126 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5128 /* For mode line and header line clicks, return X, Y relative to
5129 the left window edge. Use mode_line_string to look for a
5130 string on the click position. */
5131 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5136 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5137 /* Note that mode_line_string takes COL, ROW as pixels and
5138 converts them to characters. */
5141 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5142 &object
, &dx
, &dy
, &width
, &height
);
5143 if (STRINGP (string
))
5144 string_info
= Fcons (string
, make_number (charpos
));
5145 textpos
= (w
== XWINDOW (selected_window
)
5146 && current_buffer
== XBUFFER (w
->buffer
))
5147 ? PT
: XMARKER (w
->pointm
)->charpos
;
5152 /* For fringes and margins, Y is relative to the area's (and the
5153 window's) top edge, while X is meaningless. */
5154 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5159 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5162 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5163 &object
, &dx
, &dy
, &width
, &height
);
5164 if (STRINGP (string
))
5165 string_info
= Fcons (string
, make_number (charpos
));
5166 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5168 else if (part
== ON_LEFT_FRINGE
)
5170 posn
= Qleft_fringe
;
5173 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5174 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5175 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5177 else if (part
== ON_RIGHT_FRINGE
)
5179 posn
= Qright_fringe
;
5182 - window_box_width (w
, LEFT_MARGIN_AREA
)
5183 - window_box_width (w
, TEXT_AREA
)
5184 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5185 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5187 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5189 else if (part
== ON_VERTICAL_BORDER
)
5191 posn
= Qvertical_line
;
5196 /* Nothing special for part == ON_SCROLL_BAR. */
5198 /* For clicks in the text area, fringes, or margins, call
5199 buffer_posn_from_coords to extract TEXTPOS, the buffer
5200 position nearest to the click. */
5203 Lisp_Object string2
, object2
= Qnil
;
5204 struct display_pos p
;
5206 int width2
, height2
;
5207 /* The pixel X coordinate passed to buffer_posn_from_coords
5208 is the X coordinate relative to the text area for
5209 text-area and right-margin clicks, zero otherwise. */
5211 = (part
== ON_TEXT
) ? xret
5212 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5213 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5217 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5218 &object2
, &dx2
, &dy2
,
5220 textpos
= CHARPOS (p
.pos
);
5221 if (col
< 0) col
= x2
;
5222 if (row
< 0) row
= y2
;
5223 if (dx
< 0) dx
= dx2
;
5224 if (dy
< 0) dy
= dy2
;
5225 if (width
< 0) width
= width2
;
5226 if (height
< 0) height
= height2
;
5230 posn
= make_number (textpos
);
5231 if (STRINGP (string2
))
5232 string_info
= Fcons (string2
,
5233 make_number (CHARPOS (p
.string_pos
)));
5239 #ifdef HAVE_WINDOW_SYSTEM
5240 if (IMAGEP (object
))
5242 Lisp_Object image_map
, hotspot
;
5243 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5245 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5247 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5248 posn
= XCAR (hotspot
);
5255 Fcons (make_number (dx
), make_number (dy
)),
5256 Fcons (make_number (width
), make_number (height
)));
5259 extra_info
= Fcons (string_info
,
5260 Fcons (make_number (textpos
),
5261 Fcons (Fcons (make_number (col
),
5266 XSETFRAME (window
, f
);
5270 return Fcons (window
,
5272 Fcons (Fcons (make_number (xret
),
5273 make_number (yret
)),
5274 Fcons (make_number (t
),
5278 /* Given a struct input_event, build the lisp event which represents
5279 it. If EVENT is 0, build a mouse movement event from the mouse
5280 movement buffer, which should have a movement event in it.
5282 Note that events must be passed to this function in the order they
5283 are received; this function stores the location of button presses
5284 in order to build drag events when the button is released. */
5287 make_lispy_event (struct input_event
*event
)
5291 switch (event
->kind
)
5293 /* A simple keystroke. */
5294 case ASCII_KEYSTROKE_EVENT
:
5295 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5297 Lisp_Object lispy_c
;
5298 EMACS_INT c
= event
->code
;
5299 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5302 eassert (c
== event
->code
);
5303 /* Turn ASCII characters into control characters
5305 if (event
->modifiers
& ctrl_modifier
)
5307 c
= make_ctrl_char (c
);
5308 event
->modifiers
&= ~ctrl_modifier
;
5312 /* Add in the other modifier bits. The shift key was taken care
5313 of by the X code. */
5314 c
|= (event
->modifiers
5315 & (meta_modifier
| alt_modifier
5316 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5317 /* Distinguish Shift-SPC from SPC. */
5318 if ((event
->code
) == 040
5319 && event
->modifiers
& shift_modifier
)
5320 c
|= shift_modifier
;
5321 button_down_time
= 0;
5322 XSETFASTINT (lispy_c
, c
);
5327 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5328 except that they are non-key events (last-nonmenu-event is nil). */
5329 case NS_NONKEY_EVENT
:
5332 /* A function key. The symbol may need to have modifier prefixes
5334 case NON_ASCII_KEYSTROKE_EVENT
:
5335 button_down_time
= 0;
5337 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5338 if (event
->code
== lispy_accent_codes
[i
])
5339 return modify_event_symbol (i
,
5341 Qfunction_key
, Qnil
,
5342 lispy_accent_keys
, &accent_key_syms
,
5343 (sizeof (lispy_accent_keys
)
5344 / sizeof (lispy_accent_keys
[0])));
5348 if (event
->code
>= 0x400 && event
->code
< 0x500)
5349 return modify_event_symbol (event
->code
- 0x400,
5350 event
->modifiers
& ~shift_modifier
,
5351 Qfunction_key
, Qnil
,
5352 lispy_kana_keys
, &func_key_syms
,
5353 (sizeof (lispy_kana_keys
)
5354 / sizeof (lispy_kana_keys
[0])));
5355 #endif /* XK_kana_A */
5358 #ifdef ISO_FUNCTION_KEY_OFFSET
5359 if (event
->code
< FUNCTION_KEY_OFFSET
5360 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5361 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5363 Qfunction_key
, Qnil
,
5364 iso_lispy_function_keys
, &func_key_syms
,
5365 (sizeof (iso_lispy_function_keys
)
5366 / sizeof (iso_lispy_function_keys
[0])));
5369 /* Handle system-specific or unknown keysyms. */
5370 if (event
->code
& (1 << 28)
5371 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5372 || (event
->code
- FUNCTION_KEY_OFFSET
5373 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5374 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5376 /* We need to use an alist rather than a vector as the cache
5377 since we can't make a vector long enough. */
5378 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5379 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5380 return modify_event_symbol (event
->code
,
5383 KVAR (current_kboard
, Vsystem_key_alist
),
5384 0, &KVAR (current_kboard
, system_key_syms
),
5388 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5390 Qfunction_key
, Qnil
,
5391 lispy_function_keys
, &func_key_syms
,
5392 (sizeof (lispy_function_keys
)
5393 / sizeof (lispy_function_keys
[0])));
5396 case MULTIMEDIA_KEY_EVENT
:
5397 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5398 / sizeof (lispy_multimedia_keys
[0]))
5399 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5401 return modify_event_symbol (event
->code
, event
->modifiers
,
5402 Qfunction_key
, Qnil
,
5403 lispy_multimedia_keys
, &func_key_syms
,
5404 (sizeof (lispy_multimedia_keys
)
5405 / sizeof (lispy_multimedia_keys
[0])));
5411 /* A mouse click. Figure out where it is, decide whether it's
5412 a press, click or drag, and build the appropriate structure. */
5413 case MOUSE_CLICK_EVENT
:
5414 #ifndef USE_TOOLKIT_SCROLL_BARS
5415 case SCROLL_BAR_CLICK_EVENT
:
5418 int button
= event
->code
;
5420 Lisp_Object position
;
5421 Lisp_Object
*start_pos_ptr
;
5422 Lisp_Object start_pos
;
5426 /* Build the position as appropriate for this mouse click. */
5427 if (event
->kind
== MOUSE_CLICK_EVENT
)
5429 struct frame
*f
= XFRAME (event
->frame_or_window
);
5430 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5434 /* Ignore mouse events that were made on frame that
5435 have been deleted. */
5436 if (! FRAME_LIVE_P (f
))
5439 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5440 /* EVENT->x and EVENT->y are frame-relative pixel
5441 coordinates at this place. Under old redisplay, COLUMN
5442 and ROW are set to frame relative glyph coordinates
5443 which are then used to determine whether this click is
5444 in a menu (non-toolkit version). */
5445 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5446 &column
, &row
, NULL
, 1);
5448 /* In the non-toolkit version, clicks on the menu bar
5449 are ordinary button events in the event buffer.
5450 Distinguish them, and invoke the menu.
5452 (In the toolkit version, the toolkit handles the menu bar
5453 and Emacs doesn't know about it until after the user
5454 makes a selection.) */
5455 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5456 && (event
->modifiers
& down_modifier
))
5458 Lisp_Object items
, item
;
5460 /* Find the menu bar item under `column'. */
5462 items
= FRAME_MENU_BAR_ITEMS (f
);
5463 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5465 Lisp_Object pos
, string
;
5466 string
= AREF (items
, i
+ 1);
5467 pos
= AREF (items
, i
+ 3);
5470 if (column
>= XINT (pos
)
5471 && column
< XINT (pos
) + SCHARS (string
))
5473 item
= AREF (items
, i
);
5478 /* ELisp manual 2.4b says (x y) are window relative but
5479 code says they are frame-relative. */
5481 = Fcons (event
->frame_or_window
,
5483 Fcons (Fcons (event
->x
, event
->y
),
5484 Fcons (make_number (event
->timestamp
),
5487 return Fcons (item
, Fcons (position
, Qnil
));
5489 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5491 position
= make_lispy_position (f
, event
->x
, event
->y
,
5494 #ifndef USE_TOOLKIT_SCROLL_BARS
5497 /* It's a scrollbar click. */
5499 Lisp_Object portion_whole
;
5502 window
= event
->frame_or_window
;
5503 portion_whole
= Fcons (event
->x
, event
->y
);
5504 part
= *scroll_bar_parts
[(int) event
->part
];
5508 Fcons (Qvertical_scroll_bar
,
5509 Fcons (portion_whole
,
5510 Fcons (make_number (event
->timestamp
),
5511 Fcons (part
, Qnil
)))));
5513 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5515 if (button
>= ASIZE (button_down_location
))
5517 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5518 button_down_location
= larger_vector (button_down_location
,
5520 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5523 start_pos_ptr
= aref_addr (button_down_location
, button
);
5524 start_pos
= *start_pos_ptr
;
5525 *start_pos_ptr
= Qnil
;
5528 /* On window-system frames, use the value of
5529 double-click-fuzz as is. On other frames, interpret it
5530 as a multiple of 1/8 characters. */
5534 if (WINDOWP (event
->frame_or_window
))
5535 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5536 else if (FRAMEP (event
->frame_or_window
))
5537 f
= XFRAME (event
->frame_or_window
);
5541 if (FRAME_WINDOW_P (f
))
5542 fuzz
= double_click_fuzz
;
5544 fuzz
= double_click_fuzz
/ 8;
5546 is_double
= (button
== last_mouse_button
5547 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5548 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5549 && button_down_time
!= 0
5550 && (EQ (Vdouble_click_time
, Qt
)
5551 || (NATNUMP (Vdouble_click_time
)
5552 && (event
->timestamp
- button_down_time
5553 < XFASTINT (Vdouble_click_time
)))));
5556 last_mouse_button
= button
;
5557 last_mouse_x
= XINT (event
->x
);
5558 last_mouse_y
= XINT (event
->y
);
5560 /* If this is a button press, squirrel away the location, so
5561 we can decide later whether it was a click or a drag. */
5562 if (event
->modifiers
& down_modifier
)
5566 double_click_count
++;
5567 event
->modifiers
|= ((double_click_count
> 2)
5572 double_click_count
= 1;
5573 button_down_time
= event
->timestamp
;
5574 *start_pos_ptr
= Fcopy_alist (position
);
5575 ignore_mouse_drag_p
= 0;
5578 /* Now we're releasing a button - check the co-ordinates to
5579 see if this was a click or a drag. */
5580 else if (event
->modifiers
& up_modifier
)
5582 /* If we did not see a down before this up, ignore the up.
5583 Probably this happened because the down event chose a
5584 menu item. It would be an annoyance to treat the
5585 release of the button that chose the menu item as a
5588 if (!CONSP (start_pos
))
5591 event
->modifiers
&= ~up_modifier
;
5594 Lisp_Object new_down
, down
;
5595 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5597 /* The third element of every position
5598 should be the (x,y) pair. */
5599 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5600 new_down
= Fcar (Fcdr (Fcdr (position
)));
5603 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5605 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5606 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5609 if (ignore_mouse_drag_p
)
5611 event
->modifiers
|= click_modifier
;
5612 ignore_mouse_drag_p
= 0;
5614 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5615 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5616 /* Maybe the mouse has moved a lot, caused scrolling, and
5617 eventually ended up at the same screen position (but
5618 not buffer position) in which case it is a drag, not
5620 /* FIXME: OTOH if the buffer position has changed
5621 because of a timer or process filter rather than
5622 because of mouse movement, it should be considered as
5623 a click. But mouse-drag-region completely ignores
5624 this case and it hasn't caused any real problem, so
5625 it's probably OK to ignore it as well. */
5626 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5627 /* Mouse hasn't moved (much). */
5628 event
->modifiers
|= click_modifier
;
5631 button_down_time
= 0;
5632 event
->modifiers
|= drag_modifier
;
5635 /* Don't check is_double; treat this as multiple
5636 if the down-event was multiple. */
5637 if (double_click_count
> 1)
5638 event
->modifiers
|= ((double_click_count
> 2)
5644 /* Every mouse event should either have the down_modifier or
5645 the up_modifier set. */
5649 /* Get the symbol we should use for the mouse click. */
5652 head
= modify_event_symbol (button
,
5654 Qmouse_click
, Vlispy_mouse_stem
,
5657 ASIZE (mouse_syms
));
5658 if (event
->modifiers
& drag_modifier
)
5663 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5666 Fcons (make_number (double_click_count
),
5676 case HORIZ_WHEEL_EVENT
:
5678 Lisp_Object position
;
5681 /* Build the position as appropriate for this mouse click. */
5682 struct frame
*f
= XFRAME (event
->frame_or_window
);
5684 /* Ignore wheel events that were made on frame that have been
5686 if (! FRAME_LIVE_P (f
))
5689 position
= make_lispy_position (f
, event
->x
, event
->y
,
5692 /* Set double or triple modifiers to indicate the wheel speed. */
5694 /* On window-system frames, use the value of
5695 double-click-fuzz as is. On other frames, interpret it
5696 as a multiple of 1/8 characters. */
5702 if (WINDOWP (event
->frame_or_window
))
5703 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5704 else if (FRAMEP (event
->frame_or_window
))
5705 fr
= XFRAME (event
->frame_or_window
);
5709 fuzz
= FRAME_WINDOW_P (fr
)
5710 ? double_click_fuzz
: double_click_fuzz
/ 8;
5712 if (event
->modifiers
& up_modifier
)
5714 /* Emit a wheel-up event. */
5715 event
->modifiers
&= ~up_modifier
;
5718 else if (event
->modifiers
& down_modifier
)
5720 /* Emit a wheel-down event. */
5721 event
->modifiers
&= ~down_modifier
;
5725 /* Every wheel event should either have the down_modifier or
5726 the up_modifier set. */
5729 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5732 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5733 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5734 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5735 && button_down_time
!= 0
5736 && (EQ (Vdouble_click_time
, Qt
)
5737 || (NATNUMP (Vdouble_click_time
)
5738 && (event
->timestamp
- button_down_time
5739 < XFASTINT (Vdouble_click_time
)))));
5742 double_click_count
++;
5743 event
->modifiers
|= ((double_click_count
> 2)
5749 double_click_count
= 1;
5750 event
->modifiers
|= click_modifier
;
5753 button_down_time
= event
->timestamp
;
5754 /* Use a negative value to distinguish wheel from mouse button. */
5755 last_mouse_button
= - (1 + symbol_num
);
5756 last_mouse_x
= XINT (event
->x
);
5757 last_mouse_y
= XINT (event
->y
);
5759 /* Get the symbol we should use for the wheel event. */
5760 head
= modify_event_symbol (symbol_num
,
5766 ASIZE (wheel_syms
));
5769 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5772 Fcons (make_number (double_click_count
),
5781 #ifdef USE_TOOLKIT_SCROLL_BARS
5783 /* We don't have down and up events if using toolkit scroll bars,
5784 so make this always a click event. Store in the `part' of
5785 the Lisp event a symbol which maps to the following actions:
5787 `above_handle' page up
5788 `below_handle' page down
5792 `bottom' bottom of buffer
5793 `handle' thumb has been dragged.
5794 `end-scroll' end of interaction with scroll bar
5796 The incoming input_event contains in its `part' member an
5797 index of type `enum scroll_bar_part' which we can use as an
5798 index in scroll_bar_parts to get the appropriate symbol. */
5800 case SCROLL_BAR_CLICK_EVENT
:
5802 Lisp_Object position
, head
, window
, portion_whole
, part
;
5804 window
= event
->frame_or_window
;
5805 portion_whole
= Fcons (event
->x
, event
->y
);
5806 part
= *scroll_bar_parts
[(int) event
->part
];
5810 Fcons (Qvertical_scroll_bar
,
5811 Fcons (portion_whole
,
5812 Fcons (make_number (event
->timestamp
),
5813 Fcons (part
, Qnil
)))));
5815 /* Always treat scroll bar events as clicks. */
5816 event
->modifiers
|= click_modifier
;
5817 event
->modifiers
&= ~up_modifier
;
5819 if (event
->code
>= ASIZE (mouse_syms
))
5820 mouse_syms
= larger_vector (mouse_syms
,
5821 event
->code
- ASIZE (mouse_syms
) + 1,
5824 /* Get the symbol we should use for the mouse click. */
5825 head
= modify_event_symbol (event
->code
,
5830 ASIZE (mouse_syms
));
5831 return Fcons (head
, Fcons (position
, Qnil
));
5834 #endif /* USE_TOOLKIT_SCROLL_BARS */
5836 case DRAG_N_DROP_EVENT
:
5839 Lisp_Object head
, position
;
5842 f
= XFRAME (event
->frame_or_window
);
5845 /* Ignore mouse events that were made on frames that
5846 have been deleted. */
5847 if (! FRAME_LIVE_P (f
))
5850 position
= make_lispy_position (f
, event
->x
, event
->y
,
5853 head
= modify_event_symbol (0, event
->modifiers
,
5855 lispy_drag_n_drop_names
,
5856 &drag_n_drop_syms
, 1);
5862 #endif /* HAVE_MOUSE */
5864 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5865 || defined (HAVE_NS) || defined (USE_GTK)
5866 case MENU_BAR_EVENT
:
5867 if (EQ (event
->arg
, event
->frame_or_window
))
5868 /* This is the prefix key. We translate this to
5869 `(menu_bar)' because the code in keyboard.c for menu
5870 events, which we use, relies on this. */
5871 return Fcons (Qmenu_bar
, Qnil
);
5875 case SELECT_WINDOW_EVENT
:
5876 /* Make an event (select-window (WINDOW)). */
5877 return Fcons (Qselect_window
,
5878 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5881 case TOOL_BAR_EVENT
:
5882 if (EQ (event
->arg
, event
->frame_or_window
))
5883 /* This is the prefix key. We translate this to
5884 `(tool_bar)' because the code in keyboard.c for tool bar
5885 events, which we use, relies on this. */
5886 return Fcons (Qtool_bar
, Qnil
);
5887 else if (SYMBOLP (event
->arg
))
5888 return apply_modifiers (event
->modifiers
, event
->arg
);
5891 case USER_SIGNAL_EVENT
:
5892 /* A user signal. */
5894 char *name
= find_user_signal_name (event
->code
);
5897 return intern (name
);
5900 case SAVE_SESSION_EVENT
:
5901 return Qsave_session
;
5906 return Fcons (Qdbus_event
, event
->arg
);
5908 #endif /* HAVE_DBUS */
5909 #ifdef HAVE_XWIDGETS
5912 printf("cool, an xwidget event arrived in make_lispy_event!\n");
5913 return Fcons (Qxwidget_event
,event
->arg
);
5916 case CONFIG_CHANGED_EVENT
:
5917 return Fcons (Qconfig_changed_event
,
5919 Fcons (event
->frame_or_window
, Qnil
)));
5921 case GPM_CLICK_EVENT
:
5923 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5924 Lisp_Object head
, position
;
5925 Lisp_Object
*start_pos_ptr
;
5926 Lisp_Object start_pos
;
5927 int button
= event
->code
;
5929 if (button
>= ASIZE (button_down_location
))
5931 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5932 button_down_location
= larger_vector (button_down_location
,
5934 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5937 start_pos_ptr
= aref_addr (button_down_location
, button
);
5938 start_pos
= *start_pos_ptr
;
5940 position
= make_lispy_position (f
, event
->x
, event
->y
,
5943 if (event
->modifiers
& down_modifier
)
5944 *start_pos_ptr
= Fcopy_alist (position
);
5945 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5947 if (!CONSP (start_pos
))
5949 event
->modifiers
&= ~up_modifier
;
5952 head
= modify_event_symbol (button
,
5954 Qmouse_click
, Vlispy_mouse_stem
,
5957 ASIZE (mouse_syms
));
5959 if (event
->modifiers
& drag_modifier
)
5964 else if (event
->modifiers
& double_modifier
)
5967 Fcons (make_number (2),
5969 else if (event
->modifiers
& triple_modifier
)
5972 Fcons (make_number (3),
5979 #endif /* HAVE_GPM */
5981 /* The 'kind' field of the event is something we don't recognize. */
5987 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
5990 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5991 Lisp_Object x
, Lisp_Object y
, Time t
)
5993 /* Is it a scroll bar movement? */
5994 if (frame
&& ! NILP (bar_window
))
5996 Lisp_Object part_sym
;
5998 part_sym
= *scroll_bar_parts
[(int) part
];
5999 return Fcons (Qscroll_bar_movement
,
6000 Fcons (list5 (bar_window
,
6001 Qvertical_scroll_bar
,
6007 /* Or is it an ordinary mouse movement? */
6010 Lisp_Object position
;
6011 position
= make_lispy_position (frame
, x
, y
, t
);
6012 return list2 (Qmouse_movement
, position
);
6016 #endif /* HAVE_MOUSE || HAVE GPM */
6018 /* Construct a switch frame event. */
6020 make_lispy_switch_frame (Lisp_Object frame
)
6022 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6025 /* Manipulating modifiers. */
6027 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6029 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6030 SYMBOL's name of the end of the modifiers; the string from this
6031 position is the unmodified symbol name.
6033 This doesn't use any caches. */
6036 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6042 CHECK_SYMBOL (symbol
);
6045 name
= SYMBOL_NAME (symbol
);
6047 for (i
= 0; i
< SBYTES (name
) - 1; )
6049 ptrdiff_t this_mod_end
= 0;
6052 /* See if the name continues with a modifier word.
6053 Check that the word appears, but don't check what follows it.
6054 Set this_mod and this_mod_end to record what we find. */
6056 switch (SREF (name
, i
))
6058 #define SINGLE_LETTER_MOD(BIT) \
6059 (this_mod_end = i + 1, this_mod = BIT)
6062 SINGLE_LETTER_MOD (alt_modifier
);
6066 SINGLE_LETTER_MOD (ctrl_modifier
);
6070 SINGLE_LETTER_MOD (hyper_modifier
);
6074 SINGLE_LETTER_MOD (meta_modifier
);
6078 SINGLE_LETTER_MOD (shift_modifier
);
6082 SINGLE_LETTER_MOD (super_modifier
);
6085 #undef SINGLE_LETTER_MOD
6087 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6088 if (i + LEN + 1 <= SBYTES (name) \
6089 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6091 this_mod_end = i + LEN; \
6096 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6097 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6098 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6102 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6104 #undef MULTI_LETTER_MOD
6108 /* If we found no modifier, stop looking for them. */
6109 if (this_mod_end
== 0)
6112 /* Check there is a dash after the modifier, so that it
6113 really is a modifier. */
6114 if (this_mod_end
>= SBYTES (name
)
6115 || SREF (name
, this_mod_end
) != '-')
6118 /* This modifier is real; look for another. */
6119 modifiers
|= this_mod
;
6120 i
= this_mod_end
+ 1;
6123 /* Should we include the `click' modifier? */
6124 if (! (modifiers
& (down_modifier
| drag_modifier
6125 | double_modifier
| triple_modifier
))
6126 && i
+ 7 == SBYTES (name
)
6127 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6128 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6129 modifiers
|= click_modifier
;
6131 if (! (modifiers
& (double_modifier
| triple_modifier
))
6132 && i
+ 6 < SBYTES (name
)
6133 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6134 modifiers
|= click_modifier
;
6142 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6143 prepended to the string BASE[0..BASE_LEN-1].
6144 This doesn't use any caches. */
6146 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6148 /* Since BASE could contain nulls, we can't use intern here; we have
6149 to use Fintern, which expects a genuine Lisp_String, and keeps a
6151 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6157 /* Only the event queue may use the `up' modifier; it should always
6158 be turned into a click or drag event before presented to lisp code. */
6159 if (modifiers
& up_modifier
)
6162 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6163 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6164 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6165 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6166 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6167 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6168 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6169 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6170 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6171 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6172 /* The click modifier is denoted by the absence of other modifiers. */
6176 mod_len
= p
- new_mods
;
6180 Lisp_Object new_name
;
6182 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6183 mod_len
+ base_len_byte
);
6184 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6185 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6187 return Fintern (new_name
, Qnil
);
6192 static const char *const modifier_names
[] =
6194 "up", "down", "drag", "click", "double", "triple", 0, 0,
6195 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6196 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6198 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6200 static Lisp_Object modifier_symbols
;
6202 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6204 lispy_modifier_list (int modifiers
)
6206 Lisp_Object modifier_list
;
6209 modifier_list
= Qnil
;
6210 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6211 if (modifiers
& (1<<i
))
6212 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6215 return modifier_list
;
6219 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6220 where UNMODIFIED is the unmodified form of SYMBOL,
6221 MASK is the set of modifiers present in SYMBOL's name.
6222 This is similar to parse_modifiers_uncached, but uses the cache in
6223 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6224 Qevent_symbol_elements property. */
6226 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6229 parse_modifiers (Lisp_Object symbol
)
6231 Lisp_Object elements
;
6233 if (INTEGERP (symbol
))
6234 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6235 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6237 else if (!SYMBOLP (symbol
))
6240 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6241 if (CONSP (elements
))
6246 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6247 Lisp_Object unmodified
;
6250 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6251 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6254 if (modifiers
& ~INTMASK
)
6256 XSETFASTINT (mask
, modifiers
);
6257 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6259 /* Cache the parsing results on SYMBOL. */
6260 Fput (symbol
, Qevent_symbol_element_mask
,
6262 Fput (symbol
, Qevent_symbol_elements
,
6263 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6265 /* Since we know that SYMBOL is modifiers applied to unmodified,
6266 it would be nice to put that in unmodified's cache.
6267 But we can't, since we're not sure that parse_modifiers is
6274 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6275 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6276 doc
: /* Parse the event symbol. For internal use. */)
6277 (Lisp_Object symbol
)
6279 /* Fill the cache if needed. */
6280 parse_modifiers (symbol
);
6281 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6282 and use the Lispier representation stored on Qevent_symbol_elements
6284 return Fget (symbol
, Qevent_symbol_elements
);
6287 /* Apply the modifiers MODIFIERS to the symbol BASE.
6288 BASE must be unmodified.
6290 This is like apply_modifiers_uncached, but uses BASE's
6291 Qmodifier_cache property, if present. It also builds
6292 Qevent_symbol_elements properties, since it has that info anyway.
6294 apply_modifiers copies the value of BASE's Qevent_kind property to
6295 the modified symbol. */
6297 apply_modifiers (int modifiers
, Lisp_Object base
)
6299 Lisp_Object cache
, idx
, entry
, new_symbol
;
6301 /* Mask out upper bits. We don't know where this value's been. */
6302 modifiers
&= INTMASK
;
6304 if (INTEGERP (base
))
6305 return make_number (XINT (base
) | modifiers
);
6307 /* The click modifier never figures into cache indices. */
6308 cache
= Fget (base
, Qmodifier_cache
);
6309 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6310 entry
= assq_no_quit (idx
, cache
);
6313 new_symbol
= XCDR (entry
);
6316 /* We have to create the symbol ourselves. */
6317 new_symbol
= apply_modifiers_uncached (modifiers
,
6318 SSDATA (SYMBOL_NAME (base
)),
6319 SCHARS (SYMBOL_NAME (base
)),
6320 SBYTES (SYMBOL_NAME (base
)));
6322 /* Add the new symbol to the base's cache. */
6323 entry
= Fcons (idx
, new_symbol
);
6324 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6326 /* We have the parsing info now for free, so we could add it to
6328 XSETFASTINT (idx, modifiers);
6329 Fput (new_symbol, Qevent_symbol_element_mask,
6330 Fcons (base, Fcons (idx, Qnil)));
6331 Fput (new_symbol, Qevent_symbol_elements,
6332 Fcons (base, lispy_modifier_list (modifiers)));
6333 Sadly, this is only correct if `base' is indeed a base event,
6334 which is not necessarily the case. -stef */
6337 /* Make sure this symbol is of the same kind as BASE.
6339 You'd think we could just set this once and for all when we
6340 intern the symbol above, but reorder_modifiers may call us when
6341 BASE's property isn't set right; we can't assume that just
6342 because it has a Qmodifier_cache property it must have its
6343 Qevent_kind set right as well. */
6344 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6348 kind
= Fget (base
, Qevent_kind
);
6350 Fput (new_symbol
, Qevent_kind
, kind
);
6357 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6358 return a symbol with the modifiers placed in the canonical order.
6359 Canonical order is alphabetical, except for down and drag, which
6360 always come last. The 'click' modifier is never written out.
6362 Fdefine_key calls this to make sure that (for example) C-M-foo
6363 and M-C-foo end up being equivalent in the keymap. */
6366 reorder_modifiers (Lisp_Object symbol
)
6368 /* It's hopefully okay to write the code this way, since everything
6369 will soon be in caches, and no consing will be done at all. */
6372 parsed
= parse_modifiers (symbol
);
6373 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6378 /* For handling events, we often want to produce a symbol whose name
6379 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6380 to some base, like the name of a function key or mouse button.
6381 modify_event_symbol produces symbols of this sort.
6383 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6384 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6387 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6388 into symbol names, or a string specifying a name stem used to
6389 construct a symbol name or the form `STEM-N', where N is the decimal
6390 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6391 non-nil; otherwise NAME_TABLE is used.
6393 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6394 persist between calls to modify_event_symbol that it can use to
6395 store a cache of the symbols it's generated for this NAME_TABLE
6396 before. The object stored there may be a vector or an alist.
6398 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6400 MODIFIERS is a set of modifier bits (as given in struct input_events)
6401 whose prefixes should be applied to the symbol name.
6403 SYMBOL_KIND is the value to be placed in the event_kind property of
6404 the returned symbol.
6406 The symbols we create are supposed to have an
6407 `event-symbol-elements' property, which lists the modifiers present
6408 in the symbol's name. */
6411 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6412 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6413 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6416 Lisp_Object symbol_int
;
6418 /* Get rid of the "vendor-specific" bit here. */
6419 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6421 /* Is this a request for a valid symbol? */
6422 if (symbol_num
< 0 || symbol_num
>= table_size
)
6425 if (CONSP (*symbol_table
))
6426 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6428 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6429 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6430 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6431 we've never used that symbol before. */
6434 if (! VECTORP (*symbol_table
)
6435 || ASIZE (*symbol_table
) != table_size
)
6439 XSETFASTINT (size
, table_size
);
6440 *symbol_table
= Fmake_vector (size
, Qnil
);
6443 value
= AREF (*symbol_table
, symbol_num
);
6446 /* Have we already used this symbol before? */
6449 /* No; let's create it. */
6450 if (CONSP (name_alist_or_stem
))
6451 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6452 else if (STRINGP (name_alist_or_stem
))
6455 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6456 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6458 buf
= SAFE_ALLOCA (len
);
6459 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6460 XINT (symbol_int
) + 1);
6461 value
= intern (buf
);
6464 else if (name_table
!= 0 && name_table
[symbol_num
])
6465 value
= intern (name_table
[symbol_num
]);
6467 #ifdef HAVE_WINDOW_SYSTEM
6470 char *name
= x_get_keysym_name (symbol_num
);
6472 value
= intern (name
);
6478 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6479 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6480 value
= intern (buf
);
6483 if (CONSP (*symbol_table
))
6484 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6486 ASET (*symbol_table
, symbol_num
, value
);
6488 /* Fill in the cache entries for this symbol; this also
6489 builds the Qevent_symbol_elements property, which the user
6491 apply_modifiers (modifiers
& click_modifier
, value
);
6492 Fput (value
, Qevent_kind
, symbol_kind
);
6495 /* Apply modifiers to that symbol. */
6496 return apply_modifiers (modifiers
, value
);
6499 /* Convert a list that represents an event type,
6500 such as (ctrl meta backspace), into the usual representation of that
6501 event type as a number or a symbol. */
6503 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6504 doc
: /* Convert the event description list EVENT-DESC to an event type.
6505 EVENT-DESC should contain one base event type (a character or symbol)
6506 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6507 drag, down, double or triple). The base must be last.
6508 The return value is an event type (a character or symbol) which
6509 has the same base event type and all the specified modifiers. */)
6510 (Lisp_Object event_desc
)
6518 while (CONSP (rest
))
6526 /* Given a symbol, see if it is a modifier name. */
6527 if (SYMBOLP (elt
) && CONSP (rest
))
6528 this = parse_solitary_modifier (elt
);
6532 else if (!NILP (base
))
6533 error ("Two bases given in one event");
6539 /* Let the symbol A refer to the character A. */
6540 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6541 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6543 if (INTEGERP (base
))
6545 /* Turn (shift a) into A. */
6546 if ((modifiers
& shift_modifier
) != 0
6547 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6549 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6550 modifiers
&= ~shift_modifier
;
6553 /* Turn (control a) into C-a. */
6554 if (modifiers
& ctrl_modifier
)
6555 return make_number ((modifiers
& ~ctrl_modifier
)
6556 | make_ctrl_char (XINT (base
)));
6558 return make_number (modifiers
| XINT (base
));
6560 else if (SYMBOLP (base
))
6561 return apply_modifiers (modifiers
, base
);
6564 error ("Invalid base event");
6569 /* Try to recognize SYMBOL as a modifier name.
6570 Return the modifier flag bit, or 0 if not recognized. */
6573 parse_solitary_modifier (Lisp_Object symbol
)
6575 Lisp_Object name
= SYMBOL_NAME (symbol
);
6577 switch (SREF (name
, 0))
6579 #define SINGLE_LETTER_MOD(BIT) \
6580 if (SBYTES (name) == 1) \
6583 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6584 if (LEN == SBYTES (name) \
6585 && ! memcmp (SDATA (name), NAME, LEN)) \
6589 SINGLE_LETTER_MOD (alt_modifier
);
6593 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6597 SINGLE_LETTER_MOD (ctrl_modifier
);
6601 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6602 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6606 SINGLE_LETTER_MOD (hyper_modifier
);
6610 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6614 SINGLE_LETTER_MOD (meta_modifier
);
6618 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6622 SINGLE_LETTER_MOD (shift_modifier
);
6626 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6627 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6628 SINGLE_LETTER_MOD (super_modifier
);
6632 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6633 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6634 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6638 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6641 #undef SINGLE_LETTER_MOD
6642 #undef MULTI_LETTER_MOD
6648 /* Return true if EVENT is a list whose elements are all integers or symbols.
6649 Such a list is not valid as an event,
6650 but it can be a Lucid-style event type list. */
6653 lucid_event_type_list_p (Lisp_Object object
)
6657 if (! CONSP (object
))
6660 if (EQ (XCAR (object
), Qhelp_echo
)
6661 || EQ (XCAR (object
), Qvertical_line
)
6662 || EQ (XCAR (object
), Qmode_line
)
6663 || EQ (XCAR (object
), Qheader_line
))
6666 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6670 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6677 /* Return true if terminal input chars are available.
6678 Also, store the return value into INPUT_PENDING.
6680 Serves the purpose of ioctl (0, FIONREAD, ...)
6681 but works even if FIONREAD does not exist.
6682 (In fact, this may actually read some input.)
6684 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6685 timer events that are ripe.
6686 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6687 events (FOCUS_IN_EVENT).
6688 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6689 movements and toolkit scroll bar thumb drags. */
6692 get_input_pending (int flags
)
6694 /* First of all, have we already counted some input? */
6695 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6697 /* If input is being read as it arrives, and we have none, there is none. */
6698 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6700 /* Try to read some input and see how much we get. */
6702 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6705 return input_pending
;
6708 /* Put a BUFFER_SWITCH_EVENT in the buffer
6709 so that read_key_sequence will notice the new current buffer. */
6712 record_asynch_buffer_change (void)
6714 struct input_event event
;
6718 event
.kind
= BUFFER_SWITCH_EVENT
;
6719 event
.frame_or_window
= Qnil
;
6722 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6723 The purpose of the event is to make read_key_sequence look up the
6724 keymaps again. If we aren't in read_key_sequence, we don't need one,
6725 and the event could cause trouble by messing up (input-pending-p).
6726 Note: Fwaiting_for_user_input_p always returns nil when async
6727 subprocesses aren't supported. */
6728 tem
= Fwaiting_for_user_input_p ();
6732 /* Make sure no interrupt happens while storing the event. */
6734 if (interrupt_input
)
6735 kbd_buffer_store_event (&event
);
6740 kbd_buffer_store_event (&event
);
6745 /* Read any terminal input already buffered up by the system
6746 into the kbd_buffer, but do not wait.
6748 Return the number of keyboard chars read, or -1 meaning
6749 this is a bad time to try to read input. */
6758 /* Store pending user signal events, if any. */
6759 store_user_signal_events ();
6761 /* Loop through the available terminals, and call their input hooks. */
6765 struct terminal
*next
= t
->next_terminal
;
6767 if (t
->read_socket_hook
)
6770 struct input_event hold_quit
;
6772 if (input_blocked_p ())
6774 pending_signals
= 1;
6778 EVENT_INIT (hold_quit
);
6779 hold_quit
.kind
= NO_EVENT
;
6781 /* No need for FIONREAD or fcntl; just say don't wait. */
6782 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6785 if (nr
== -1) /* Not OK to read input now. */
6789 else if (nr
== -2) /* Non-transient error. */
6791 /* The terminal device terminated; it should be closed. */
6793 /* Kill Emacs if this was our last terminal. */
6794 if (!terminal_list
->next_terminal
)
6795 /* Formerly simply reported no input, but that
6796 sometimes led to a failure of Emacs to terminate.
6797 SIGHUP seems appropriate if we can't reach the
6799 /* ??? Is it really right to send the signal just to
6800 this process rather than to the whole process
6801 group? Perhaps on systems with FIONREAD Emacs is
6802 alone in its group. */
6803 terminate_due_to_signal (SIGHUP
, 10);
6805 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6808 XSETTERMINAL (tmp
, t
);
6809 Fdelete_terminal (tmp
, Qnoelisp
);
6813 if (hold_quit
.kind
!= NO_EVENT
)
6814 kbd_buffer_store_event (&hold_quit
);
6823 frame_make_pointer_visible ();
6829 decode_keyboard_code (struct tty_display_info
*tty
,
6830 struct coding_system
*coding
,
6831 unsigned char *buf
, int nbytes
)
6833 unsigned char *src
= buf
;
6834 const unsigned char *p
;
6839 if (tty
->meta_key
!= 2)
6840 for (i
= 0; i
< nbytes
; i
++)
6842 if (coding
->carryover_bytes
> 0)
6844 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6845 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6846 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6847 nbytes
+= coding
->carryover_bytes
;
6849 coding
->destination
= alloca (nbytes
* 4);
6850 coding
->dst_bytes
= nbytes
* 4;
6851 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6852 if (coding
->produced_char
== 0)
6854 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6856 struct input_event event_buf
;
6858 EVENT_INIT (event_buf
);
6859 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6861 (ASCII_CHAR_P (event_buf
.code
)
6862 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6863 /* See the comment in tty_read_avail_input. */
6864 event_buf
.frame_or_window
= tty
->top_frame
;
6865 event_buf
.arg
= Qnil
;
6866 kbd_buffer_store_event (&event_buf
);
6870 /* This is the tty way of reading available input.
6872 Note that each terminal device has its own `struct terminal' object,
6873 and so this function is called once for each individual termcap
6874 terminal. The first parameter indicates which terminal to read from. */
6877 tty_read_avail_input (struct terminal
*terminal
,
6878 struct input_event
*hold_quit
)
6880 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6881 the kbd_buffer can really hold. That may prevent loss
6882 of characters on some systems when input is stuffed at us. */
6883 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6885 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6888 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6890 if (kbd_on_hold_p () || buffer_free
<= 0)
6892 #endif /* subprocesses */
6894 if (!terminal
->name
) /* Don't read from a dead terminal. */
6897 if (terminal
->type
!= output_termcap
6898 && terminal
->type
!= output_msdos_raw
)
6901 /* XXX I think the following code should be moved to separate hook
6902 functions in system-dependent files. */
6905 #else /* not WINDOWSNT */
6906 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6910 return 0; /* The terminal is suspended. */
6913 n_to_read
= dos_keysns ();
6917 cbuf
[0] = dos_keyread ();
6920 #else /* not MSDOS */
6925 struct input_event gpm_hold_quit
;
6926 int gpm
, fd
= gpm_fd
;
6928 EVENT_INIT (gpm_hold_quit
);
6929 gpm_hold_quit
.kind
= NO_EVENT
;
6931 /* gpm==1 if event received.
6932 gpm==0 if the GPM daemon has closed the connection, in which case
6933 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6934 we save it in `fd' so close_gpm can remove it from the
6936 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6937 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6938 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6941 /* Presumably the GPM daemon has closed the connection. */
6943 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6944 kbd_buffer_store_event (&gpm_hold_quit
);
6948 #endif /* HAVE_GPM */
6950 /* Determine how many characters we should *try* to read. */
6951 #ifdef USABLE_FIONREAD
6952 /* Find out how much input is available. */
6953 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6955 if (! noninteractive
)
6956 return -2; /* Close this terminal. */
6962 if (n_to_read
> sizeof cbuf
)
6963 n_to_read
= sizeof cbuf
;
6964 #elif defined USG || defined CYGWIN
6965 /* Read some input if available, but don't wait. */
6966 n_to_read
= sizeof cbuf
;
6967 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6969 # error "Cannot read without possibly delaying"
6973 /* Don't read more than we can store. */
6974 if (n_to_read
> buffer_free
)
6975 n_to_read
= buffer_free
;
6976 #endif /* subprocesses */
6978 /* Now read; for one reason or another, this will not block.
6979 NREAD is set to the number of chars read. */
6982 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6983 /* POSIX infers that processes which are not in the session leader's
6984 process group won't get SIGHUP's at logout time. BSDI adheres to
6985 this part standard and returns -1 from read (0) with errno==EIO
6986 when the control tty is taken away.
6987 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6988 if (nread
== -1 && errno
== EIO
)
6989 return -2; /* Close this terminal. */
6990 #if defined (AIX) && defined (_BSD)
6991 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6992 This looks incorrect, but it isn't, because _BSD causes
6993 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6994 and that causes a value other than 0 when there is no input. */
6996 return -2; /* Close this terminal. */
7000 /* We used to retry the read if it was interrupted.
7001 But this does the wrong thing when O_NONBLOCK causes
7002 an EAGAIN error. Does anybody know of a situation
7003 where a retry is actually needed? */
7005 nread
< 0 && (errno
== EAGAIN
7018 #ifndef USABLE_FIONREAD
7019 #if defined (USG) || defined (CYGWIN)
7020 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7021 #endif /* USG or CYGWIN */
7022 #endif /* no FIONREAD */
7027 #endif /* not MSDOS */
7028 #endif /* not WINDOWSNT */
7030 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7031 & CODING_REQUIRE_DECODING_MASK
)
7033 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7036 /* Decode the key sequence except for those with meta
7038 for (i
= from
= 0; ; i
++)
7039 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7041 struct input_event buf
;
7043 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7048 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7049 buf
.modifiers
= meta_modifier
;
7050 buf
.code
= cbuf
[i
] & ~0x80;
7051 /* See the comment below. */
7052 buf
.frame_or_window
= tty
->top_frame
;
7054 kbd_buffer_store_event (&buf
);
7060 for (i
= 0; i
< nread
; i
++)
7062 struct input_event buf
;
7064 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7066 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7067 buf
.modifiers
= meta_modifier
;
7068 if (tty
->meta_key
!= 2)
7072 /* Set the frame corresponding to the active tty. Note that the
7073 value of selected_frame is not reliable here, redisplay tends
7074 to temporarily change it. */
7075 buf
.frame_or_window
= tty
->top_frame
;
7078 kbd_buffer_store_event (&buf
);
7079 /* Don't look at input that follows a C-g too closely.
7080 This reduces lossage due to autorepeat on C-g. */
7081 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7082 && buf
.code
== quit_char
)
7090 handle_async_input (void)
7095 int nread
= gobble_input ();
7096 /* -1 means it's not ok to read the input now.
7097 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7098 0 means there was no keyboard input available. */
7106 process_pending_signals (void)
7108 pending_signals
= 0;
7109 handle_async_input ();
7110 do_pending_atimers ();
7113 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7114 and also (if the level is now 0) reinvoke any pending signal. */
7117 unblock_input_to (int level
)
7119 interrupt_input_blocked
= level
;
7122 if (pending_signals
)
7123 process_pending_signals ();
7129 /* End critical section.
7131 If doing signal-driven input, and a signal came in when input was
7132 blocked, reinvoke the signal handler now to deal with it. */
7135 unblock_input (void)
7137 unblock_input_to (interrupt_input_blocked
- 1);
7140 /* Undo any number of BLOCK_INPUT calls,
7141 and also reinvoke any pending signal. */
7144 totally_unblock_input (void)
7146 unblock_input_to (0);
7152 handle_input_available_signal (int sig
)
7154 pending_signals
= 1;
7156 if (input_available_clear_time
)
7157 *input_available_clear_time
= make_emacs_time (0, 0);
7161 deliver_input_available_signal (int sig
)
7163 deliver_process_signal (sig
, handle_input_available_signal
);
7165 #endif /* USABLE_SIGIO */
7168 /* User signal events. */
7170 struct user_signal_info
7172 /* Signal number. */
7175 /* Name of the signal. */
7178 /* Number of pending signals. */
7181 struct user_signal_info
*next
;
7184 /* List of user signals. */
7185 static struct user_signal_info
*user_signals
= NULL
;
7188 add_user_signal (int sig
, const char *name
)
7190 struct sigaction action
;
7191 struct user_signal_info
*p
;
7193 for (p
= user_signals
; p
; p
= p
->next
)
7195 /* Already added. */
7198 p
= xmalloc (sizeof *p
);
7200 p
->name
= xstrdup (name
);
7202 p
->next
= user_signals
;
7205 emacs_sigaction_init (&action
, deliver_user_signal
);
7206 sigaction (sig
, &action
, 0);
7210 handle_user_signal (int sig
)
7212 struct user_signal_info
*p
;
7213 const char *special_event_name
= NULL
;
7215 if (SYMBOLP (Vdebug_on_event
))
7216 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7218 for (p
= user_signals
; p
; p
= p
->next
)
7221 if (special_event_name
7222 && strcmp (special_event_name
, p
->name
) == 0)
7224 /* Enter the debugger in many ways. */
7225 debug_on_next_call
= 1;
7228 Vinhibit_quit
= Qnil
;
7230 /* Eat the event. */
7236 if (interrupt_input
)
7237 handle_input_available_signal (sig
);
7241 /* Tell wait_reading_process_output that it needs to wake
7242 up and look around. */
7243 if (input_available_clear_time
)
7244 *input_available_clear_time
= make_emacs_time (0, 0);
7251 deliver_user_signal (int sig
)
7253 deliver_process_signal (sig
, handle_user_signal
);
7257 find_user_signal_name (int sig
)
7259 struct user_signal_info
*p
;
7261 for (p
= user_signals
; p
; p
= p
->next
)
7269 store_user_signal_events (void)
7271 struct user_signal_info
*p
;
7272 struct input_event buf
;
7273 bool buf_initialized
= 0;
7275 for (p
= user_signals
; p
; p
= p
->next
)
7276 if (p
->npending
> 0)
7278 if (! buf_initialized
)
7280 memset (&buf
, 0, sizeof buf
);
7281 buf
.kind
= USER_SIGNAL_EVENT
;
7282 buf
.frame_or_window
= selected_frame
;
7283 buf_initialized
= 1;
7289 kbd_buffer_store_event (&buf
);
7292 while (p
->npending
> 0);
7297 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7298 static Lisp_Object menu_bar_one_keymap_changed_items
;
7300 /* These variables hold the vector under construction within
7301 menu_bar_items and its subroutines, and the current index
7302 for storing into that vector. */
7303 static Lisp_Object menu_bar_items_vector
;
7304 static int menu_bar_items_index
;
7307 static const char* separator_names
[] = {
7312 "single-dashed-line",
7313 "double-dashed-line",
7315 "shadow-etched-out",
7316 "shadow-etched-in-dash",
7317 "shadow-etched-out-dash",
7318 "shadow-double-etched-in",
7319 "shadow-double-etched-out",
7320 "shadow-double-etched-in-dash",
7321 "shadow-double-etched-out-dash",
7325 /* Return true if LABEL specifies a separator. */
7328 menu_separator_name_p (const char *label
)
7332 else if (strlen (label
) > 3
7333 && memcmp (label
, "--", 2) == 0
7338 for (i
= 0; separator_names
[i
]; ++i
)
7339 if (strcmp (label
, separator_names
[i
]) == 0)
7344 /* It's a separator if it contains only dashes. */
7345 while (*label
== '-')
7347 return (*label
== 0);
7354 /* Return a vector of menu items for a menu bar, appropriate
7355 to the current buffer. Each item has three elements in the vector:
7358 OLD is an old vector we can optionally reuse, or nil. */
7361 menu_bar_items (Lisp_Object old
)
7363 /* The number of keymaps we're scanning right now, and the number of
7364 keymaps we have allocated space for. */
7367 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7368 in the current keymaps, or nil where it is not a prefix. */
7371 Lisp_Object def
, tail
;
7376 /* In order to build the menus, we need to call the keymap
7377 accessors. They all call QUIT. But this function is called
7378 during redisplay, during which a quit is fatal. So inhibit
7379 quitting while building the menus.
7380 We do this instead of specbind because (1) errors will clear it anyway
7381 and (2) this avoids risk of specpdl overflow. */
7382 oquit
= Vinhibit_quit
;
7386 menu_bar_items_vector
= old
;
7388 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7389 menu_bar_items_index
= 0;
7391 /* Build our list of keymaps.
7392 If we recognize a function key and replace its escape sequence in
7393 keybuf with its symbol, or if the sequence starts with a mouse
7394 click and we need to switch buffers, we jump back here to rebuild
7395 the initial keymaps from the current buffer. */
7399 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7400 if (!NILP (Voverriding_local_map_menu_flag
))
7402 /* Yes, use them (if non-nil) as well as the global map. */
7403 maps
= alloca (3 * sizeof (maps
[0]));
7405 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7406 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7407 if (!NILP (Voverriding_local_map
))
7408 maps
[nmaps
++] = Voverriding_local_map
;
7412 /* No, so use major and minor mode keymaps and keymap property.
7413 Note that menu-bar bindings in the local-map and keymap
7414 properties may not work reliable, as they are only
7415 recognized when the menu-bar (or mode-line) is updated,
7416 which does not normally happen after every command. */
7419 nminor
= current_minor_maps (NULL
, &tmaps
);
7420 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7422 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7423 maps
[nmaps
++] = tem
;
7424 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7426 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7428 maps
[nmaps
++] = current_global_map
;
7431 /* Look up in each map the dummy prefix key `menu-bar'. */
7433 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7434 if (!NILP (maps
[mapno
]))
7436 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7440 menu_bar_one_keymap_changed_items
= Qnil
;
7441 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7445 /* Move to the end those items that should be at the end. */
7447 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7450 int end
= menu_bar_items_index
;
7452 for (i
= 0; i
< end
; i
+= 4)
7453 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7455 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7456 /* Move the item at index I to the end,
7457 shifting all the others forward. */
7458 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7459 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7460 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7461 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7463 memmove (aref_addr (menu_bar_items_vector
, i
),
7464 aref_addr (menu_bar_items_vector
, i
+ 4),
7465 (end
- i
- 4) * word_size
);
7466 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7467 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7468 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7469 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7474 /* Add nil, nil, nil, nil at the end. */
7476 int i
= menu_bar_items_index
;
7477 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7478 menu_bar_items_vector
=
7479 larger_vector (menu_bar_items_vector
, 4, -1);
7480 /* Add this item. */
7481 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7482 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7483 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7484 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7485 menu_bar_items_index
= i
;
7488 Vinhibit_quit
= oquit
;
7489 return menu_bar_items_vector
;
7492 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7493 If there's already an item for KEY, add this DEF to it. */
7495 Lisp_Object item_properties
;
7498 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7500 struct gcpro gcpro1
;
7505 if (EQ (item
, Qundefined
))
7507 /* If a map has an explicit `undefined' as definition,
7508 discard any previously made menu bar item. */
7510 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7511 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7513 if (menu_bar_items_index
> i
+ 4)
7514 memmove (aref_addr (menu_bar_items_vector
, i
),
7515 aref_addr (menu_bar_items_vector
, i
+ 4),
7516 (menu_bar_items_index
- i
- 4) * word_size
);
7517 menu_bar_items_index
-= 4;
7521 /* If this keymap has already contributed to this KEY,
7522 don't contribute to it a second time. */
7523 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7524 if (!NILP (tem
) || NILP (item
))
7527 menu_bar_one_keymap_changed_items
7528 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7530 /* We add to menu_bar_one_keymap_changed_items before doing the
7531 parse_menu_item, so that if it turns out it wasn't a menu item,
7532 it still correctly hides any further menu item. */
7534 parsed
= parse_menu_item (item
, 1);
7539 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7541 /* Find any existing item for this KEY. */
7542 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7543 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7546 /* If we did not find this KEY, add it at the end. */
7547 if (i
== menu_bar_items_index
)
7549 /* If vector is too small, get a bigger one. */
7550 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7551 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7552 /* Add this item. */
7553 ASET (menu_bar_items_vector
, i
, key
); i
++;
7554 ASET (menu_bar_items_vector
, i
,
7555 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7556 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7557 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7558 menu_bar_items_index
= i
;
7560 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7564 old
= AREF (menu_bar_items_vector
, i
+ 2);
7565 /* If the new and the old items are not both keymaps,
7566 the lookup will only find `item'. */
7567 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7568 ASET (menu_bar_items_vector
, i
+ 2, item
);
7572 /* This is used as the handler when calling menu_item_eval_property. */
7574 menu_item_eval_property_1 (Lisp_Object arg
)
7576 /* If we got a quit from within the menu computation,
7577 quit all the way out of it. This takes care of C-] in the debugger. */
7578 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7579 Fsignal (Qquit
, Qnil
);
7585 eval_dyn (Lisp_Object form
)
7587 return Feval (form
, Qnil
);
7590 /* Evaluate an expression and return the result (or nil if something
7591 went wrong). Used to evaluate dynamic parts of menu items. */
7593 menu_item_eval_property (Lisp_Object sexpr
)
7595 ptrdiff_t count
= SPECPDL_INDEX ();
7597 specbind (Qinhibit_redisplay
, Qt
);
7598 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7599 menu_item_eval_property_1
);
7600 return unbind_to (count
, val
);
7603 /* This function parses a menu item and leaves the result in the
7604 vector item_properties.
7605 ITEM is a key binding, a possible menu item.
7606 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7608 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7609 parse_menu_item returns true if the item is a menu item and false
7613 parse_menu_item (Lisp_Object item
, int inmenubar
)
7615 Lisp_Object def
, tem
, item_string
, start
;
7617 Lisp_Object keyhint
;
7626 /* Create item_properties vector if necessary. */
7627 if (NILP (item_properties
))
7629 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7631 /* Initialize optional entries. */
7632 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7633 ASET (item_properties
, i
, Qnil
);
7634 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7636 /* Save the item here to protect it from GC. */
7637 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7639 item_string
= XCAR (item
);
7643 if (STRINGP (item_string
))
7645 /* Old format menu item. */
7646 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7648 /* Maybe help string. */
7649 if (CONSP (item
) && STRINGP (XCAR (item
)))
7651 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7656 /* Maybe an obsolete key binding cache. */
7657 if (CONSP (item
) && CONSP (XCAR (item
))
7658 && (NILP (XCAR (XCAR (item
)))
7659 || VECTORP (XCAR (XCAR (item
)))))
7662 /* This is the real definition--the function to run. */
7663 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7665 /* Get enable property, if any. */
7668 tem
= Fget (item
, Qmenu_enable
);
7669 if (!NILP (Venable_disabled_menus_and_buttons
))
7670 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7671 else if (!NILP (tem
))
7672 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7675 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7677 /* New format menu item. */
7678 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7679 start
= XCDR (item
);
7682 /* We have a real binding. */
7683 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7685 item
= XCDR (start
);
7686 /* Is there an obsolete cache list with key equivalences. */
7687 if (CONSP (item
) && CONSP (XCAR (item
)))
7690 /* Parse properties. */
7691 while (CONSP (item
) && CONSP (XCDR (item
)))
7696 if (EQ (tem
, QCenable
))
7698 if (!NILP (Venable_disabled_menus_and_buttons
))
7699 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7701 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7703 else if (EQ (tem
, QCvisible
))
7705 /* If got a visible property and that evaluates to nil
7706 then ignore this item. */
7707 tem
= menu_item_eval_property (XCAR (item
));
7711 else if (EQ (tem
, QChelp
))
7712 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7713 else if (EQ (tem
, QCfilter
))
7715 else if (EQ (tem
, QCkey_sequence
))
7718 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7719 /* Be GC protected. Set keyhint to item instead of tem. */
7722 else if (EQ (tem
, QCkeys
))
7725 if (CONSP (tem
) || STRINGP (tem
))
7726 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7728 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7733 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7735 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7737 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7743 else if (inmenubar
|| !NILP (start
))
7747 return 0; /* not a menu item */
7749 /* If item string is not a string, evaluate it to get string.
7750 If we don't get a string, skip this item. */
7751 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7752 if (!(STRINGP (item_string
)))
7754 item_string
= menu_item_eval_property (item_string
);
7755 if (!STRINGP (item_string
))
7757 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7760 /* If got a filter apply it on definition. */
7761 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7764 def
= menu_item_eval_property (list2 (XCAR (filter
),
7765 list2 (Qquote
, def
)));
7767 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7770 /* Enable or disable selection of item. */
7771 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7774 tem
= menu_item_eval_property (tem
);
7775 if (inmenubar
&& NILP (tem
))
7776 return 0; /* Ignore disabled items in menu bar. */
7777 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7780 /* If we got no definition, this item is just unselectable text which
7781 is OK in a submenu but not in the menubar. */
7783 return (!inmenubar
);
7785 /* See if this is a separate pane or a submenu. */
7786 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7787 tem
= get_keymap (def
, 0, 1);
7788 /* For a subkeymap, just record its details and exit. */
7791 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7792 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7796 /* At the top level in the menu bar, do likewise for commands also.
7797 The menu bar does not display equivalent key bindings anyway.
7798 ITEM_PROPERTY_DEF is already set up properly. */
7802 { /* This is a command. See if there is an equivalent key binding. */
7803 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7805 /* The previous code preferred :key-sequence to :keys, so we
7806 preserve this behavior. */
7807 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7808 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7811 Lisp_Object prefix
= keyeq
;
7812 Lisp_Object keys
= Qnil
;
7816 def
= XCAR (prefix
);
7817 prefix
= XCDR (prefix
);
7820 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7822 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7824 keys
= XCAR (keyhint
);
7825 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7827 /* We have a suggested key. Is it bound to the command? */
7830 /* If the command is an alias for another
7831 (such as lmenu.el set it up), check if the
7832 original command matches the cached command. */
7834 && EQ (tem
, XSYMBOL (def
)->function
))))
7839 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7843 tem
= Fkey_description (keys
, Qnil
);
7846 if (STRINGP (XCAR (prefix
)))
7847 tem
= concat2 (XCAR (prefix
), tem
);
7848 if (STRINGP (XCDR (prefix
)))
7849 tem
= concat2 (tem
, XCDR (prefix
));
7851 keyeq
= concat2 (build_string (" "), tem
);
7852 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7858 /* If we have an equivalent key binding, use that. */
7859 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7862 /* Include this when menu help is implemented.
7863 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7864 if (!(NILP (tem) || STRINGP (tem)))
7866 tem = menu_item_eval_property (tem);
7869 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7873 /* Handle radio buttons or toggle boxes. */
7874 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7876 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7877 menu_item_eval_property (tem
));
7884 /***********************************************************************
7886 ***********************************************************************/
7888 /* A vector holding tool bar items while they are parsed in function
7889 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7892 static Lisp_Object tool_bar_items_vector
;
7894 /* A vector holding the result of parse_tool_bar_item. Layout is like
7895 the one for a single item in tool_bar_items_vector. */
7897 static Lisp_Object tool_bar_item_properties
;
7899 /* Next free index in tool_bar_items_vector. */
7901 static int ntool_bar_items
;
7903 /* The symbols `:image' and `:rtl'. */
7905 static Lisp_Object QCimage
;
7906 static Lisp_Object QCrtl
;
7908 /* Function prototypes. */
7910 static void init_tool_bar_items (Lisp_Object
);
7911 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7912 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7913 static void append_tool_bar_item (void);
7916 /* Return a vector of tool bar items for keymaps currently in effect.
7917 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7918 tool bar items found. */
7921 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7930 /* In order to build the menus, we need to call the keymap
7931 accessors. They all call QUIT. But this function is called
7932 during redisplay, during which a quit is fatal. So inhibit
7933 quitting while building the menus. We do this instead of
7934 specbind because (1) errors will clear it anyway and (2) this
7935 avoids risk of specpdl overflow. */
7936 oquit
= Vinhibit_quit
;
7939 /* Initialize tool_bar_items_vector and protect it from GC. */
7940 init_tool_bar_items (reuse
);
7942 /* Build list of keymaps in maps. Set nmaps to the number of maps
7945 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7946 if (!NILP (Voverriding_local_map_menu_flag
))
7948 /* Yes, use them (if non-nil) as well as the global map. */
7949 maps
= alloca (3 * sizeof *maps
);
7951 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7952 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7953 if (!NILP (Voverriding_local_map
))
7954 maps
[nmaps
++] = Voverriding_local_map
;
7958 /* No, so use major and minor mode keymaps and keymap property.
7959 Note that tool-bar bindings in the local-map and keymap
7960 properties may not work reliable, as they are only
7961 recognized when the tool-bar (or mode-line) is updated,
7962 which does not normally happen after every command. */
7965 nminor
= current_minor_maps (NULL
, &tmaps
);
7966 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7968 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7969 maps
[nmaps
++] = tem
;
7970 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7972 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7975 /* Add global keymap at the end. */
7976 maps
[nmaps
++] = current_global_map
;
7978 /* Process maps in reverse order and look up in each map the prefix
7980 for (i
= nmaps
- 1; i
>= 0; --i
)
7981 if (!NILP (maps
[i
]))
7985 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7987 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7990 Vinhibit_quit
= oquit
;
7991 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7992 return tool_bar_items_vector
;
7996 /* Process the definition of KEY which is DEF. */
7999 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8002 struct gcpro gcpro1
, gcpro2
;
8004 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8008 if (EQ (def
, Qundefined
))
8010 /* If a map has an explicit `undefined' as definition,
8011 discard any previously made item. */
8012 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8014 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8016 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8018 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8019 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8020 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8022 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8027 else if (parse_tool_bar_item (key
, def
))
8028 /* Append a new tool bar item to tool_bar_items_vector. Accept
8029 more than one definition for the same key. */
8030 append_tool_bar_item ();
8035 /* Access slot with index IDX of vector tool_bar_item_properties. */
8036 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8038 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8040 ASET (tool_bar_item_properties
, idx
, val
);
8044 /* Parse a tool bar item specification ITEM for key KEY and return the
8045 result in tool_bar_item_properties. Value is false if ITEM is
8048 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8050 CAPTION is the caption of the item, If it's not a string, it is
8051 evaluated to get a string.
8053 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8054 as binding are currently ignored.
8056 The following properties are recognized:
8060 FORM is evaluated and specifies whether the tool bar item is
8061 enabled or disabled.
8065 FORM is evaluated and specifies whether the tool bar item is visible.
8067 - `:filter FUNCTION'
8069 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8070 result is stored as the new binding.
8072 - `:button (TYPE SELECTED)'
8074 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8075 and specifies whether the button is selected (pressed) or not.
8079 IMAGES is either a single image specification or a vector of four
8080 image specifications. See enum tool_bar_item_images.
8082 - `:help HELP-STRING'.
8084 Gives a help string to display for the tool bar item.
8086 - `:label LABEL-STRING'.
8088 A text label to show with the tool bar button if labels are enabled. */
8091 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8093 Lisp_Object filter
= Qnil
;
8094 Lisp_Object caption
;
8096 bool have_label
= 0;
8098 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8099 Rule out items that aren't lists, don't start with
8100 `menu-item' or whose rest following `tool-bar-item' is not a
8105 /* As an exception, allow old-style menu separators. */
8106 if (STRINGP (XCAR (item
)))
8107 item
= Fcons (XCAR (item
), Qnil
);
8108 else if (!EQ (XCAR (item
), Qmenu_item
)
8109 || (item
= XCDR (item
), !CONSP (item
)))
8112 /* Create tool_bar_item_properties vector if necessary. Reset it to
8114 if (VECTORP (tool_bar_item_properties
))
8116 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8120 tool_bar_item_properties
8121 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8124 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8125 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8127 /* Get the caption of the item. If the caption is not a string,
8128 evaluate it to get a string. If we don't get a string, skip this
8130 caption
= XCAR (item
);
8131 if (!STRINGP (caption
))
8133 caption
= menu_item_eval_property (caption
);
8134 if (!STRINGP (caption
))
8137 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8139 /* If the rest following the caption is not a list, the menu item is
8140 either a separator, or invalid. */
8144 if (menu_separator_name_p (SSDATA (caption
)))
8146 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8147 #if !defined (USE_GTK) && !defined (HAVE_NS)
8148 /* If we use build_desired_tool_bar_string to render the
8149 tool bar, the separator is rendered as an image. */
8150 PROP (TOOL_BAR_ITEM_IMAGES
)
8151 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8152 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8153 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8154 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8161 /* Store the binding. */
8162 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8165 /* Ignore cached key binding, if any. */
8166 if (CONSP (item
) && CONSP (XCAR (item
)))
8169 /* Process the rest of the properties. */
8170 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8172 Lisp_Object ikey
, value
;
8175 value
= XCAR (XCDR (item
));
8177 if (EQ (ikey
, QCenable
))
8179 /* `:enable FORM'. */
8180 if (!NILP (Venable_disabled_menus_and_buttons
))
8181 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8183 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8185 else if (EQ (ikey
, QCvisible
))
8187 /* `:visible FORM'. If got a visible property and that
8188 evaluates to nil then ignore this item. */
8189 if (NILP (menu_item_eval_property (value
)))
8192 else if (EQ (ikey
, QChelp
))
8193 /* `:help HELP-STRING'. */
8194 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8195 else if (EQ (ikey
, QCvert_only
))
8196 /* `:vert-only t/nil'. */
8197 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8198 else if (EQ (ikey
, QClabel
))
8200 const char *bad_label
= "!!?GARBLED ITEM?!!";
8201 /* `:label LABEL-STRING'. */
8202 set_prop (TOOL_BAR_ITEM_LABEL
,
8203 STRINGP (value
) ? value
: build_string (bad_label
));
8206 else if (EQ (ikey
, QCfilter
))
8207 /* ':filter FORM'. */
8209 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8211 /* `:button (TYPE . SELECTED)'. */
8212 Lisp_Object type
, selected
;
8214 type
= XCAR (value
);
8215 selected
= XCDR (value
);
8216 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8218 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8219 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8222 else if (EQ (ikey
, QCimage
)
8224 || (VECTORP (value
) && ASIZE (value
) == 4)))
8225 /* Value is either a single image specification or a vector
8226 of 4 such specifications for the different button states. */
8227 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8228 else if (EQ (ikey
, QCrtl
))
8230 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8236 /* Try to make one from caption and key. */
8237 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8238 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8239 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8240 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8242 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8243 char *buf
= xmalloc (max_lbl
+ 1);
8244 Lisp_Object new_lbl
;
8245 ptrdiff_t caption_len
= strlen (capt
);
8247 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8250 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8252 buf
[caption_len
] = '\0';
8256 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8260 strcpy (buf
, label
);
8262 for (j
= 0; buf
[j
] != '\0'; ++j
)
8270 new_lbl
= Fupcase_initials (build_string (label
));
8271 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8272 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8274 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8278 /* If got a filter apply it on binding. */
8280 set_prop (TOOL_BAR_ITEM_BINDING
,
8281 (menu_item_eval_property
8284 PROP (TOOL_BAR_ITEM_BINDING
))))));
8286 /* See if the binding is a keymap. Give up if it is. */
8287 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8290 /* Enable or disable selection of item. */
8291 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8292 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8293 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8295 /* Handle radio buttons or toggle boxes. */
8296 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8297 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8298 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8306 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8307 that can be reused. */
8310 init_tool_bar_items (Lisp_Object reuse
)
8312 if (VECTORP (reuse
))
8313 tool_bar_items_vector
= reuse
;
8315 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8316 ntool_bar_items
= 0;
8320 /* Append parsed tool bar item properties from
8321 tool_bar_item_properties */
8324 append_tool_bar_item (void)
8328 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8330 /* Enlarge tool_bar_items_vector if necessary. */
8332 tool_bar_items_vector
8333 = larger_vector (tool_bar_items_vector
, incr
, -1);
8335 /* Append entries from tool_bar_item_properties to the end of
8336 tool_bar_items_vector. */
8337 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8338 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8339 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8346 /* Read a character using menus based on maps in the array MAPS.
8347 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8348 Return t if we displayed a menu but the user rejected it.
8350 PREV_EVENT is the previous input event, or nil if we are reading
8351 the first event of a key sequence.
8353 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8354 if we used a mouse menu to read the input, or false otherwise. If
8355 USED_MOUSE_MENU is null, don't dereference it.
8357 The prompting is done based on the prompt-string of the map
8358 and the strings associated with various map elements.
8360 This can be done with X menus or with menus put in the minibuf.
8361 These are done in different ways, depending on how the input will be read.
8362 Menus using X are done after auto-saving in read-char, getting the input
8363 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8364 and do auto-saving in the inner call of read_char. */
8367 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8368 Lisp_Object prev_event
, bool *used_mouse_menu
)
8374 if (used_mouse_menu
)
8375 *used_mouse_menu
= 0;
8377 /* Use local over global Menu maps */
8379 if (! menu_prompting
)
8382 /* Optionally disregard all but the global map. */
8383 if (inhibit_local_menu_bar_menus
)
8385 maps
+= (nmaps
- 1);
8390 /* If we got to this point via a mouse click,
8391 use a real menu for mouse selection. */
8392 if (EVENT_HAS_PARAMETERS (prev_event
)
8393 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8394 && !EQ (XCAR (prev_event
), Qtool_bar
))
8396 /* Display the menu and get the selection. */
8397 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8399 ptrdiff_t nmaps1
= 0;
8401 /* Use the maps that are not nil. */
8402 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8403 if (!NILP (maps
[mapno
]))
8404 realmaps
[nmaps1
++] = maps
[mapno
];
8406 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8411 record_menu_key (XCAR (value
));
8413 /* If we got multiple events, unread all but
8415 There is no way to prevent those unread events
8416 from showing up later in last_nonmenu_event.
8417 So turn symbol and integer events into lists,
8418 to indicate that they came from a mouse menu,
8419 so that when present in last_nonmenu_event
8420 they won't confuse things. */
8421 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8423 record_menu_key (XCAR (tem
));
8424 if (SYMBOLP (XCAR (tem
))
8425 || INTEGERP (XCAR (tem
)))
8426 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8429 /* If we got more than one event, put all but the first
8430 onto this list to be read later.
8431 Return just the first event now. */
8432 Vunread_command_events
8433 = nconc2 (XCDR (value
), Vunread_command_events
);
8434 value
= XCAR (value
);
8436 else if (NILP (value
))
8438 if (used_mouse_menu
)
8439 *used_mouse_menu
= 1;
8442 #endif /* HAVE_MENUS */
8446 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8447 We make this bigger when necessary, and never free it. */
8448 static char *read_char_minibuf_menu_text
;
8449 /* Size of that buffer. */
8450 static ptrdiff_t read_char_minibuf_menu_width
;
8453 read_char_minibuf_menu_prompt (int commandflag
,
8454 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8457 register Lisp_Object name
;
8459 /* FIXME: Use the minibuffer's frame width. */
8460 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8462 bool nobindings
= 1;
8463 Lisp_Object rest
, vector
;
8469 if (! menu_prompting
)
8472 /* Get the menu name from the first map that has one (a prompt string). */
8473 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8475 name
= Fkeymap_prompt (maps
[mapno
]);
8480 /* If we don't have any menus, just read a character normally. */
8481 if (!STRINGP (name
))
8484 /* Make sure we have a big enough buffer for the menu text. */
8485 width
= max (width
, SBYTES (name
));
8486 if (STRING_BYTES_BOUND
- 4 < width
)
8487 memory_full (SIZE_MAX
);
8488 if (width
+ 4 > read_char_minibuf_menu_width
)
8490 read_char_minibuf_menu_text
8491 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8492 read_char_minibuf_menu_width
= width
+ 4;
8494 menu
= read_char_minibuf_menu_text
;
8496 /* Prompt string always starts with map's prompt, and a space. */
8497 strcpy (menu
, SSDATA (name
));
8498 nlength
= SBYTES (name
);
8499 menu
[nlength
++] = ':';
8500 menu
[nlength
++] = ' ';
8503 /* Start prompting at start of first map. */
8507 /* Present the documented bindings, a line at a time. */
8511 ptrdiff_t i
= nlength
;
8513 Lisp_Object orig_defn_macro
;
8515 /* Loop over elements of map. */
8520 /* If reached end of map, start at beginning of next map. */
8524 /* At end of last map, wrap around to first map if just starting,
8525 or end this line if already have something on it. */
8529 if (notfirst
|| nobindings
) break;
8534 /* Look at the next element of the map. */
8536 elt
= AREF (vector
, idx
);
8538 elt
= Fcar_safe (rest
);
8540 if (idx
< 0 && VECTORP (elt
))
8542 /* If we found a dense table in the keymap,
8543 advanced past it, but start scanning its contents. */
8544 rest
= Fcdr_safe (rest
);
8550 /* An ordinary element. */
8551 Lisp_Object event
, tem
;
8555 event
= Fcar_safe (elt
); /* alist */
8556 elt
= Fcdr_safe (elt
);
8560 XSETINT (event
, idx
); /* vector */
8563 /* Ignore the element if it has no prompt string. */
8564 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8566 /* True if the char to type matches the string. */
8568 Lisp_Object upcased_event
, downcased_event
;
8569 Lisp_Object desc
= Qnil
;
8571 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8573 upcased_event
= Fupcase (event
);
8574 downcased_event
= Fdowncase (event
);
8575 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8576 || XINT (downcased_event
) == SREF (s
, 0));
8578 desc
= Fsingle_key_description (event
, Qnil
);
8580 #if 0 /* It is redundant to list the equivalent key bindings because
8581 the prefix is what the user has already typed. */
8583 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8585 /* Insert equivalent keybinding. */
8586 s
= concat2 (s
, tem
);
8589 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8590 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8592 /* Insert button prefix. */
8593 Lisp_Object selected
8594 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8595 if (EQ (tem
, QCradio
))
8596 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8598 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8599 s
= concat2 (tem
, s
);
8603 /* If we have room for the prompt string, add it to this line.
8604 If this is the first on the line, always add it. */
8605 if ((SCHARS (s
) + i
+ 2
8606 + (char_matches
? 0 : SCHARS (desc
) + 3))
8610 ptrdiff_t thiswidth
;
8612 /* Punctuate between strings. */
8615 strcpy (menu
+ i
, ", ");
8621 /* If the char to type doesn't match the string's
8622 first char, explicitly show what char to type. */
8625 /* Add as much of string as fits. */
8626 thiswidth
= min (SCHARS (desc
), width
- i
);
8627 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8629 strcpy (menu
+ i
, " = ");
8633 /* Add as much of string as fits. */
8634 thiswidth
= min (SCHARS (s
), width
- i
);
8635 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8641 /* If this element does not fit, end the line now,
8642 and save the element for the next line. */
8643 strcpy (menu
+ i
, "...");
8648 /* Move past this element. */
8649 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8650 /* Handle reaching end of dense table. */
8655 rest
= Fcdr_safe (rest
);
8659 /* Prompt with that and read response. */
8660 message2_nolog (menu
, strlen (menu
),
8661 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8663 /* Make believe its not a keyboard macro in case the help char
8664 is pressed. Help characters are not recorded because menu prompting
8665 is not used on replay.
8667 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8668 kset_defining_kbd_macro (current_kboard
, Qnil
);
8670 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8671 while (BUFFERP (obj
));
8672 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8674 if (!INTEGERP (obj
))
8676 else if (XINT (obj
) == -2)
8679 if (! EQ (obj
, menu_prompt_more_char
)
8680 && (!INTEGERP (menu_prompt_more_char
)
8681 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8683 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8684 store_kbd_macro_char (obj
);
8687 /* Help char - go round again */
8691 /* Reading key sequences. */
8693 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8694 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8695 keymap, or nil otherwise. Return the index of the first keymap in
8696 which KEY has any binding, or NMAPS if no map has a binding.
8698 If KEY is a meta ASCII character, treat it like meta-prefix-char
8699 followed by the corresponding non-meta character. Keymaps in
8700 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8703 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8706 NEXT may be the same array as CURRENT. */
8709 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8710 Lisp_Object
*defs
, Lisp_Object
*next
)
8712 ptrdiff_t i
, first_binding
;
8714 first_binding
= nmaps
;
8715 for (i
= nmaps
- 1; i
>= 0; i
--)
8717 if (! NILP (current
[i
]))
8719 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8720 if (! NILP (defs
[i
]))
8727 /* Given the set of bindings we've found, produce the next set of maps. */
8728 if (first_binding
< nmaps
)
8729 for (i
= 0; i
< nmaps
; i
++)
8730 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8732 return first_binding
;
8735 /* Structure used to keep track of partial application of key remapping
8736 such as Vfunction_key_map and Vkey_translation_map. */
8737 typedef struct keyremap
8739 /* This is the map originally specified for this use. */
8741 /* This is a submap reached by looking up, in PARENT,
8742 the events from START to END. */
8744 /* Positions [START, END) in the key sequence buffer
8745 are the key that we have scanned so far.
8746 Those events are the ones that we will replace
8747 if PARENT maps them into a key sequence. */
8751 /* Lookup KEY in MAP.
8752 MAP is a keymap mapping keys to key vectors or functions.
8753 If the mapping is a function and DO_FUNCALL is true,
8754 the function is called with PROMPT as parameter and its return
8755 value is used as the return value of this function (after checking
8756 that it is indeed a vector). */
8759 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8764 next
= access_keymap (map
, key
, 1, 0, 1);
8766 /* Handle a symbol whose function definition is a keymap
8768 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8769 && (ARRAYP (XSYMBOL (next
)->function
)
8770 || KEYMAPP (XSYMBOL (next
)->function
)))
8771 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8773 /* If the keymap gives a function, not an
8774 array, then call the function with one arg and use
8775 its value instead. */
8776 if (do_funcall
&& FUNCTIONP (next
))
8781 next
= call1 (next
, prompt
);
8782 /* If the function returned something invalid,
8783 barf--don't ignore it.
8784 (To ignore it safely, we would need to gcpro a bunch of
8785 other variables.) */
8786 if (! (VECTORP (next
) || STRINGP (next
)))
8787 error ("Function %s returns invalid key sequence",
8788 SSDATA (SYMBOL_NAME (tem
)));
8793 /* Do one step of the key remapping used for function-key-map and
8794 key-translation-map:
8795 KEYBUF is the buffer holding the input events.
8796 BUFSIZE is its maximum size.
8797 FKEY is a pointer to the keyremap structure to use.
8798 INPUT is the index of the last element in KEYBUF.
8799 DOIT if true says that the remapping can actually take place.
8800 DIFF is used to return the number of keys added/removed by the remapping.
8801 PARENT is the root of the keymap.
8802 PROMPT is the prompt to use if the remapping happens through a function.
8803 Return true if the remapping actually took place. */
8806 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8807 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8809 Lisp_Object next
, key
;
8811 key
= keybuf
[fkey
->end
++];
8813 if (KEYMAPP (fkey
->parent
))
8814 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8818 /* If keybuf[fkey->start..fkey->end] is bound in the
8819 map and we're in a position to do the key remapping, replace it with
8820 the binding and restart with fkey->start at the end. */
8821 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8823 int len
= XFASTINT (Flength (next
));
8826 *diff
= len
- (fkey
->end
- fkey
->start
);
8828 if (bufsize
- input
<= *diff
)
8829 error ("Key sequence too long");
8831 /* Shift the keys that follow fkey->end. */
8833 for (i
= fkey
->end
; i
< input
; i
++)
8834 keybuf
[i
+ *diff
] = keybuf
[i
];
8836 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8837 keybuf
[i
+ *diff
] = keybuf
[i
];
8838 /* Overwrite the old keys with the new ones. */
8839 for (i
= 0; i
< len
; i
++)
8840 keybuf
[fkey
->start
+ i
]
8841 = Faref (next
, make_number (i
));
8843 fkey
->start
= fkey
->end
+= *diff
;
8844 fkey
->map
= fkey
->parent
;
8849 fkey
->map
= get_keymap (next
, 0, 1);
8851 /* If we no longer have a bound suffix, try a new position for
8853 if (!CONSP (fkey
->map
))
8855 fkey
->end
= ++fkey
->start
;
8856 fkey
->map
= fkey
->parent
;
8862 test_undefined (Lisp_Object binding
)
8864 return (EQ (binding
, Qundefined
)
8865 || (!NILP (binding
) && SYMBOLP (binding
)
8866 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8869 /* Read a sequence of keys that ends with a non prefix character,
8870 storing it in KEYBUF, a buffer of size BUFSIZE.
8872 Return the length of the key sequence stored.
8873 Return -1 if the user rejected a command menu.
8875 Echo starting immediately unless `prompt' is 0.
8877 Where a key sequence ends depends on the currently active keymaps.
8878 These include any minor mode keymaps active in the current buffer,
8879 the current buffer's local map, and the global map.
8881 If a key sequence has no other bindings, we check Vfunction_key_map
8882 to see if some trailing subsequence might be the beginning of a
8883 function key's sequence. If so, we try to read the whole function
8884 key, and substitute its symbolic name into the key sequence.
8886 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8887 `double-' events into similar click events, if that would make them
8888 bound. We try to turn `triple-' events first into `double-' events,
8891 If we get a mouse click in a mode line, vertical divider, or other
8892 non-text area, we treat the click as if it were prefixed by the
8893 symbol denoting that area - `mode-line', `vertical-line', or
8896 If the sequence starts with a mouse click, we read the key sequence
8897 with respect to the buffer clicked on, not the current buffer.
8899 If the user switches frames in the midst of a key sequence, we put
8900 off the switch-frame event until later; the next call to
8901 read_char will return it.
8903 If FIX_CURRENT_BUFFER, we restore current_buffer
8904 from the selected window's buffer. */
8907 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8908 bool dont_downcase_last
, bool can_return_switch_frame
,
8909 bool fix_current_buffer
)
8911 Lisp_Object from_string
;
8912 ptrdiff_t count
= SPECPDL_INDEX ();
8914 /* How many keys there are in the current key sequence. */
8917 /* The length of the echo buffer when we started reading, and
8918 the length of this_command_keys when we started reading. */
8919 ptrdiff_t echo_start
IF_LINT (= 0);
8920 ptrdiff_t keys_start
;
8922 /* The number of keymaps we're scanning right now, and the number of
8923 keymaps we have allocated space for. */
8925 ptrdiff_t nmaps_allocated
= 0;
8927 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8928 the current keymaps. */
8929 Lisp_Object
*defs
= NULL
;
8931 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8932 in the current keymaps, or nil where it is not a prefix. */
8933 Lisp_Object
*submaps
= NULL
;
8935 /* The local map to start out with at start of key sequence. */
8936 Lisp_Object orig_local_map
;
8938 /* The map from the `keymap' property to start out with at start of
8940 Lisp_Object orig_keymap
;
8942 /* Positive if we have already considered switching to the local-map property
8943 of the place where a mouse click occurred. */
8944 int localized_local_map
= 0;
8946 /* The index in submaps[] of the first keymap that has a binding for
8947 this key sequence. In other words, the lowest i such that
8948 submaps[i] is non-nil. */
8949 ptrdiff_t first_binding
;
8950 /* Index of the first key that has no binding.
8951 It is useless to try fkey.start larger than that. */
8954 /* If t < mock_input, then KEYBUF[t] should be read as the next
8957 We use this to recover after recognizing a function key. Once we
8958 realize that a suffix of the current key sequence is actually a
8959 function key's escape sequence, we replace the suffix with the
8960 function key's binding from Vfunction_key_map. Now keybuf
8961 contains a new and different key sequence, so the echo area,
8962 this_command_keys, and the submaps and defs arrays are wrong. In
8963 this situation, we set mock_input to t, set t to 0, and jump to
8964 restart_sequence; the loop will read keys from keybuf up until
8965 mock_input, thus rebuilding the state; and then it will resume
8966 reading characters from the keyboard. */
8969 /* If the sequence is unbound in submaps[], then
8970 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8971 and fkey.map is its binding.
8973 These might be > t, indicating that all function key scanning
8974 should hold off until t reaches them. We do this when we've just
8975 recognized a function key, to avoid searching for the function
8976 key's again in Vfunction_key_map. */
8979 /* Likewise, for key_translation_map and input-decode-map. */
8980 keyremap keytran
, indec
;
8982 /* True if we are trying to map a key by changing an upper-case
8983 letter to lower case, or a shifted function key to an unshifted
8985 bool shift_translated
= 0;
8987 /* If we receive a `switch-frame' or `select-window' event in the middle of
8988 a key sequence, we put it off for later.
8989 While we're reading, we keep the event here. */
8990 Lisp_Object delayed_switch_frame
;
8992 /* See the comment below... */
8993 #if defined (GOBBLE_FIRST_EVENT)
8994 Lisp_Object first_event
;
8997 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8998 int original_uppercase_position
= -1;
9000 /* Gets around Microsoft compiler limitations. */
9003 struct buffer
*starting_buffer
;
9005 /* List of events for which a fake prefix key has been generated. */
9006 Lisp_Object fake_prefixed_keys
= Qnil
;
9008 #if defined (GOBBLE_FIRST_EVENT)
9012 struct gcpro gcpro1
;
9014 GCPRO1 (fake_prefixed_keys
);
9015 raw_keybuf_count
= 0;
9017 last_nonmenu_event
= Qnil
;
9019 delayed_switch_frame
= Qnil
;
9025 /* Install the string STR as the beginning of the string of
9026 echoing, so that it serves as a prompt for the next
9028 kset_echo_string (current_kboard
, prompt
);
9029 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9032 else if (cursor_in_echo_area
9033 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9034 && NILP (Fzerop (Vecho_keystrokes
)))
9035 /* This doesn't put in a dash if the echo buffer is empty, so
9036 you don't always see a dash hanging out in the minibuffer. */
9040 /* Record the initial state of the echo area and this_command_keys;
9041 we will need to restore them if we replay a key sequence. */
9043 echo_start
= echo_length ();
9044 keys_start
= this_command_key_count
;
9045 this_single_command_key_start
= keys_start
;
9047 #if defined (GOBBLE_FIRST_EVENT)
9048 /* This doesn't quite work, because some of the things that read_char
9049 does cannot safely be bypassed. It seems too risky to try to make
9052 /* Read the first char of the sequence specially, before setting
9053 up any keymaps, in case a filter runs and switches buffers on us. */
9054 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9056 #endif /* GOBBLE_FIRST_EVENT */
9058 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9059 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9062 /* We jump here when we need to reinitialize fkey and keytran; this
9063 happens if we switch keyboards between rescans. */
9064 replay_entire_sequence
:
9066 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9067 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9068 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9069 indec
.start
= indec
.end
= 0;
9070 fkey
.start
= fkey
.end
= 0;
9071 keytran
.start
= keytran
.end
= 0;
9073 /* We jump here when the key sequence has been thoroughly changed, and
9074 we need to rescan it starting from the beginning. When we jump here,
9075 keybuf[0..mock_input] holds the sequence we should reread. */
9078 starting_buffer
= current_buffer
;
9079 first_unbound
= bufsize
+ 1;
9081 /* Build our list of keymaps.
9082 If we recognize a function key and replace its escape sequence in
9083 keybuf with its symbol, or if the sequence starts with a mouse
9084 click and we need to switch buffers, we jump back here to rebuild
9085 the initial keymaps from the current buffer. */
9088 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9090 if (2 > nmaps_allocated
)
9092 submaps
= alloca (2 * sizeof *submaps
);
9093 defs
= alloca (2 * sizeof *defs
);
9094 nmaps_allocated
= 2;
9096 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9098 else if (!NILP (Voverriding_local_map
))
9100 if (2 > nmaps_allocated
)
9102 submaps
= alloca (2 * sizeof *submaps
);
9103 defs
= alloca (2 * sizeof *defs
);
9104 nmaps_allocated
= 2;
9106 submaps
[nmaps
++] = Voverriding_local_map
;
9114 nminor
= current_minor_maps (0, &maps
);
9115 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9117 if (total
> nmaps_allocated
)
9119 submaps
= alloca (total
* sizeof *submaps
);
9120 defs
= alloca (total
* sizeof *defs
);
9121 nmaps_allocated
= total
;
9124 if (!NILP (orig_keymap
))
9125 submaps
[nmaps
++] = orig_keymap
;
9127 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9131 submaps
[nmaps
++] = orig_local_map
;
9133 submaps
[nmaps
++] = current_global_map
;
9135 /* Find an accurate initial value for first_binding. */
9136 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9137 if (! NILP (submaps
[first_binding
]))
9140 /* Start from the beginning in keybuf. */
9143 /* These are no-ops the first time through, but if we restart, they
9144 revert the echo area and this_command_keys to their original state. */
9145 this_command_key_count
= keys_start
;
9146 if (INTERACTIVE
&& t
< mock_input
)
9147 echo_truncate (echo_start
);
9149 /* If the best binding for the current key sequence is a keymap, or
9150 we may be looking at a function key's escape sequence, keep on
9152 while (first_binding
< nmaps
9153 /* Keep reading as long as there's a prefix binding. */
9154 ? !NILP (submaps
[first_binding
])
9155 /* Don't return in the middle of a possible function key sequence,
9156 if the only bindings we found were via case conversion.
9157 Thus, if ESC O a has a function-key-map translation
9158 and ESC o has a binding, don't return after ESC O,
9159 so that we can translate ESC O plus the next character. */
9160 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9163 bool used_mouse_menu
= 0;
9165 /* Where the last real key started. If we need to throw away a
9166 key that has expanded into more than one element of keybuf
9167 (say, a mouse click on the mode line which is being treated
9168 as [mode-line (mouse-...)], then we backtrack to this point
9170 int last_real_key_start
;
9172 /* These variables are analogous to echo_start and keys_start;
9173 while those allow us to restart the entire key sequence,
9174 echo_local_start and keys_local_start allow us to throw away
9176 ptrdiff_t echo_local_start
IF_LINT (= 0);
9177 int keys_local_start
;
9178 ptrdiff_t local_first_binding
;
9180 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9181 eassert (indec
.start
<= indec
.end
);
9182 eassert (fkey
.start
<= fkey
.end
);
9183 eassert (keytran
.start
<= keytran
.end
);
9184 /* key-translation-map is applied *after* function-key-map
9185 which is itself applied *after* input-decode-map. */
9186 eassert (fkey
.end
<= indec
.start
);
9187 eassert (keytran
.end
<= fkey
.start
);
9189 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9190 first_unbound
< keytran
.start
)
9191 { /* The prefix upto first_unbound has no binding and has
9192 no translation left to do either, so we know it's unbound.
9193 If we don't stop now, we risk staying here indefinitely
9194 (if the user keeps entering fkey or keytran prefixes
9195 like C-c ESC ESC ESC ESC ...) */
9197 for (i
= first_unbound
+ 1; i
< t
; i
++)
9198 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9199 mock_input
= t
- first_unbound
- 1;
9200 indec
.end
= indec
.start
-= first_unbound
+ 1;
9201 indec
.map
= indec
.parent
;
9202 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9203 fkey
.map
= fkey
.parent
;
9204 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9205 keytran
.map
= keytran
.parent
;
9206 goto replay_sequence
;
9210 error ("Key sequence too long");
9213 echo_local_start
= echo_length ();
9214 keys_local_start
= this_command_key_count
;
9215 local_first_binding
= first_binding
;
9218 /* These are no-ops, unless we throw away a keystroke below and
9219 jumped back up to replay_key; in that case, these restore the
9220 variables to their original state, allowing us to replay the
9222 if (INTERACTIVE
&& t
< mock_input
)
9223 echo_truncate (echo_local_start
);
9224 this_command_key_count
= keys_local_start
;
9225 first_binding
= local_first_binding
;
9227 /* By default, assume each event is "real". */
9228 last_real_key_start
= t
;
9230 /* Does mock_input indicate that we are re-reading a key sequence? */
9234 add_command_key (key
);
9235 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9236 && NILP (Fzerop (Vecho_keystrokes
)))
9240 /* If not, we should actually read a character. */
9244 KBOARD
*interrupted_kboard
= current_kboard
;
9245 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9246 key
= read_char (NILP (prompt
), nmaps
,
9247 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9248 &used_mouse_menu
, NULL
);
9249 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9250 /* When switching to a new tty (with a new keyboard),
9251 read_char returns the new buffer, rather than -2
9252 (Bug#5095). This is because `terminal-init-xterm'
9253 calls read-char, which eats the wrong_kboard_jmpbuf
9254 return. Any better way to fix this? -- cyd */
9255 || (interrupted_kboard
!= current_kboard
))
9260 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9261 if (k
== interrupted_kboard
)
9266 /* Don't touch interrupted_kboard when it's been
9268 delayed_switch_frame
= Qnil
;
9269 goto replay_entire_sequence
;
9272 if (!NILP (delayed_switch_frame
))
9275 (interrupted_kboard
,
9276 Fcons (delayed_switch_frame
,
9277 KVAR (interrupted_kboard
, kbd_queue
)));
9278 delayed_switch_frame
= Qnil
;
9283 (interrupted_kboard
,
9284 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9286 /* If the side queue is non-empty, ensure it begins with a
9287 switch-frame, so we'll replay it in the right context. */
9288 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9289 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9290 !(EVENT_HAS_PARAMETERS (key
)
9291 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9295 XSETFRAME (frame
, interrupted_frame
);
9297 (interrupted_kboard
,
9298 Fcons (make_lispy_switch_frame (frame
),
9299 KVAR (interrupted_kboard
, kbd_queue
)));
9302 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9303 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9304 goto replay_entire_sequence
;
9308 /* read_char returns t when it shows a menu and the user rejects it.
9312 unbind_to (count
, Qnil
);
9317 /* read_char returns -1 at the end of a macro.
9318 Emacs 18 handles this by returning immediately with a
9319 zero, so that's what we'll do. */
9320 if (INTEGERP (key
) && XINT (key
) == -1)
9323 /* The Microsoft C compiler can't handle the goto that
9329 /* If the current buffer has been changed from under us, the
9330 keymap may have changed, so replay the sequence. */
9333 timer_resume_idle ();
9336 /* Reset the current buffer from the selected window
9337 in case something changed the former and not the latter.
9338 This is to be more consistent with the behavior
9339 of the command_loop_1. */
9340 if (fix_current_buffer
)
9342 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9344 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9345 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9348 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9349 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9350 goto replay_sequence
;
9353 /* If we have a quit that was typed in another frame, and
9354 quit_throw_to_read_char switched buffers,
9355 replay to get the right keymap. */
9357 && XINT (key
) == quit_char
9358 && current_buffer
!= starting_buffer
)
9361 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9366 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9367 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9368 goto replay_sequence
;
9373 if (EVENT_HAS_PARAMETERS (key
)
9374 /* Either a `switch-frame' or a `select-window' event. */
9375 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9377 /* If we're at the beginning of a key sequence, and the caller
9378 says it's okay, go ahead and return this event. If we're
9379 in the midst of a key sequence, delay it until the end. */
9380 if (t
> 0 || !can_return_switch_frame
)
9382 delayed_switch_frame
= key
;
9388 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9392 /* Clicks in non-text areas get prefixed by the symbol
9393 in their CHAR-ADDRESS field. For example, a click on
9394 the mode line is prefixed by the symbol `mode-line'.
9396 Furthermore, key sequences beginning with mouse clicks
9397 are read using the keymaps of the buffer clicked on, not
9398 the current buffer. So we may have to switch the buffer
9401 When we turn one event into two events, we must make sure
9402 that neither of the two looks like the original--so that,
9403 if we replay the events, they won't be expanded again.
9404 If not for this, such reexpansion could happen either here
9405 or when user programs play with this-command-keys. */
9406 if (EVENT_HAS_PARAMETERS (key
))
9411 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9412 if (EQ (kind
, Qmouse_click
))
9414 Lisp_Object window
, posn
;
9416 window
= POSN_WINDOW (EVENT_START (key
));
9417 posn
= POSN_POSN (EVENT_START (key
));
9420 || (!NILP (fake_prefixed_keys
)
9421 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9423 /* We're looking a second time at an event for which
9424 we generated a fake prefix key. Set
9425 last_real_key_start appropriately. */
9427 last_real_key_start
= t
- 1;
9430 if (last_real_key_start
== 0)
9432 /* Key sequences beginning with mouse clicks are
9433 read using the keymaps in the buffer clicked on,
9434 not the current buffer. If we're at the
9435 beginning of a key sequence, switch buffers. */
9436 if (WINDOWP (window
)
9437 && BUFFERP (XWINDOW (window
)->buffer
)
9438 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9440 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9445 /* Arrange to go back to the original buffer once we're
9446 done reading the key sequence. Note that we can't
9447 use save_excursion_{save,restore} here, because they
9448 save point as well as the current buffer; we don't
9449 want to save point, because redisplay may change it,
9450 to accommodate a Fset_window_start or something. We
9451 don't want to do this at the top of the function,
9452 because we may get input from a subprocess which
9453 wants to change the selected window and stuff (say,
9455 record_unwind_current_buffer ();
9457 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9459 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9460 orig_local_map
= get_local_map (PT
, current_buffer
,
9462 orig_keymap
= get_local_map (PT
, current_buffer
,
9464 goto replay_sequence
;
9467 /* For a mouse click, get the local text-property keymap
9468 of the place clicked on, rather than point. */
9469 if (CONSP (XCDR (key
))
9470 && ! localized_local_map
)
9472 Lisp_Object map_here
, start
, pos
;
9474 localized_local_map
= 1;
9475 start
= EVENT_START (key
);
9477 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9479 pos
= POSN_BUFFER_POSN (start
);
9481 && XINT (pos
) >= BEGV
9482 && XINT (pos
) <= ZV
)
9484 map_here
= get_local_map (XINT (pos
),
9487 if (!EQ (map_here
, orig_local_map
))
9489 orig_local_map
= map_here
;
9490 ++localized_local_map
;
9493 map_here
= get_local_map (XINT (pos
),
9496 if (!EQ (map_here
, orig_keymap
))
9498 orig_keymap
= map_here
;
9499 ++localized_local_map
;
9502 if (localized_local_map
> 1)
9507 goto replay_sequence
;
9514 /* Expand mode-line and scroll-bar events into two events:
9515 use posn as a fake prefix key. */
9517 && (NILP (fake_prefixed_keys
)
9518 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9520 if (bufsize
- t
<= 1)
9521 error ("Key sequence too long");
9524 keybuf
[t
+ 1] = key
;
9527 /* Record that a fake prefix key has been generated
9528 for KEY. Don't modify the event; this would
9529 prevent proper action when the event is pushed
9530 back into unread-command-events. */
9531 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9533 /* If on a mode line string with a local keymap,
9534 reconsider the key sequence with that keymap. */
9535 if (string
= POSN_STRING (EVENT_START (key
)),
9536 (CONSP (string
) && STRINGP (XCAR (string
))))
9538 Lisp_Object pos
, map
, map2
;
9540 pos
= XCDR (string
);
9541 string
= XCAR (string
);
9543 && XINT (pos
) < SCHARS (string
))
9545 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9547 orig_local_map
= map
;
9548 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9551 if (!NILP (map
) || !NILP (map2
))
9552 goto replay_sequence
;
9558 else if (NILP (from_string
)
9559 && (string
= POSN_STRING (EVENT_START (key
)),
9560 (CONSP (string
) && STRINGP (XCAR (string
)))))
9562 /* For a click on a string, i.e. overlay string or a
9563 string displayed via the `display' property,
9564 consider `local-map' and `keymap' properties of
9566 Lisp_Object pos
, map
, map2
;
9568 pos
= XCDR (string
);
9569 string
= XCAR (string
);
9571 && XINT (pos
) < SCHARS (string
))
9573 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9575 orig_local_map
= map
;
9576 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9580 if (!NILP (map
) || !NILP (map2
))
9582 from_string
= string
;
9585 goto replay_sequence
;
9590 else if (CONSP (XCDR (key
))
9591 && CONSP (EVENT_START (key
))
9592 && CONSP (XCDR (EVENT_START (key
))))
9596 posn
= POSN_POSN (EVENT_START (key
));
9597 /* Handle menu-bar events:
9598 insert the dummy prefix event `menu-bar'. */
9599 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9601 if (bufsize
- t
<= 1)
9602 error ("Key sequence too long");
9606 /* Zap the position in key, so we know that we've
9607 expanded it, and don't try to do so again. */
9608 POSN_SET_POSN (EVENT_START (key
),
9609 Fcons (posn
, Qnil
));
9612 goto replay_sequence
;
9614 else if (CONSP (posn
))
9616 /* We're looking at the second event of a
9617 sequence which we expanded before. Set
9618 last_real_key_start appropriately. */
9619 if (last_real_key_start
== t
&& t
> 0)
9620 last_real_key_start
= t
- 1;
9625 /* We have finally decided that KEY is something we might want
9627 first_binding
= (follow_key (key
,
9628 nmaps
- first_binding
,
9629 submaps
+ first_binding
,
9630 defs
+ first_binding
,
9631 submaps
+ first_binding
)
9634 /* If KEY wasn't bound, we'll try some fallbacks. */
9635 if (first_binding
< nmaps
)
9636 /* This is needed for the following scenario:
9637 event 0: a down-event that gets dropped by calling replay_key.
9638 event 1: some normal prefix like C-h.
9639 After event 0, first_unbound is 0, after event 1 indec.start,
9640 fkey.start, and keytran.start are all 1, so when we see that
9641 C-h is bound, we need to update first_unbound. */
9642 first_unbound
= max (t
+ 1, first_unbound
);
9647 /* Remember the position to put an upper bound on indec.start. */
9648 first_unbound
= min (t
, first_unbound
);
9650 head
= EVENT_HEAD (key
);
9651 if (help_char_p (head
) && t
> 0)
9653 read_key_sequence_cmd
= Vprefix_help_command
;
9655 last_nonmenu_event
= key
;
9656 /* The Microsoft C compiler can't handle the goto that
9664 Lisp_Object breakdown
;
9667 breakdown
= parse_modifiers (head
);
9668 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9669 /* Attempt to reduce an unbound mouse event to a simpler
9670 event that is bound:
9671 Drags reduce to clicks.
9672 Double-clicks reduce to clicks.
9673 Triple-clicks reduce to double-clicks, then to clicks.
9674 Down-clicks are eliminated.
9675 Double-downs reduce to downs, then are eliminated.
9676 Triple-downs reduce to double-downs, then to downs,
9677 then are eliminated. */
9678 if (modifiers
& (down_modifier
| drag_modifier
9679 | double_modifier
| triple_modifier
))
9681 while (modifiers
& (down_modifier
| drag_modifier
9682 | double_modifier
| triple_modifier
))
9684 Lisp_Object new_head
, new_click
;
9685 if (modifiers
& triple_modifier
)
9686 modifiers
^= (double_modifier
| triple_modifier
);
9687 else if (modifiers
& double_modifier
)
9688 modifiers
&= ~double_modifier
;
9689 else if (modifiers
& drag_modifier
)
9690 modifiers
&= ~drag_modifier
;
9693 /* Dispose of this `down' event by simply jumping
9694 back to replay_key, to get another event.
9696 Note that if this event came from mock input,
9697 then just jumping back to replay_key will just
9698 hand it to us again. So we have to wipe out any
9701 We could delete keybuf[t] and shift everything
9702 after that to the left by one spot, but we'd also
9703 have to fix up any variable that points into
9704 keybuf, and shifting isn't really necessary
9707 Adding prefixes for non-textual mouse clicks
9708 creates two characters of mock input, and both
9709 must be thrown away. If we're only looking at
9710 the prefix now, we can just jump back to
9711 replay_key. On the other hand, if we've already
9712 processed the prefix, and now the actual click
9713 itself is giving us trouble, then we've lost the
9714 state of the keymaps we want to backtrack to, and
9715 we need to replay the whole sequence to rebuild
9718 Beyond that, only function key expansion could
9719 create more than two keys, but that should never
9720 generate mouse events, so it's okay to zero
9721 mock_input in that case too.
9723 FIXME: The above paragraph seems just plain
9724 wrong, if you consider things like
9725 xterm-mouse-mode. -stef
9727 Isn't this just the most wonderful code ever? */
9729 /* If mock_input > t + 1, the above simplification
9730 will actually end up dropping keys on the floor.
9731 This is probably OK for now, but even
9732 if mock_input <= t + 1, we need to adjust indec,
9734 Typical case [header-line down-mouse-N]:
9735 mock_input = 2, t = 1, fkey.end = 1,
9736 last_real_key_start = 0. */
9737 if (indec
.end
> last_real_key_start
)
9739 indec
.end
= indec
.start
9740 = min (last_real_key_start
, indec
.start
);
9741 indec
.map
= indec
.parent
;
9742 if (fkey
.end
> last_real_key_start
)
9744 fkey
.end
= fkey
.start
9745 = min (last_real_key_start
, fkey
.start
);
9746 fkey
.map
= fkey
.parent
;
9747 if (keytran
.end
> last_real_key_start
)
9749 keytran
.end
= keytran
.start
9750 = min (last_real_key_start
, keytran
.start
);
9751 keytran
.map
= keytran
.parent
;
9755 if (t
== last_real_key_start
)
9762 mock_input
= last_real_key_start
;
9763 goto replay_sequence
;
9768 = apply_modifiers (modifiers
, XCAR (breakdown
));
9770 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9772 /* Look for a binding for this new key. follow_key
9773 promises that it didn't munge submaps the
9774 last time we called it, since key was unbound. */
9776 = (follow_key (new_click
,
9777 nmaps
- local_first_binding
,
9778 submaps
+ local_first_binding
,
9779 defs
+ local_first_binding
,
9780 submaps
+ local_first_binding
)
9781 + local_first_binding
);
9783 /* If that click is bound, go for it. */
9784 if (first_binding
< nmaps
)
9789 /* Otherwise, we'll leave key set to the drag event. */
9796 /* Normally, last_nonmenu_event gets the previous key we read.
9797 But when a mouse popup menu is being used,
9798 we don't update last_nonmenu_event; it continues to hold the mouse
9799 event that preceded the first level of menu. */
9800 if (!used_mouse_menu
)
9801 last_nonmenu_event
= key
;
9803 /* Record what part of this_command_keys is the current key sequence. */
9804 this_single_command_key_start
= this_command_key_count
- t
;
9806 /* Look for this sequence in input-decode-map.
9807 Scan from indec.end until we find a bound suffix. */
9808 while (indec
.end
< t
)
9810 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9814 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9815 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9820 mock_input
= diff
+ max (t
, mock_input
);
9821 goto replay_sequence
;
9825 if (first_binding
< nmaps
9826 && NILP (submaps
[first_binding
])
9827 && !test_undefined (defs
[first_binding
])
9828 && indec
.start
>= t
)
9829 /* There is a binding and it's not a prefix.
9830 (and it doesn't have any input-decode-map translation pending).
9831 There is thus no function-key in this sequence.
9832 Moving fkey.start is important in this case to allow keytran.start
9833 to go over the sequence before we return (since we keep the
9834 invariant that keytran.end <= fkey.start). */
9837 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9840 /* If the sequence is unbound, see if we can hang a function key
9841 off the end of it. */
9842 /* Continue scan from fkey.end until we find a bound suffix. */
9843 while (fkey
.end
< indec
.start
)
9845 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9849 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9850 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9851 max (t
, mock_input
),
9852 /* If there's a binding (i.e.
9853 first_binding >= nmaps) we don't want
9854 to apply this function-key-mapping. */
9856 && (first_binding
>= nmaps
9857 || test_undefined (defs
[first_binding
])),
9862 mock_input
= diff
+ max (t
, mock_input
);
9863 /* Adjust the input-decode-map counters. */
9865 indec
.start
+= diff
;
9867 goto replay_sequence
;
9871 /* Look for this sequence in key-translation-map.
9872 Scan from keytran.end until we find a bound suffix. */
9873 while (keytran
.end
< fkey
.start
)
9875 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9879 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9880 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9885 mock_input
= diff
+ max (t
, mock_input
);
9886 /* Adjust the function-key-map and input-decode-map counters. */
9888 indec
.start
+= diff
;
9892 goto replay_sequence
;
9896 /* If KEY is not defined in any of the keymaps,
9897 and cannot be part of a function key or translation,
9898 and is an upper case letter
9899 use the corresponding lower-case letter instead. */
9900 if (first_binding
>= nmaps
9901 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9903 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9904 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9905 || (XINT (key
) & shift_modifier
)))
9907 Lisp_Object new_key
;
9909 original_uppercase
= key
;
9910 original_uppercase_position
= t
- 1;
9912 if (XINT (key
) & shift_modifier
)
9913 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9915 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9916 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9918 /* We have to do this unconditionally, regardless of whether
9919 the lower-case char is defined in the keymaps, because they
9920 might get translated through function-key-map. */
9921 keybuf
[t
- 1] = new_key
;
9922 mock_input
= max (t
, mock_input
);
9923 shift_translated
= 1;
9925 goto replay_sequence
;
9927 /* If KEY is not defined in any of the keymaps,
9928 and cannot be part of a function key or translation,
9929 and is a shifted function key,
9930 use the corresponding unshifted function key instead. */
9931 if (first_binding
>= nmaps
9932 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9934 Lisp_Object breakdown
= parse_modifiers (key
);
9936 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9938 if (modifiers
& shift_modifier
9939 /* Treat uppercase keys as shifted. */
9941 && (KEY_TO_CHAR (key
)
9942 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9943 && uppercasep (KEY_TO_CHAR (key
))))
9946 = (modifiers
& shift_modifier
9947 ? apply_modifiers (modifiers
& ~shift_modifier
,
9949 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9951 original_uppercase
= key
;
9952 original_uppercase_position
= t
- 1;
9954 /* We have to do this unconditionally, regardless of whether
9955 the lower-case char is defined in the keymaps, because they
9956 might get translated through function-key-map. */
9957 keybuf
[t
- 1] = new_key
;
9958 mock_input
= max (t
, mock_input
);
9959 /* Reset fkey (and consequently keytran) to apply
9960 function-key-map on the result, so that S-backspace is
9961 correctly mapped to DEL (via backspace). OTOH,
9962 input-decode-map doesn't need to go through it again. */
9963 fkey
.start
= fkey
.end
= 0;
9964 keytran
.start
= keytran
.end
= 0;
9965 shift_translated
= 1;
9967 goto replay_sequence
;
9972 read_key_sequence_cmd
= (first_binding
< nmaps
9973 ? defs
[first_binding
]
9975 read_key_sequence_remapped
9976 /* Remap command through active keymaps.
9977 Do the remapping here, before the unbind_to so it uses the keymaps
9978 of the appropriate buffer. */
9979 = SYMBOLP (read_key_sequence_cmd
)
9980 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9983 unread_switch_frame
= delayed_switch_frame
;
9984 unbind_to (count
, Qnil
);
9986 /* Don't downcase the last character if the caller says don't.
9987 Don't downcase it if the result is undefined, either. */
9988 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9990 && t
- 1 == original_uppercase_position
)
9992 keybuf
[t
- 1] = original_uppercase
;
9993 shift_translated
= 0;
9996 if (shift_translated
)
9997 Vthis_command_keys_shift_translated
= Qt
;
9999 /* Occasionally we fabricate events, perhaps by expanding something
10000 according to function-key-map, or by adding a prefix symbol to a
10001 mouse click in the scroll bar or modeline. In this cases, return
10002 the entire generated key sequence, even if we hit an unbound
10003 prefix or a definition before the end. This means that you will
10004 be able to push back the event properly, and also means that
10005 read-key-sequence will always return a logical unit.
10008 for (; t
< mock_input
; t
++)
10010 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10011 && NILP (Fzerop (Vecho_keystrokes
)))
10012 echo_char (keybuf
[t
]);
10013 add_command_key (keybuf
[t
]);
10020 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10021 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10022 The sequence is sufficient to specify a non-prefix command in the
10023 current local and global maps.
10025 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10026 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10027 as a continuation of the previous key.
10029 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10030 convert the last event to lower case. (Normally any upper case event
10031 is converted to lower case if the original event is undefined and the lower
10032 case equivalent is defined.) A non-nil value is appropriate for reading
10033 a key sequence to be defined.
10035 A C-g typed while in this function is treated like any other character,
10036 and `quit-flag' is not set.
10038 If the key sequence starts with a mouse click, then the sequence is read
10039 using the keymaps of the buffer of the window clicked in, not the buffer
10040 of the selected window as normal.
10042 `read-key-sequence' drops unbound button-down events, since you normally
10043 only care about the click or drag events which follow them. If a drag
10044 or multi-click event is unbound, but the corresponding click event would
10045 be bound, `read-key-sequence' turns the event into a click event at the
10046 drag's starting position. This means that you don't have to distinguish
10047 between click and drag, double, or triple events unless you want to.
10049 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10050 lines separating windows, and scroll bars with imaginary keys
10051 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10053 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10054 function will process a switch-frame event if the user switches frames
10055 before typing anything. If the user switches frames in the middle of a
10056 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10057 is nil, then the event will be put off until after the current key sequence.
10059 `read-key-sequence' checks `function-key-map' for function key
10060 sequences, where they wouldn't conflict with ordinary bindings. See
10061 `function-key-map' for more details.
10063 The optional fifth argument CMD-LOOP, if non-nil, means
10064 that this key sequence is being read by something that will
10065 read commands one after another. It should be nil if the caller
10066 will read just one key sequence. */)
10067 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10069 Lisp_Object keybuf
[30];
10071 struct gcpro gcpro1
;
10072 ptrdiff_t count
= SPECPDL_INDEX ();
10074 if (!NILP (prompt
))
10075 CHECK_STRING (prompt
);
10078 specbind (Qinput_method_exit_on_first_char
,
10079 (NILP (cmd_loop
) ? Qt
: Qnil
));
10080 specbind (Qinput_method_use_echo_area
,
10081 (NILP (cmd_loop
) ? Qt
: Qnil
));
10083 memset (keybuf
, 0, sizeof keybuf
);
10084 GCPRO1 (keybuf
[0]);
10085 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10087 if (NILP (continue_echo
))
10089 this_command_key_count
= 0;
10090 this_command_key_count_reset
= 0;
10091 this_single_command_key_start
= 0;
10094 #ifdef HAVE_WINDOW_SYSTEM
10095 if (display_hourglass_p
)
10096 cancel_hourglass ();
10099 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10100 prompt
, ! NILP (dont_downcase_last
),
10101 ! NILP (can_return_switch_frame
), 0);
10103 #if 0 /* The following is fine for code reading a key sequence and
10104 then proceeding with a lengthy computation, but it's not good
10105 for code reading keys in a loop, like an input method. */
10106 #ifdef HAVE_WINDOW_SYSTEM
10107 if (display_hourglass_p
)
10108 start_hourglass ();
10118 return unbind_to (count
, make_event_array (i
, keybuf
));
10121 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10122 Sread_key_sequence_vector
, 1, 5, 0,
10123 doc
: /* Like `read-key-sequence' but always return a vector. */)
10124 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10126 Lisp_Object keybuf
[30];
10128 struct gcpro gcpro1
;
10129 ptrdiff_t count
= SPECPDL_INDEX ();
10131 if (!NILP (prompt
))
10132 CHECK_STRING (prompt
);
10135 specbind (Qinput_method_exit_on_first_char
,
10136 (NILP (cmd_loop
) ? Qt
: Qnil
));
10137 specbind (Qinput_method_use_echo_area
,
10138 (NILP (cmd_loop
) ? Qt
: Qnil
));
10140 memset (keybuf
, 0, sizeof keybuf
);
10141 GCPRO1 (keybuf
[0]);
10142 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10144 if (NILP (continue_echo
))
10146 this_command_key_count
= 0;
10147 this_command_key_count_reset
= 0;
10148 this_single_command_key_start
= 0;
10151 #ifdef HAVE_WINDOW_SYSTEM
10152 if (display_hourglass_p
)
10153 cancel_hourglass ();
10156 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10157 prompt
, ! NILP (dont_downcase_last
),
10158 ! NILP (can_return_switch_frame
), 0);
10160 #ifdef HAVE_WINDOW_SYSTEM
10161 if (display_hourglass_p
)
10162 start_hourglass ();
10171 return unbind_to (count
, Fvector (i
, keybuf
));
10174 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10175 doc
: /* Execute CMD as an editor command.
10176 CMD must be a symbol that satisfies the `commandp' predicate.
10177 Optional second arg RECORD-FLAG non-nil
10178 means unconditionally put this command in `command-history'.
10179 Otherwise, that is done only if an arg is read using the minibuffer.
10180 The argument KEYS specifies the value to use instead of (this-command-keys)
10181 when reading the arguments; if it is nil, (this-command-keys) is used.
10182 The argument SPECIAL, if non-nil, means that this command is executing
10183 a special event, so ignore the prefix argument and don't clear it. */)
10184 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10186 register Lisp_Object final
;
10187 register Lisp_Object tem
;
10188 Lisp_Object prefixarg
;
10190 debug_on_next_call
= 0;
10192 if (NILP (special
))
10194 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10195 Vcurrent_prefix_arg
= prefixarg
;
10196 kset_prefix_arg (current_kboard
, Qnil
);
10203 tem
= Fget (cmd
, Qdisabled
);
10206 tem
= Fsymbol_value (Qdisabled_command_function
);
10208 return Frun_hooks (1, &Qdisabled_command_function
);
10214 final
= Findirect_function (cmd
, Qnil
);
10216 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10218 struct gcpro gcpro1
, gcpro2
;
10220 GCPRO2 (cmd
, prefixarg
);
10221 Fautoload_do_load (final
, cmd
, Qnil
);
10228 if (STRINGP (final
) || VECTORP (final
))
10230 /* If requested, place the macro in the command history. For
10231 other sorts of commands, call-interactively takes care of
10233 if (!NILP (record_flag
))
10236 = Fcons (Fcons (Qexecute_kbd_macro
,
10237 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10240 /* Don't keep command history around forever. */
10241 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10243 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10245 XSETCDR (tem
, Qnil
);
10249 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10252 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10253 /* Don't call Fcall_interactively directly because we want to make
10254 sure the backtrace has an entry for `call-interactively'.
10255 For the same reason, pass `cmd' rather than `final'. */
10256 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10263 /* Return true if input events are pending. */
10266 detect_input_pending (void)
10268 return input_pending
|| get_input_pending (0);
10271 /* Return true if input events other than mouse movements are
10275 detect_input_pending_ignore_squeezables (void)
10277 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10280 /* Return true if input events are pending, and run any pending timers. */
10283 detect_input_pending_run_timers (bool do_display
)
10285 unsigned old_timers_run
= timers_run
;
10287 if (!input_pending
)
10288 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10290 if (old_timers_run
!= timers_run
&& do_display
)
10292 redisplay_preserve_echo_area (8);
10293 /* The following fixes a bug when using lazy-lock with
10294 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10295 from an idle timer function. The symptom of the bug is that
10296 the cursor sometimes doesn't become visible until the next X
10297 event is processed. --gerd. */
10299 Lisp_Object tail
, frame
;
10300 FOR_EACH_FRAME (tail
, frame
)
10301 if (FRAME_RIF (XFRAME (frame
)))
10302 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10306 return input_pending
;
10309 /* This is called in some cases before a possible quit.
10310 It cases the next call to detect_input_pending to recompute input_pending.
10311 So calling this function unnecessarily can't do any harm. */
10314 clear_input_pending (void)
10319 /* Return true if there are pending requeued events.
10320 This isn't used yet. The hope is to make wait_reading_process_output
10321 call it, and return if it runs Lisp code that unreads something.
10322 The problem is, kbd_buffer_get_event needs to be fixed to know what
10323 to do in that case. It isn't trivial. */
10326 requeued_events_pending_p (void)
10328 return (!NILP (Vunread_command_events
));
10332 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10333 doc
: /* Return t if command input is currently available with no wait.
10334 Actually, the value is nil only if we can be sure that no input is available;
10335 if there is a doubt, the value is t. */)
10338 if (!NILP (Vunread_command_events
)
10339 || !NILP (Vunread_post_input_method_events
)
10340 || !NILP (Vunread_input_method_events
))
10343 /* Process non-user-visible events (Bug#10195). */
10344 process_special_events ();
10346 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10347 | READABLE_EVENTS_FILTER_EVENTS
)
10351 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10352 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10355 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10358 if (total_keys
< NUM_RECENT_KEYS
)
10359 return Fvector (total_keys
, keys
);
10362 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10363 vcopy (val
, 0, keys
+ recent_keys_index
,
10364 NUM_RECENT_KEYS
- recent_keys_index
);
10365 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10366 keys
, recent_keys_index
);
10371 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10372 doc
: /* Return the key sequence that invoked this command.
10373 However, if the command has called `read-key-sequence', it returns
10374 the last key sequence that has been read.
10375 The value is a string or a vector.
10377 See also `this-command-keys-vector'. */)
10380 return make_event_array (this_command_key_count
,
10381 XVECTOR (this_command_keys
)->contents
);
10384 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10385 doc
: /* Return the key sequence that invoked this command, as a vector.
10386 However, if the command has called `read-key-sequence', it returns
10387 the last key sequence that has been read.
10389 See also `this-command-keys'. */)
10392 return Fvector (this_command_key_count
,
10393 XVECTOR (this_command_keys
)->contents
);
10396 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10397 Sthis_single_command_keys
, 0, 0, 0,
10398 doc
: /* Return the key sequence that invoked this command.
10399 More generally, it returns the last key sequence read, either by
10400 the command loop or by `read-key-sequence'.
10401 Unlike `this-command-keys', this function's value
10402 does not include prefix arguments.
10403 The value is always a vector. */)
10406 return Fvector (this_command_key_count
10407 - this_single_command_key_start
,
10408 (XVECTOR (this_command_keys
)->contents
10409 + this_single_command_key_start
));
10412 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10413 Sthis_single_command_raw_keys
, 0, 0, 0,
10414 doc
: /* Return the raw events that were read for this command.
10415 More generally, it returns the last key sequence read, either by
10416 the command loop or by `read-key-sequence'.
10417 Unlike `this-single-command-keys', this function's value
10418 shows the events before all translations (except for input methods).
10419 The value is always a vector. */)
10422 return Fvector (raw_keybuf_count
,
10423 (XVECTOR (raw_keybuf
)->contents
));
10426 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10427 Sreset_this_command_lengths
, 0, 0, 0,
10428 doc
: /* Make the unread events replace the last command and echo.
10429 Used in `universal-argument-other-key'.
10431 `universal-argument-other-key' rereads the event just typed.
10432 It then gets translated through `function-key-map'.
10433 The translated event has to replace the real events,
10434 both in the value of (this-command-keys) and in echoing.
10435 To achieve this, `universal-argument-other-key' calls
10436 `reset-this-command-lengths', which discards the record of reading
10437 these events the first time. */)
10440 this_command_key_count
= before_command_key_count
;
10441 if (this_command_key_count
< this_single_command_key_start
)
10442 this_single_command_key_start
= this_command_key_count
;
10444 echo_truncate (before_command_echo_length
);
10446 /* Cause whatever we put into unread-command-events
10447 to echo as if it were being freshly read from the keyboard. */
10448 this_command_key_count_reset
= 1;
10453 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10454 Sclear_this_command_keys
, 0, 1, 0,
10455 doc
: /* Clear out the vector that `this-command-keys' returns.
10456 Also clear the record of the last 100 events, unless optional arg
10457 KEEP-RECORD is non-nil. */)
10458 (Lisp_Object keep_record
)
10462 this_command_key_count
= 0;
10463 this_command_key_count_reset
= 0;
10465 if (NILP (keep_record
))
10467 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10468 ASET (recent_keys
, i
, Qnil
);
10470 recent_keys_index
= 0;
10475 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10476 doc
: /* Return the current depth in recursive edits. */)
10480 /* Wrap around reliably on integer overflow. */
10481 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10482 XSETINT (temp
, sum
);
10486 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10487 "FOpen dribble file: ",
10488 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10489 If FILE is nil, close any open dribble file.
10490 The file will be closed when Emacs exits. */)
10502 file
= Fexpand_file_name (file
, Qnil
);
10503 dribble
= fopen (SSDATA (file
), "w");
10505 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10510 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10511 doc
: /* Discard the contents of the terminal input buffer.
10512 Also end any kbd macro being defined. */)
10515 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10517 /* Discard the last command from the macro. */
10518 Fcancel_kbd_macro_events ();
10522 update_mode_lines
++;
10524 Vunread_command_events
= Qnil
;
10526 discard_tty_input ();
10528 kbd_fetch_ptr
= kbd_store_ptr
;
10534 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10535 doc
: /* Stop Emacs and return to superior process. You can resume later.
10536 If `cannot-suspend' is non-nil, or if the system doesn't support job
10537 control, run a subshell instead.
10539 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10540 to be read as terminal input by Emacs's parent, after suspension.
10542 Before suspending, run the normal hook `suspend-hook'.
10543 After resumption run the normal hook `suspend-resume-hook'.
10545 Some operating systems cannot stop the Emacs process and resume it later.
10546 On such systems, Emacs starts a subshell instead of suspending. */)
10547 (Lisp_Object stuffstring
)
10549 ptrdiff_t count
= SPECPDL_INDEX ();
10550 int old_height
, old_width
;
10552 struct gcpro gcpro1
;
10555 if (tty_list
&& tty_list
->next
)
10556 error ("There are other tty frames open; close them before suspending Emacs");
10558 if (!NILP (stuffstring
))
10559 CHECK_STRING (stuffstring
);
10561 /* Run the functions in suspend-hook. */
10562 hook
= intern ("suspend-hook");
10563 Frun_hooks (1, &hook
);
10565 GCPRO1 (stuffstring
);
10566 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10567 reset_all_sys_modes ();
10568 /* sys_suspend can get an error if it tries to fork a subshell
10569 and the system resources aren't available for that. */
10570 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10572 stuff_buffered_input (stuffstring
);
10573 if (cannot_suspend
)
10577 unbind_to (count
, Qnil
);
10579 /* Check if terminal/window size has changed.
10580 Note that this is not useful when we are running directly
10581 with a window system; but suspend should be disabled in that case. */
10582 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10583 if (width
!= old_width
|| height
!= old_height
)
10584 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10586 /* Run suspend-resume-hook. */
10587 hook
= intern ("suspend-resume-hook");
10588 Frun_hooks (1, &hook
);
10594 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10595 Then in any case stuff anything Emacs has read ahead and not used. */
10598 stuff_buffered_input (Lisp_Object stuffstring
)
10600 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10601 register unsigned char *p
;
10603 if (STRINGP (stuffstring
))
10605 register ptrdiff_t count
;
10607 p
= SDATA (stuffstring
);
10608 count
= SBYTES (stuffstring
);
10609 while (count
-- > 0)
10614 /* Anything we have read ahead, put back for the shell to read. */
10615 /* ?? What should this do when we have multiple keyboards??
10616 Should we ignore anything that was typed in at the "wrong" kboard?
10618 rms: we should stuff everything back into the kboard
10620 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10623 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10624 kbd_fetch_ptr
= kbd_buffer
;
10625 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10626 stuff_char (kbd_fetch_ptr
->code
);
10628 clear_event (kbd_fetch_ptr
);
10632 #endif /* SIGTSTP */
10636 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10638 input_available_clear_time
= time_to_clear
;
10640 /* Tell handle_interrupt to throw back to read_char, */
10641 waiting_for_input
= 1;
10643 /* If handle_interrupt was called before and buffered a C-g,
10644 make it run again now, to avoid timing error. */
10645 if (!NILP (Vquit_flag
))
10646 quit_throw_to_read_char (0);
10650 clear_waiting_for_input (void)
10652 /* Tell handle_interrupt not to throw back to read_char, */
10653 waiting_for_input
= 0;
10654 input_available_clear_time
= 0;
10657 /* The SIGINT handler.
10659 If we have a frame on the controlling tty, we assume that the
10660 SIGINT was generated by C-g, so we call handle_interrupt.
10661 Otherwise, tell QUIT to kill Emacs. */
10664 handle_interrupt_signal (int sig
)
10666 /* See if we have an active terminal on our controlling tty. */
10667 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10670 /* If there are no frames there, let's pretend that we are a
10671 well-behaving UN*X program and quit. We must not call Lisp
10672 in a signal handler, so tell QUIT to exit when it is
10674 Vquit_flag
= Qkill_emacs
;
10678 /* Otherwise, the SIGINT was probably generated by C-g. */
10680 /* Set internal_last_event_frame to the top frame of the
10681 controlling tty, if we have a frame there. We disable the
10682 interrupt key on secondary ttys, so the SIGINT must have come
10683 from the controlling tty. */
10684 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10686 handle_interrupt (1);
10691 deliver_interrupt_signal (int sig
)
10693 deliver_process_signal (sig
, handle_interrupt_signal
);
10697 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10698 of the number of times C-g has been requested. If C-g is pressed
10699 enough times, then quit anyway. See bug#6585. */
10700 static int volatile force_quit_count
;
10702 /* This routine is called at interrupt level in response to C-g.
10704 It is called from the SIGINT handler or kbd_buffer_store_event.
10706 If `waiting_for_input' is non zero, then unless `echoing' is
10707 nonzero, immediately throw back to read_char.
10709 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10710 eval to throw, when it gets a chance. If quit-flag is already
10711 non-nil, it stops the job right away. */
10714 handle_interrupt (bool in_signal_handler
)
10720 /* XXX This code needs to be revised for multi-tty support. */
10721 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10723 if (! in_signal_handler
)
10725 /* If SIGINT isn't blocked, don't let us be interrupted by
10726 a SIGINT. It might be harmful due to non-reentrancy
10727 in I/O functions. */
10729 sigemptyset (&blocked
);
10730 sigaddset (&blocked
, SIGINT
);
10731 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10735 reset_all_sys_modes ();
10737 #ifdef SIGTSTP /* Support possible in later USG versions */
10739 * On systems which can suspend the current process and return to the original
10740 * shell, this command causes the user to end up back at the shell.
10741 * The "Auto-save" and "Abort" questions are not asked until
10742 * the user elects to return to emacs, at which point he can save the current
10743 * job and either dump core or continue.
10747 /* Perhaps should really fork an inferior shell?
10748 But that would not provide any way to get back
10749 to the original shell, ever. */
10750 printf ("No support for stopping a process on this operating system;\n");
10751 printf ("you can continue or abort.\n");
10752 #endif /* not SIGTSTP */
10754 /* We must remain inside the screen area when the internal terminal
10755 is used. Note that [Enter] is not echoed by dos. */
10756 cursor_to (SELECTED_FRAME (), 0, 0);
10758 /* It doesn't work to autosave while GC is in progress;
10759 the code used for auto-saving doesn't cope with the mark bit. */
10760 if (!gc_in_progress
)
10762 printf ("Auto-save? (y or n) ");
10764 if (((c
= getchar ()) & ~040) == 'Y')
10766 Fdo_auto_save (Qt
, Qnil
);
10768 printf ("\r\nAuto-save done");
10769 #else /* not MSDOS */
10770 printf ("Auto-save done\n");
10771 #endif /* not MSDOS */
10773 while (c
!= '\n') c
= getchar ();
10777 /* During GC, it must be safe to reenable quitting again. */
10778 Vinhibit_quit
= Qnil
;
10781 #endif /* not MSDOS */
10782 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10783 printf ("but will instead do a real quit after garbage collection ends\r\n");
10788 printf ("\r\nAbort? (y or n) ");
10789 #else /* not MSDOS */
10790 printf ("Abort (and dump core)? (y or n) ");
10791 #endif /* not MSDOS */
10793 if (((c
= getchar ()) & ~040) == 'Y')
10795 while (c
!= '\n') c
= getchar ();
10797 printf ("\r\nContinuing...\r\n");
10798 #else /* not MSDOS */
10799 printf ("Continuing...\n");
10800 #endif /* not MSDOS */
10802 init_all_sys_modes ();
10806 /* If executing a function that wants to be interrupted out of
10807 and the user has not deferred quitting by binding `inhibit-quit'
10808 then quit right away. */
10809 if (immediate_quit
&& NILP (Vinhibit_quit
))
10811 struct gl_state_s saved
;
10812 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10814 immediate_quit
= 0;
10815 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10817 GCPRO4 (saved
.object
, saved
.global_code
,
10818 saved
.current_syntax_table
, saved
.old_prop
);
10819 Fsignal (Qquit
, Qnil
);
10824 { /* Else request quit when it's safe. */
10825 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10826 force_quit_count
= count
;
10829 immediate_quit
= 1;
10830 Vinhibit_quit
= Qnil
;
10836 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10838 /* TODO: The longjmp in this call throws the NS event loop integration off,
10839 and it seems to do fine without this. Probably some attention
10840 needs to be paid to the setting of waiting_for_input in
10841 wait_reading_process_output() under HAVE_NS because of the call
10842 to ns_select there (needed because otherwise events aren't picked up
10843 outside of polling since we don't get SIGIO like X and we don't have a
10844 separate event loop thread like W32. */
10846 if (waiting_for_input
&& !echoing
)
10847 quit_throw_to_read_char (in_signal_handler
);
10851 /* Handle a C-g by making read_char return C-g. */
10854 quit_throw_to_read_char (bool from_signal
)
10856 /* When not called from a signal handler it is safe to call
10858 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10859 Fkill_emacs (Qnil
);
10861 /* Prevent another signal from doing this before we finish. */
10862 clear_waiting_for_input ();
10865 Vunread_command_events
= Qnil
;
10867 if (FRAMEP (internal_last_event_frame
)
10868 && !EQ (internal_last_event_frame
, selected_frame
))
10869 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10872 sys_longjmp (getcjmp
, 1);
10875 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10876 Sset_input_interrupt_mode
, 1, 1, 0,
10877 doc
: /* Set interrupt mode of reading keyboard input.
10878 If INTERRUPT is non-nil, Emacs will use input interrupts;
10879 otherwise Emacs uses CBREAK mode.
10881 See also `current-input-mode'. */)
10882 (Lisp_Object interrupt
)
10884 bool new_interrupt_input
;
10885 #ifdef USABLE_SIGIO
10886 #ifdef HAVE_X_WINDOWS
10887 if (x_display_list
!= NULL
)
10889 /* When using X, don't give the user a real choice,
10890 because we haven't implemented the mechanisms to support it. */
10891 new_interrupt_input
= 1;
10894 #endif /* HAVE_X_WINDOWS */
10895 new_interrupt_input
= !NILP (interrupt
);
10896 #else /* not USABLE_SIGIO */
10897 new_interrupt_input
= 0;
10898 #endif /* not USABLE_SIGIO */
10900 if (new_interrupt_input
!= interrupt_input
)
10902 #ifdef POLL_FOR_INPUT
10906 /* this causes startup screen to be restored and messes with the mouse */
10907 reset_all_sys_modes ();
10908 interrupt_input
= new_interrupt_input
;
10909 init_all_sys_modes ();
10911 interrupt_input
= new_interrupt_input
;
10914 #ifdef POLL_FOR_INPUT
10915 poll_suppress_count
= 1;
10922 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10923 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10924 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10925 C-q in key sequences.
10927 This setting only has an effect on tty terminals and only when
10928 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10930 See also `current-input-mode'. */)
10931 (Lisp_Object flow
, Lisp_Object terminal
)
10933 struct terminal
*t
= get_terminal (terminal
, 1);
10934 struct tty_display_info
*tty
;
10935 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10937 tty
= t
->display_info
.tty
;
10939 if (tty
->flow_control
!= !NILP (flow
))
10942 /* this causes startup screen to be restored and messes with the mouse */
10943 reset_sys_modes (tty
);
10946 tty
->flow_control
= !NILP (flow
);
10949 init_sys_modes (tty
);
10955 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10956 doc
: /* Enable or disable 8-bit input on TERMINAL.
10957 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10958 bit as the Meta modifier.
10960 If META is nil, Emacs will ignore the top bit, on the assumption it is
10963 Otherwise, Emacs will accept and pass through 8-bit input without
10964 specially interpreting the top bit.
10966 This setting only has an effect on tty terminal devices.
10968 Optional parameter TERMINAL specifies the tty terminal device to use.
10969 It may be a terminal object, a frame, or nil for the terminal used by
10970 the currently selected frame.
10972 See also `current-input-mode'. */)
10973 (Lisp_Object meta
, Lisp_Object terminal
)
10975 struct terminal
*t
= get_terminal (terminal
, 1);
10976 struct tty_display_info
*tty
;
10979 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10981 tty
= t
->display_info
.tty
;
10985 else if (EQ (meta
, Qt
))
10990 if (tty
->meta_key
!= new_meta
)
10993 /* this causes startup screen to be restored and messes with the mouse */
10994 reset_sys_modes (tty
);
10997 tty
->meta_key
= new_meta
;
11000 init_sys_modes (tty
);
11006 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11007 doc
: /* Specify character used for quitting.
11008 QUIT must be an ASCII character.
11010 This function only has an effect on the controlling tty of the Emacs
11013 See also `current-input-mode'. */)
11016 struct terminal
*t
= get_named_tty ("/dev/tty");
11017 struct tty_display_info
*tty
;
11018 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11020 tty
= t
->display_info
.tty
;
11022 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11023 error ("QUIT must be an ASCII character");
11026 /* this causes startup screen to be restored and messes with the mouse */
11027 reset_sys_modes (tty
);
11030 /* Don't let this value be out of range. */
11031 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11034 init_sys_modes (tty
);
11040 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11041 doc
: /* Set mode of reading keyboard input.
11042 First arg INTERRUPT non-nil means use input interrupts;
11043 nil means use CBREAK mode.
11044 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11045 (no effect except in CBREAK mode).
11046 Third arg META t means accept 8-bit input (for a Meta key).
11047 META nil means ignore the top bit, on the assumption it is parity.
11048 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11049 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11050 See also `current-input-mode'. */)
11051 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11053 Fset_input_interrupt_mode (interrupt
);
11054 Fset_output_flow_control (flow
, Qnil
);
11055 Fset_input_meta_mode (meta
, Qnil
);
11057 Fset_quit_char (quit
);
11061 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11062 doc
: /* Return information about the way Emacs currently reads keyboard input.
11063 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11064 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11065 nil, Emacs is using CBREAK mode.
11066 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11067 terminal; this does not apply if Emacs uses interrupt-driven input.
11068 META is t if accepting 8-bit input with 8th bit as Meta flag.
11069 META nil means ignoring the top bit, on the assumption it is parity.
11070 META is neither t nor nil if accepting 8-bit input and using
11071 all 8 bits as the character code.
11072 QUIT is the character Emacs currently uses to quit.
11073 The elements of this list correspond to the arguments of
11074 `set-input-mode'. */)
11077 Lisp_Object val
[4];
11078 struct frame
*sf
= XFRAME (selected_frame
);
11080 val
[0] = interrupt_input
? Qt
: Qnil
;
11081 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11083 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11084 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11086 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11093 XSETFASTINT (val
[3], quit_char
);
11095 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11098 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11099 doc
: /* Return position information for pixel coordinates X and Y.
11100 By default, X and Y are relative to text area of the selected window.
11101 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11102 If optional fourth arg WHOLE is non-nil, X is relative to the left
11103 edge of the window.
11105 The return value is similar to a mouse click position:
11106 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11107 IMAGE (DX . DY) (WIDTH . HEIGHT))
11108 The `posn-' functions access elements of such lists. */)
11109 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11114 if (NILP (frame_or_window
))
11115 frame_or_window
= selected_window
;
11117 if (WINDOWP (frame_or_window
))
11119 struct window
*w
= decode_live_window (frame_or_window
);
11121 XSETINT (x
, (XINT (x
)
11122 + WINDOW_LEFT_EDGE_X (w
)
11124 ? window_box_left_offset (w
, TEXT_AREA
)
11126 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11127 frame_or_window
= w
->frame
;
11130 CHECK_LIVE_FRAME (frame_or_window
);
11132 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11135 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11136 doc
: /* Return position information for buffer POS in WINDOW.
11137 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11139 Return nil if position is not visible in window. Otherwise,
11140 the return value is similar to that returned by `event-start' for
11141 a mouse click at the upper left corner of the glyph corresponding
11142 to the given buffer position:
11143 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11144 IMAGE (DX . DY) (WIDTH . HEIGHT))
11145 The `posn-' functions access elements of such lists. */)
11146 (Lisp_Object pos
, Lisp_Object window
)
11151 window
= selected_window
;
11153 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11156 Lisp_Object x
= XCAR (tem
);
11157 Lisp_Object y
= XCAR (XCDR (tem
));
11159 /* Point invisible due to hscrolling? */
11162 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11170 * Set up a new kboard object with reasonable initial values.
11173 init_kboard (KBOARD
*kb
)
11175 kset_overriding_terminal_local_map (kb
, Qnil
);
11176 kset_last_command (kb
, Qnil
);
11177 kset_real_last_command (kb
, Qnil
);
11178 kset_keyboard_translate_table (kb
, Qnil
);
11179 kset_last_repeatable_command (kb
, Qnil
);
11180 kset_prefix_arg (kb
, Qnil
);
11181 kset_last_prefix_arg (kb
, Qnil
);
11182 kset_kbd_queue (kb
, Qnil
);
11183 kb
->kbd_queue_has_data
= 0;
11184 kb
->immediate_echo
= 0;
11185 kset_echo_string (kb
, Qnil
);
11186 kb
->echo_after_prompt
= -1;
11187 kb
->kbd_macro_buffer
= 0;
11188 kb
->kbd_macro_bufsize
= 0;
11189 kset_defining_kbd_macro (kb
, Qnil
);
11190 kset_last_kbd_macro (kb
, Qnil
);
11191 kb
->reference_count
= 0;
11192 kset_system_key_alist (kb
, Qnil
);
11193 kset_system_key_syms (kb
, Qnil
);
11194 kset_window_system (kb
, Qt
); /* Unset. */
11195 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11196 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11197 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11198 kset_default_minibuffer_frame (kb
, Qnil
);
11202 * Destroy the contents of a kboard object, but not the object itself.
11203 * We use this just before deleting it, or if we're going to initialize
11204 * it a second time.
11207 wipe_kboard (KBOARD
*kb
)
11209 xfree (kb
->kbd_macro_buffer
);
11212 /* Free KB and memory referenced from it. */
11215 delete_kboard (KBOARD
*kb
)
11219 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11222 *kbp
= kb
->next_kboard
;
11224 /* Prevent a dangling reference to KB. */
11225 if (kb
== current_kboard
11226 && FRAMEP (selected_frame
)
11227 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11229 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11231 if (current_kboard
== kb
)
11240 init_keyboard (void)
11242 /* This is correct before outermost invocation of the editor loop. */
11243 command_loop_level
= -1;
11244 immediate_quit
= 0;
11245 quit_char
= Ctl ('g');
11246 Vunread_command_events
= Qnil
;
11247 timer_idleness_start_time
= invalid_emacs_time ();
11249 recent_keys_index
= 0;
11250 kbd_fetch_ptr
= kbd_buffer
;
11251 kbd_store_ptr
= kbd_buffer
;
11252 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11253 do_mouse_tracking
= Qnil
;
11256 interrupt_input_blocked
= 0;
11257 pending_signals
= 0;
11259 /* This means that command_loop_1 won't try to select anything the first
11261 internal_last_event_frame
= Qnil
;
11262 Vlast_event_frame
= internal_last_event_frame
;
11264 current_kboard
= initial_kboard
;
11265 /* Re-initialize the keyboard again. */
11266 wipe_kboard (current_kboard
);
11267 init_kboard (current_kboard
);
11268 /* A value of nil for Vwindow_system normally means a tty, but we also use
11269 it for the initial terminal since there is no window system there. */
11270 kset_window_system (current_kboard
, Qnil
);
11272 if (!noninteractive
)
11274 /* Before multi-tty support, these handlers used to be installed
11275 only if the current session was a tty session. Now an Emacs
11276 session may have multiple display types, so we always handle
11277 SIGINT. There is special code in handle_interrupt_signal to exit
11278 Emacs on SIGINT when there are no termcap frames on the
11279 controlling terminal. */
11280 struct sigaction action
;
11281 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11282 sigaction (SIGINT
, &action
, 0);
11284 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11285 SIGQUIT and we can't tell which one it will give us. */
11286 sigaction (SIGQUIT
, &action
, 0);
11287 #endif /* not DOS_NT */
11289 #ifdef USABLE_SIGIO
11290 if (!noninteractive
)
11292 struct sigaction action
;
11293 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11294 sigaction (SIGIO
, &action
, 0);
11298 /* Use interrupt input by default, if it works and noninterrupt input
11299 has deficiencies. */
11301 #ifdef INTERRUPT_INPUT
11302 interrupt_input
= 1;
11304 interrupt_input
= 0;
11307 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11310 if (keyboard_init_hook
)
11311 (*keyboard_init_hook
) ();
11313 #ifdef POLL_FOR_INPUT
11315 poll_suppress_count
= 1;
11320 /* This type's only use is in syms_of_keyboard, to initialize the
11321 event header symbols and put properties on them. */
11322 struct event_head
{
11328 static const struct event_head head_table
[] = {
11329 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11330 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11331 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11332 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11333 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11334 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11335 /* `select-window' should be handled just like `switch-frame'
11336 in read_key_sequence. */
11337 {&Qselect_window
, "select-window", &Qswitch_frame
}
11341 syms_of_keyboard (void)
11343 pending_funcalls
= Qnil
;
11344 staticpro (&pending_funcalls
);
11346 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11347 staticpro (&Vlispy_mouse_stem
);
11350 DEFSYM (QCimage
, ":image");
11351 DEFSYM (Qhelp_echo
, "help-echo");
11352 DEFSYM (QCrtl
, ":rtl");
11354 staticpro (&item_properties
);
11355 item_properties
= Qnil
;
11357 staticpro (&tool_bar_item_properties
);
11358 tool_bar_item_properties
= Qnil
;
11359 staticpro (&tool_bar_items_vector
);
11360 tool_bar_items_vector
= Qnil
;
11362 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11363 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11364 DEFSYM (Qself_insert_command
, "self-insert-command");
11365 DEFSYM (Qforward_char
, "forward-char");
11366 DEFSYM (Qbackward_char
, "backward-char");
11367 DEFSYM (Qdisabled
, "disabled");
11368 DEFSYM (Qundefined
, "undefined");
11369 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11370 DEFSYM (Qpost_command_hook
, "post-command-hook");
11371 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11372 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11373 DEFSYM (Qfunction_key
, "function-key");
11374 DEFSYM (Qmouse_click
, "mouse-click");
11375 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11376 DEFSYM (Qsave_session
, "save-session");
11377 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11378 DEFSYM (Qmenu_enable
, "menu-enable");
11381 DEFSYM (Qlanguage_change
, "language-change");
11385 DEFSYM (Qdbus_event
, "dbus-event");
11388 #ifdef HAVE_XWIDGETS
11389 Qxwidget_event
= intern ("xwidget-event");
11390 staticpro (&Qxwidget_event
);
11392 DEFSYM (QCenable
, ":enable");
11393 DEFSYM (QCvisible
, ":visible");
11394 DEFSYM (QChelp
, ":help");
11395 DEFSYM (QCfilter
, ":filter");
11396 DEFSYM (QCbutton
, ":button");
11397 DEFSYM (QCkeys
, ":keys");
11398 DEFSYM (QCkey_sequence
, ":key-sequence");
11399 DEFSYM (QCtoggle
, ":toggle");
11400 DEFSYM (QCradio
, ":radio");
11401 DEFSYM (QClabel
, ":label");
11402 DEFSYM (QCvert_only
, ":vert-only");
11404 DEFSYM (Qmode_line
, "mode-line");
11405 DEFSYM (Qvertical_line
, "vertical-line");
11406 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11407 DEFSYM (Qmenu_bar
, "menu-bar");
11409 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11410 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11413 DEFSYM (Qabove_handle
, "above-handle");
11414 DEFSYM (Qhandle
, "handle");
11415 DEFSYM (Qbelow_handle
, "below-handle");
11416 DEFSYM (Qup
, "up");
11417 DEFSYM (Qdown
, "down");
11418 DEFSYM (Qtop
, "top");
11419 DEFSYM (Qbottom
, "bottom");
11420 DEFSYM (Qend_scroll
, "end-scroll");
11421 DEFSYM (Qratio
, "ratio");
11423 DEFSYM (Qevent_kind
, "event-kind");
11424 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11425 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11426 DEFSYM (Qmodifier_cache
, "modifier-cache");
11428 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11429 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11431 DEFSYM (Qpolling_period
, "polling-period");
11433 DEFSYM (Qx_set_selection
, "x-set-selection");
11434 DEFSYM (QPRIMARY
, "PRIMARY");
11435 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11436 DEFSYM (Qhandle_select_window
, "handle-select-window");
11438 DEFSYM (Qinput_method_function
, "input-method-function");
11439 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11440 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11442 DEFSYM (Qhelp_form_show
, "help-form-show");
11444 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11445 Fset (Qinput_method_use_echo_area
, Qnil
);
11447 last_point_position_buffer
= Qnil
;
11448 last_point_position_window
= Qnil
;
11452 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11454 for (i
= 0; i
< len
; i
++)
11456 const struct event_head
*p
= &head_table
[i
];
11457 *p
->var
= intern_c_string (p
->name
);
11458 staticpro (p
->var
);
11459 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11460 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11464 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11465 staticpro (&button_down_location
);
11466 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11467 staticpro (&mouse_syms
);
11468 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11469 / sizeof (lispy_wheel_names
[0])),
11471 staticpro (&wheel_syms
);
11475 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11477 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11478 for (i
= 0; i
< len
; i
++)
11479 if (modifier_names
[i
])
11480 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11481 staticpro (&modifier_symbols
);
11484 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11485 staticpro (&recent_keys
);
11487 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11488 staticpro (&this_command_keys
);
11490 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11491 staticpro (&raw_keybuf
);
11493 DEFSYM (Qextended_command_history
, "extended-command-history");
11494 Fset (Qextended_command_history
, Qnil
);
11496 accent_key_syms
= Qnil
;
11497 staticpro (&accent_key_syms
);
11499 func_key_syms
= Qnil
;
11500 staticpro (&func_key_syms
);
11502 drag_n_drop_syms
= Qnil
;
11503 staticpro (&drag_n_drop_syms
);
11505 unread_switch_frame
= Qnil
;
11506 staticpro (&unread_switch_frame
);
11508 internal_last_event_frame
= Qnil
;
11509 staticpro (&internal_last_event_frame
);
11511 read_key_sequence_cmd
= Qnil
;
11512 staticpro (&read_key_sequence_cmd
);
11513 read_key_sequence_remapped
= Qnil
;
11514 staticpro (&read_key_sequence_remapped
);
11516 menu_bar_one_keymap_changed_items
= Qnil
;
11517 staticpro (&menu_bar_one_keymap_changed_items
);
11519 menu_bar_items_vector
= Qnil
;
11520 staticpro (&menu_bar_items_vector
);
11522 help_form_saved_window_configs
= Qnil
;
11523 staticpro (&help_form_saved_window_configs
);
11525 defsubr (&Scurrent_idle_time
);
11526 defsubr (&Sevent_symbol_parse_modifiers
);
11527 defsubr (&Sevent_convert_list
);
11528 defsubr (&Sread_key_sequence
);
11529 defsubr (&Sread_key_sequence_vector
);
11530 defsubr (&Srecursive_edit
);
11531 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11532 defsubr (&Strack_mouse
);
11534 defsubr (&Sinput_pending_p
);
11535 defsubr (&Scommand_execute
);
11536 defsubr (&Srecent_keys
);
11537 defsubr (&Sthis_command_keys
);
11538 defsubr (&Sthis_command_keys_vector
);
11539 defsubr (&Sthis_single_command_keys
);
11540 defsubr (&Sthis_single_command_raw_keys
);
11541 defsubr (&Sreset_this_command_lengths
);
11542 defsubr (&Sclear_this_command_keys
);
11543 defsubr (&Ssuspend_emacs
);
11544 defsubr (&Sabort_recursive_edit
);
11545 defsubr (&Sexit_recursive_edit
);
11546 defsubr (&Srecursion_depth
);
11547 defsubr (&Stop_level
);
11548 defsubr (&Sdiscard_input
);
11549 defsubr (&Sopen_dribble_file
);
11550 defsubr (&Sset_input_interrupt_mode
);
11551 defsubr (&Sset_output_flow_control
);
11552 defsubr (&Sset_input_meta_mode
);
11553 defsubr (&Sset_quit_char
);
11554 defsubr (&Sset_input_mode
);
11555 defsubr (&Scurrent_input_mode
);
11556 defsubr (&Sposn_at_point
);
11557 defsubr (&Sposn_at_x_y
);
11559 DEFVAR_LISP ("last-command-event", last_command_event
,
11560 doc
: /* Last input event that was part of a command. */);
11562 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11563 doc
: /* Last input event in a command, except for mouse menu events.
11564 Mouse menus give back keys that don't look like mouse events;
11565 this variable holds the actual mouse event that led to the menu,
11566 so that you can determine whether the command was run by mouse or not. */);
11568 DEFVAR_LISP ("last-input-event", last_input_event
,
11569 doc
: /* Last input event. */);
11571 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11572 doc
: /* List of events to be read as the command input.
11573 These events are processed first, before actual keyboard input.
11574 Events read from this list are not normally added to `this-command-keys',
11575 as they will already have been added once as they were read for the first time.
11576 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11577 Vunread_command_events
= Qnil
;
11579 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11580 doc
: /* List of events to be processed as input by input methods.
11581 These events are processed before `unread-command-events'
11582 and actual keyboard input, but are not given to `input-method-function'. */);
11583 Vunread_post_input_method_events
= Qnil
;
11585 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11586 doc
: /* List of events to be processed as input by input methods.
11587 These events are processed after `unread-command-events', but
11588 before actual keyboard input.
11589 If there's an active input method, the events are given to
11590 `input-method-function'. */);
11591 Vunread_input_method_events
= Qnil
;
11593 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11594 doc
: /* Meta-prefix character code.
11595 Meta-foo as command input turns into this character followed by foo. */);
11596 XSETINT (meta_prefix_char
, 033);
11598 DEFVAR_KBOARD ("last-command", Vlast_command
,
11599 doc
: /* The last command executed.
11600 Normally a symbol with a function definition, but can be whatever was found
11601 in the keymap, or whatever the variable `this-command' was set to by that
11604 The value `mode-exit' is special; it means that the previous command
11605 read an event that told it to exit, and it did so and unread that event.
11606 In other words, the present command is the event that made the previous
11609 The value `kill-region' is special; it means that the previous command
11610 was a kill command.
11612 `last-command' has a separate binding for each terminal device.
11613 See Info node `(elisp)Multiple Terminals'. */);
11615 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11616 doc
: /* Same as `last-command', but never altered by Lisp code.
11617 Taken from the previous value of `real-this-command'. */);
11619 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11620 doc
: /* Last command that may be repeated.
11621 The last command executed that was not bound to an input event.
11622 This is the command `repeat' will try to repeat.
11623 Taken from a previous value of `real-this-command'. */);
11625 DEFVAR_LISP ("this-command", Vthis_command
,
11626 doc
: /* The command now being executed.
11627 The command can set this variable; whatever is put here
11628 will be in `last-command' during the following command. */);
11629 Vthis_command
= Qnil
;
11631 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11632 doc
: /* This is like `this-command', except that commands should never modify it. */);
11633 Vreal_this_command
= Qnil
;
11635 DEFVAR_LISP ("this-command-keys-shift-translated",
11636 Vthis_command_keys_shift_translated
,
11637 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11638 Shift-translation occurs when there is no binding for the key sequence
11639 as entered, but a binding was found by changing an upper-case letter
11640 to lower-case, or a shifted function key to an unshifted one. */);
11641 Vthis_command_keys_shift_translated
= Qnil
;
11643 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11644 doc
: /* The command bound to the current key sequence before remapping.
11645 It equals `this-command' if the original command was not remapped through
11646 any of the active keymaps. Otherwise, the value of `this-command' is the
11647 result of looking up the original command in the active keymaps. */);
11648 Vthis_original_command
= Qnil
;
11650 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11651 doc
: /* Number of input events between auto-saves.
11652 Zero means disable autosaving due to number of characters typed. */);
11653 auto_save_interval
= 300;
11655 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11656 doc
: /* Number of seconds idle time before auto-save.
11657 Zero or nil means disable auto-saving due to idleness.
11658 After auto-saving due to this many seconds of idle time,
11659 Emacs also does a garbage collection if that seems to be warranted. */);
11660 XSETFASTINT (Vauto_save_timeout
, 30);
11662 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11663 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11664 The value may be integer or floating point.
11665 If the value is zero, don't echo at all. */);
11666 Vecho_keystrokes
= make_number (1);
11668 DEFVAR_INT ("polling-period", polling_period
,
11669 doc
: /* Interval between polling for input during Lisp execution.
11670 The reason for polling is to make C-g work to stop a running program.
11671 Polling is needed only when using X windows and SIGIO does not work.
11672 Polling is automatically disabled in all other cases. */);
11673 polling_period
= 2;
11675 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11676 doc
: /* Maximum time between mouse clicks to make a double-click.
11677 Measured in milliseconds. The value nil means disable double-click
11678 recognition; t means double-clicks have no time limit and are detected
11679 by position only. */);
11680 Vdouble_click_time
= make_number (500);
11682 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11683 doc
: /* Maximum mouse movement between clicks to make a double-click.
11684 On window-system frames, value is the number of pixels the mouse may have
11685 moved horizontally or vertically between two clicks to make a double-click.
11686 On non window-system frames, value is interpreted in units of 1/8 characters
11689 This variable is also the threshold for motion of the mouse
11690 to count as a drag. */);
11691 double_click_fuzz
= 3;
11693 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11694 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11695 inhibit_local_menu_bar_menus
= 0;
11697 DEFVAR_INT ("num-input-keys", num_input_keys
,
11698 doc
: /* Number of complete key sequences read as input so far.
11699 This includes key sequences read from keyboard macros.
11700 The number is effectively the number of interactive command invocations. */);
11701 num_input_keys
= 0;
11703 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11704 doc
: /* Number of input events read from the keyboard so far.
11705 This does not include events generated by keyboard macros. */);
11706 num_nonmacro_input_events
= 0;
11708 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11709 doc
: /* The frame in which the most recently read event occurred.
11710 If the last event came from a keyboard macro, this is set to `macro'. */);
11711 Vlast_event_frame
= Qnil
;
11713 /* This variable is set up in sysdep.c. */
11714 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11715 doc
: /* The ERASE character as set by the user with stty. */);
11717 DEFVAR_LISP ("help-char", Vhelp_char
,
11718 doc
: /* Character to recognize as meaning Help.
11719 When it is read, do `(eval help-form)', and display result if it's a string.
11720 If the value of `help-form' is nil, this char can be read normally. */);
11721 XSETINT (Vhelp_char
, Ctl ('H'));
11723 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11724 doc
: /* List of input events to recognize as meaning Help.
11725 These work just like the value of `help-char' (see that). */);
11726 Vhelp_event_list
= Qnil
;
11728 DEFVAR_LISP ("help-form", Vhelp_form
,
11729 doc
: /* Form to execute when character `help-char' is read.
11730 If the form returns a string, that string is displayed.
11731 If `help-form' is nil, the help char is not recognized. */);
11734 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11735 doc
: /* Command to run when `help-char' character follows a prefix key.
11736 This command is used only when there is no actual binding
11737 for that character after that prefix key. */);
11738 Vprefix_help_command
= Qnil
;
11740 DEFVAR_LISP ("top-level", Vtop_level
,
11741 doc
: /* Form to evaluate when Emacs starts up.
11742 Useful to set before you dump a modified Emacs. */);
11745 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11746 doc
: /* Translate table for local keyboard input, or nil.
11747 If non-nil, the value should be a char-table. Each character read
11748 from the keyboard is looked up in this char-table. If the value found
11749 there is non-nil, then it is used instead of the actual input character.
11751 The value can also be a string or vector, but this is considered obsolete.
11752 If it is a string or vector of length N, character codes N and up are left
11753 untranslated. In a vector, an element which is nil means "no translation".
11755 This is applied to the characters supplied to input methods, not their
11756 output. See also `translation-table-for-input'.
11758 This variable has a separate binding for each terminal.
11759 See Info node `(elisp)Multiple Terminals'. */);
11761 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11762 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11763 \(Even if the operating system has support for stopping a process.\) */);
11764 cannot_suspend
= 0;
11766 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11767 doc
: /* Non-nil means prompt with menus when appropriate.
11768 This is done when reading from a keymap that has a prompt string,
11769 for elements that have prompt strings.
11770 The menu is displayed on the screen
11771 if X menus were enabled at configuration
11772 time and the previous event was a mouse click prefix key.
11773 Otherwise, menu prompting uses the echo area. */);
11774 menu_prompting
= 1;
11776 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11777 doc
: /* Character to see next line of menu prompt.
11778 Type this character while in a menu prompt to rotate around the lines of it. */);
11779 XSETINT (menu_prompt_more_char
, ' ');
11781 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11782 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11783 Emacs applies the modifiers of the character stored here to each keyboard
11784 character it reads. For example, after evaluating the expression
11785 (setq extra-keyboard-modifiers ?\\C-x)
11786 all input characters will have the control modifier applied to them.
11788 Note that the character ?\\C-@, equivalent to the integer zero, does
11789 not count as a control character; rather, it counts as a character
11790 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11791 cancels any modification. */);
11792 extra_keyboard_modifiers
= 0;
11794 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11795 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11796 The command loop sets this to nil before each command,
11797 and tests the value when the command returns.
11798 Buffer modification stores t in this variable. */);
11799 Vdeactivate_mark
= Qnil
;
11800 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11802 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11803 doc
: /* Normal hook run before each command is executed.
11804 If an unhandled error happens in running this hook,
11805 the function in which the error occurred is unconditionally removed, since
11806 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11807 Vpre_command_hook
= Qnil
;
11809 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11810 doc
: /* Normal hook run after each command is executed.
11811 If an unhandled error happens in running this hook,
11812 the function in which the error occurred is unconditionally removed, since
11813 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11814 Vpost_command_hook
= Qnil
;
11817 DEFVAR_LISP ("echo-area-clear-hook", ...,
11818 doc
: /* Normal hook run when clearing the echo area. */);
11820 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11821 Fset (Qecho_area_clear_hook
, Qnil
);
11823 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11824 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11825 Vlucid_menu_bar_dirty_flag
= Qnil
;
11827 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11828 doc
: /* List of menu bar items to move to the end of the menu bar.
11829 The elements of the list are event types that may have menu bar bindings. */);
11830 Vmenu_bar_final_items
= Qnil
;
11832 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11833 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11834 This is used internally by graphical displays that do not render
11835 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11836 Vtool_bar_separator_image_expression
= Qnil
;
11838 DEFVAR_KBOARD ("overriding-terminal-local-map",
11839 Voverriding_terminal_local_map
,
11840 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11841 If this variable is non-nil, it is used as a keymap instead of the
11842 buffer's local map, and the minor mode keymaps and text property keymaps.
11843 It also replaces `overriding-local-map'.
11845 This variable is intended to let commands such as `universal-argument'
11846 set up a different keymap for reading the next command.
11848 `overriding-terminal-local-map' has a separate binding for each
11850 See Info node `(elisp)Multiple Terminals'. */);
11852 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11853 doc
: /* Keymap that overrides all other local keymaps.
11854 If this variable is non-nil, it is used as a keymap--replacing the
11855 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11856 Voverriding_local_map
= Qnil
;
11858 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11859 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11860 Otherwise, the menu bar continues to reflect the buffer's local map
11861 and the minor mode maps regardless of `overriding-local-map'. */);
11862 Voverriding_local_map_menu_flag
= Qnil
;
11864 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11865 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11866 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11868 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11869 doc
: /* Non-nil means generate motion events for mouse motion. */);
11871 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11872 doc
: /* Alist of system-specific X windows key symbols.
11873 Each element should have the form (N . SYMBOL) where N is the
11874 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11875 and SYMBOL is its name.
11877 `system-key-alist' has a separate binding for each terminal device.
11878 See Info node `(elisp)Multiple Terminals'. */);
11880 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11881 doc
: /* Keymap that translates key sequences to key sequences during input.
11882 This is used mainly for mapping key sequences into some preferred
11883 key events (symbols).
11885 The `read-key-sequence' function replaces any subsequence bound by
11886 `local-function-key-map' with its binding. More precisely, when the
11887 active keymaps have no binding for the current key sequence but
11888 `local-function-key-map' binds a suffix of the sequence to a vector or
11889 string, `read-key-sequence' replaces the matching suffix with its
11890 binding, and continues with the new sequence.
11892 If the binding is a function, it is called with one argument (the prompt)
11893 and its return value (a key sequence) is used.
11895 The events that come from bindings in `local-function-key-map' are not
11896 themselves looked up in `local-function-key-map'.
11898 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11899 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11900 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11901 typing `ESC O P x' would return [f1 x].
11903 `local-function-key-map' has a separate binding for each terminal
11904 device. See Info node `(elisp)Multiple Terminals'. If you need to
11905 define a binding on all terminals, change `function-key-map'
11906 instead. Initially, `local-function-key-map' is an empty keymap that
11907 has `function-key-map' as its parent on all terminal devices. */);
11909 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11910 doc
: /* Keymap that decodes input escape sequences.
11911 This is used mainly for mapping ASCII function key sequences into
11912 real Emacs function key events (symbols).
11914 The `read-key-sequence' function replaces any subsequence bound by
11915 `input-decode-map' with its binding. Contrary to `function-key-map',
11916 this map applies its rebinding regardless of the presence of an ordinary
11917 binding. So it is more like `key-translation-map' except that it applies
11918 before `function-key-map' rather than after.
11920 If the binding is a function, it is called with one argument (the prompt)
11921 and its return value (a key sequence) is used.
11923 The events that come from bindings in `input-decode-map' are not
11924 themselves looked up in `input-decode-map'.
11926 This variable is keyboard-local. */);
11928 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11929 doc
: /* The parent keymap of all `local-function-key-map' instances.
11930 Function key definitions that apply to all terminal devices should go
11931 here. If a mapping is defined in both the current
11932 `local-function-key-map' binding and this variable, then the local
11933 definition will take precedence. */);
11934 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11936 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11937 doc
: /* Keymap of key translations that can override keymaps.
11938 This keymap works like `function-key-map', but comes after that,
11939 and its non-prefix bindings override ordinary bindings.
11940 Another difference is that it is global rather than keyboard-local. */);
11941 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11943 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11944 doc
: /* List of deferred actions to be performed at a later time.
11945 The precise format isn't relevant here; we just check whether it is nil. */);
11946 Vdeferred_action_list
= Qnil
;
11948 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11949 doc
: /* Function to call to handle deferred actions, after each command.
11950 This function is called with no arguments after each command
11951 whenever `deferred-action-list' is non-nil. */);
11952 Vdeferred_action_function
= Qnil
;
11954 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11955 doc
: /* List of warnings to be displayed after this command.
11956 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11957 as per the args of `display-warning' (which see).
11958 If this variable is non-nil, `delayed-warnings-hook' will be run
11959 immediately after running `post-command-hook'. */);
11960 Vdelayed_warnings_list
= Qnil
;
11962 DEFVAR_LISP ("timer-list", Vtimer_list
,
11963 doc
: /* List of active absolute time timers in order of increasing time. */);
11964 Vtimer_list
= Qnil
;
11966 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11967 doc
: /* List of active idle-time timers in order of increasing time. */);
11968 Vtimer_idle_list
= Qnil
;
11970 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11971 doc
: /* If non-nil, the function that implements the current input method.
11972 It's called with one argument, a printing character that was just read.
11973 \(That means a character with code 040...0176.)
11974 Typically this function uses `read-event' to read additional events.
11975 When it does so, it should first bind `input-method-function' to nil
11976 so it will not be called recursively.
11978 The function should return a list of zero or more events
11979 to be used as input. If it wants to put back some events
11980 to be reconsidered, separately, by the input method,
11981 it can add them to the beginning of `unread-command-events'.
11983 The input method function can find in `input-method-previous-message'
11984 the previous echo area message.
11986 The input method function should refer to the variables
11987 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11988 for guidance on what to do. */);
11989 Vinput_method_function
= Qnil
;
11991 DEFVAR_LISP ("input-method-previous-message",
11992 Vinput_method_previous_message
,
11993 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11994 This variable exists because `read-event' clears the echo area
11995 before running the input method. It is nil if there was no message. */);
11996 Vinput_method_previous_message
= Qnil
;
11998 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11999 doc
: /* If non-nil, the function that implements the display of help.
12000 It's called with one argument, the help string to display. */);
12001 Vshow_help_function
= Qnil
;
12003 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12004 doc
: /* If non-nil, suppress point adjustment after executing a command.
12006 After a command is executed, if point is moved into a region that has
12007 special properties (e.g. composition, display), we adjust point to
12008 the boundary of the region. But, when a command sets this variable to
12009 non-nil, we suppress the point adjustment.
12011 This variable is set to nil before reading a command, and is checked
12012 just after executing the command. */);
12013 Vdisable_point_adjustment
= Qnil
;
12015 DEFVAR_LISP ("global-disable-point-adjustment",
12016 Vglobal_disable_point_adjustment
,
12017 doc
: /* If non-nil, always suppress point adjustment.
12019 The default value is nil, in which case, point adjustment are
12020 suppressed only after special commands that set
12021 `disable-point-adjustment' (which see) to non-nil. */);
12022 Vglobal_disable_point_adjustment
= Qnil
;
12024 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12025 doc
: /* How long to display an echo-area message when the minibuffer is active.
12026 If the value is not a number, such messages don't time out. */);
12027 Vminibuffer_message_timeout
= make_number (2);
12029 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12030 doc
: /* If non-nil, any keyboard input throws to this symbol.
12031 The value of that variable is passed to `quit-flag' and later causes a
12032 peculiar kind of quitting. */);
12033 Vthrow_on_input
= Qnil
;
12035 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12036 doc
: /* If non-nil, function to output error messages.
12037 The arguments are the error data, a list of the form
12038 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12039 such as just as `condition-case' would bind its variable to,
12040 the context (a string which normally goes at the start of the message),
12041 and the Lisp function within which the error was signaled. */);
12042 Vcommand_error_function
= Qnil
;
12044 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12045 Venable_disabled_menus_and_buttons
,
12046 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12048 Help functions bind this to allow help on disabled menu items
12049 and tool-bar buttons. */);
12050 Venable_disabled_menus_and_buttons
= Qnil
;
12052 DEFVAR_LISP ("select-active-regions",
12053 Vselect_active_regions
,
12054 doc
: /* If non-nil, an active region automatically sets the primary selection.
12055 If the value is `only', only temporarily active regions (usually made
12056 by mouse-dragging or shift-selection) set the window selection.
12058 This takes effect only when Transient Mark mode is enabled. */);
12059 Vselect_active_regions
= Qt
;
12061 DEFVAR_LISP ("saved-region-selection",
12062 Vsaved_region_selection
,
12063 doc
: /* Contents of active region prior to buffer modification.
12064 If `select-active-regions' is non-nil, Emacs sets this to the
12065 text in the region before modifying the buffer. The next
12066 `deactivate-mark' call uses this to set the window selection. */);
12067 Vsaved_region_selection
= Qnil
;
12069 DEFVAR_LISP ("selection-inhibit-update-commands",
12070 Vselection_inhibit_update_commands
,
12071 doc
: /* List of commands which should not update the selection.
12072 Normally, if `select-active-regions' is non-nil and the mark remains
12073 active after a command (i.e. the mark was not deactivated), the Emacs
12074 command loop sets the selection to the text in the region. However,
12075 if the command is in this list, the selection is not updated. */);
12076 Vselection_inhibit_update_commands
12077 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12079 DEFVAR_LISP ("debug-on-event",
12081 doc
: /* Enter debugger on this event. When Emacs
12082 receives the special event specified by this variable, it will try to
12083 break into the debugger as soon as possible instead of processing the
12084 event normally through `special-event-map'.
12086 Currently, the only supported values for this
12087 variable are `sigusr1' and `sigusr2'. */);
12088 Vdebug_on_event
= intern_c_string ("sigusr2");
12090 /* Create the initial keyboard. */
12091 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12092 init_kboard (initial_kboard
);
12093 /* Vwindow_system is left at t for now. */
12094 initial_kboard
->next_kboard
= all_kboards
;
12095 all_kboards
= initial_kboard
;
12099 keys_of_keyboard (void)
12101 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12102 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12103 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12104 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12105 initial_define_key (meta_map
, 'x', "execute-extended-command");
12107 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12108 "handle-delete-frame");
12109 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12110 "ns-put-working-text");
12111 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12112 "ns-unput-working-text");
12113 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12114 current-prefix-arg, as is done in `handle-switch-frame'.
12115 But `handle-switch-frame is not run from the special-map.
12116 Commands from that map are run in a special way that automatically
12117 preserves the prefix-arg. Restoring the prefix arg here is not just
12118 redundant but harmful:
12120 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12121 - after the first prompt, the exit-minibuffer-hook is run which may
12122 iconify a frame and thus push a `iconify-frame' event.
12123 - after running exit-minibuffer-hook, current-prefix-arg is
12124 restored to the non-nil value it had before the prompt.
12125 - we enter the second prompt.
12126 current-prefix-arg is non-nil, prefix-arg is nil.
12127 - before running the first real event, we run the special iconify-frame
12128 event, but we pass the `special' arg to execute-command so
12129 current-prefix-arg and prefix-arg are left untouched.
12130 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12131 - the next key event will have a spuriously non-nil current-prefix-arg. */
12132 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12134 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12136 /* Handling it at such a low-level causes read_key_sequence to get
12137 * confused because it doesn't realize that the current_buffer was
12138 * changed by read_char.
12140 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12141 * "handle-select-window"); */
12142 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12143 "handle-save-session");
12146 /* Define a special event which is raised for dbus callback
12148 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12149 "dbus-handle-event");
12152 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12154 #if defined (WINDOWSNT)
12155 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12160 /* Mark the pointers in the kboard objects.
12161 Called by Fgarbage_collect. */
12163 mark_kboards (void)
12167 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12169 if (kb
->kbd_macro_buffer
)
12170 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12172 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12173 mark_object (KVAR (kb
, Vlast_command
));
12174 mark_object (KVAR (kb
, Vreal_last_command
));
12175 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12176 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12177 mark_object (KVAR (kb
, Vprefix_arg
));
12178 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12179 mark_object (KVAR (kb
, kbd_queue
));
12180 mark_object (KVAR (kb
, defining_kbd_macro
));
12181 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12182 mark_object (KVAR (kb
, Vsystem_key_alist
));
12183 mark_object (KVAR (kb
, system_key_syms
));
12184 mark_object (KVAR (kb
, Vwindow_system
));
12185 mark_object (KVAR (kb
, Vinput_decode_map
));
12186 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12187 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12188 mark_object (KVAR (kb
, echo_string
));
12191 struct input_event
*event
;
12192 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12194 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12195 event
= kbd_buffer
;
12196 /* These two special event types has no Lisp_Objects to mark. */
12197 if (event
->kind
!= SELECTION_REQUEST_EVENT
12198 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12200 mark_object (event
->x
);
12201 mark_object (event
->y
);
12202 mark_object (event
->frame_or_window
);
12203 mark_object (event
->arg
);