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 static Lisp_Object Qmouse_fixup_help_message
;
311 /* Symbols to denote kinds of events. */
312 static Lisp_Object Qfunction_key
;
313 Lisp_Object Qmouse_click
;
315 Lisp_Object Qlanguage_change
;
317 Lisp_Object Qfile_w32notify
;
320 static Lisp_Object Qdrag_n_drop
;
321 static Lisp_Object Qsave_session
;
323 static Lisp_Object Qdbus_event
;
326 static Lisp_Object Qfile_inotify
;
327 #endif /* HAVE_INOTIFY */
328 static Lisp_Object Qconfig_changed_event
;
330 /* Lisp_Object Qmouse_movement; - also an event header */
332 /* Properties of event headers. */
333 Lisp_Object Qevent_kind
;
334 static Lisp_Object Qevent_symbol_elements
;
336 /* Menu and tool bar item parts. */
337 static Lisp_Object Qmenu_enable
;
338 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
339 Lisp_Object QCfilter
;
341 /* Non-nil disable property on a command means
342 do not execute it; call disabled-command-function's value instead. */
343 Lisp_Object QCtoggle
, QCradio
;
344 static Lisp_Object QCbutton
, QClabel
;
346 static Lisp_Object QCvert_only
;
348 /* An event header symbol HEAD may have a property named
349 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
350 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
351 mask of modifiers applied to it. If present, this is used to help
352 speed up parse_modifiers. */
353 Lisp_Object Qevent_symbol_element_mask
;
355 /* An unmodified event header BASE may have a property named
356 Qmodifier_cache, which is an alist mapping modifier masks onto
357 modified versions of BASE. If present, this helps speed up
359 static Lisp_Object Qmodifier_cache
;
361 /* Symbols to use for parts of windows. */
362 Lisp_Object Qmode_line
;
363 Lisp_Object Qvertical_line
;
364 static Lisp_Object Qvertical_scroll_bar
;
365 Lisp_Object Qmenu_bar
;
367 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
368 static Lisp_Object
command_loop (void);
369 static Lisp_Object Qextended_command_history
;
370 EMACS_TIME
timer_check (void);
372 static void echo_now (void);
373 static ptrdiff_t echo_length (void);
375 static Lisp_Object Qpolling_period
;
377 /* Incremented whenever a timer is run. */
380 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
382 EMACS_TIME
*input_available_clear_time
;
384 /* True means use SIGIO interrupts; false means use CBREAK mode.
385 Default is true if INTERRUPT_INPUT is defined. */
386 bool interrupt_input
;
388 /* Nonzero while interrupts are temporarily deferred during redisplay. */
389 bool interrupts_deferred
;
391 /* If we support a window system, turn on the code to poll periodically
392 to detect C-g. It isn't actually used when doing interrupt input. */
393 #ifdef HAVE_WINDOW_SYSTEM
394 #define POLL_FOR_INPUT
397 /* The time when Emacs started being idle. */
399 static EMACS_TIME timer_idleness_start_time
;
401 /* After Emacs stops being idle, this saves the last value
402 of timer_idleness_start_time from when it was idle. */
404 static EMACS_TIME timer_last_idleness_start_time
;
407 /* Global variable declarations. */
409 /* Flags for readable_events. */
410 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
411 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
412 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
414 /* Function for init_keyboard to call with no args (if nonzero). */
415 static void (*keyboard_init_hook
) (void);
417 static bool get_input_pending (int);
418 static bool readable_events (int);
419 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
420 Lisp_Object
, bool *);
421 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
423 static Lisp_Object
make_lispy_event (struct input_event
*);
424 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
425 enum scroll_bar_part
,
426 Lisp_Object
, Lisp_Object
,
428 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
429 Lisp_Object
, const char *const *,
430 Lisp_Object
*, ptrdiff_t);
431 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
432 static bool help_char_p (Lisp_Object
);
433 static void save_getcjmp (sys_jmp_buf
);
434 static void restore_getcjmp (sys_jmp_buf
);
435 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
436 static void clear_event (struct input_event
*);
437 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
439 static void deliver_input_available_signal (int signo
);
441 static void handle_interrupt (bool);
442 static _Noreturn
void quit_throw_to_read_char (bool);
443 static void process_special_events (void);
444 static void timer_start_idle (void);
445 static void timer_stop_idle (void);
446 static void timer_resume_idle (void);
447 static void deliver_user_signal (int);
448 static char *find_user_signal_name (int);
449 static void store_user_signal_events (void);
451 /* These setters are used only in this file, so they can be private. */
453 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
455 kb
->INTERNAL_FIELD (echo_string
) = val
;
458 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
460 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
463 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
465 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
468 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
470 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
473 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
475 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
478 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
480 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
483 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
485 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
488 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
490 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
493 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
495 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
499 /* Add C to the echo string, if echoing is going on.
500 C can be a character, which is printed prettily ("M-C-x" and all that
501 jazz), or a symbol, whose name is printed. */
504 echo_char (Lisp_Object c
)
506 if (current_kboard
->immediate_echo
)
508 int size
= KEY_DESCRIPTION_SIZE
+ 100;
509 char *buffer
= alloca (size
);
511 Lisp_Object echo_string
;
513 echo_string
= KVAR (current_kboard
, echo_string
);
515 /* If someone has passed us a composite event, use its head symbol. */
520 ptr
= push_key_description (XINT (c
), ptr
);
522 else if (SYMBOLP (c
))
524 Lisp_Object name
= SYMBOL_NAME (c
);
525 int nbytes
= SBYTES (name
);
527 if (size
- (ptr
- buffer
) < nbytes
)
529 int offset
= ptr
- buffer
;
530 size
= max (2 * size
, size
+ nbytes
);
531 buffer
= alloca (size
);
532 ptr
= buffer
+ offset
;
535 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
536 STRING_MULTIBYTE (name
), 1);
539 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
542 const char *text
= " (Type ? for further options)";
543 int len
= strlen (text
);
545 if (size
- (ptr
- buffer
) < len
)
547 int offset
= ptr
- buffer
;
549 buffer
= alloca (size
);
550 ptr
= buffer
+ offset
;
553 memcpy (ptr
, text
, len
);
557 /* Replace a dash from echo_dash with a space, otherwise
558 add a space at the end as a separator between keys. */
559 if (STRINGP (echo_string
)
560 && SCHARS (echo_string
) > 1)
562 Lisp_Object last_char
, prev_char
, idx
;
564 idx
= make_number (SCHARS (echo_string
) - 2);
565 prev_char
= Faref (echo_string
, idx
);
567 idx
= make_number (SCHARS (echo_string
) - 1);
568 last_char
= Faref (echo_string
, idx
);
570 /* We test PREV_CHAR to make sure this isn't the echoing
572 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
573 Faset (echo_string
, idx
, make_number (' '));
575 echo_string
= concat2 (echo_string
, build_string (" "));
577 else if (STRINGP (echo_string
))
578 echo_string
= concat2 (echo_string
, build_string (" "));
582 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
588 /* Temporarily add a dash to the end of the echo string if it's not
589 empty, so that it serves as a mini-prompt for the very next character. */
594 /* Do nothing if not echoing at all. */
595 if (NILP (KVAR (current_kboard
, echo_string
)))
598 if (this_command_key_count
== 0)
601 if (!current_kboard
->immediate_echo
602 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
605 /* Do nothing if we just printed a prompt. */
606 if (current_kboard
->echo_after_prompt
607 == SCHARS (KVAR (current_kboard
, echo_string
)))
610 /* Do nothing if we have already put a dash at the end. */
611 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
613 Lisp_Object last_char
, prev_char
, idx
;
615 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
616 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
618 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
619 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
621 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
625 /* Put a dash at the end of the buffer temporarily,
626 but make it go away when the next character is added. */
629 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
633 /* Display the current echo string, and begin echoing if not already
639 if (!current_kboard
->immediate_echo
)
642 current_kboard
->immediate_echo
= 1;
644 for (i
= 0; i
< this_command_key_count
; i
++)
648 /* Set before_command_echo_length to the value that would
649 have been saved before the start of this subcommand in
650 command_loop_1, if we had already been echoing then. */
651 if (i
== this_single_command_key_start
)
652 before_command_echo_length
= echo_length ();
654 c
= AREF (this_command_keys
, i
);
655 if (! (EVENT_HAS_PARAMETERS (c
)
656 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
660 /* Set before_command_echo_length to the value that would
661 have been saved before the start of this subcommand in
662 command_loop_1, if we had already been echoing then. */
663 if (this_command_key_count
== this_single_command_key_start
)
664 before_command_echo_length
= echo_length ();
666 /* Put a dash at the end to invite the user to type more. */
671 message3_nolog (KVAR (current_kboard
, echo_string
),
672 SBYTES (KVAR (current_kboard
, echo_string
)),
673 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
676 /* Record in what buffer we echoed, and from which kboard. */
677 echo_message_buffer
= echo_area_buffer
[0];
678 echo_kboard
= current_kboard
;
680 if (waiting_for_input
&& !NILP (Vquit_flag
))
681 quit_throw_to_read_char (0);
684 /* Turn off echoing, for the start of a new command. */
687 cancel_echoing (void)
689 current_kboard
->immediate_echo
= 0;
690 current_kboard
->echo_after_prompt
= -1;
691 kset_echo_string (current_kboard
, Qnil
);
692 ok_to_echo_at_next_pause
= NULL
;
694 echo_message_buffer
= Qnil
;
697 /* Return the length of the current echo string. */
702 return (STRINGP (KVAR (current_kboard
, echo_string
))
703 ? SCHARS (KVAR (current_kboard
, echo_string
))
707 /* Truncate the current echo message to its first LEN chars.
708 This and echo_char get used by read_key_sequence when the user
709 switches frames while entering a key sequence. */
712 echo_truncate (ptrdiff_t nchars
)
714 if (STRINGP (KVAR (current_kboard
, echo_string
)))
715 kset_echo_string (current_kboard
,
716 Fsubstring (KVAR (current_kboard
, echo_string
),
717 make_number (0), make_number (nchars
)));
718 truncate_echo_area (nchars
);
722 /* Functions for manipulating this_command_keys. */
724 add_command_key (Lisp_Object key
)
726 #if 0 /* Not needed after we made Freset_this_command_lengths
727 do the job immediately. */
728 /* If reset-this-command-length was called recently, obey it now.
729 See the doc string of that function for an explanation of why. */
730 if (before_command_restore_flag
)
732 this_command_key_count
= before_command_key_count_1
;
733 if (this_command_key_count
< this_single_command_key_start
)
734 this_single_command_key_start
= this_command_key_count
;
735 echo_truncate (before_command_echo_length_1
);
736 before_command_restore_flag
= 0;
740 if (this_command_key_count
>= ASIZE (this_command_keys
))
741 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
743 ASET (this_command_keys
, this_command_key_count
, key
);
744 ++this_command_key_count
;
749 recursive_edit_1 (void)
751 ptrdiff_t count
= SPECPDL_INDEX ();
754 if (command_loop_level
> 0)
756 specbind (Qstandard_output
, Qt
);
757 specbind (Qstandard_input
, Qt
);
760 #ifdef HAVE_WINDOW_SYSTEM
761 /* The command loop has started an hourglass timer, so we have to
762 cancel it here, otherwise it will fire because the recursive edit
763 can take some time. Do not check for display_hourglass_p here,
764 because it could already be nil. */
768 /* This function may have been called from a debugger called from
769 within redisplay, for instance by Edebugging a function called
770 from fontification-functions. We want to allow redisplay in
771 the debugging session.
773 The recursive edit is left with a `(throw exit ...)'. The `exit'
774 tag is not caught anywhere in redisplay, i.e. when we leave the
775 recursive edit, the original redisplay leading to the recursive
776 edit will be unwound. The outcome should therefore be safe. */
777 specbind (Qinhibit_redisplay
, Qnil
);
780 val
= command_loop ();
782 Fsignal (Qquit
, Qnil
);
783 /* Handle throw from read_minibuf when using minibuffer
784 while it's active but we're in another window. */
786 xsignal1 (Qerror
, val
);
788 return unbind_to (count
, Qnil
);
791 /* When an auto-save happens, record the "time", and don't do again soon. */
794 record_auto_save (void)
796 last_auto_save
= num_nonmacro_input_events
;
799 /* Make an auto save happen as soon as possible at command level. */
803 force_auto_save_soon (void)
805 last_auto_save
= - auto_save_interval
- 1;
807 record_asynch_buffer_change ();
811 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
812 doc
: /* Invoke the editor command loop recursively.
813 To get out of the recursive edit, a command can do `(throw 'exit nil)';
814 that tells this function to return.
815 Alternatively, `(throw 'exit t)' makes this function signal an error.
816 This function is called by the editor initialization to begin editing. */)
819 ptrdiff_t count
= SPECPDL_INDEX ();
822 /* If we enter while input is blocked, don't lock up here.
823 This may happen through the debugger during redisplay. */
824 if (input_blocked_p ())
827 command_loop_level
++;
828 update_mode_lines
= 1;
830 if (command_loop_level
831 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
832 buffer
= Fcurrent_buffer ();
836 /* If we leave recursive_edit_1 below with a `throw' for instance,
837 like it is done in the splash screen display, we have to
838 make sure that we restore single_kboard as command_loop_1
839 would have done if it were left normally. */
840 if (command_loop_level
> 0)
841 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
842 record_unwind_protect (recursive_edit_unwind
, buffer
);
845 return unbind_to (count
, Qnil
);
849 recursive_edit_unwind (Lisp_Object buffer
)
851 if (BUFFERP (buffer
))
852 Fset_buffer (buffer
);
854 command_loop_level
--;
855 update_mode_lines
= 1;
860 #if 0 /* These two functions are now replaced with
861 temporarily_switch_to_single_kboard. */
865 #if 0 /* Theory: if there's anything in Vunread_command_events,
866 it will right away be read by read_key_sequence,
867 and then if we do switch KBOARDS, it will go into the side
868 queue then. So we don't need to do anything special here -- rms. */
869 if (CONSP (Vunread_command_events
))
871 current_kboard
->kbd_queue
872 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
873 current_kboard
->kbd_queue_has_data
= 1;
875 Vunread_command_events
= Qnil
;
880 /* Switch to the single-kboard state, making current_kboard
881 the only KBOARD from which further input is accepted. */
884 single_kboard_state ()
890 /* If we're in single_kboard state for kboard KBOARD,
894 not_single_kboard_state (KBOARD
*kboard
)
896 if (kboard
== current_kboard
)
900 /* Maintain a stack of kboards, so other parts of Emacs
901 can switch temporarily to the kboard of a given frame
902 and then revert to the previous status. */
907 struct kboard_stack
*next
;
910 static struct kboard_stack
*kboard_stack
;
913 push_kboard (struct kboard
*k
)
915 struct kboard_stack
*p
= xmalloc (sizeof *p
);
917 p
->next
= kboard_stack
;
918 p
->kboard
= current_kboard
;
928 struct kboard_stack
*p
= kboard_stack
;
930 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
932 if (t
->kboard
== p
->kboard
)
934 current_kboard
= p
->kboard
;
941 /* The terminal we remembered has been deleted. */
942 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
945 kboard_stack
= p
->next
;
949 /* Switch to single_kboard mode, making current_kboard the only KBOARD
950 from which further input is accepted. If F is non-nil, set its
951 KBOARD as the current keyboard.
953 This function uses record_unwind_protect to return to the previous
956 If Emacs is already in single_kboard mode, and F's keyboard is
957 locked, then this function will throw an error. */
960 temporarily_switch_to_single_kboard (struct frame
*f
)
962 bool was_locked
= single_kboard
;
965 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
966 /* We can not switch keyboards while in single_kboard mode.
967 In rare cases, Lisp code may call `recursive-edit' (or
968 `read-minibuffer' or `y-or-n-p') after it switched to a
969 locked frame. For example, this is likely to happen
970 when server.el connects to a new terminal while Emacs is in
971 single_kboard mode. It is best to throw an error instead
972 of presenting the user with a frozen screen. */
973 error ("Terminal %d is locked, cannot read from it",
974 FRAME_TERMINAL (f
)->id
);
976 /* This call is unnecessary, but helps
977 `restore_kboard_configuration' discover if somebody changed
978 `current_kboard' behind our back. */
979 push_kboard (current_kboard
);
982 current_kboard
= FRAME_KBOARD (f
);
984 record_unwind_protect (restore_kboard_configuration
,
985 (was_locked
? Qt
: Qnil
));
988 #if 0 /* This function is not needed anymore. */
990 record_single_kboard_state ()
993 push_kboard (current_kboard
);
994 record_unwind_protect (restore_kboard_configuration
,
995 (single_kboard
? Qt
: Qnil
));
1000 restore_kboard_configuration (Lisp_Object was_locked
)
1002 if (NILP (was_locked
))
1006 struct kboard
*prev
= current_kboard
;
1009 /* The pop should not change the kboard. */
1010 if (single_kboard
&& current_kboard
!= prev
)
1017 /* Handle errors that are not handled at inner levels
1018 by printing an error message and returning to the editor command loop. */
1021 cmd_error (Lisp_Object data
)
1023 Lisp_Object old_level
, old_length
;
1024 char macroerror
[sizeof "After..kbd macro iterations: "
1025 + INT_STRLEN_BOUND (EMACS_INT
)];
1027 #ifdef HAVE_WINDOW_SYSTEM
1028 if (display_hourglass_p
)
1029 cancel_hourglass ();
1032 if (!NILP (executing_kbd_macro
))
1034 if (executing_kbd_macro_iterations
== 1)
1035 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1037 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1038 executing_kbd_macro_iterations
);
1043 Vstandard_output
= Qt
;
1044 Vstandard_input
= Qt
;
1045 Vexecuting_kbd_macro
= Qnil
;
1046 executing_kbd_macro
= Qnil
;
1047 kset_prefix_arg (current_kboard
, Qnil
);
1048 kset_last_prefix_arg (current_kboard
, Qnil
);
1051 /* Avoid unquittable loop if data contains a circular list. */
1052 old_level
= Vprint_level
;
1053 old_length
= Vprint_length
;
1054 XSETFASTINT (Vprint_level
, 10);
1055 XSETFASTINT (Vprint_length
, 10);
1056 cmd_error_internal (data
, macroerror
);
1057 Vprint_level
= old_level
;
1058 Vprint_length
= old_length
;
1061 Vinhibit_quit
= Qnil
;
1063 return make_number (0);
1066 /* Take actions on handling an error. DATA is the data that describes
1069 CONTEXT is a C-string containing ASCII characters only which
1070 describes the context in which the error happened. If we need to
1071 generalize CONTEXT to allow multibyte characters, make it a Lisp
1075 cmd_error_internal (Lisp_Object data
, const char *context
)
1077 struct frame
*sf
= SELECTED_FRAME ();
1079 /* The immediate context is not interesting for Quits,
1080 since they are asynchronous. */
1081 if (EQ (XCAR (data
), Qquit
))
1082 Vsignaling_function
= Qnil
;
1087 /* Use user's specified output function if any. */
1088 if (!NILP (Vcommand_error_function
))
1089 call3 (Vcommand_error_function
, data
,
1090 context
? build_string (context
) : empty_unibyte_string
,
1091 Vsignaling_function
);
1092 /* If the window system or terminal frame hasn't been initialized
1093 yet, or we're not interactive, write the message to stderr and exit. */
1094 else if (!sf
->glyphs_initialized_p
1095 /* The initial frame is a special non-displaying frame. It
1096 will be current in daemon mode when there are no frames
1097 to display, and in non-daemon mode before the real frame
1098 has finished initializing. If an error is thrown in the
1099 latter case while creating the frame, then the frame
1100 will never be displayed, so the safest thing to do is
1101 write to stderr and quit. In daemon mode, there are
1102 many other potential errors that do not prevent frames
1103 from being created, so continuing as normal is better in
1105 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1108 print_error_message (data
, Qexternal_debugging_output
,
1109 context
, Vsignaling_function
);
1110 Fterpri (Qexternal_debugging_output
);
1111 Fkill_emacs (make_number (-1));
1115 clear_message (1, 0);
1117 message_log_maybe_newline ();
1120 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1123 Vsignaling_function
= Qnil
;
1126 static Lisp_Object
command_loop_2 (Lisp_Object
);
1127 static Lisp_Object
top_level_1 (Lisp_Object
);
1129 /* Entry to editor-command-loop.
1130 This level has the catches for exiting/returning to editor command loop.
1131 It returns nil to exit recursive edit, t to abort it. */
1136 if (command_loop_level
> 0 || minibuf_level
> 0)
1139 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1140 executing_kbd_macro
= Qnil
;
1146 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1147 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1148 executing_kbd_macro
= Qnil
;
1150 /* End of file in -batch run causes exit here. */
1156 /* Here we catch errors in execution of commands within the
1157 editing loop, and reenter the editing loop.
1158 When there is an error, cmd_error runs and returns a non-nil
1159 value to us. A value of nil means that command_loop_1 itself
1160 returned due to end of file (or end of kbd macro). */
1163 command_loop_2 (Lisp_Object ignore
)
1165 register Lisp_Object val
;
1168 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1169 while (!NILP (val
));
1177 return Feval (Vtop_level
, Qnil
);
1181 top_level_1 (Lisp_Object ignore
)
1183 /* On entry to the outer level, run the startup file */
1184 if (!NILP (Vtop_level
))
1185 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1186 else if (!NILP (Vpurify_flag
))
1187 message ("Bare impure Emacs (standard Lisp code not loaded)");
1189 message ("Bare Emacs (standard Lisp code not loaded)");
1193 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1194 doc
: /* Exit all recursive editing levels.
1195 This also exits all active minibuffers. */)
1198 #ifdef HAVE_WINDOW_SYSTEM
1199 if (display_hourglass_p
)
1200 cancel_hourglass ();
1203 /* Unblock input if we enter with input blocked. This may happen if
1204 redisplay traps e.g. during tool-bar update with input blocked. */
1205 totally_unblock_input ();
1207 Fthrow (Qtop_level
, Qnil
);
1210 static _Noreturn
void
1211 user_error (const char *msg
)
1213 xsignal1 (Quser_error
, build_string (msg
));
1217 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1218 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1221 if (command_loop_level
> 0 || minibuf_level
> 0)
1222 Fthrow (Qexit
, Qnil
);
1224 user_error ("No recursive edit is in progress");
1228 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1229 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1232 if (command_loop_level
> 0 || minibuf_level
> 0)
1235 user_error ("No recursive edit is in progress");
1238 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1239 of this function. */
1242 tracking_off (Lisp_Object old_value
)
1244 do_mouse_tracking
= old_value
;
1245 if (NILP (old_value
))
1247 /* Redisplay may have been preempted because there was input
1248 available, and it assumes it will be called again after the
1249 input has been processed. If the only input available was
1250 the sort that we have just disabled, then we need to call
1252 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1254 redisplay_preserve_echo_area (6);
1255 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1261 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1262 doc
: /* Evaluate BODY with mouse movement events enabled.
1263 Within a `track-mouse' form, mouse motion generates input events that
1264 you can read with `read-event'.
1265 Normally, mouse motion is ignored.
1266 usage: (track-mouse BODY...) */)
1269 ptrdiff_t count
= SPECPDL_INDEX ();
1272 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1274 do_mouse_tracking
= Qt
;
1276 val
= Fprogn (args
);
1277 return unbind_to (count
, val
);
1280 /* If mouse has moved on some frame, return one of those frames.
1284 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1285 after resizing the tool-bar window. */
1287 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1290 bool ignore_mouse_drag_p
;
1293 some_mouse_moved (void)
1295 Lisp_Object tail
, frame
;
1297 if (ignore_mouse_drag_p
)
1299 /* ignore_mouse_drag_p = 0; */
1303 FOR_EACH_FRAME (tail
, frame
)
1305 if (XFRAME (frame
)->mouse_moved
)
1306 return XFRAME (frame
);
1313 /* This is the actual command reading loop,
1314 sans error-handling encapsulation. */
1316 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1318 void safe_run_hooks (Lisp_Object
);
1319 static void adjust_point_for_property (ptrdiff_t, bool);
1321 /* Cancel hourglass from protect_unwind.
1323 #ifdef HAVE_WINDOW_SYSTEM
1325 cancel_hourglass_unwind (Lisp_Object arg
)
1327 cancel_hourglass ();
1332 /* The last boundary auto-added to buffer-undo-list. */
1333 Lisp_Object last_undo_boundary
;
1335 /* FIXME: This is wrong rather than test window-system, we should call
1336 a new set-selection, which will then dispatch to x-set-selection, or
1337 tty-set-selection, or w32-set-selection, ... */
1340 command_loop_1 (void)
1343 Lisp_Object keybuf
[30];
1345 EMACS_INT prev_modiff
= 0;
1346 struct buffer
*prev_buffer
= NULL
;
1347 bool already_adjusted
= 0;
1349 kset_prefix_arg (current_kboard
, Qnil
);
1350 kset_last_prefix_arg (current_kboard
, Qnil
);
1351 Vdeactivate_mark
= Qnil
;
1352 waiting_for_input
= 0;
1355 this_command_key_count
= 0;
1356 this_command_key_count_reset
= 0;
1357 this_single_command_key_start
= 0;
1359 if (NILP (Vmemory_full
))
1361 /* Make sure this hook runs after commands that get errors and
1362 throw to top level. */
1363 /* Note that the value cell will never directly contain nil
1364 if the symbol is a local variable. */
1365 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1366 safe_run_hooks (Qpost_command_hook
);
1368 /* If displaying a message, resize the echo area window to fit
1369 that message's size exactly. */
1370 if (!NILP (echo_area_buffer
[0]))
1371 resize_echo_area_exactly ();
1373 /* If there are warnings waiting, process them. */
1374 if (!NILP (Vdelayed_warnings_list
))
1375 safe_run_hooks (Qdelayed_warnings_hook
);
1377 if (!NILP (Vdeferred_action_list
))
1378 safe_run_hooks (Qdeferred_action_function
);
1381 /* Do this after running Vpost_command_hook, for consistency. */
1382 kset_last_command (current_kboard
, Vthis_command
);
1383 kset_real_last_command (current_kboard
, Vreal_this_command
);
1384 if (!CONSP (last_command_event
))
1385 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1389 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1392 /* Make sure the current window's buffer is selected. */
1393 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1395 /* Display any malloc warning that just came out. Use while because
1396 displaying one warning can cause another. */
1398 while (pending_malloc_warning
)
1399 display_malloc_warning ();
1401 Vdeactivate_mark
= Qnil
;
1403 /* Don't ignore mouse movements for more than a single command
1404 loop. (This flag is set in xdisp.c whenever the tool bar is
1405 resized, because the resize moves text up or down, and would
1406 generate false mouse drag events if we don't ignore them.) */
1407 ignore_mouse_drag_p
= 0;
1409 /* If minibuffer on and echo area in use,
1410 wait a short time and redraw minibuffer. */
1413 && !NILP (echo_area_buffer
[0])
1414 && EQ (minibuf_window
, echo_area_window
)
1415 && NUMBERP (Vminibuffer_message_timeout
))
1417 /* Bind inhibit-quit to t so that C-g gets read in
1418 rather than quitting back to the minibuffer. */
1419 ptrdiff_t count
= SPECPDL_INDEX ();
1420 specbind (Qinhibit_quit
, Qt
);
1422 sit_for (Vminibuffer_message_timeout
, 0, 2);
1424 /* Clear the echo area. */
1426 safe_run_hooks (Qecho_area_clear_hook
);
1428 unbind_to (count
, Qnil
);
1430 /* If a C-g came in before, treat it as input now. */
1431 if (!NILP (Vquit_flag
))
1434 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1438 /* If it has changed current-menubar from previous value,
1439 really recompute the menubar from the value. */
1440 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1441 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1442 call0 (Qrecompute_lucid_menubar
);
1444 before_command_key_count
= this_command_key_count
;
1445 before_command_echo_length
= echo_length ();
1447 Vthis_command
= Qnil
;
1448 Vreal_this_command
= Qnil
;
1449 Vthis_original_command
= Qnil
;
1450 Vthis_command_keys_shift_translated
= Qnil
;
1452 /* Read next key sequence; i gets its length. */
1453 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1456 /* A filter may have run while we were reading the input. */
1457 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1459 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1463 /* Now we have read a key sequence of length I,
1464 or else I is 0 and we found end of file. */
1466 if (i
== 0) /* End of file -- happens only in */
1467 return Qnil
; /* a kbd macro, at the end. */
1468 /* -1 means read_key_sequence got a menu that was rejected.
1469 Just loop around and read another command. */
1473 this_command_key_count
= 0;
1474 this_command_key_count_reset
= 0;
1475 this_single_command_key_start
= 0;
1479 last_command_event
= keybuf
[i
- 1];
1481 /* If the previous command tried to force a specific window-start,
1482 forget about that, in case this command moves point far away
1483 from that position. But also throw away beg_unchanged and
1484 end_unchanged information in that case, so that redisplay will
1485 update the whole window properly. */
1486 if (XWINDOW (selected_window
)->force_start
)
1489 XWINDOW (selected_window
)->force_start
= 0;
1490 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1491 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1494 cmd
= read_key_sequence_cmd
;
1495 if (!NILP (Vexecuting_kbd_macro
))
1497 if (!NILP (Vquit_flag
))
1499 Vexecuting_kbd_macro
= Qt
;
1500 QUIT
; /* Make some noise. */
1501 /* Will return since macro now empty. */
1505 /* Do redisplay processing after this command except in special
1506 cases identified below. */
1507 prev_buffer
= current_buffer
;
1508 prev_modiff
= MODIFF
;
1509 last_point_position
= PT
;
1510 last_point_position_window
= selected_window
;
1511 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1513 /* By default, we adjust point to a boundary of a region that
1514 has such a property that should be treated intangible
1515 (e.g. composition, display). But, some commands will set
1516 this variable differently. */
1517 Vdisable_point_adjustment
= Qnil
;
1519 /* Process filters and timers may have messed with deactivate-mark.
1520 reset it before we execute the command. */
1521 Vdeactivate_mark
= Qnil
;
1523 /* Remap command through active keymaps. */
1524 Vthis_original_command
= cmd
;
1525 if (!NILP (read_key_sequence_remapped
))
1526 cmd
= read_key_sequence_remapped
;
1528 /* Execute the command. */
1530 Vthis_command
= cmd
;
1531 Vreal_this_command
= cmd
;
1532 safe_run_hooks (Qpre_command_hook
);
1534 already_adjusted
= 0;
1536 if (NILP (Vthis_command
))
1538 /* nil means key is undefined. */
1539 Lisp_Object keys
= Fvector (i
, keybuf
);
1540 keys
= Fkey_description (keys
, Qnil
);
1542 message_with_string ("%s is undefined", keys
, 0);
1543 kset_defining_kbd_macro (current_kboard
, Qnil
);
1544 update_mode_lines
= 1;
1545 /* If this is a down-mouse event, don't reset prefix-arg;
1546 pass it to the command run by the up event. */
1547 if (EVENT_HAS_PARAMETERS (last_command_event
))
1549 Lisp_Object breakdown
1550 = parse_modifiers (EVENT_HEAD (last_command_event
));
1551 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1552 if (!(modifiers
& down_modifier
))
1553 kset_prefix_arg (current_kboard
, Qnil
);
1556 kset_prefix_arg (current_kboard
, Qnil
);
1560 /* Here for a command that isn't executed directly. */
1562 #ifdef HAVE_WINDOW_SYSTEM
1563 ptrdiff_t scount
= SPECPDL_INDEX ();
1565 if (display_hourglass_p
1566 && NILP (Vexecuting_kbd_macro
))
1568 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1573 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1575 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1578 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1579 ? Qnil
: BVAR (current_buffer
, undo_list
));
1581 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1583 #ifdef HAVE_WINDOW_SYSTEM
1584 /* Do not check display_hourglass_p here, because
1585 Fcommand_execute could change it, but we should cancel
1586 hourglass cursor anyway.
1587 But don't cancel the hourglass within a macro
1588 just because a command in the macro finishes. */
1589 if (NILP (Vexecuting_kbd_macro
))
1590 unbind_to (scount
, Qnil
);
1593 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1595 safe_run_hooks (Qpost_command_hook
);
1597 /* If displaying a message, resize the echo area window to fit
1598 that message's size exactly. */
1599 if (!NILP (echo_area_buffer
[0]))
1600 resize_echo_area_exactly ();
1602 /* If there are warnings waiting, process them. */
1603 if (!NILP (Vdelayed_warnings_list
))
1604 safe_run_hooks (Qdelayed_warnings_hook
);
1606 safe_run_hooks (Qdeferred_action_function
);
1608 /* If there is a prefix argument,
1609 1) We don't want Vlast_command to be ``universal-argument''
1610 (that would be dumb), so don't set Vlast_command,
1611 2) we want to leave echoing on so that the prefix will be
1612 echoed as part of this key sequence, so don't call
1614 3) we want to leave this_command_key_count non-zero, so that
1615 read_char will realize that it is re-reading a character, and
1616 not echo it a second time.
1618 If the command didn't actually create a prefix arg,
1619 but is merely a frame event that is transparent to prefix args,
1620 then the above doesn't apply. */
1621 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1622 || CONSP (last_command_event
))
1624 kset_last_command (current_kboard
, Vthis_command
);
1625 kset_real_last_command (current_kboard
, Vreal_this_command
);
1626 if (!CONSP (last_command_event
))
1627 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1629 this_command_key_count
= 0;
1630 this_command_key_count_reset
= 0;
1631 this_single_command_key_start
= 0;
1634 if (!NILP (BVAR (current_buffer
, mark_active
))
1635 && !NILP (Vrun_hooks
))
1637 /* In Emacs 22, setting transient-mark-mode to `only' was a
1638 way of turning it on for just one command. This usage is
1639 obsolete, but support it anyway. */
1640 if (EQ (Vtransient_mark_mode
, Qidentity
))
1641 Vtransient_mark_mode
= Qnil
;
1642 else if (EQ (Vtransient_mark_mode
, Qonly
))
1643 Vtransient_mark_mode
= Qidentity
;
1645 if (!NILP (Vdeactivate_mark
))
1646 /* If `select-active-regions' is non-nil, this call to
1647 `deactivate-mark' also sets the PRIMARY selection. */
1648 call0 (Qdeactivate_mark
);
1651 /* Even if not deactivating the mark, set PRIMARY if
1652 `select-active-regions' is non-nil. */
1653 if (!NILP (Fwindow_system (Qnil
))
1654 /* Even if mark_active is non-nil, the actual buffer
1655 marker may not have been set yet (Bug#7044). */
1656 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1657 && (EQ (Vselect_active_regions
, Qonly
)
1658 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1659 : (!NILP (Vselect_active_regions
)
1660 && !NILP (Vtransient_mark_mode
)))
1661 && NILP (Fmemq (Vthis_command
,
1662 Vselection_inhibit_update_commands
)))
1665 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1668 call2 (Qx_set_selection
, QPRIMARY
,
1669 make_buffer_string (beg
, end
, 0));
1671 call2 (Qx_set_selection
, QPRIMARY
,
1672 make_buffer_string (end
, beg
, 0));
1673 /* Don't set empty selections. */
1676 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1678 Lisp_Object hook
= intern ("activate-mark-hook");
1679 Frun_hooks (1, &hook
);
1683 Vsaved_region_selection
= Qnil
;
1688 if (current_buffer
== prev_buffer
1689 && last_point_position
!= PT
1690 && NILP (Vdisable_point_adjustment
)
1691 && NILP (Vglobal_disable_point_adjustment
))
1693 if (last_point_position
> BEGV
1694 && last_point_position
< ZV
1695 && (composition_adjust_point (last_point_position
,
1696 last_point_position
)
1697 != last_point_position
))
1698 /* The last point was temporarily set within a grapheme
1699 cluster to prevent automatic composition. To recover
1700 the automatic composition, we must update the
1702 windows_or_buffers_changed
++;
1703 if (!already_adjusted
)
1704 adjust_point_for_property (last_point_position
,
1705 MODIFF
!= prev_modiff
);
1708 /* Install chars successfully executed in kbd macro. */
1710 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1711 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1712 finalize_kbd_macro_chars ();
1716 /* Adjust point to a boundary of a region that has such a property
1717 that should be treated intangible. For the moment, we check
1718 `composition', `display' and `invisible' properties.
1719 LAST_PT is the last position of point. */
1722 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1725 Lisp_Object val
, overlay
, tmp
;
1726 /* When called after buffer modification, we should temporarily
1727 suppress the point adjustment for automatic composition so that a
1728 user can keep inserting another character at point or keep
1729 deleting characters around point. */
1730 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1731 ptrdiff_t orig_pt
= PT
;
1733 /* FIXME: cycling is probably not necessary because these properties
1734 can't be usefully combined anyway. */
1735 while (check_composition
|| check_display
|| check_invisible
)
1737 /* FIXME: check `intangible'. */
1738 if (check_composition
1739 && PT
> BEGV
&& PT
< ZV
1740 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1743 check_display
= check_invisible
= 1;
1745 check_composition
= 0;
1747 && PT
> BEGV
&& PT
< ZV
1748 && !NILP (val
= get_char_property_and_overlay
1749 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1750 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1751 && (!OVERLAYP (overlay
)
1752 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1753 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1754 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1755 && (beg
< PT
/* && end > PT <- It's always the case. */
1756 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1759 SET_PT (PT
< last_pt
1760 ? (STRINGP (val
) && SCHARS (val
) == 0
1761 ? max (beg
- 1, BEGV
)
1764 check_composition
= check_invisible
= 1;
1767 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1773 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1776 /* FIXME: We should stop if we find a spot between
1777 two runs of `invisible' where inserted text would
1778 be visible. This is important when we have two
1779 invisible boundaries that enclose an area: if the
1780 area is empty, we need this test in order to make
1781 it possible to place point in the middle rather
1782 than skip both boundaries. However, this code
1783 also stops anywhere in a non-sticky text-property,
1784 which breaks (e.g.) Org mode. */
1785 && (val
= get_pos_property (make_number (end
),
1787 TEXT_PROP_MEANS_INVISIBLE (val
))
1789 && !NILP (val
= get_char_property_and_overlay
1790 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1791 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1793 ellipsis
= ellipsis
|| inv
> 1
1794 || (OVERLAYP (overlay
)
1795 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1796 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1797 tmp
= Fnext_single_char_property_change
1798 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1799 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1803 && (val
= get_pos_property (make_number (beg
),
1805 TEXT_PROP_MEANS_INVISIBLE (val
))
1807 && !NILP (val
= get_char_property_and_overlay
1808 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1809 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1811 ellipsis
= ellipsis
|| inv
> 1
1812 || (OVERLAYP (overlay
)
1813 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1814 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1815 tmp
= Fprevious_single_char_property_change
1816 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1817 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1820 /* Move away from the inside area. */
1821 if (beg
< PT
&& end
> PT
)
1823 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1824 /* We haven't moved yet (so we don't need to fear
1825 infinite-looping) and we were outside the range
1826 before (so either end of the range still corresponds
1827 to a move in the right direction): pretend we moved
1828 less than we actually did, so that we still have
1829 more freedom below in choosing which end of the range
1831 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1832 /* We either have moved already or the last point
1833 was already in the range: we don't get to choose
1834 which end of the range we have to go to. */
1835 : (PT
< last_pt
? beg
: end
));
1836 check_composition
= check_display
= 1;
1838 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1839 the point to something other than its argument, due to
1840 point-motion hooks, intangibility, etc. */
1841 eassert (PT
== beg
|| PT
== end
);
1844 /* Pretend the area doesn't exist if the buffer is not
1846 if (!modified
&& !ellipsis
&& beg
< end
)
1848 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1849 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1850 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1851 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1852 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1853 /* We've already moved as far as we can. Trying to go
1854 to the other end would mean moving backwards and thus
1855 could lead to an infinite loop. */
1857 else if (val
= get_pos_property (make_number (PT
),
1859 TEXT_PROP_MEANS_INVISIBLE (val
)
1860 && (val
= get_pos_property
1861 (make_number (PT
== beg
? end
: beg
),
1863 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1864 (check_composition
= check_display
= 1,
1865 SET_PT (PT
== beg
? end
: beg
));
1868 check_invisible
= 0;
1872 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1875 safe_run_hooks_1 (void)
1877 eassert (CONSP (Vinhibit_quit
));
1878 return call0 (XCDR (Vinhibit_quit
));
1881 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1885 safe_run_hooks_error (Lisp_Object error_data
)
1888 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1889 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1890 Lisp_Object args
[4];
1891 args
[0] = build_string ("Error in %s (%s): %S");
1894 args
[3] = error_data
;
1900 Lisp_Object newval
= Qnil
;
1901 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1902 if (EQ (fun
, XCAR (val
)))
1905 newval
= Fcons (XCAR (val
), newval
);
1907 return Fset (hook
, Fnreverse (newval
));
1908 /* Not found in the local part of the hook. Let's look at the global
1911 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1912 : Fdefault_value (hook
));
1913 CONSP (val
); val
= XCDR (val
))
1914 if (EQ (fun
, XCAR (val
)))
1917 newval
= Fcons (XCAR (val
), newval
);
1919 return Fset_default (hook
, Fnreverse (newval
));
1925 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1927 eassert (nargs
== 1);
1928 if (CONSP (Vinhibit_quit
))
1929 XSETCDR (Vinhibit_quit
, args
[0]);
1931 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1933 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1937 /* If we get an error while running the hook, cause the hook variable
1938 to be nil. Also inhibit quits, so that C-g won't cause the hook
1939 to mysteriously evaporate. */
1942 safe_run_hooks (Lisp_Object hook
)
1944 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1945 to its body or to its handlers other than via globals such as
1946 dynamically-bound variables ;-) */
1947 ptrdiff_t count
= SPECPDL_INDEX ();
1948 specbind (Qinhibit_quit
, hook
);
1950 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1952 unbind_to (count
, Qnil
);
1956 /* Nonzero means polling for input is temporarily suppressed. */
1958 int poll_suppress_count
;
1961 #ifdef POLL_FOR_INPUT
1963 /* Asynchronous timer for polling. */
1965 static struct atimer
*poll_timer
;
1967 /* Poll for input, so that we catch a C-g if it comes in. This
1968 function is called from x_make_frame_visible, see comment
1972 poll_for_input_1 (void)
1974 if (! input_blocked_p ()
1975 && !waiting_for_input
)
1979 /* Timer callback function for poll_timer. TIMER is equal to
1983 poll_for_input (struct atimer
*timer
)
1985 if (poll_suppress_count
== 0)
1986 pending_signals
= 1;
1989 #endif /* POLL_FOR_INPUT */
1991 /* Begin signals to poll for input, if they are appropriate.
1992 This function is called unconditionally from various places. */
1995 start_polling (void)
1997 #ifdef POLL_FOR_INPUT
1998 /* XXX This condition was (read_socket_hook && !interrupt_input),
1999 but read_socket_hook is not global anymore. Let's pretend that
2001 if (!interrupt_input
)
2003 /* Turn alarm handling on unconditionally. It might have
2004 been turned off in process.c. */
2005 turn_on_atimers (1);
2007 /* If poll timer doesn't exist, are we need one with
2008 a different interval, start a new one. */
2009 if (poll_timer
== NULL
2010 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2012 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2013 EMACS_TIME interval
= make_emacs_time (period
, 0);
2016 cancel_atimer (poll_timer
);
2018 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2019 poll_for_input
, NULL
);
2022 /* Let the timer's callback function poll for input
2023 if this becomes zero. */
2024 --poll_suppress_count
;
2029 /* True if we are using polling to handle input asynchronously. */
2032 input_polling_used (void)
2034 #ifdef POLL_FOR_INPUT
2035 /* XXX This condition was (read_socket_hook && !interrupt_input),
2036 but read_socket_hook is not global anymore. Let's pretend that
2038 return !interrupt_input
;
2044 /* Turn off polling. */
2049 #ifdef POLL_FOR_INPUT
2050 /* XXX This condition was (read_socket_hook && !interrupt_input),
2051 but read_socket_hook is not global anymore. Let's pretend that
2053 if (!interrupt_input
)
2054 ++poll_suppress_count
;
2058 /* Set the value of poll_suppress_count to COUNT
2059 and start or stop polling accordingly. */
2062 set_poll_suppress_count (int count
)
2064 #ifdef POLL_FOR_INPUT
2065 if (count
== 0 && poll_suppress_count
!= 0)
2067 poll_suppress_count
= 1;
2070 else if (count
!= 0 && poll_suppress_count
== 0)
2074 poll_suppress_count
= count
;
2078 /* Bind polling_period to a value at least N.
2079 But don't decrease it. */
2082 bind_polling_period (int n
)
2084 #ifdef POLL_FOR_INPUT
2085 EMACS_INT
new = polling_period
;
2090 stop_other_atimers (poll_timer
);
2092 specbind (Qpolling_period
, make_number (new));
2093 /* Start a new alarm with the new period. */
2098 /* Apply the control modifier to CHARACTER. */
2101 make_ctrl_char (int c
)
2103 /* Save the upper bits here. */
2104 int upper
= c
& ~0177;
2106 if (! ASCII_BYTE_P (c
))
2107 return c
|= ctrl_modifier
;
2111 /* Everything in the columns containing the upper-case letters
2112 denotes a control character. */
2113 if (c
>= 0100 && c
< 0140)
2117 /* Set the shift modifier for a control char
2118 made from a shifted letter. But only for letters! */
2119 if (oc
>= 'A' && oc
<= 'Z')
2120 c
|= shift_modifier
;
2123 /* The lower-case letters denote control characters too. */
2124 else if (c
>= 'a' && c
<= 'z')
2127 /* Include the bits for control and shift
2128 only if the basic ASCII code can't indicate them. */
2132 /* Replace the high bits. */
2133 c
|= (upper
& ~ctrl_modifier
);
2138 /* Display the help-echo property of the character after the mouse pointer.
2139 Either show it in the echo area, or call show-help-function to display
2140 it by other means (maybe in a tooltip).
2142 If HELP is nil, that means clear the previous help echo.
2144 If HELP is a string, display that string. If HELP is a function,
2145 call it with OBJECT and POS as arguments; the function should
2146 return a help string or nil for none. For all other types of HELP,
2147 evaluate it to obtain a string.
2149 WINDOW is the window in which the help was generated, if any.
2150 It is nil if not in a window.
2152 If OBJECT is a buffer, POS is the position in the buffer where the
2153 `help-echo' text property was found.
2155 If OBJECT is an overlay, that overlay has a `help-echo' property,
2156 and POS is the position in the overlay's buffer under the mouse.
2158 If OBJECT is a string (an overlay string or a string displayed with
2159 the `display' property). POS is the position in that string under
2162 Note: this function may only be called with HELP nil or a string
2163 from X code running asynchronously. */
2166 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2169 if (!NILP (help
) && !STRINGP (help
))
2171 if (FUNCTIONP (help
))
2172 help
= safe_call (4, help
, window
, object
, pos
);
2174 help
= safe_eval (help
);
2176 if (!STRINGP (help
))
2180 if (!noninteractive
&& STRINGP (help
))
2182 /* The mouse-fixup-help-message Lisp function can call
2183 mouse_position_hook, which resets the mouse_moved flags.
2184 This causes trouble if we are trying to read a mouse motion
2185 event (i.e., if we are inside a `track-mouse' form), so we
2186 restore the mouse_moved flag. */
2187 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2188 help
= call1 (Qmouse_fixup_help_message
, help
);
2193 if (STRINGP (help
) || NILP (help
))
2195 if (!NILP (Vshow_help_function
))
2196 call1 (Vshow_help_function
, help
);
2197 help_echo_showing_p
= STRINGP (help
);
2203 /* Input of single characters from keyboard */
2205 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2206 EMACS_TIME
*end_time
);
2207 static void record_char (Lisp_Object c
);
2209 static Lisp_Object help_form_saved_window_configs
;
2211 read_char_help_form_unwind (Lisp_Object arg
)
2213 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2214 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2215 if (!NILP (window_config
))
2216 Fset_window_configuration (window_config
);
2220 #define STOP_POLLING \
2221 do { if (! polling_stopped_here) stop_polling (); \
2222 polling_stopped_here = 1; } while (0)
2224 #define RESUME_POLLING \
2225 do { if (polling_stopped_here) start_polling (); \
2226 polling_stopped_here = 0; } while (0)
2228 /* read a character from the keyboard; call the redisplay if needed */
2229 /* commandflag 0 means do not autosave, but do redisplay.
2230 -1 means do not redisplay, but do autosave.
2233 /* The arguments MAPS and NMAPS are for menu prompting.
2234 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2236 PREV_EVENT is the previous input event, or nil if we are reading
2237 the first event of a key sequence (or not reading a key sequence).
2238 If PREV_EVENT is t, that is a "magic" value that says
2239 not to run input methods, but in other respects to act as if
2240 not reading a key sequence.
2242 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2243 if we used a mouse menu to read the input, or false otherwise. If
2244 USED_MOUSE_MENU is null, don't dereference it.
2246 Value is -2 when we find input on another keyboard. A second call
2247 to read_char will read it.
2249 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2250 specifying the maximum time to wait until. If no input arrives by
2251 that time, stop waiting and return nil.
2253 Value is t if we showed a menu and the user rejected it. */
2256 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2257 Lisp_Object prev_event
,
2258 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2262 sys_jmp_buf local_getcjmp
;
2263 sys_jmp_buf save_jump
;
2264 Lisp_Object tem
, save
;
2265 volatile Lisp_Object previous_echo_area_message
;
2266 volatile Lisp_Object also_record
;
2267 volatile bool reread
;
2268 struct gcpro gcpro1
, gcpro2
;
2269 bool volatile polling_stopped_here
= 0;
2270 struct kboard
*orig_kboard
= current_kboard
;
2274 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2275 before_command_key_count
= this_command_key_count
;
2276 before_command_echo_length
= echo_length ();
2279 previous_echo_area_message
= Qnil
;
2281 GCPRO2 (c
, previous_echo_area_message
);
2286 if (CONSP (Vunread_post_input_method_events
))
2288 c
= XCAR (Vunread_post_input_method_events
);
2289 Vunread_post_input_method_events
2290 = XCDR (Vunread_post_input_method_events
);
2292 /* Undo what read_char_x_menu_prompt did when it unread
2293 additional keys returned by Fx_popup_menu. */
2295 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2303 if (CONSP (Vunread_command_events
))
2305 bool was_disabled
= 0;
2307 c
= XCAR (Vunread_command_events
);
2308 Vunread_command_events
= XCDR (Vunread_command_events
);
2312 /* Undo what sit-for did when it unread additional keys
2313 inside universal-argument. */
2316 && EQ (XCAR (c
), Qt
))
2322 /* Undo what read_char_x_menu_prompt did when it unread
2323 additional keys returned by Fx_popup_menu. */
2325 && EQ (XCDR (c
), Qdisabled
)
2326 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2332 /* If the queued event is something that used the mouse,
2333 set used_mouse_menu accordingly. */
2335 /* Also check was_disabled so last-nonmenu-event won't return
2336 a bad value when submenus are involved. (Bug#447) */
2337 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2338 *used_mouse_menu
= 1;
2340 goto reread_for_input_method
;
2343 if (CONSP (Vunread_input_method_events
))
2345 c
= XCAR (Vunread_input_method_events
);
2346 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2348 /* Undo what read_char_x_menu_prompt did when it unread
2349 additional keys returned by Fx_popup_menu. */
2351 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2355 goto reread_for_input_method
;
2358 this_command_key_count_reset
= 0;
2360 if (!NILP (Vexecuting_kbd_macro
))
2362 /* We set this to Qmacro; since that's not a frame, nobody will
2363 try to switch frames on us, and the selected window will
2366 Since this event came from a macro, it would be misleading to
2367 leave internal_last_event_frame set to wherever the last
2368 real event came from. Normally, a switch-frame event selects
2369 internal_last_event_frame after each command is read, but
2370 events read from a macro should never cause a new frame to be
2372 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2374 /* Exit the macro if we are at the end.
2375 Also, some things replace the macro with t
2376 to force an early exit. */
2377 if (EQ (Vexecuting_kbd_macro
, Qt
)
2378 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2384 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2385 if (STRINGP (Vexecuting_kbd_macro
)
2386 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2387 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2389 executing_kbd_macro_index
++;
2394 if (!NILP (unread_switch_frame
))
2396 c
= unread_switch_frame
;
2397 unread_switch_frame
= Qnil
;
2399 /* This event should make it into this_command_keys, and get echoed
2400 again, so we do not set `reread'. */
2404 /* if redisplay was requested */
2405 if (commandflag
>= 0)
2407 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2409 /* If there is pending input, process any events which are not
2410 user-visible, such as X selection_request events. */
2412 || detect_input_pending_run_timers (0))
2413 swallow_events (0); /* may clear input_pending */
2415 /* Redisplay if no pending input. */
2416 while (!input_pending
)
2418 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2419 redisplay_preserve_echo_area (5);
2424 /* Normal case: no input arrived during redisplay. */
2427 /* Input arrived and pre-empted redisplay.
2428 Process any events which are not user-visible. */
2430 /* If that cleared input_pending, try again to redisplay. */
2433 /* Prevent the redisplay we just did
2434 from messing up echoing of the input after the prompt. */
2435 if (commandflag
== 0 && echo_current
)
2436 echo_message_buffer
= echo_area_buffer
[0];
2440 /* Message turns off echoing unless more keystrokes turn it on again.
2442 The code in 20.x for the condition was
2444 1. echo_area_glyphs && *echo_area_glyphs
2445 2. && echo_area_glyphs != current_kboard->echobuf
2446 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2448 (1) means there's a current message displayed
2450 (2) means it's not the message from echoing from the current
2453 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2454 is set to a non-null value. This is done in read_char and it is
2455 set to echo_area_glyphs after a call to echo_char. That means
2456 ok_to_echo_at_next_pause is either null or
2457 current_kboard->echobuf with the appropriate current_kboard at
2460 So, condition (3) means in clear text ok_to_echo_at_next_pause
2461 must be either null, or the current message isn't from echoing at
2462 all, or it's from echoing from a different kboard than the
2465 if (/* There currently is something in the echo area. */
2466 !NILP (echo_area_buffer
[0])
2467 && (/* And it's either not from echoing. */
2468 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2469 /* Or it's an echo from a different kboard. */
2470 || echo_kboard
!= current_kboard
2471 /* Or we explicitly allow overwriting whatever there is. */
2472 || ok_to_echo_at_next_pause
== NULL
))
2477 /* Try reading a character via menu prompting in the minibuf.
2478 Try this before the sit-for, because the sit-for
2479 would do the wrong thing if we are supposed to do
2480 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2481 after a mouse event so don't try a minibuf menu. */
2483 if (nmaps
> 0 && INTERACTIVE
2484 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2485 /* Don't bring up a menu if we already have another event. */
2486 && NILP (Vunread_command_events
)
2487 && !detect_input_pending_run_timers (0))
2489 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2491 if (INTEGERP (c
) && XINT (c
) == -2)
2492 return c
; /* wrong_kboard_jmpbuf */
2498 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2499 We will do that below, temporarily for short sections of code,
2500 when appropriate. local_getcjmp must be in effect
2501 around any call to sit_for or kbd_buffer_get_event;
2502 it *must not* be in effect when we call redisplay. */
2504 jmpcount
= SPECPDL_INDEX ();
2505 if (sys_setjmp (local_getcjmp
))
2507 /* Handle quits while reading the keyboard. */
2508 /* We must have saved the outer value of getcjmp here,
2509 so restore it now. */
2510 restore_getcjmp (save_jump
);
2511 unbind_to (jmpcount
, Qnil
);
2512 XSETINT (c
, quit_char
);
2513 internal_last_event_frame
= selected_frame
;
2514 Vlast_event_frame
= internal_last_event_frame
;
2515 /* If we report the quit char as an event,
2516 don't do so more than once. */
2517 if (!NILP (Vinhibit_quit
))
2521 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2522 if (kb
!= current_kboard
)
2524 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2525 /* We shouldn't get here if we were in single-kboard mode! */
2530 while (CONSP (XCDR (last
)))
2532 if (!NILP (XCDR (last
)))
2536 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2538 XSETCDR (last
, Fcons (c
, Qnil
));
2539 kb
->kbd_queue_has_data
= 1;
2540 current_kboard
= kb
;
2541 /* This is going to exit from read_char
2542 so we had better get rid of this frame's stuff. */
2544 return make_number (-2); /* wrong_kboard_jmpbuf */
2550 /* Start idle timers if no time limit is supplied. We don't do it
2551 if a time limit is supplied to avoid an infinite recursion in the
2552 situation where an idle timer calls `sit-for'. */
2555 timer_start_idle ();
2557 /* If in middle of key sequence and minibuffer not active,
2558 start echoing if enough time elapses. */
2560 if (minibuf_level
== 0
2562 && !current_kboard
->immediate_echo
2563 && this_command_key_count
> 0
2565 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2566 && NILP (Fzerop (Vecho_keystrokes
))
2567 && (/* No message. */
2568 NILP (echo_area_buffer
[0])
2569 /* Or empty message. */
2570 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2571 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2572 /* Or already echoing from same kboard. */
2573 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2574 /* Or not echoing before and echoing allowed. */
2575 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2577 /* After a mouse event, start echoing right away.
2578 This is because we are probably about to display a menu,
2579 and we don't want to delay before doing so. */
2580 if (EVENT_HAS_PARAMETERS (prev_event
))
2586 save_getcjmp (save_jump
);
2587 restore_getcjmp (local_getcjmp
);
2588 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2589 restore_getcjmp (save_jump
);
2591 && ! CONSP (Vunread_command_events
))
2596 /* Maybe auto save due to number of keystrokes. */
2598 if (commandflag
!= 0
2599 && auto_save_interval
> 0
2600 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2601 && !detect_input_pending_run_timers (0))
2603 Fdo_auto_save (Qnil
, Qnil
);
2604 /* Hooks can actually change some buffers in auto save. */
2608 /* Try reading using an X menu.
2609 This is never confused with reading using the minibuf
2610 because the recursive call of read_char in read_char_minibuf_menu_prompt
2611 does not pass on any keymaps. */
2613 if (nmaps
> 0 && INTERACTIVE
2614 && !NILP (prev_event
)
2615 && EVENT_HAS_PARAMETERS (prev_event
)
2616 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2617 && !EQ (XCAR (prev_event
), Qtool_bar
)
2618 /* Don't bring up a menu if we already have another event. */
2619 && NILP (Vunread_command_events
))
2621 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2623 /* Now that we have read an event, Emacs is not idle. */
2630 /* Maybe autosave and/or garbage collect due to idleness. */
2632 if (INTERACTIVE
&& NILP (c
))
2635 ptrdiff_t buffer_size
;
2637 /* Slow down auto saves logarithmically in size of current buffer,
2638 and garbage collect while we're at it. */
2639 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2640 last_non_minibuf_size
= Z
- BEG
;
2641 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2643 while (buffer_size
> 64)
2644 delay_level
++, buffer_size
-= buffer_size
>> 2;
2645 if (delay_level
< 4) delay_level
= 4;
2646 /* delay_level is 4 for files under around 50k, 7 at 100k,
2647 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2649 /* Auto save if enough time goes by without input. */
2650 if (commandflag
!= 0
2651 && num_nonmacro_input_events
> last_auto_save
2652 && INTEGERP (Vauto_save_timeout
)
2653 && XINT (Vauto_save_timeout
) > 0)
2656 EMACS_INT timeout
= (delay_level
2657 * min (XFASTINT (Vauto_save_timeout
) / 4,
2658 MOST_POSITIVE_FIXNUM
/ delay_level
));
2659 save_getcjmp (save_jump
);
2660 restore_getcjmp (local_getcjmp
);
2661 tem0
= sit_for (make_number (timeout
), 1, 1);
2662 restore_getcjmp (save_jump
);
2665 && ! CONSP (Vunread_command_events
))
2667 Fdo_auto_save (Qnil
, Qnil
);
2672 /* If there is still no input available, ask for GC. */
2673 if (!detect_input_pending_run_timers (0))
2677 /* Notify the caller if an autosave hook, or a timer, sentinel or
2678 filter in the sit_for calls above have changed the current
2679 kboard. This could happen if they use the minibuffer or start a
2680 recursive edit, like the fancy splash screen in server.el's
2681 filter. If this longjmp wasn't here, read_key_sequence would
2682 interpret the next key sequence using the wrong translation
2683 tables and function keymaps. */
2684 if (NILP (c
) && current_kboard
!= orig_kboard
)
2687 return make_number (-2); /* wrong_kboard_jmpbuf */
2690 /* If this has become non-nil here, it has been set by a timer
2691 or sentinel or filter. */
2692 if (CONSP (Vunread_command_events
))
2694 c
= XCAR (Vunread_command_events
);
2695 Vunread_command_events
= XCDR (Vunread_command_events
);
2698 /* Read something from current KBOARD's side queue, if possible. */
2702 if (current_kboard
->kbd_queue_has_data
)
2704 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2706 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2707 kset_kbd_queue (current_kboard
,
2708 XCDR (KVAR (current_kboard
, kbd_queue
)));
2709 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2710 current_kboard
->kbd_queue_has_data
= 0;
2711 input_pending
= readable_events (0);
2712 if (EVENT_HAS_PARAMETERS (c
)
2713 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2714 internal_last_event_frame
= XCAR (XCDR (c
));
2715 Vlast_event_frame
= internal_last_event_frame
;
2719 /* If current_kboard's side queue is empty check the other kboards.
2720 If one of them has data that we have not yet seen here,
2721 switch to it and process the data waiting for it.
2723 Note: if the events queued up for another kboard
2724 have already been seen here, and therefore are not a complete command,
2725 the kbd_queue_has_data field is 0, so we skip that kboard here.
2726 That's to avoid an infinite loop switching between kboards here. */
2727 if (NILP (c
) && !single_kboard
)
2730 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2731 if (kb
->kbd_queue_has_data
)
2733 current_kboard
= kb
;
2734 /* This is going to exit from read_char
2735 so we had better get rid of this frame's stuff. */
2737 return make_number (-2); /* wrong_kboard_jmpbuf */
2745 /* Finally, we read from the main queue,
2746 and if that gives us something we can't use yet, we put it on the
2747 appropriate side queue and try again. */
2751 KBOARD
*kb
IF_LINT (= NULL
);
2753 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2756 /* Actually read a character, waiting if necessary. */
2757 save_getcjmp (save_jump
);
2758 restore_getcjmp (local_getcjmp
);
2760 timer_start_idle ();
2761 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2762 restore_getcjmp (save_jump
);
2764 if (! NILP (c
) && (kb
!= current_kboard
))
2766 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2769 while (CONSP (XCDR (last
)))
2771 if (!NILP (XCDR (last
)))
2775 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2777 XSETCDR (last
, Fcons (c
, Qnil
));
2778 kb
->kbd_queue_has_data
= 1;
2782 current_kboard
= kb
;
2783 /* This is going to exit from read_char
2784 so we had better get rid of this frame's stuff. */
2786 return make_number (-2);
2790 /* Terminate Emacs in batch mode if at eof. */
2791 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2792 Fkill_emacs (make_number (1));
2796 /* Add in any extra modifiers, where appropriate. */
2797 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2798 || ((extra_keyboard_modifiers
& 0177) < ' '
2799 && (extra_keyboard_modifiers
& 0177) != 0))
2800 XSETINT (c
, make_ctrl_char (XINT (c
)));
2802 /* Transfer any other modifier bits directly from
2803 extra_keyboard_modifiers to c. Ignore the actual character code
2804 in the low 16 bits of extra_keyboard_modifiers. */
2805 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2816 if (commandflag
>= 0
2817 && !input_pending
&& !detect_input_pending_run_timers (0))
2823 /* Buffer switch events are only for internal wakeups
2824 so don't show them to the user.
2825 Also, don't record a key if we already did. */
2829 /* Process special events within read_char
2830 and loop around to read another event. */
2833 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2838 struct buffer
*prev_buffer
= current_buffer
;
2839 last_input_event
= c
;
2840 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2842 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2843 /* We stopped being idle for this event; undo that. This
2844 prevents automatic window selection (under
2845 mouse_autoselect_window from acting as a real input event, for
2846 example banishing the mouse under mouse-avoidance-mode. */
2847 timer_resume_idle ();
2849 if (current_buffer
!= prev_buffer
)
2851 /* The command may have changed the keymaps. Pretend there
2852 is input in another keyboard and return. This will
2853 recalculate keymaps. */
2854 c
= make_number (-2);
2861 /* Handle things that only apply to characters. */
2864 /* If kbd_buffer_get_event gave us an EOF, return that. */
2868 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2869 && UNSIGNED_CMP (XFASTINT (c
), <,
2870 SCHARS (KVAR (current_kboard
,
2871 Vkeyboard_translate_table
))))
2872 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2873 && UNSIGNED_CMP (XFASTINT (c
), <,
2874 ASIZE (KVAR (current_kboard
,
2875 Vkeyboard_translate_table
))))
2876 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2880 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2881 /* nil in keyboard-translate-table means no translation. */
2887 /* If this event is a mouse click in the menu bar,
2888 return just menu-bar for now. Modify the mouse click event
2889 so we won't do this twice, then queue it up. */
2890 if (EVENT_HAS_PARAMETERS (c
)
2892 && CONSP (EVENT_START (c
))
2893 && CONSP (XCDR (EVENT_START (c
))))
2897 posn
= POSN_POSN (EVENT_START (c
));
2898 /* Handle menu-bar events:
2899 insert the dummy prefix event `menu-bar'. */
2900 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2902 /* Change menu-bar to (menu-bar) as the event "position". */
2903 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2906 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2911 /* Store these characters into recent_keys, the dribble file if any,
2912 and the keyboard macro being defined, if any. */
2914 if (! NILP (also_record
))
2915 record_char (also_record
);
2917 /* Wipe the echo area.
2918 But first, if we are about to use an input method,
2919 save the echo area contents for it to refer to. */
2921 && ! NILP (Vinput_method_function
)
2922 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2924 previous_echo_area_message
= Fcurrent_message ();
2925 Vinput_method_previous_message
= previous_echo_area_message
;
2928 /* Now wipe the echo area, except for help events which do their
2929 own stuff with the echo area. */
2931 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2932 && !(EQ (Qswitch_frame
, XCAR (c
)))
2933 /* Don't wipe echo area for select window events: These might
2934 get delayed via `mouse-autoselect-window' (Bug#11304). */
2935 && !(EQ (Qselect_window
, XCAR (c
)))))
2937 if (!NILP (echo_area_buffer
[0]))
2939 safe_run_hooks (Qecho_area_clear_hook
);
2940 clear_message (1, 0);
2944 reread_for_input_method
:
2946 /* Pass this to the input method, if appropriate. */
2948 && ! NILP (Vinput_method_function
)
2949 /* Don't run the input method within a key sequence,
2950 after the first event of the key sequence. */
2951 && NILP (prev_event
)
2952 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2955 ptrdiff_t key_count
;
2956 bool key_count_reset
;
2957 struct gcpro gcpro1
;
2958 ptrdiff_t count
= SPECPDL_INDEX ();
2960 /* Save the echo status. */
2961 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2962 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2963 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2964 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2967 if (before_command_restore_flag
)
2969 this_command_key_count
= before_command_key_count_1
;
2970 if (this_command_key_count
< this_single_command_key_start
)
2971 this_single_command_key_start
= this_command_key_count
;
2972 echo_truncate (before_command_echo_length_1
);
2973 before_command_restore_flag
= 0;
2977 /* Save the this_command_keys status. */
2978 key_count
= this_command_key_count
;
2979 key_count_reset
= this_command_key_count_reset
;
2982 keys
= Fcopy_sequence (this_command_keys
);
2987 /* Clear out this_command_keys. */
2988 this_command_key_count
= 0;
2989 this_command_key_count_reset
= 0;
2991 /* Now wipe the echo area. */
2992 if (!NILP (echo_area_buffer
[0]))
2993 safe_run_hooks (Qecho_area_clear_hook
);
2994 clear_message (1, 0);
2997 /* If we are not reading a key sequence,
2998 never use the echo area. */
3001 specbind (Qinput_method_use_echo_area
, Qt
);
3004 /* Call the input method. */
3005 tem
= call1 (Vinput_method_function
, c
);
3007 tem
= unbind_to (count
, tem
);
3009 /* Restore the saved echoing state
3010 and this_command_keys state. */
3011 this_command_key_count
= key_count
;
3012 this_command_key_count_reset
= key_count_reset
;
3014 this_command_keys
= keys
;
3017 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3018 kset_echo_string (current_kboard
, saved_echo_string
);
3019 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3020 if (saved_immediate_echo
)
3025 /* The input method can return no events. */
3028 /* Bring back the previous message, if any. */
3029 if (! NILP (previous_echo_area_message
))
3030 message_with_string ("%s", previous_echo_area_message
, 0);
3033 /* It returned one event or more. */
3035 Vunread_post_input_method_events
3036 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3041 /* Display help if not echoing. */
3042 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3044 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3045 Lisp_Object help
, object
, position
, window
, htem
;
3047 htem
= Fcdr (XCDR (c
));
3050 window
= Fcar (htem
);
3052 object
= Fcar (htem
);
3054 position
= Fcar (htem
);
3056 show_help_echo (help
, window
, object
, position
);
3058 /* We stopped being idle for this event; undo that. */
3060 timer_resume_idle ();
3064 if ((! reread
|| this_command_key_count
== 0
3065 || this_command_key_count_reset
)
3069 /* Don't echo mouse motion events. */
3070 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3071 && NILP (Fzerop (Vecho_keystrokes
))
3072 && ! (EVENT_HAS_PARAMETERS (c
)
3073 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3076 if (! NILP (also_record
))
3077 echo_char (also_record
);
3078 /* Once we reread a character, echoing can happen
3079 the next time we pause to read a new one. */
3080 ok_to_echo_at_next_pause
= current_kboard
;
3083 /* Record this character as part of the current key. */
3084 add_command_key (c
);
3085 if (! NILP (also_record
))
3086 add_command_key (also_record
);
3089 last_input_event
= c
;
3092 /* Process the help character specially if enabled */
3093 if (!NILP (Vhelp_form
) && help_char_p (c
))
3095 ptrdiff_t count
= SPECPDL_INDEX ();
3097 help_form_saved_window_configs
3098 = Fcons (Fcurrent_window_configuration (Qnil
),
3099 help_form_saved_window_configs
);
3100 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3101 call0 (Qhelp_form_show
);
3106 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3107 if (EVENT_HAS_PARAMETERS (c
)
3108 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3109 XSETCAR (help_form_saved_window_configs
, Qnil
);
3111 while (BUFFERP (c
));
3112 /* Remove the help from the frame */
3113 unbind_to (count
, Qnil
);
3116 if (EQ (c
, make_number (040)))
3120 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3121 while (BUFFERP (c
));
3130 /* Record a key that came from a mouse menu.
3131 Record it for echoing, for this-command-keys, and so on. */
3134 record_menu_key (Lisp_Object c
)
3136 /* Wipe the echo area. */
3137 clear_message (1, 0);
3142 before_command_key_count
= this_command_key_count
;
3143 before_command_echo_length
= echo_length ();
3146 /* Don't echo mouse motion events. */
3147 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3148 && NILP (Fzerop (Vecho_keystrokes
)))
3152 /* Once we reread a character, echoing can happen
3153 the next time we pause to read a new one. */
3154 ok_to_echo_at_next_pause
= 0;
3157 /* Record this character as part of the current key. */
3158 add_command_key (c
);
3160 /* Re-reading in the middle of a command */
3161 last_input_event
= c
;
3165 /* Return true if should recognize C as "the help character". */
3168 help_char_p (Lisp_Object c
)
3172 if (EQ (c
, Vhelp_char
))
3174 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3175 if (EQ (c
, XCAR (tail
)))
3180 /* Record the input event C in various ways. */
3183 record_char (Lisp_Object c
)
3187 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3189 /* To avoid filling recent_keys with help-echo and mouse-movement
3190 events, we filter out repeated help-echo events, only store the
3191 first and last in a series of mouse-movement events, and don't
3192 store repeated help-echo events which are only separated by
3193 mouse-movement events. */
3195 Lisp_Object ev1
, ev2
, ev3
;
3198 if ((ix1
= recent_keys_index
- 1) < 0)
3199 ix1
= NUM_RECENT_KEYS
- 1;
3200 ev1
= AREF (recent_keys
, ix1
);
3202 if ((ix2
= ix1
- 1) < 0)
3203 ix2
= NUM_RECENT_KEYS
- 1;
3204 ev2
= AREF (recent_keys
, ix2
);
3206 if ((ix3
= ix2
- 1) < 0)
3207 ix3
= NUM_RECENT_KEYS
- 1;
3208 ev3
= AREF (recent_keys
, ix3
);
3210 if (EQ (XCAR (c
), Qhelp_echo
))
3212 /* Don't record `help-echo' in recent_keys unless it shows some help
3213 message, and a different help than the previously recorded
3215 Lisp_Object help
, last_help
;
3217 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3218 if (!STRINGP (help
))
3220 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3221 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3223 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3224 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3225 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3227 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3228 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3229 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3230 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3233 else if (EQ (XCAR (c
), Qmouse_movement
))
3235 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3236 So additional mouse movement events replace the last element. */
3237 Lisp_Object last_window
, window
;
3239 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3240 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3241 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3242 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3243 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3245 ASET (recent_keys
, ix1
, c
);
3251 store_kbd_macro_char (c
);
3255 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3256 ASET (recent_keys
, recent_keys_index
, c
);
3257 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3258 recent_keys_index
= 0;
3260 else if (recorded
< 0)
3262 /* We need to remove one or two events from recent_keys.
3263 To do this, we simply put nil at those events and move the
3264 recent_keys_index backwards over those events. Usually,
3265 users will never see those nil events, as they will be
3266 overwritten by the command keys entered to see recent_keys
3269 while (recorded
++ < 0 && total_keys
> 0)
3271 if (total_keys
< NUM_RECENT_KEYS
)
3273 if (--recent_keys_index
< 0)
3274 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3275 ASET (recent_keys
, recent_keys_index
, Qnil
);
3279 num_nonmacro_input_events
++;
3281 /* Write c to the dribble file. If c is a lispy event, write
3282 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3283 If you, dear reader, have a better idea, you've got the source. :-) */
3289 if (XUINT (c
) < 0x100)
3290 putc (XUINT (c
), dribble
);
3292 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3296 Lisp_Object dribblee
;
3298 /* If it's a structured event, take the event header. */
3299 dribblee
= EVENT_HEAD (c
);
3301 if (SYMBOLP (dribblee
))
3303 putc ('<', dribble
);
3304 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3305 SBYTES (SYMBOL_NAME (dribblee
)),
3307 putc ('>', dribble
);
3316 /* Copy out or in the info on where C-g should throw to.
3317 This is used when running Lisp code from within get_char,
3318 in case get_char is called recursively.
3319 See read_process_output. */
3322 save_getcjmp (sys_jmp_buf temp
)
3324 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3328 restore_getcjmp (sys_jmp_buf temp
)
3330 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3333 /* Low level keyboard/mouse input.
3334 kbd_buffer_store_event places events in kbd_buffer, and
3335 kbd_buffer_get_event retrieves them. */
3337 /* Return true if there are any events in the queue that read-char
3338 would return. If this returns false, a read-char would block. */
3340 readable_events (int flags
)
3342 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3345 /* If the buffer contains only FOCUS_IN_EVENT events, and
3346 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3347 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3349 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3350 #ifdef USE_TOOLKIT_SCROLL_BARS
3351 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3355 struct input_event
*event
;
3357 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3364 #ifdef USE_TOOLKIT_SCROLL_BARS
3365 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3367 event
->kind
== FOCUS_IN_EVENT
)
3368 #ifdef USE_TOOLKIT_SCROLL_BARS
3369 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3370 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3371 && event
->part
== scroll_bar_handle
3372 && event
->modifiers
== 0)
3377 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3380 while (event
!= kbd_store_ptr
);
3386 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3387 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3391 if (current_kboard
->kbd_queue_has_data
)
3397 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3398 if (kb
->kbd_queue_has_data
)
3404 /* Set this for debugging, to have a way to get out */
3405 int stop_character EXTERNALLY_VISIBLE
;
3408 event_to_kboard (struct input_event
*event
)
3410 /* Not applicable for these special events. */
3411 if (event
->kind
== SELECTION_REQUEST_EVENT
3412 || event
->kind
== SELECTION_CLEAR_EVENT
)
3416 Lisp_Object obj
= event
->frame_or_window
;
3417 /* There are some events that set this field to nil or string. */
3419 obj
= WINDOW_FRAME (XWINDOW (obj
));
3420 /* Also ignore dead frames here. */
3421 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3422 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3427 /* Return the number of slots occupied in kbd_buffer. */
3430 kbd_buffer_nr_stored (void)
3432 return kbd_fetch_ptr
== kbd_store_ptr
3434 : (kbd_fetch_ptr
< kbd_store_ptr
3435 ? kbd_store_ptr
- kbd_fetch_ptr
3436 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3437 + (kbd_store_ptr
- kbd_buffer
)));
3439 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3442 kbd_buffer_store_event (register struct input_event
*event
)
3444 kbd_buffer_store_event_hold (event
, 0);
3447 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3449 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3450 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3451 Else, if EVENT is a quit event, store the quit event
3452 in HOLD_QUIT, and return (thus ignoring further events).
3454 This is used to postpone the processing of the quit event until all
3455 subsequent input events have been parsed (and discarded). */
3458 kbd_buffer_store_event_hold (register struct input_event
*event
,
3459 struct input_event
*hold_quit
)
3461 if (event
->kind
== NO_EVENT
)
3464 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3467 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3469 register int c
= event
->code
& 0377;
3471 if (event
->modifiers
& ctrl_modifier
)
3472 c
= make_ctrl_char (c
);
3474 c
|= (event
->modifiers
3475 & (meta_modifier
| alt_modifier
3476 | hyper_modifier
| super_modifier
));
3480 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3481 struct input_event
*sp
;
3483 if (single_kboard
&& kb
!= current_kboard
)
3486 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3487 Fcons (make_number (c
), Qnil
)));
3488 kb
->kbd_queue_has_data
= 1;
3489 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3491 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3494 if (event_to_kboard (sp
) == kb
)
3496 sp
->kind
= NO_EVENT
;
3497 sp
->frame_or_window
= Qnil
;
3506 *hold_quit
= *event
;
3510 /* If this results in a quit_char being returned to Emacs as
3511 input, set Vlast_event_frame properly. If this doesn't
3512 get returned to Emacs as an event, the next event read
3513 will set Vlast_event_frame again, so this is safe to do. */
3517 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3519 focus
= event
->frame_or_window
;
3520 internal_last_event_frame
= focus
;
3521 Vlast_event_frame
= focus
;
3524 last_event_timestamp
= event
->timestamp
;
3526 handle_interrupt (0);
3530 if (c
&& c
== stop_character
)
3536 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3537 Just ignore the second one. */
3538 else if (event
->kind
== BUFFER_SWITCH_EVENT
3539 && kbd_fetch_ptr
!= kbd_store_ptr
3540 && ((kbd_store_ptr
== kbd_buffer
3541 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3542 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3545 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3546 kbd_store_ptr
= kbd_buffer
;
3548 /* Don't let the very last slot in the buffer become full,
3549 since that would make the two pointers equal,
3550 and that is indistinguishable from an empty buffer.
3551 Discard the event if it would fill the last slot. */
3552 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3554 *kbd_store_ptr
= *event
;
3557 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3559 /* Don't read keyboard input until we have processed kbd_buffer.
3560 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3561 hold_keyboard_input ();
3562 if (!noninteractive
)
3566 #endif /* subprocesses */
3569 /* If we're inside while-no-input, and this event qualifies
3570 as input, set quit-flag to cause an interrupt. */
3571 if (!NILP (Vthrow_on_input
)
3572 && event
->kind
!= FOCUS_IN_EVENT
3573 && event
->kind
!= HELP_EVENT
3574 && event
->kind
!= DEICONIFY_EVENT
)
3576 Vquit_flag
= Vthrow_on_input
;
3577 /* If we're inside a function that wants immediate quits,
3579 if (immediate_quit
&& NILP (Vinhibit_quit
))
3588 /* Put an input event back in the head of the event queue. */
3591 kbd_buffer_unget_event (register struct input_event
*event
)
3593 if (kbd_fetch_ptr
== kbd_buffer
)
3594 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3596 /* Don't let the very last slot in the buffer become full, */
3597 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3600 *kbd_fetch_ptr
= *event
;
3605 /* Generate a HELP_EVENT input_event and store it in the keyboard
3608 HELP is the help form.
3610 FRAME and WINDOW are the frame and window where the help is
3611 generated. OBJECT is the Lisp object where the help was found (a
3612 buffer, a string, an overlay, or nil if neither from a string nor
3613 from a buffer). POS is the position within OBJECT where the help
3617 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3618 Lisp_Object object
, ptrdiff_t pos
)
3620 struct input_event event
;
3624 event
.kind
= HELP_EVENT
;
3625 event
.frame_or_window
= frame
;
3627 event
.x
= WINDOWP (window
) ? window
: frame
;
3630 kbd_buffer_store_event (&event
);
3634 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3637 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3639 struct input_event event
;
3641 event
.kind
= HELP_EVENT
;
3642 event
.frame_or_window
= frame
;
3647 kbd_buffer_store_event (&event
);
3651 /* Discard any mouse events in the event buffer by setting them to
3654 discard_mouse_events (void)
3656 struct input_event
*sp
;
3657 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3659 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3662 if (sp
->kind
== MOUSE_CLICK_EVENT
3663 || sp
->kind
== WHEEL_EVENT
3664 || sp
->kind
== HORIZ_WHEEL_EVENT
3666 || sp
->kind
== GPM_CLICK_EVENT
3668 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3670 sp
->kind
= NO_EVENT
;
3676 /* Return true if there are any real events waiting in the event
3677 buffer, not counting `NO_EVENT's.
3679 Discard NO_EVENT events at the front of the input queue, possibly
3680 leaving the input queue empty if there are no real input events. */
3683 kbd_buffer_events_waiting (void)
3685 struct input_event
*sp
;
3687 for (sp
= kbd_fetch_ptr
;
3688 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3691 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3696 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3700 /* Clear input event EVENT. */
3703 clear_event (struct input_event
*event
)
3705 event
->kind
= NO_EVENT
;
3709 /* Read one event from the event buffer, waiting if necessary.
3710 The value is a Lisp object representing the event.
3711 The value is nil for an event that should be ignored,
3712 or that was handled here.
3713 We always read and discard one event. */
3716 kbd_buffer_get_event (KBOARD
**kbp
,
3717 bool *used_mouse_menu
,
3718 EMACS_TIME
*end_time
)
3723 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3725 /* Start reading input again because we have processed enough to
3726 be able to accept new events again. */
3727 unhold_keyboard_input ();
3730 #endif /* subprocesses */
3732 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3734 /* In case we are running as a daemon, only do this before
3735 detaching from the terminal. */
3736 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3740 *kbp
= current_kboard
;
3743 #endif /* ! HAVE_DBUS */
3745 /* Wait until there is input available. */
3748 /* Break loop if there's an unread command event. Needed in
3749 moused window autoselection which uses a timer to insert such
3751 if (CONSP (Vunread_command_events
))
3754 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3756 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3759 /* If the quit flag is set, then read_char will return
3760 quit_char, so that counts as "available input." */
3761 if (!NILP (Vquit_flag
))
3762 quit_throw_to_read_char (0);
3764 /* One way or another, wait until input is available; then, if
3765 interrupt handlers have not read it, read it now. */
3770 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3772 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3776 EMACS_TIME now
= current_emacs_time ();
3777 if (EMACS_TIME_LE (*end_time
, now
))
3778 return Qnil
; /* Finished waiting. */
3781 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3782 wait_reading_process_output (min (EMACS_SECS (duration
),
3784 EMACS_NSECS (duration
),
3785 -1, 1, Qnil
, NULL
, 0);
3789 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3791 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3795 if (CONSP (Vunread_command_events
))
3798 first
= XCAR (Vunread_command_events
);
3799 Vunread_command_events
= XCDR (Vunread_command_events
);
3800 *kbp
= current_kboard
;
3804 /* At this point, we know that there is a readable event available
3805 somewhere. If the event queue is empty, then there must be a
3806 mouse movement enabled and available. */
3807 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3809 struct input_event
*event
;
3811 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3815 last_event_timestamp
= event
->timestamp
;
3817 *kbp
= event_to_kboard (event
);
3819 *kbp
= current_kboard
; /* Better than returning null ptr? */
3823 /* These two kinds of events get special handling
3824 and don't actually appear to the command loop.
3825 We return nil for them. */
3826 if (event
->kind
== SELECTION_REQUEST_EVENT
3827 || event
->kind
== SELECTION_CLEAR_EVENT
)
3830 struct input_event copy
;
3832 /* Remove it from the buffer before processing it,
3833 since otherwise swallow_events will see it
3834 and process it again. */
3836 kbd_fetch_ptr
= event
+ 1;
3837 input_pending
= readable_events (0);
3838 x_handle_selection_event (©
);
3840 /* We're getting selection request events, but we don't have
3846 #if defined (HAVE_NS)
3847 else if (event
->kind
== NS_TEXT_EVENT
)
3849 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3850 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3852 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3853 kbd_fetch_ptr
= event
+ 1;
3854 if (used_mouse_menu
)
3855 *used_mouse_menu
= 1;
3859 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3860 || defined (HAVE_NS)
3861 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3863 /* Make an event (delete-frame (FRAME)). */
3864 obj
= Fcons (event
->frame_or_window
, Qnil
);
3865 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3866 kbd_fetch_ptr
= event
+ 1;
3869 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3870 || defined (HAVE_NS)
3871 else if (event
->kind
== ICONIFY_EVENT
)
3873 /* Make an event (iconify-frame (FRAME)). */
3874 obj
= Fcons (event
->frame_or_window
, Qnil
);
3875 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3876 kbd_fetch_ptr
= event
+ 1;
3878 else if (event
->kind
== DEICONIFY_EVENT
)
3880 /* Make an event (make-frame-visible (FRAME)). */
3881 obj
= Fcons (event
->frame_or_window
, Qnil
);
3882 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3883 kbd_fetch_ptr
= event
+ 1;
3886 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3888 /* The value doesn't matter here; only the type is tested. */
3889 XSETBUFFER (obj
, current_buffer
);
3890 kbd_fetch_ptr
= event
+ 1;
3892 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3893 || defined (HAVE_NS) || defined (USE_GTK)
3894 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3896 kbd_fetch_ptr
= event
+ 1;
3897 input_pending
= readable_events (0);
3898 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3899 x_activate_menubar (XFRAME (event
->frame_or_window
));
3903 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3905 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3906 obj
= Fcons (Qlanguage_change
,
3907 list3 (event
->frame_or_window
,
3908 make_number (event
->code
),
3909 make_number (event
->modifiers
)));
3910 kbd_fetch_ptr
= event
+ 1;
3912 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3914 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3915 obj
= Fcons (Qfile_w32notify
,
3916 list2 (list3 (make_number (event
->code
),
3919 event
->frame_or_window
));
3920 kbd_fetch_ptr
= event
+ 1;
3923 else if (event
->kind
== SAVE_SESSION_EVENT
)
3925 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3926 kbd_fetch_ptr
= event
+ 1;
3928 /* Just discard these, by returning nil.
3929 With MULTI_KBOARD, these events are used as placeholders
3930 when we need to randomly delete events from the queue.
3931 (They shouldn't otherwise be found in the buffer,
3932 but on some machines it appears they do show up
3933 even without MULTI_KBOARD.) */
3934 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3935 mouse events during a popup-menu call. */
3936 else if (event
->kind
== NO_EVENT
)
3937 kbd_fetch_ptr
= event
+ 1;
3938 else if (event
->kind
== HELP_EVENT
)
3940 Lisp_Object object
, position
, help
, frame
, window
;
3942 frame
= event
->frame_or_window
;
3943 object
= event
->arg
;
3944 position
= make_number (event
->code
);
3947 clear_event (event
);
3949 kbd_fetch_ptr
= event
+ 1;
3950 if (!WINDOWP (window
))
3952 obj
= Fcons (Qhelp_echo
,
3953 list5 (frame
, help
, window
, object
, position
));
3955 else if (event
->kind
== FOCUS_IN_EVENT
)
3957 /* Notification of a FocusIn event. The frame receiving the
3958 focus is in event->frame_or_window. Generate a
3959 switch-frame event if necessary. */
3960 Lisp_Object frame
, focus
;
3962 frame
= event
->frame_or_window
;
3963 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3967 if (!EQ (frame
, internal_last_event_frame
)
3968 && !EQ (frame
, selected_frame
))
3969 obj
= make_lispy_switch_frame (frame
);
3970 internal_last_event_frame
= frame
;
3971 kbd_fetch_ptr
= event
+ 1;
3974 else if (event
->kind
== DBUS_EVENT
)
3976 obj
= make_lispy_event (event
);
3977 kbd_fetch_ptr
= event
+ 1;
3981 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3983 obj
= make_lispy_event (event
);
3984 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3989 obj
= make_lispy_event (event
);
3990 kbd_fetch_ptr
= event
+ 1;
3994 /* If this event is on a different frame, return a switch-frame this
3995 time, and leave the event in the queue for next time. */
3999 frame
= event
->frame_or_window
;
4001 frame
= XCAR (frame
);
4002 else if (WINDOWP (frame
))
4003 frame
= WINDOW_FRAME (XWINDOW (frame
));
4005 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4009 if (! EQ (frame
, internal_last_event_frame
)
4010 && !EQ (frame
, selected_frame
))
4011 obj
= make_lispy_switch_frame (frame
);
4012 internal_last_event_frame
= frame
;
4014 /* If we didn't decide to make a switch-frame event, go ahead
4015 and build a real event from the queue entry. */
4019 obj
= make_lispy_event (event
);
4021 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4022 || defined (HAVE_NS) || defined (USE_GTK)
4023 /* If this was a menu selection, then set the flag to inhibit
4024 writing to last_nonmenu_event. Don't do this if the event
4025 we're returning is (menu-bar), though; that indicates the
4026 beginning of the menu sequence, and we might as well leave
4027 that as the `event with parameters' for this selection. */
4029 && !EQ (event
->frame_or_window
, event
->arg
)
4030 && (event
->kind
== MENU_BAR_EVENT
4031 || event
->kind
== TOOL_BAR_EVENT
))
4032 *used_mouse_menu
= 1;
4035 /* Certain system events are non-key events. */
4037 && event
->kind
== NS_NONKEY_EVENT
)
4038 *used_mouse_menu
= 1;
4041 /* Wipe out this event, to catch bugs. */
4042 clear_event (event
);
4043 kbd_fetch_ptr
= event
+ 1;
4047 /* Try generating a mouse motion event. */
4048 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4050 FRAME_PTR f
= some_mouse_moved ();
4051 Lisp_Object bar_window
;
4052 enum scroll_bar_part part
;
4056 *kbp
= current_kboard
;
4057 /* Note that this uses F to determine which terminal to look at.
4058 If there is no valid info, it does not store anything
4059 so x remains nil. */
4062 /* XXX Can f or mouse_position_hook be NULL here? */
4063 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4064 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4069 /* Decide if we should generate a switch-frame event. Don't
4070 generate switch-frame events for motion outside of all Emacs
4076 frame
= FRAME_FOCUS_FRAME (f
);
4078 XSETFRAME (frame
, f
);
4080 if (! EQ (frame
, internal_last_event_frame
)
4081 && !EQ (frame
, selected_frame
))
4082 obj
= make_lispy_switch_frame (frame
);
4083 internal_last_event_frame
= frame
;
4086 /* If we didn't decide to make a switch-frame event, go ahead and
4087 return a mouse-motion event. */
4088 if (!NILP (x
) && NILP (obj
))
4089 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4092 /* We were promised by the above while loop that there was
4093 something for us to read! */
4096 input_pending
= readable_events (0);
4098 Vlast_event_frame
= internal_last_event_frame
;
4103 /* Process any non-user-visible events (currently X selection events),
4104 without reading any user-visible events. */
4107 process_special_events (void)
4109 struct input_event
*event
;
4111 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4113 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4116 if (event
== kbd_store_ptr
)
4120 /* If we find a stored X selection request, handle it now. */
4121 if (event
->kind
== SELECTION_REQUEST_EVENT
4122 || event
->kind
== SELECTION_CLEAR_EVENT
)
4126 /* Remove the event from the fifo buffer before processing;
4127 otherwise swallow_events called recursively could see it
4128 and process it again. To do this, we move the events
4129 between kbd_fetch_ptr and EVENT one slot to the right,
4132 struct input_event copy
= *event
;
4133 struct input_event
*beg
4134 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4135 ? kbd_buffer
: kbd_fetch_ptr
;
4138 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4139 else if (event
< beg
)
4141 if (event
> kbd_buffer
)
4142 memmove (kbd_buffer
+ 1, kbd_buffer
,
4143 (event
- kbd_buffer
) * sizeof (struct input_event
));
4144 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4145 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4146 memmove (beg
+ 1, beg
,
4147 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4148 * sizeof (struct input_event
));
4151 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4152 kbd_fetch_ptr
= kbd_buffer
+ 1;
4156 /* X wants last_event_timestamp for selection ownership. */
4157 last_event_timestamp
= copy
.timestamp
;
4158 input_pending
= readable_events (0);
4159 x_handle_selection_event (©
);
4161 /* We're getting selection request events, but we don't have
4169 /* Process any events that are not user-visible, run timer events that
4170 are ripe, and return, without reading any user-visible events. */
4173 swallow_events (bool do_display
)
4175 unsigned old_timers_run
;
4177 process_special_events ();
4179 old_timers_run
= timers_run
;
4180 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4182 if (timers_run
!= old_timers_run
&& do_display
)
4183 redisplay_preserve_echo_area (7);
4186 /* Record the start of when Emacs is idle,
4187 for the sake of running idle-time timers. */
4190 timer_start_idle (void)
4194 /* If we are already in the idle state, do nothing. */
4195 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4198 timer_idleness_start_time
= current_emacs_time ();
4199 timer_last_idleness_start_time
= timer_idleness_start_time
;
4201 /* Mark all idle-time timers as once again candidates for running. */
4202 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4206 timer
= XCAR (timers
);
4208 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4210 ASET (timer
, 0, Qnil
);
4214 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4217 timer_stop_idle (void)
4219 timer_idleness_start_time
= invalid_emacs_time ();
4222 /* Resume idle timer from last idle start time. */
4225 timer_resume_idle (void)
4227 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4230 timer_idleness_start_time
= timer_last_idleness_start_time
;
4233 /* This is only for debugging. */
4234 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4236 /* List of elisp functions to call, delayed because they were generated in
4237 a context where Elisp could not be safely run (e.g. redisplay, signal,
4238 ...). Each element has the form (FUN . ARGS). */
4239 Lisp_Object pending_funcalls
;
4241 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4243 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4245 Lisp_Object
*vector
;
4247 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4249 vector
= XVECTOR (timer
)->contents
;
4250 if (! NILP (vector
[0]))
4253 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4258 /* Check whether a timer has fired. To prevent larger problems we simply
4259 disregard elements that are not proper timers. Do not make a circular
4260 timer list for the time being.
4262 Returns the time to wait until the next timer fires. If a
4263 timer is triggering now, return zero.
4264 If no timer is active, return -1.
4266 If a timer is ripe, we run it, with quitting turned off.
4267 In that case we return 0 to indicate that a new timer_check_2 call
4271 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4273 EMACS_TIME nexttime
;
4275 EMACS_TIME idleness_now
;
4276 Lisp_Object chosen_timer
;
4277 struct gcpro gcpro1
;
4279 nexttime
= invalid_emacs_time ();
4281 chosen_timer
= Qnil
;
4282 GCPRO1 (chosen_timer
);
4284 /* First run the code that was delayed. */
4285 while (CONSP (pending_funcalls
))
4287 Lisp_Object funcall
= XCAR (pending_funcalls
);
4288 pending_funcalls
= XCDR (pending_funcalls
);
4289 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4292 if (CONSP (timers
) || CONSP (idle_timers
))
4294 now
= current_emacs_time ();
4295 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4296 ? sub_emacs_time (now
, timer_idleness_start_time
)
4297 : make_emacs_time (0, 0));
4300 while (CONSP (timers
) || CONSP (idle_timers
))
4302 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4303 EMACS_TIME timer_time
, idle_timer_time
;
4304 EMACS_TIME difference
;
4305 EMACS_TIME timer_difference
= invalid_emacs_time ();
4306 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4307 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4309 /* Set TIMER and TIMER_DIFFERENCE
4310 based on the next ordinary timer.
4311 TIMER_DIFFERENCE is the distance in time from NOW to when
4312 this timer becomes ripe (negative if it's already ripe).
4313 Skip past invalid timers and timers already handled. */
4316 timer
= XCAR (timers
);
4317 if (! decode_timer (timer
, &timer_time
))
4319 timers
= XCDR (timers
);
4323 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4324 timer_difference
= (timer_ripe
4325 ? sub_emacs_time (now
, timer_time
)
4326 : sub_emacs_time (timer_time
, now
));
4329 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4330 based on the next idle timer. */
4331 if (CONSP (idle_timers
))
4333 idle_timer
= XCAR (idle_timers
);
4334 if (! decode_timer (idle_timer
, &idle_timer_time
))
4336 idle_timers
= XCDR (idle_timers
);
4340 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4341 idle_timer_difference
=
4343 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4344 : sub_emacs_time (idle_timer_time
, idleness_now
));
4347 /* Decide which timer is the next timer,
4348 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4349 Also step down the list where we found that timer. */
4351 if (EMACS_TIME_VALID_P (timer_difference
)
4352 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4353 || idle_timer_ripe
< timer_ripe
4354 || (idle_timer_ripe
== timer_ripe
4356 ? EMACS_TIME_LT (idle_timer_difference
,
4358 : EMACS_TIME_LT (timer_difference
,
4359 idle_timer_difference
)))))
4361 chosen_timer
= timer
;
4362 timers
= XCDR (timers
);
4363 difference
= timer_difference
;
4368 chosen_timer
= idle_timer
;
4369 idle_timers
= XCDR (idle_timers
);
4370 difference
= idle_timer_difference
;
4371 ripe
= idle_timer_ripe
;
4374 /* If timer is ripe, run it if it hasn't been run. */
4377 if (NILP (AREF (chosen_timer
, 0)))
4379 ptrdiff_t count
= SPECPDL_INDEX ();
4380 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4382 /* Mark the timer as triggered to prevent problems if the lisp
4383 code fails to reschedule it right. */
4384 ASET (chosen_timer
, 0, Qt
);
4386 specbind (Qinhibit_quit
, Qt
);
4388 call1 (Qtimer_event_handler
, chosen_timer
);
4389 Vdeactivate_mark
= old_deactivate_mark
;
4391 unbind_to (count
, Qnil
);
4393 /* Since we have handled the event,
4394 we don't need to tell the caller to wake up and do it. */
4395 /* But the caller must still wait for the next timer, so
4396 return 0 to indicate that. */
4399 nexttime
= make_emacs_time (0, 0);
4403 /* When we encounter a timer that is still waiting,
4404 return the amount of time to wait before it is ripe. */
4411 /* No timers are pending in the future. */
4412 /* Return 0 if we generated an event, and -1 if not. */
4418 /* Check whether a timer has fired. To prevent larger problems we simply
4419 disregard elements that are not proper timers. Do not make a circular
4420 timer list for the time being.
4422 Returns the time to wait until the next timer fires.
4423 If no timer is active, return an invalid value.
4425 As long as any timer is ripe, we run it. */
4430 EMACS_TIME nexttime
;
4431 Lisp_Object timers
, idle_timers
;
4432 struct gcpro gcpro1
, gcpro2
;
4434 Lisp_Object tem
= Vinhibit_quit
;
4437 /* We use copies of the timers' lists to allow a timer to add itself
4438 again, without locking up Emacs if the newly added timer is
4439 already ripe when added. */
4441 /* Always consider the ordinary timers. */
4442 timers
= Fcopy_sequence (Vtimer_list
);
4443 /* Consider the idle timers only if Emacs is idle. */
4444 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4445 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4449 Vinhibit_quit
= tem
;
4451 GCPRO2 (timers
, idle_timers
);
4455 nexttime
= timer_check_2 (timers
, idle_timers
);
4457 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4463 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4464 doc
: /* Return the current length of Emacs idleness, or nil.
4465 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4466 in the same style as (current-time).
4468 The value when Emacs is not idle is nil.
4470 PSEC is a multiple of the system clock resolution. */)
4473 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4474 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4475 timer_idleness_start_time
));
4480 /* Caches for modify_event_symbol. */
4481 static Lisp_Object accent_key_syms
;
4482 static Lisp_Object func_key_syms
;
4483 static Lisp_Object mouse_syms
;
4484 static Lisp_Object wheel_syms
;
4485 static Lisp_Object drag_n_drop_syms
;
4487 /* This is a list of keysym codes for special "accent" characters.
4488 It parallels lispy_accent_keys. */
4490 static const int lispy_accent_codes
[] =
4492 #ifdef XK_dead_circumflex
4497 #ifdef XK_dead_grave
4502 #ifdef XK_dead_tilde
4507 #ifdef XK_dead_diaeresis
4512 #ifdef XK_dead_macron
4517 #ifdef XK_dead_degree
4522 #ifdef XK_dead_acute
4527 #ifdef XK_dead_cedilla
4532 #ifdef XK_dead_breve
4537 #ifdef XK_dead_ogonek
4542 #ifdef XK_dead_caron
4547 #ifdef XK_dead_doubleacute
4548 XK_dead_doubleacute
,
4552 #ifdef XK_dead_abovedot
4557 #ifdef XK_dead_abovering
4567 #ifdef XK_dead_belowdot
4572 #ifdef XK_dead_voiced_sound
4573 XK_dead_voiced_sound
,
4577 #ifdef XK_dead_semivoiced_sound
4578 XK_dead_semivoiced_sound
,
4594 /* This is a list of Lisp names for special "accent" characters.
4595 It parallels lispy_accent_codes. */
4597 static const char *const lispy_accent_keys
[] =
4615 "dead-voiced-sound",
4616 "dead-semivoiced-sound",
4622 #define FUNCTION_KEY_OFFSET 0x0
4624 const char *const lispy_function_keys
[] =
4628 0, /* VK_LBUTTON 0x01 */
4629 0, /* VK_RBUTTON 0x02 */
4630 "cancel", /* VK_CANCEL 0x03 */
4631 0, /* VK_MBUTTON 0x04 */
4633 0, 0, 0, /* 0x05 .. 0x07 */
4635 "backspace", /* VK_BACK 0x08 */
4636 "tab", /* VK_TAB 0x09 */
4638 0, 0, /* 0x0A .. 0x0B */
4640 "clear", /* VK_CLEAR 0x0C */
4641 "return", /* VK_RETURN 0x0D */
4643 0, 0, /* 0x0E .. 0x0F */
4645 0, /* VK_SHIFT 0x10 */
4646 0, /* VK_CONTROL 0x11 */
4647 0, /* VK_MENU 0x12 */
4648 "pause", /* VK_PAUSE 0x13 */
4649 "capslock", /* VK_CAPITAL 0x14 */
4650 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4652 "junja", /* VK_JUNJA 0x17 */
4653 "final", /* VK_FINAL 0x18 */
4654 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4656 "escape", /* VK_ESCAPE 0x1B */
4657 "convert", /* VK_CONVERT 0x1C */
4658 "non-convert", /* VK_NONCONVERT 0x1D */
4659 "accept", /* VK_ACCEPT 0x1E */
4660 "mode-change", /* VK_MODECHANGE 0x1F */
4661 0, /* VK_SPACE 0x20 */
4662 "prior", /* VK_PRIOR 0x21 */
4663 "next", /* VK_NEXT 0x22 */
4664 "end", /* VK_END 0x23 */
4665 "home", /* VK_HOME 0x24 */
4666 "left", /* VK_LEFT 0x25 */
4667 "up", /* VK_UP 0x26 */
4668 "right", /* VK_RIGHT 0x27 */
4669 "down", /* VK_DOWN 0x28 */
4670 "select", /* VK_SELECT 0x29 */
4671 "print", /* VK_PRINT 0x2A */
4672 "execute", /* VK_EXECUTE 0x2B */
4673 "snapshot", /* VK_SNAPSHOT 0x2C */
4674 "insert", /* VK_INSERT 0x2D */
4675 "delete", /* VK_DELETE 0x2E */
4676 "help", /* VK_HELP 0x2F */
4678 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4680 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4682 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4684 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4686 0, 0, 0, 0, 0, 0, 0, 0, 0,
4687 0, 0, 0, 0, 0, 0, 0, 0, 0,
4688 0, 0, 0, 0, 0, 0, 0, 0,
4690 "lwindow", /* VK_LWIN 0x5B */
4691 "rwindow", /* VK_RWIN 0x5C */
4692 "apps", /* VK_APPS 0x5D */
4695 "kp-0", /* VK_NUMPAD0 0x60 */
4696 "kp-1", /* VK_NUMPAD1 0x61 */
4697 "kp-2", /* VK_NUMPAD2 0x62 */
4698 "kp-3", /* VK_NUMPAD3 0x63 */
4699 "kp-4", /* VK_NUMPAD4 0x64 */
4700 "kp-5", /* VK_NUMPAD5 0x65 */
4701 "kp-6", /* VK_NUMPAD6 0x66 */
4702 "kp-7", /* VK_NUMPAD7 0x67 */
4703 "kp-8", /* VK_NUMPAD8 0x68 */
4704 "kp-9", /* VK_NUMPAD9 0x69 */
4705 "kp-multiply", /* VK_MULTIPLY 0x6A */
4706 "kp-add", /* VK_ADD 0x6B */
4707 "kp-separator", /* VK_SEPARATOR 0x6C */
4708 "kp-subtract", /* VK_SUBTRACT 0x6D */
4709 "kp-decimal", /* VK_DECIMAL 0x6E */
4710 "kp-divide", /* VK_DIVIDE 0x6F */
4711 "f1", /* VK_F1 0x70 */
4712 "f2", /* VK_F2 0x71 */
4713 "f3", /* VK_F3 0x72 */
4714 "f4", /* VK_F4 0x73 */
4715 "f5", /* VK_F5 0x74 */
4716 "f6", /* VK_F6 0x75 */
4717 "f7", /* VK_F7 0x76 */
4718 "f8", /* VK_F8 0x77 */
4719 "f9", /* VK_F9 0x78 */
4720 "f10", /* VK_F10 0x79 */
4721 "f11", /* VK_F11 0x7A */
4722 "f12", /* VK_F12 0x7B */
4723 "f13", /* VK_F13 0x7C */
4724 "f14", /* VK_F14 0x7D */
4725 "f15", /* VK_F15 0x7E */
4726 "f16", /* VK_F16 0x7F */
4727 "f17", /* VK_F17 0x80 */
4728 "f18", /* VK_F18 0x81 */
4729 "f19", /* VK_F19 0x82 */
4730 "f20", /* VK_F20 0x83 */
4731 "f21", /* VK_F21 0x84 */
4732 "f22", /* VK_F22 0x85 */
4733 "f23", /* VK_F23 0x86 */
4734 "f24", /* VK_F24 0x87 */
4736 0, 0, 0, 0, /* 0x88 .. 0x8B */
4737 0, 0, 0, 0, /* 0x8C .. 0x8F */
4739 "kp-numlock", /* VK_NUMLOCK 0x90 */
4740 "scroll", /* VK_SCROLL 0x91 */
4741 /* Not sure where the following block comes from.
4742 Windows headers have NEC and Fujitsu specific keys in
4743 this block, but nothing generic. */
4744 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4745 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4746 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4747 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4748 "kp-end", /* VK_NUMPAD_END 0x96 */
4749 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4750 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4751 "kp-up", /* VK_NUMPAD_UP 0x99 */
4752 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4753 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4754 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4755 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4757 0, 0, /* 0x9E .. 0x9F */
4760 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4761 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4762 * No other API or message will distinguish left and right keys this way.
4767 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4768 to enable them selectively, and gives access to a few more functions.
4769 See lispy_multimedia_keys below. */
4770 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4771 0, 0, 0, /* 0xAD .. 0xAF Volume */
4772 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4773 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4775 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4776 0, 0, 0, 0, 0, 0, 0, 0, 0,
4778 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4779 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4780 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4783 "ax", /* VK_OEM_AX 0xE1 */
4784 0, /* VK_OEM_102 0xE2 */
4785 "ico-help", /* VK_ICO_HELP 0xE3 */
4786 "ico-00", /* VK_ICO_00 0xE4 */
4787 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4788 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4789 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4791 "reset", /* VK_OEM_RESET 0xE9 */
4792 "jump", /* VK_OEM_JUMP 0xEA */
4793 "oem-pa1", /* VK_OEM_PA1 0xEB */
4794 "oem-pa2", /* VK_OEM_PA2 0xEC */
4795 "oem-pa3", /* VK_OEM_PA3 0xED */
4796 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4797 "cusel", /* VK_OEM_CUSEL 0xEF */
4798 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4799 "finish", /* VK_OEM_FINISH 0xF1 */
4800 "copy", /* VK_OEM_COPY 0xF2 */
4801 "auto", /* VK_OEM_AUTO 0xF3 */
4802 "enlw", /* VK_OEM_ENLW 0xF4 */
4803 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4804 "attn", /* VK_ATTN 0xF6 */
4805 "crsel", /* VK_CRSEL 0xF7 */
4806 "exsel", /* VK_EXSEL 0xF8 */
4807 "ereof", /* VK_EREOF 0xF9 */
4808 "play", /* VK_PLAY 0xFA */
4809 "zoom", /* VK_ZOOM 0xFB */
4810 "noname", /* VK_NONAME 0xFC */
4811 "pa1", /* VK_PA1 0xFD */
4812 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4816 /* Some of these duplicate the "Media keys" on newer keyboards,
4817 but they are delivered to the application in a different way. */
4818 static const char *const lispy_multimedia_keys
[] =
4826 "browser-favorites",
4863 "toggle-dictate-command",
4869 "media-fast-forward",
4872 "media-channel-down"
4875 #else /* not HAVE_NTGUI */
4877 /* This should be dealt with in XTread_socket now, and that doesn't
4878 depend on the client system having the Kana syms defined. See also
4879 the XK_kana_A case below. */
4882 static const char *const lispy_kana_keys
[] =
4884 /* X Keysym value */
4885 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4886 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4887 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4888 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4889 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4890 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4891 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4892 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4894 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4895 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4896 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4897 "kana-i", "kana-u", "kana-e", "kana-o",
4898 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4899 "prolongedsound", "kana-A", "kana-I", "kana-U",
4900 "kana-E", "kana-O", "kana-KA", "kana-KI",
4901 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4902 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4903 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4904 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4905 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4906 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4907 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4908 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4909 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4910 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4911 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4912 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4914 #endif /* XK_kana_A */
4917 #define FUNCTION_KEY_OFFSET 0xff00
4919 /* You'll notice that this table is arranged to be conveniently
4920 indexed by X Windows keysym values. */
4921 static const char *const lispy_function_keys
[] =
4923 /* X Keysym value */
4925 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4926 "backspace", "tab", "linefeed", "clear",
4928 0, 0, 0, "pause", /* 0xff10...1f */
4929 0, 0, 0, 0, 0, 0, 0, "escape",
4931 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4932 "romaji", "hiragana", "katakana", "hiragana-katakana",
4933 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4934 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4935 "eisu-toggle", /* 0xff30...3f */
4936 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4937 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4939 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4940 "down", "prior", "next", "end",
4941 "begin", 0, 0, 0, 0, 0, 0, 0,
4942 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4953 "break", /* 0xff6b */
4956 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4957 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4958 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4959 0, 0, 0, 0, 0, 0, 0, 0,
4960 "kp-tab", /* 0xff89 */
4962 "kp-enter", /* 0xff8d */
4964 "kp-f1", /* 0xff91 */
4968 "kp-home", /* 0xff95 */
4973 "kp-prior", /* kp-page-up */
4974 "kp-next", /* kp-page-down */
4980 0, 0, 0, 0, 0, 0, 0, 0, 0,
4981 "kp-multiply", /* 0xffaa */
4986 "kp-divide", /* 0xffaf */
4987 "kp-0", /* 0xffb0 */
4988 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4991 "kp-equal", /* 0xffbd */
4992 "f1", /* 0xffbe */ /* IsFunctionKey */
4994 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4995 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4996 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4997 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4998 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4999 0, 0, 0, 0, 0, 0, 0, 0,
5000 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5001 0, 0, 0, 0, 0, 0, 0, "delete"
5004 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5005 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5007 static const char *const iso_lispy_function_keys
[] =
5009 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5010 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5011 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5012 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5013 "iso-lefttab", /* 0xfe20 */
5014 "iso-move-line-up", "iso-move-line-down",
5015 "iso-partial-line-up", "iso-partial-line-down",
5016 "iso-partial-space-left", "iso-partial-space-right",
5017 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5018 "iso-release-margin-left", "iso-release-margin-right",
5019 "iso-release-both-margins",
5020 "iso-fast-cursor-left", "iso-fast-cursor-right",
5021 "iso-fast-cursor-up", "iso-fast-cursor-down",
5022 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5023 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5026 #endif /* not HAVE_NTGUI */
5028 static Lisp_Object Vlispy_mouse_stem
;
5030 static const char *const lispy_wheel_names
[] =
5032 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5035 /* drag-n-drop events are generated when a set of selected files are
5036 dragged from another application and dropped onto an Emacs window. */
5037 static const char *const lispy_drag_n_drop_names
[] =
5042 /* Scroll bar parts. */
5043 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5044 Lisp_Object Qup
, Qdown
, Qbottom
;
5045 static Lisp_Object Qend_scroll
;
5047 static Lisp_Object Qratio
;
5049 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5050 static Lisp_Object
*const scroll_bar_parts
[] = {
5051 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5052 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5055 /* A vector, indexed by button number, giving the down-going location
5056 of currently depressed buttons, both scroll bar and non-scroll bar.
5058 The elements have the form
5059 (BUTTON-NUMBER MODIFIER-MASK . REST)
5060 where REST is the cdr of a position as it would be reported in the event.
5062 The make_lispy_event function stores positions here to tell the
5063 difference between click and drag events, and to store the starting
5064 location to be included in drag events. */
5066 static Lisp_Object button_down_location
;
5068 /* Information about the most recent up-going button event: Which
5069 button, what location, and what time. */
5071 static int last_mouse_button
;
5072 static int last_mouse_x
;
5073 static int last_mouse_y
;
5074 static Time button_down_time
;
5076 /* The number of clicks in this multiple-click. */
5078 static int double_click_count
;
5080 /* X and Y are frame-relative coordinates for a click or wheel event.
5081 Return a Lisp-style event list. */
5084 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5087 enum window_part part
;
5088 Lisp_Object posn
= Qnil
;
5089 Lisp_Object extra_info
= Qnil
;
5090 /* Coordinate pixel positions to return. */
5091 int xret
= 0, yret
= 0;
5092 /* The window under frame pixel coordinates (x,y) */
5093 Lisp_Object window
= f
5094 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5097 if (WINDOWP (window
))
5099 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5100 struct window
*w
= XWINDOW (window
);
5101 Lisp_Object string_info
= Qnil
;
5102 ptrdiff_t textpos
= -1;
5103 int col
= -1, row
= -1;
5104 int dx
= -1, dy
= -1;
5105 int width
= -1, height
= -1;
5106 Lisp_Object object
= Qnil
;
5108 /* Pixel coordinates relative to the window corner. */
5109 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5110 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5112 /* For text area clicks, return X, Y relative to the corner of
5113 this text area. Note that dX, dY etc are set below, by
5114 buffer_posn_from_coords. */
5115 if (part
== ON_TEXT
)
5117 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5118 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5120 /* For mode line and header line clicks, return X, Y relative to
5121 the left window edge. Use mode_line_string to look for a
5122 string on the click position. */
5123 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5128 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5129 /* Note that mode_line_string takes COL, ROW as pixels and
5130 converts them to characters. */
5133 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5134 &object
, &dx
, &dy
, &width
, &height
);
5135 if (STRINGP (string
))
5136 string_info
= Fcons (string
, make_number (charpos
));
5137 textpos
= (w
== XWINDOW (selected_window
)
5138 && current_buffer
== XBUFFER (w
->buffer
))
5139 ? PT
: XMARKER (w
->pointm
)->charpos
;
5144 /* For fringes and margins, Y is relative to the area's (and the
5145 window's) top edge, while X is meaningless. */
5146 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5151 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5154 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5155 &object
, &dx
, &dy
, &width
, &height
);
5156 if (STRINGP (string
))
5157 string_info
= Fcons (string
, make_number (charpos
));
5158 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5160 else if (part
== ON_LEFT_FRINGE
)
5162 posn
= Qleft_fringe
;
5165 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5166 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5167 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5169 else if (part
== ON_RIGHT_FRINGE
)
5171 posn
= Qright_fringe
;
5174 - window_box_width (w
, LEFT_MARGIN_AREA
)
5175 - window_box_width (w
, TEXT_AREA
)
5176 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5177 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5179 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5181 else if (part
== ON_VERTICAL_BORDER
)
5183 posn
= Qvertical_line
;
5188 /* Nothing special for part == ON_SCROLL_BAR. */
5190 /* For clicks in the text area, fringes, or margins, call
5191 buffer_posn_from_coords to extract TEXTPOS, the buffer
5192 position nearest to the click. */
5195 Lisp_Object string2
, object2
= Qnil
;
5196 struct display_pos p
;
5198 int width2
, height2
;
5199 /* The pixel X coordinate passed to buffer_posn_from_coords
5200 is the X coordinate relative to the text area for
5201 text-area and right-margin clicks, zero otherwise. */
5203 = (part
== ON_TEXT
) ? xret
5204 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5205 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5209 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5210 &object2
, &dx2
, &dy2
,
5212 textpos
= CHARPOS (p
.pos
);
5213 if (col
< 0) col
= x2
;
5214 if (row
< 0) row
= y2
;
5215 if (dx
< 0) dx
= dx2
;
5216 if (dy
< 0) dy
= dy2
;
5217 if (width
< 0) width
= width2
;
5218 if (height
< 0) height
= height2
;
5222 posn
= make_number (textpos
);
5223 if (STRINGP (string2
))
5224 string_info
= Fcons (string2
,
5225 make_number (CHARPOS (p
.string_pos
)));
5231 #ifdef HAVE_WINDOW_SYSTEM
5232 if (IMAGEP (object
))
5234 Lisp_Object image_map
, hotspot
;
5235 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5237 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5239 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5240 posn
= XCAR (hotspot
);
5247 Fcons (make_number (dx
), make_number (dy
)),
5248 Fcons (make_number (width
), make_number (height
)));
5251 extra_info
= Fcons (string_info
,
5252 Fcons (make_number (textpos
),
5253 Fcons (Fcons (make_number (col
),
5258 XSETFRAME (window
, f
);
5262 return Fcons (window
,
5264 Fcons (Fcons (make_number (xret
),
5265 make_number (yret
)),
5266 Fcons (make_number (t
),
5270 /* Given a struct input_event, build the lisp event which represents
5271 it. If EVENT is 0, build a mouse movement event from the mouse
5272 movement buffer, which should have a movement event in it.
5274 Note that events must be passed to this function in the order they
5275 are received; this function stores the location of button presses
5276 in order to build drag events when the button is released. */
5279 make_lispy_event (struct input_event
*event
)
5283 switch (event
->kind
)
5285 /* A simple keystroke. */
5286 case ASCII_KEYSTROKE_EVENT
:
5287 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5289 Lisp_Object lispy_c
;
5290 EMACS_INT c
= event
->code
;
5291 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5294 eassert (c
== event
->code
);
5295 /* Turn ASCII characters into control characters
5297 if (event
->modifiers
& ctrl_modifier
)
5299 c
= make_ctrl_char (c
);
5300 event
->modifiers
&= ~ctrl_modifier
;
5304 /* Add in the other modifier bits. The shift key was taken care
5305 of by the X code. */
5306 c
|= (event
->modifiers
5307 & (meta_modifier
| alt_modifier
5308 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5309 /* Distinguish Shift-SPC from SPC. */
5310 if ((event
->code
) == 040
5311 && event
->modifiers
& shift_modifier
)
5312 c
|= shift_modifier
;
5313 button_down_time
= 0;
5314 XSETFASTINT (lispy_c
, c
);
5319 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5320 except that they are non-key events (last-nonmenu-event is nil). */
5321 case NS_NONKEY_EVENT
:
5324 /* A function key. The symbol may need to have modifier prefixes
5326 case NON_ASCII_KEYSTROKE_EVENT
:
5327 button_down_time
= 0;
5329 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5330 if (event
->code
== lispy_accent_codes
[i
])
5331 return modify_event_symbol (i
,
5333 Qfunction_key
, Qnil
,
5334 lispy_accent_keys
, &accent_key_syms
,
5335 (sizeof (lispy_accent_keys
)
5336 / sizeof (lispy_accent_keys
[0])));
5340 if (event
->code
>= 0x400 && event
->code
< 0x500)
5341 return modify_event_symbol (event
->code
- 0x400,
5342 event
->modifiers
& ~shift_modifier
,
5343 Qfunction_key
, Qnil
,
5344 lispy_kana_keys
, &func_key_syms
,
5345 (sizeof (lispy_kana_keys
)
5346 / sizeof (lispy_kana_keys
[0])));
5347 #endif /* XK_kana_A */
5350 #ifdef ISO_FUNCTION_KEY_OFFSET
5351 if (event
->code
< FUNCTION_KEY_OFFSET
5352 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5353 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5355 Qfunction_key
, Qnil
,
5356 iso_lispy_function_keys
, &func_key_syms
,
5357 (sizeof (iso_lispy_function_keys
)
5358 / sizeof (iso_lispy_function_keys
[0])));
5361 /* Handle system-specific or unknown keysyms. */
5362 if (event
->code
& (1 << 28)
5363 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5364 || (event
->code
- FUNCTION_KEY_OFFSET
5365 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5366 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5368 /* We need to use an alist rather than a vector as the cache
5369 since we can't make a vector long enough. */
5370 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5371 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5372 return modify_event_symbol (event
->code
,
5375 KVAR (current_kboard
, Vsystem_key_alist
),
5376 0, &KVAR (current_kboard
, system_key_syms
),
5380 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5382 Qfunction_key
, Qnil
,
5383 lispy_function_keys
, &func_key_syms
,
5384 (sizeof (lispy_function_keys
)
5385 / sizeof (lispy_function_keys
[0])));
5388 case MULTIMEDIA_KEY_EVENT
:
5389 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5390 / sizeof (lispy_multimedia_keys
[0]))
5391 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5393 return modify_event_symbol (event
->code
, event
->modifiers
,
5394 Qfunction_key
, Qnil
,
5395 lispy_multimedia_keys
, &func_key_syms
,
5396 (sizeof (lispy_multimedia_keys
)
5397 / sizeof (lispy_multimedia_keys
[0])));
5402 /* A mouse click. Figure out where it is, decide whether it's
5403 a press, click or drag, and build the appropriate structure. */
5404 case MOUSE_CLICK_EVENT
:
5405 #ifndef USE_TOOLKIT_SCROLL_BARS
5406 case SCROLL_BAR_CLICK_EVENT
:
5409 int button
= event
->code
;
5411 Lisp_Object position
;
5412 Lisp_Object
*start_pos_ptr
;
5413 Lisp_Object start_pos
;
5417 /* Build the position as appropriate for this mouse click. */
5418 if (event
->kind
== MOUSE_CLICK_EVENT
)
5420 struct frame
*f
= XFRAME (event
->frame_or_window
);
5421 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5425 /* Ignore mouse events that were made on frame that
5426 have been deleted. */
5427 if (! FRAME_LIVE_P (f
))
5430 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5431 /* EVENT->x and EVENT->y are frame-relative pixel
5432 coordinates at this place. Under old redisplay, COLUMN
5433 and ROW are set to frame relative glyph coordinates
5434 which are then used to determine whether this click is
5435 in a menu (non-toolkit version). */
5436 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5437 &column
, &row
, NULL
, 1);
5439 /* In the non-toolkit version, clicks on the menu bar
5440 are ordinary button events in the event buffer.
5441 Distinguish them, and invoke the menu.
5443 (In the toolkit version, the toolkit handles the menu bar
5444 and Emacs doesn't know about it until after the user
5445 makes a selection.) */
5446 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5447 && (event
->modifiers
& down_modifier
))
5449 Lisp_Object items
, item
;
5451 /* Find the menu bar item under `column'. */
5453 items
= FRAME_MENU_BAR_ITEMS (f
);
5454 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5456 Lisp_Object pos
, string
;
5457 string
= AREF (items
, i
+ 1);
5458 pos
= AREF (items
, i
+ 3);
5461 if (column
>= XINT (pos
)
5462 && column
< XINT (pos
) + SCHARS (string
))
5464 item
= AREF (items
, i
);
5469 /* ELisp manual 2.4b says (x y) are window relative but
5470 code says they are frame-relative. */
5472 = Fcons (event
->frame_or_window
,
5474 Fcons (Fcons (event
->x
, event
->y
),
5475 Fcons (make_number (event
->timestamp
),
5478 return Fcons (item
, Fcons (position
, Qnil
));
5480 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5482 position
= make_lispy_position (f
, event
->x
, event
->y
,
5485 #ifndef USE_TOOLKIT_SCROLL_BARS
5488 /* It's a scrollbar click. */
5490 Lisp_Object portion_whole
;
5493 window
= event
->frame_or_window
;
5494 portion_whole
= Fcons (event
->x
, event
->y
);
5495 part
= *scroll_bar_parts
[(int) event
->part
];
5499 Fcons (Qvertical_scroll_bar
,
5500 Fcons (portion_whole
,
5501 Fcons (make_number (event
->timestamp
),
5502 Fcons (part
, Qnil
)))));
5504 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5506 if (button
>= ASIZE (button_down_location
))
5508 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5509 button_down_location
= larger_vector (button_down_location
,
5511 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5514 start_pos_ptr
= aref_addr (button_down_location
, button
);
5515 start_pos
= *start_pos_ptr
;
5516 *start_pos_ptr
= Qnil
;
5519 /* On window-system frames, use the value of
5520 double-click-fuzz as is. On other frames, interpret it
5521 as a multiple of 1/8 characters. */
5525 if (WINDOWP (event
->frame_or_window
))
5526 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5527 else if (FRAMEP (event
->frame_or_window
))
5528 f
= XFRAME (event
->frame_or_window
);
5532 if (FRAME_WINDOW_P (f
))
5533 fuzz
= double_click_fuzz
;
5535 fuzz
= double_click_fuzz
/ 8;
5537 is_double
= (button
== last_mouse_button
5538 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5539 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5540 && button_down_time
!= 0
5541 && (EQ (Vdouble_click_time
, Qt
)
5542 || (NATNUMP (Vdouble_click_time
)
5543 && (event
->timestamp
- button_down_time
5544 < XFASTINT (Vdouble_click_time
)))));
5547 last_mouse_button
= button
;
5548 last_mouse_x
= XINT (event
->x
);
5549 last_mouse_y
= XINT (event
->y
);
5551 /* If this is a button press, squirrel away the location, so
5552 we can decide later whether it was a click or a drag. */
5553 if (event
->modifiers
& down_modifier
)
5557 double_click_count
++;
5558 event
->modifiers
|= ((double_click_count
> 2)
5563 double_click_count
= 1;
5564 button_down_time
= event
->timestamp
;
5565 *start_pos_ptr
= Fcopy_alist (position
);
5566 ignore_mouse_drag_p
= 0;
5569 /* Now we're releasing a button - check the co-ordinates to
5570 see if this was a click or a drag. */
5571 else if (event
->modifiers
& up_modifier
)
5573 /* If we did not see a down before this up, ignore the up.
5574 Probably this happened because the down event chose a
5575 menu item. It would be an annoyance to treat the
5576 release of the button that chose the menu item as a
5579 if (!CONSP (start_pos
))
5582 event
->modifiers
&= ~up_modifier
;
5585 Lisp_Object new_down
, down
;
5586 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5588 /* The third element of every position
5589 should be the (x,y) pair. */
5590 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5591 new_down
= Fcar (Fcdr (Fcdr (position
)));
5594 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5596 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5597 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5600 if (ignore_mouse_drag_p
)
5602 event
->modifiers
|= click_modifier
;
5603 ignore_mouse_drag_p
= 0;
5605 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5606 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5607 /* Maybe the mouse has moved a lot, caused scrolling, and
5608 eventually ended up at the same screen position (but
5609 not buffer position) in which case it is a drag, not
5611 /* FIXME: OTOH if the buffer position has changed
5612 because of a timer or process filter rather than
5613 because of mouse movement, it should be considered as
5614 a click. But mouse-drag-region completely ignores
5615 this case and it hasn't caused any real problem, so
5616 it's probably OK to ignore it as well. */
5617 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5618 /* Mouse hasn't moved (much). */
5619 event
->modifiers
|= click_modifier
;
5622 button_down_time
= 0;
5623 event
->modifiers
|= drag_modifier
;
5626 /* Don't check is_double; treat this as multiple
5627 if the down-event was multiple. */
5628 if (double_click_count
> 1)
5629 event
->modifiers
|= ((double_click_count
> 2)
5635 /* Every mouse event should either have the down_modifier or
5636 the up_modifier set. */
5640 /* Get the symbol we should use for the mouse click. */
5643 head
= modify_event_symbol (button
,
5645 Qmouse_click
, Vlispy_mouse_stem
,
5648 ASIZE (mouse_syms
));
5649 if (event
->modifiers
& drag_modifier
)
5654 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5657 Fcons (make_number (double_click_count
),
5667 case HORIZ_WHEEL_EVENT
:
5669 Lisp_Object position
;
5672 /* Build the position as appropriate for this mouse click. */
5673 struct frame
*f
= XFRAME (event
->frame_or_window
);
5675 /* Ignore wheel events that were made on frame that have been
5677 if (! FRAME_LIVE_P (f
))
5680 position
= make_lispy_position (f
, event
->x
, event
->y
,
5683 /* Set double or triple modifiers to indicate the wheel speed. */
5685 /* On window-system frames, use the value of
5686 double-click-fuzz as is. On other frames, interpret it
5687 as a multiple of 1/8 characters. */
5693 if (WINDOWP (event
->frame_or_window
))
5694 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5695 else if (FRAMEP (event
->frame_or_window
))
5696 fr
= XFRAME (event
->frame_or_window
);
5700 fuzz
= FRAME_WINDOW_P (fr
)
5701 ? double_click_fuzz
: double_click_fuzz
/ 8;
5703 if (event
->modifiers
& up_modifier
)
5705 /* Emit a wheel-up event. */
5706 event
->modifiers
&= ~up_modifier
;
5709 else if (event
->modifiers
& down_modifier
)
5711 /* Emit a wheel-down event. */
5712 event
->modifiers
&= ~down_modifier
;
5716 /* Every wheel event should either have the down_modifier or
5717 the up_modifier set. */
5720 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5723 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5724 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5725 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5726 && button_down_time
!= 0
5727 && (EQ (Vdouble_click_time
, Qt
)
5728 || (NATNUMP (Vdouble_click_time
)
5729 && (event
->timestamp
- button_down_time
5730 < XFASTINT (Vdouble_click_time
)))));
5733 double_click_count
++;
5734 event
->modifiers
|= ((double_click_count
> 2)
5740 double_click_count
= 1;
5741 event
->modifiers
|= click_modifier
;
5744 button_down_time
= event
->timestamp
;
5745 /* Use a negative value to distinguish wheel from mouse button. */
5746 last_mouse_button
= - (1 + symbol_num
);
5747 last_mouse_x
= XINT (event
->x
);
5748 last_mouse_y
= XINT (event
->y
);
5750 /* Get the symbol we should use for the wheel event. */
5751 head
= modify_event_symbol (symbol_num
,
5757 ASIZE (wheel_syms
));
5760 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5763 Fcons (make_number (double_click_count
),
5772 #ifdef USE_TOOLKIT_SCROLL_BARS
5774 /* We don't have down and up events if using toolkit scroll bars,
5775 so make this always a click event. Store in the `part' of
5776 the Lisp event a symbol which maps to the following actions:
5778 `above_handle' page up
5779 `below_handle' page down
5783 `bottom' bottom of buffer
5784 `handle' thumb has been dragged.
5785 `end-scroll' end of interaction with scroll bar
5787 The incoming input_event contains in its `part' member an
5788 index of type `enum scroll_bar_part' which we can use as an
5789 index in scroll_bar_parts to get the appropriate symbol. */
5791 case SCROLL_BAR_CLICK_EVENT
:
5793 Lisp_Object position
, head
, window
, portion_whole
, part
;
5795 window
= event
->frame_or_window
;
5796 portion_whole
= Fcons (event
->x
, event
->y
);
5797 part
= *scroll_bar_parts
[(int) event
->part
];
5801 Fcons (Qvertical_scroll_bar
,
5802 Fcons (portion_whole
,
5803 Fcons (make_number (event
->timestamp
),
5804 Fcons (part
, Qnil
)))));
5806 /* Always treat scroll bar events as clicks. */
5807 event
->modifiers
|= click_modifier
;
5808 event
->modifiers
&= ~up_modifier
;
5810 if (event
->code
>= ASIZE (mouse_syms
))
5811 mouse_syms
= larger_vector (mouse_syms
,
5812 event
->code
- ASIZE (mouse_syms
) + 1,
5815 /* Get the symbol we should use for the mouse click. */
5816 head
= modify_event_symbol (event
->code
,
5821 ASIZE (mouse_syms
));
5822 return Fcons (head
, Fcons (position
, Qnil
));
5825 #endif /* USE_TOOLKIT_SCROLL_BARS */
5827 case DRAG_N_DROP_EVENT
:
5830 Lisp_Object head
, position
;
5833 f
= XFRAME (event
->frame_or_window
);
5836 /* Ignore mouse events that were made on frames that
5837 have been deleted. */
5838 if (! FRAME_LIVE_P (f
))
5841 position
= make_lispy_position (f
, event
->x
, event
->y
,
5844 head
= modify_event_symbol (0, event
->modifiers
,
5846 lispy_drag_n_drop_names
,
5847 &drag_n_drop_syms
, 1);
5854 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5855 || defined (HAVE_NS) || defined (USE_GTK)
5856 case MENU_BAR_EVENT
:
5857 if (EQ (event
->arg
, event
->frame_or_window
))
5858 /* This is the prefix key. We translate this to
5859 `(menu_bar)' because the code in keyboard.c for menu
5860 events, which we use, relies on this. */
5861 return Fcons (Qmenu_bar
, Qnil
);
5865 case SELECT_WINDOW_EVENT
:
5866 /* Make an event (select-window (WINDOW)). */
5867 return Fcons (Qselect_window
,
5868 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5871 case TOOL_BAR_EVENT
:
5872 if (EQ (event
->arg
, event
->frame_or_window
))
5873 /* This is the prefix key. We translate this to
5874 `(tool_bar)' because the code in keyboard.c for tool bar
5875 events, which we use, relies on this. */
5876 return Fcons (Qtool_bar
, Qnil
);
5877 else if (SYMBOLP (event
->arg
))
5878 return apply_modifiers (event
->modifiers
, event
->arg
);
5881 case USER_SIGNAL_EVENT
:
5882 /* A user signal. */
5884 char *name
= find_user_signal_name (event
->code
);
5887 return intern (name
);
5890 case SAVE_SESSION_EVENT
:
5891 return Qsave_session
;
5896 return Fcons (Qdbus_event
, event
->arg
);
5898 #endif /* HAVE_DBUS */
5901 case FILE_NOTIFY_EVENT
:
5903 return Fcons (Qfile_inotify
, event
->arg
);
5905 #endif /* HAVE_INOTIFY */
5907 case CONFIG_CHANGED_EVENT
:
5908 return Fcons (Qconfig_changed_event
,
5910 Fcons (event
->frame_or_window
, Qnil
)));
5912 case GPM_CLICK_EVENT
:
5914 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5915 Lisp_Object head
, position
;
5916 Lisp_Object
*start_pos_ptr
;
5917 Lisp_Object start_pos
;
5918 int button
= event
->code
;
5920 if (button
>= ASIZE (button_down_location
))
5922 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5923 button_down_location
= larger_vector (button_down_location
,
5925 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5928 start_pos_ptr
= aref_addr (button_down_location
, button
);
5929 start_pos
= *start_pos_ptr
;
5931 position
= make_lispy_position (f
, event
->x
, event
->y
,
5934 if (event
->modifiers
& down_modifier
)
5935 *start_pos_ptr
= Fcopy_alist (position
);
5936 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5938 if (!CONSP (start_pos
))
5940 event
->modifiers
&= ~up_modifier
;
5943 head
= modify_event_symbol (button
,
5945 Qmouse_click
, Vlispy_mouse_stem
,
5948 ASIZE (mouse_syms
));
5950 if (event
->modifiers
& drag_modifier
)
5955 else if (event
->modifiers
& double_modifier
)
5958 Fcons (make_number (2),
5960 else if (event
->modifiers
& triple_modifier
)
5963 Fcons (make_number (3),
5970 #endif /* HAVE_GPM */
5972 /* The 'kind' field of the event is something we don't recognize. */
5979 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5980 Lisp_Object x
, Lisp_Object y
, Time t
)
5982 /* Is it a scroll bar movement? */
5983 if (frame
&& ! NILP (bar_window
))
5985 Lisp_Object part_sym
;
5987 part_sym
= *scroll_bar_parts
[(int) part
];
5988 return Fcons (Qscroll_bar_movement
,
5989 Fcons (list5 (bar_window
,
5990 Qvertical_scroll_bar
,
5996 /* Or is it an ordinary mouse movement? */
5999 Lisp_Object position
;
6000 position
= make_lispy_position (frame
, x
, y
, t
);
6001 return list2 (Qmouse_movement
, position
);
6005 /* Construct a switch frame event. */
6007 make_lispy_switch_frame (Lisp_Object frame
)
6009 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6012 /* Manipulating modifiers. */
6014 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6016 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6017 SYMBOL's name of the end of the modifiers; the string from this
6018 position is the unmodified symbol name.
6020 This doesn't use any caches. */
6023 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6029 CHECK_SYMBOL (symbol
);
6032 name
= SYMBOL_NAME (symbol
);
6034 for (i
= 0; i
< SBYTES (name
) - 1; )
6036 ptrdiff_t this_mod_end
= 0;
6039 /* See if the name continues with a modifier word.
6040 Check that the word appears, but don't check what follows it.
6041 Set this_mod and this_mod_end to record what we find. */
6043 switch (SREF (name
, i
))
6045 #define SINGLE_LETTER_MOD(BIT) \
6046 (this_mod_end = i + 1, this_mod = BIT)
6049 SINGLE_LETTER_MOD (alt_modifier
);
6053 SINGLE_LETTER_MOD (ctrl_modifier
);
6057 SINGLE_LETTER_MOD (hyper_modifier
);
6061 SINGLE_LETTER_MOD (meta_modifier
);
6065 SINGLE_LETTER_MOD (shift_modifier
);
6069 SINGLE_LETTER_MOD (super_modifier
);
6072 #undef SINGLE_LETTER_MOD
6074 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6075 if (i + LEN + 1 <= SBYTES (name) \
6076 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6078 this_mod_end = i + LEN; \
6083 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6084 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6085 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6089 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6091 #undef MULTI_LETTER_MOD
6095 /* If we found no modifier, stop looking for them. */
6096 if (this_mod_end
== 0)
6099 /* Check there is a dash after the modifier, so that it
6100 really is a modifier. */
6101 if (this_mod_end
>= SBYTES (name
)
6102 || SREF (name
, this_mod_end
) != '-')
6105 /* This modifier is real; look for another. */
6106 modifiers
|= this_mod
;
6107 i
= this_mod_end
+ 1;
6110 /* Should we include the `click' modifier? */
6111 if (! (modifiers
& (down_modifier
| drag_modifier
6112 | double_modifier
| triple_modifier
))
6113 && i
+ 7 == SBYTES (name
)
6114 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6115 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6116 modifiers
|= click_modifier
;
6118 if (! (modifiers
& (double_modifier
| triple_modifier
))
6119 && i
+ 6 < SBYTES (name
)
6120 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6121 modifiers
|= click_modifier
;
6129 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6130 prepended to the string BASE[0..BASE_LEN-1].
6131 This doesn't use any caches. */
6133 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6135 /* Since BASE could contain nulls, we can't use intern here; we have
6136 to use Fintern, which expects a genuine Lisp_String, and keeps a
6138 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6144 /* Only the event queue may use the `up' modifier; it should always
6145 be turned into a click or drag event before presented to lisp code. */
6146 if (modifiers
& up_modifier
)
6149 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6150 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6151 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6152 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6153 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6154 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6155 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6156 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6157 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6158 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6159 /* The click modifier is denoted by the absence of other modifiers. */
6163 mod_len
= p
- new_mods
;
6167 Lisp_Object new_name
;
6169 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6170 mod_len
+ base_len_byte
);
6171 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6172 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6174 return Fintern (new_name
, Qnil
);
6179 static const char *const modifier_names
[] =
6181 "up", "down", "drag", "click", "double", "triple", 0, 0,
6182 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6183 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6185 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6187 static Lisp_Object modifier_symbols
;
6189 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6191 lispy_modifier_list (int modifiers
)
6193 Lisp_Object modifier_list
;
6196 modifier_list
= Qnil
;
6197 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6198 if (modifiers
& (1<<i
))
6199 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6202 return modifier_list
;
6206 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6207 where UNMODIFIED is the unmodified form of SYMBOL,
6208 MASK is the set of modifiers present in SYMBOL's name.
6209 This is similar to parse_modifiers_uncached, but uses the cache in
6210 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6211 Qevent_symbol_elements property. */
6213 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6216 parse_modifiers (Lisp_Object symbol
)
6218 Lisp_Object elements
;
6220 if (INTEGERP (symbol
))
6221 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6222 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6224 else if (!SYMBOLP (symbol
))
6227 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6228 if (CONSP (elements
))
6233 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6234 Lisp_Object unmodified
;
6237 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6238 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6241 if (modifiers
& ~INTMASK
)
6243 XSETFASTINT (mask
, modifiers
);
6244 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6246 /* Cache the parsing results on SYMBOL. */
6247 Fput (symbol
, Qevent_symbol_element_mask
,
6249 Fput (symbol
, Qevent_symbol_elements
,
6250 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6252 /* Since we know that SYMBOL is modifiers applied to unmodified,
6253 it would be nice to put that in unmodified's cache.
6254 But we can't, since we're not sure that parse_modifiers is
6261 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6262 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6263 doc
: /* Parse the event symbol. For internal use. */)
6264 (Lisp_Object symbol
)
6266 /* Fill the cache if needed. */
6267 parse_modifiers (symbol
);
6268 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6269 and use the Lispier representation stored on Qevent_symbol_elements
6271 return Fget (symbol
, Qevent_symbol_elements
);
6274 /* Apply the modifiers MODIFIERS to the symbol BASE.
6275 BASE must be unmodified.
6277 This is like apply_modifiers_uncached, but uses BASE's
6278 Qmodifier_cache property, if present. It also builds
6279 Qevent_symbol_elements properties, since it has that info anyway.
6281 apply_modifiers copies the value of BASE's Qevent_kind property to
6282 the modified symbol. */
6284 apply_modifiers (int modifiers
, Lisp_Object base
)
6286 Lisp_Object cache
, idx
, entry
, new_symbol
;
6288 /* Mask out upper bits. We don't know where this value's been. */
6289 modifiers
&= INTMASK
;
6291 if (INTEGERP (base
))
6292 return make_number (XINT (base
) | modifiers
);
6294 /* The click modifier never figures into cache indices. */
6295 cache
= Fget (base
, Qmodifier_cache
);
6296 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6297 entry
= assq_no_quit (idx
, cache
);
6300 new_symbol
= XCDR (entry
);
6303 /* We have to create the symbol ourselves. */
6304 new_symbol
= apply_modifiers_uncached (modifiers
,
6305 SSDATA (SYMBOL_NAME (base
)),
6306 SCHARS (SYMBOL_NAME (base
)),
6307 SBYTES (SYMBOL_NAME (base
)));
6309 /* Add the new symbol to the base's cache. */
6310 entry
= Fcons (idx
, new_symbol
);
6311 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6313 /* We have the parsing info now for free, so we could add it to
6315 XSETFASTINT (idx, modifiers);
6316 Fput (new_symbol, Qevent_symbol_element_mask,
6317 Fcons (base, Fcons (idx, Qnil)));
6318 Fput (new_symbol, Qevent_symbol_elements,
6319 Fcons (base, lispy_modifier_list (modifiers)));
6320 Sadly, this is only correct if `base' is indeed a base event,
6321 which is not necessarily the case. -stef */
6324 /* Make sure this symbol is of the same kind as BASE.
6326 You'd think we could just set this once and for all when we
6327 intern the symbol above, but reorder_modifiers may call us when
6328 BASE's property isn't set right; we can't assume that just
6329 because it has a Qmodifier_cache property it must have its
6330 Qevent_kind set right as well. */
6331 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6335 kind
= Fget (base
, Qevent_kind
);
6337 Fput (new_symbol
, Qevent_kind
, kind
);
6344 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6345 return a symbol with the modifiers placed in the canonical order.
6346 Canonical order is alphabetical, except for down and drag, which
6347 always come last. The 'click' modifier is never written out.
6349 Fdefine_key calls this to make sure that (for example) C-M-foo
6350 and M-C-foo end up being equivalent in the keymap. */
6353 reorder_modifiers (Lisp_Object symbol
)
6355 /* It's hopefully okay to write the code this way, since everything
6356 will soon be in caches, and no consing will be done at all. */
6359 parsed
= parse_modifiers (symbol
);
6360 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6365 /* For handling events, we often want to produce a symbol whose name
6366 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6367 to some base, like the name of a function key or mouse button.
6368 modify_event_symbol produces symbols of this sort.
6370 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6371 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6374 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6375 into symbol names, or a string specifying a name stem used to
6376 construct a symbol name or the form `STEM-N', where N is the decimal
6377 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6378 non-nil; otherwise NAME_TABLE is used.
6380 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6381 persist between calls to modify_event_symbol that it can use to
6382 store a cache of the symbols it's generated for this NAME_TABLE
6383 before. The object stored there may be a vector or an alist.
6385 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6387 MODIFIERS is a set of modifier bits (as given in struct input_events)
6388 whose prefixes should be applied to the symbol name.
6390 SYMBOL_KIND is the value to be placed in the event_kind property of
6391 the returned symbol.
6393 The symbols we create are supposed to have an
6394 `event-symbol-elements' property, which lists the modifiers present
6395 in the symbol's name. */
6398 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6399 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6400 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6403 Lisp_Object symbol_int
;
6405 /* Get rid of the "vendor-specific" bit here. */
6406 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6408 /* Is this a request for a valid symbol? */
6409 if (symbol_num
< 0 || symbol_num
>= table_size
)
6412 if (CONSP (*symbol_table
))
6413 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6415 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6416 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6417 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6418 we've never used that symbol before. */
6421 if (! VECTORP (*symbol_table
)
6422 || ASIZE (*symbol_table
) != table_size
)
6426 XSETFASTINT (size
, table_size
);
6427 *symbol_table
= Fmake_vector (size
, Qnil
);
6430 value
= AREF (*symbol_table
, symbol_num
);
6433 /* Have we already used this symbol before? */
6436 /* No; let's create it. */
6437 if (CONSP (name_alist_or_stem
))
6438 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6439 else if (STRINGP (name_alist_or_stem
))
6442 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6443 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6445 buf
= SAFE_ALLOCA (len
);
6446 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6447 XINT (symbol_int
) + 1);
6448 value
= intern (buf
);
6451 else if (name_table
!= 0 && name_table
[symbol_num
])
6452 value
= intern (name_table
[symbol_num
]);
6454 #ifdef HAVE_WINDOW_SYSTEM
6457 char *name
= x_get_keysym_name (symbol_num
);
6459 value
= intern (name
);
6465 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6466 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6467 value
= intern (buf
);
6470 if (CONSP (*symbol_table
))
6471 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6473 ASET (*symbol_table
, symbol_num
, value
);
6475 /* Fill in the cache entries for this symbol; this also
6476 builds the Qevent_symbol_elements property, which the user
6478 apply_modifiers (modifiers
& click_modifier
, value
);
6479 Fput (value
, Qevent_kind
, symbol_kind
);
6482 /* Apply modifiers to that symbol. */
6483 return apply_modifiers (modifiers
, value
);
6486 /* Convert a list that represents an event type,
6487 such as (ctrl meta backspace), into the usual representation of that
6488 event type as a number or a symbol. */
6490 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6491 doc
: /* Convert the event description list EVENT-DESC to an event type.
6492 EVENT-DESC should contain one base event type (a character or symbol)
6493 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6494 drag, down, double or triple). The base must be last.
6495 The return value is an event type (a character or symbol) which
6496 has the same base event type and all the specified modifiers. */)
6497 (Lisp_Object event_desc
)
6505 while (CONSP (rest
))
6513 /* Given a symbol, see if it is a modifier name. */
6514 if (SYMBOLP (elt
) && CONSP (rest
))
6515 this = parse_solitary_modifier (elt
);
6519 else if (!NILP (base
))
6520 error ("Two bases given in one event");
6526 /* Let the symbol A refer to the character A. */
6527 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6528 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6530 if (INTEGERP (base
))
6532 /* Turn (shift a) into A. */
6533 if ((modifiers
& shift_modifier
) != 0
6534 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6536 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6537 modifiers
&= ~shift_modifier
;
6540 /* Turn (control a) into C-a. */
6541 if (modifiers
& ctrl_modifier
)
6542 return make_number ((modifiers
& ~ctrl_modifier
)
6543 | make_ctrl_char (XINT (base
)));
6545 return make_number (modifiers
| XINT (base
));
6547 else if (SYMBOLP (base
))
6548 return apply_modifiers (modifiers
, base
);
6551 error ("Invalid base event");
6556 /* Try to recognize SYMBOL as a modifier name.
6557 Return the modifier flag bit, or 0 if not recognized. */
6560 parse_solitary_modifier (Lisp_Object symbol
)
6562 Lisp_Object name
= SYMBOL_NAME (symbol
);
6564 switch (SREF (name
, 0))
6566 #define SINGLE_LETTER_MOD(BIT) \
6567 if (SBYTES (name) == 1) \
6570 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6571 if (LEN == SBYTES (name) \
6572 && ! memcmp (SDATA (name), NAME, LEN)) \
6576 SINGLE_LETTER_MOD (alt_modifier
);
6580 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6584 SINGLE_LETTER_MOD (ctrl_modifier
);
6588 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6589 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6593 SINGLE_LETTER_MOD (hyper_modifier
);
6597 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6601 SINGLE_LETTER_MOD (meta_modifier
);
6605 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6609 SINGLE_LETTER_MOD (shift_modifier
);
6613 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6614 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6615 SINGLE_LETTER_MOD (super_modifier
);
6619 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6620 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6621 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6625 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6628 #undef SINGLE_LETTER_MOD
6629 #undef MULTI_LETTER_MOD
6635 /* Return true if EVENT is a list whose elements are all integers or symbols.
6636 Such a list is not valid as an event,
6637 but it can be a Lucid-style event type list. */
6640 lucid_event_type_list_p (Lisp_Object object
)
6644 if (! CONSP (object
))
6647 if (EQ (XCAR (object
), Qhelp_echo
)
6648 || EQ (XCAR (object
), Qvertical_line
)
6649 || EQ (XCAR (object
), Qmode_line
)
6650 || EQ (XCAR (object
), Qheader_line
))
6653 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6657 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6664 /* Return true if terminal input chars are available.
6665 Also, store the return value into INPUT_PENDING.
6667 Serves the purpose of ioctl (0, FIONREAD, ...)
6668 but works even if FIONREAD does not exist.
6669 (In fact, this may actually read some input.)
6671 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6672 timer events that are ripe.
6673 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6674 events (FOCUS_IN_EVENT).
6675 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6676 movements and toolkit scroll bar thumb drags. */
6679 get_input_pending (int flags
)
6681 /* First of all, have we already counted some input? */
6682 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6684 /* If input is being read as it arrives, and we have none, there is none. */
6685 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6687 /* Try to read some input and see how much we get. */
6689 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6692 return input_pending
;
6695 /* Put a BUFFER_SWITCH_EVENT in the buffer
6696 so that read_key_sequence will notice the new current buffer. */
6699 record_asynch_buffer_change (void)
6701 struct input_event event
;
6705 event
.kind
= BUFFER_SWITCH_EVENT
;
6706 event
.frame_or_window
= Qnil
;
6709 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6710 The purpose of the event is to make read_key_sequence look up the
6711 keymaps again. If we aren't in read_key_sequence, we don't need one,
6712 and the event could cause trouble by messing up (input-pending-p).
6713 Note: Fwaiting_for_user_input_p always returns nil when async
6714 subprocesses aren't supported. */
6715 tem
= Fwaiting_for_user_input_p ();
6719 /* Make sure no interrupt happens while storing the event. */
6721 if (interrupt_input
)
6722 kbd_buffer_store_event (&event
);
6727 kbd_buffer_store_event (&event
);
6732 /* Read any terminal input already buffered up by the system
6733 into the kbd_buffer, but do not wait.
6735 Return the number of keyboard chars read, or -1 meaning
6736 this is a bad time to try to read input. */
6745 /* Store pending user signal events, if any. */
6746 store_user_signal_events ();
6748 /* Loop through the available terminals, and call their input hooks. */
6752 struct terminal
*next
= t
->next_terminal
;
6754 if (t
->read_socket_hook
)
6757 struct input_event hold_quit
;
6759 if (input_blocked_p ())
6761 pending_signals
= 1;
6765 EVENT_INIT (hold_quit
);
6766 hold_quit
.kind
= NO_EVENT
;
6768 /* No need for FIONREAD or fcntl; just say don't wait. */
6769 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6772 if (nr
== -1) /* Not OK to read input now. */
6776 else if (nr
== -2) /* Non-transient error. */
6778 /* The terminal device terminated; it should be closed. */
6780 /* Kill Emacs if this was our last terminal. */
6781 if (!terminal_list
->next_terminal
)
6782 /* Formerly simply reported no input, but that
6783 sometimes led to a failure of Emacs to terminate.
6784 SIGHUP seems appropriate if we can't reach the
6786 /* ??? Is it really right to send the signal just to
6787 this process rather than to the whole process
6788 group? Perhaps on systems with FIONREAD Emacs is
6789 alone in its group. */
6790 terminate_due_to_signal (SIGHUP
, 10);
6792 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6795 XSETTERMINAL (tmp
, t
);
6796 Fdelete_terminal (tmp
, Qnoelisp
);
6800 if (hold_quit
.kind
!= NO_EVENT
)
6801 kbd_buffer_store_event (&hold_quit
);
6810 frame_make_pointer_visible ();
6816 decode_keyboard_code (struct tty_display_info
*tty
,
6817 struct coding_system
*coding
,
6818 unsigned char *buf
, int nbytes
)
6820 unsigned char *src
= buf
;
6821 const unsigned char *p
;
6826 if (tty
->meta_key
!= 2)
6827 for (i
= 0; i
< nbytes
; i
++)
6829 if (coding
->carryover_bytes
> 0)
6831 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6832 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6833 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6834 nbytes
+= coding
->carryover_bytes
;
6836 coding
->destination
= alloca (nbytes
* 4);
6837 coding
->dst_bytes
= nbytes
* 4;
6838 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6839 if (coding
->produced_char
== 0)
6841 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6843 struct input_event event_buf
;
6845 EVENT_INIT (event_buf
);
6846 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6848 (ASCII_CHAR_P (event_buf
.code
)
6849 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6850 /* See the comment in tty_read_avail_input. */
6851 event_buf
.frame_or_window
= tty
->top_frame
;
6852 event_buf
.arg
= Qnil
;
6853 kbd_buffer_store_event (&event_buf
);
6857 /* This is the tty way of reading available input.
6859 Note that each terminal device has its own `struct terminal' object,
6860 and so this function is called once for each individual termcap
6861 terminal. The first parameter indicates which terminal to read from. */
6864 tty_read_avail_input (struct terminal
*terminal
,
6865 struct input_event
*hold_quit
)
6867 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6868 the kbd_buffer can really hold. That may prevent loss
6869 of characters on some systems when input is stuffed at us. */
6870 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6872 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6875 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6877 if (kbd_on_hold_p () || buffer_free
<= 0)
6879 #endif /* subprocesses */
6881 if (!terminal
->name
) /* Don't read from a dead terminal. */
6884 if (terminal
->type
!= output_termcap
6885 && terminal
->type
!= output_msdos_raw
)
6888 /* XXX I think the following code should be moved to separate hook
6889 functions in system-dependent files. */
6892 #else /* not WINDOWSNT */
6893 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6897 return 0; /* The terminal is suspended. */
6900 n_to_read
= dos_keysns ();
6904 cbuf
[0] = dos_keyread ();
6907 #else /* not MSDOS */
6912 struct input_event gpm_hold_quit
;
6913 int gpm
, fd
= gpm_fd
;
6915 EVENT_INIT (gpm_hold_quit
);
6916 gpm_hold_quit
.kind
= NO_EVENT
;
6918 /* gpm==1 if event received.
6919 gpm==0 if the GPM daemon has closed the connection, in which case
6920 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6921 we save it in `fd' so close_gpm can remove it from the
6923 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6924 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6925 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6928 /* Presumably the GPM daemon has closed the connection. */
6930 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6931 kbd_buffer_store_event (&gpm_hold_quit
);
6935 #endif /* HAVE_GPM */
6937 /* Determine how many characters we should *try* to read. */
6938 #ifdef USABLE_FIONREAD
6939 /* Find out how much input is available. */
6940 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6942 if (! noninteractive
)
6943 return -2; /* Close this terminal. */
6949 if (n_to_read
> sizeof cbuf
)
6950 n_to_read
= sizeof cbuf
;
6951 #elif defined USG || defined CYGWIN
6952 /* Read some input if available, but don't wait. */
6953 n_to_read
= sizeof cbuf
;
6954 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6956 # error "Cannot read without possibly delaying"
6960 /* Don't read more than we can store. */
6961 if (n_to_read
> buffer_free
)
6962 n_to_read
= buffer_free
;
6963 #endif /* subprocesses */
6965 /* Now read; for one reason or another, this will not block.
6966 NREAD is set to the number of chars read. */
6969 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6970 /* POSIX infers that processes which are not in the session leader's
6971 process group won't get SIGHUP's at logout time. BSDI adheres to
6972 this part standard and returns -1 from read (0) with errno==EIO
6973 when the control tty is taken away.
6974 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6975 if (nread
== -1 && errno
== EIO
)
6976 return -2; /* Close this terminal. */
6977 #if defined (AIX) && defined (_BSD)
6978 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6979 This looks incorrect, but it isn't, because _BSD causes
6980 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6981 and that causes a value other than 0 when there is no input. */
6983 return -2; /* Close this terminal. */
6987 /* We used to retry the read if it was interrupted.
6988 But this does the wrong thing when O_NONBLOCK causes
6989 an EAGAIN error. Does anybody know of a situation
6990 where a retry is actually needed? */
6992 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7002 #ifndef USABLE_FIONREAD
7003 #if defined (USG) || defined (CYGWIN)
7004 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7005 #endif /* USG or CYGWIN */
7006 #endif /* no FIONREAD */
7011 #endif /* not MSDOS */
7012 #endif /* not WINDOWSNT */
7014 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7015 & CODING_REQUIRE_DECODING_MASK
)
7017 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7020 /* Decode the key sequence except for those with meta
7022 for (i
= from
= 0; ; i
++)
7023 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7025 struct input_event buf
;
7027 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7032 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7033 buf
.modifiers
= meta_modifier
;
7034 buf
.code
= cbuf
[i
] & ~0x80;
7035 /* See the comment below. */
7036 buf
.frame_or_window
= tty
->top_frame
;
7038 kbd_buffer_store_event (&buf
);
7044 for (i
= 0; i
< nread
; i
++)
7046 struct input_event buf
;
7048 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7050 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7051 buf
.modifiers
= meta_modifier
;
7052 if (tty
->meta_key
!= 2)
7056 /* Set the frame corresponding to the active tty. Note that the
7057 value of selected_frame is not reliable here, redisplay tends
7058 to temporarily change it. */
7059 buf
.frame_or_window
= tty
->top_frame
;
7062 kbd_buffer_store_event (&buf
);
7063 /* Don't look at input that follows a C-g too closely.
7064 This reduces lossage due to autorepeat on C-g. */
7065 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7066 && buf
.code
== quit_char
)
7074 handle_async_input (void)
7079 int nread
= gobble_input ();
7080 /* -1 means it's not ok to read the input now.
7081 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7082 0 means there was no keyboard input available. */
7090 process_pending_signals (void)
7092 pending_signals
= 0;
7093 handle_async_input ();
7094 do_pending_atimers ();
7097 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7098 and also (if the level is now 0) reinvoke any pending signal. */
7101 unblock_input_to (int level
)
7103 interrupt_input_blocked
= level
;
7106 if (pending_signals
)
7107 process_pending_signals ();
7113 /* End critical section.
7115 If doing signal-driven input, and a signal came in when input was
7116 blocked, reinvoke the signal handler now to deal with it. */
7119 unblock_input (void)
7121 unblock_input_to (interrupt_input_blocked
- 1);
7124 /* Undo any number of BLOCK_INPUT calls,
7125 and also reinvoke any pending signal. */
7128 totally_unblock_input (void)
7130 unblock_input_to (0);
7136 handle_input_available_signal (int sig
)
7138 pending_signals
= 1;
7140 if (input_available_clear_time
)
7141 *input_available_clear_time
= make_emacs_time (0, 0);
7145 deliver_input_available_signal (int sig
)
7147 deliver_process_signal (sig
, handle_input_available_signal
);
7149 #endif /* USABLE_SIGIO */
7152 /* User signal events. */
7154 struct user_signal_info
7156 /* Signal number. */
7159 /* Name of the signal. */
7162 /* Number of pending signals. */
7165 struct user_signal_info
*next
;
7168 /* List of user signals. */
7169 static struct user_signal_info
*user_signals
= NULL
;
7172 add_user_signal (int sig
, const char *name
)
7174 struct sigaction action
;
7175 struct user_signal_info
*p
;
7177 for (p
= user_signals
; p
; p
= p
->next
)
7179 /* Already added. */
7182 p
= xmalloc (sizeof *p
);
7184 p
->name
= xstrdup (name
);
7186 p
->next
= user_signals
;
7189 emacs_sigaction_init (&action
, deliver_user_signal
);
7190 sigaction (sig
, &action
, 0);
7194 handle_user_signal (int sig
)
7196 struct user_signal_info
*p
;
7197 const char *special_event_name
= NULL
;
7199 if (SYMBOLP (Vdebug_on_event
))
7200 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7202 for (p
= user_signals
; p
; p
= p
->next
)
7205 if (special_event_name
7206 && strcmp (special_event_name
, p
->name
) == 0)
7208 /* Enter the debugger in many ways. */
7209 debug_on_next_call
= 1;
7212 Vinhibit_quit
= Qnil
;
7214 /* Eat the event. */
7220 if (interrupt_input
)
7221 handle_input_available_signal (sig
);
7225 /* Tell wait_reading_process_output that it needs to wake
7226 up and look around. */
7227 if (input_available_clear_time
)
7228 *input_available_clear_time
= make_emacs_time (0, 0);
7235 deliver_user_signal (int sig
)
7237 deliver_process_signal (sig
, handle_user_signal
);
7241 find_user_signal_name (int sig
)
7243 struct user_signal_info
*p
;
7245 for (p
= user_signals
; p
; p
= p
->next
)
7253 store_user_signal_events (void)
7255 struct user_signal_info
*p
;
7256 struct input_event buf
;
7257 bool buf_initialized
= 0;
7259 for (p
= user_signals
; p
; p
= p
->next
)
7260 if (p
->npending
> 0)
7262 if (! buf_initialized
)
7264 memset (&buf
, 0, sizeof buf
);
7265 buf
.kind
= USER_SIGNAL_EVENT
;
7266 buf
.frame_or_window
= selected_frame
;
7267 buf_initialized
= 1;
7273 kbd_buffer_store_event (&buf
);
7276 while (p
->npending
> 0);
7281 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7282 static Lisp_Object menu_bar_one_keymap_changed_items
;
7284 /* These variables hold the vector under construction within
7285 menu_bar_items and its subroutines, and the current index
7286 for storing into that vector. */
7287 static Lisp_Object menu_bar_items_vector
;
7288 static int menu_bar_items_index
;
7291 static const char* separator_names
[] = {
7296 "single-dashed-line",
7297 "double-dashed-line",
7299 "shadow-etched-out",
7300 "shadow-etched-in-dash",
7301 "shadow-etched-out-dash",
7302 "shadow-double-etched-in",
7303 "shadow-double-etched-out",
7304 "shadow-double-etched-in-dash",
7305 "shadow-double-etched-out-dash",
7309 /* Return true if LABEL specifies a separator. */
7312 menu_separator_name_p (const char *label
)
7316 else if (strlen (label
) > 3
7317 && memcmp (label
, "--", 2) == 0
7322 for (i
= 0; separator_names
[i
]; ++i
)
7323 if (strcmp (label
, separator_names
[i
]) == 0)
7328 /* It's a separator if it contains only dashes. */
7329 while (*label
== '-')
7331 return (*label
== 0);
7338 /* Return a vector of menu items for a menu bar, appropriate
7339 to the current buffer. Each item has three elements in the vector:
7342 OLD is an old vector we can optionally reuse, or nil. */
7345 menu_bar_items (Lisp_Object old
)
7347 /* The number of keymaps we're scanning right now, and the number of
7348 keymaps we have allocated space for. */
7351 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7352 in the current keymaps, or nil where it is not a prefix. */
7355 Lisp_Object def
, tail
;
7360 /* In order to build the menus, we need to call the keymap
7361 accessors. They all call QUIT. But this function is called
7362 during redisplay, during which a quit is fatal. So inhibit
7363 quitting while building the menus.
7364 We do this instead of specbind because (1) errors will clear it anyway
7365 and (2) this avoids risk of specpdl overflow. */
7366 oquit
= Vinhibit_quit
;
7370 menu_bar_items_vector
= old
;
7372 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7373 menu_bar_items_index
= 0;
7375 /* Build our list of keymaps.
7376 If we recognize a function key and replace its escape sequence in
7377 keybuf with its symbol, or if the sequence starts with a mouse
7378 click and we need to switch buffers, we jump back here to rebuild
7379 the initial keymaps from the current buffer. */
7383 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7384 if (!NILP (Voverriding_local_map_menu_flag
))
7386 /* Yes, use them (if non-nil) as well as the global map. */
7387 maps
= alloca (3 * sizeof (maps
[0]));
7389 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7390 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7391 if (!NILP (Voverriding_local_map
))
7392 maps
[nmaps
++] = Voverriding_local_map
;
7396 /* No, so use major and minor mode keymaps and keymap property.
7397 Note that menu-bar bindings in the local-map and keymap
7398 properties may not work reliable, as they are only
7399 recognized when the menu-bar (or mode-line) is updated,
7400 which does not normally happen after every command. */
7403 nminor
= current_minor_maps (NULL
, &tmaps
);
7404 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7406 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7407 maps
[nmaps
++] = tem
;
7408 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7410 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7412 maps
[nmaps
++] = current_global_map
;
7415 /* Look up in each map the dummy prefix key `menu-bar'. */
7417 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7418 if (!NILP (maps
[mapno
]))
7420 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7424 menu_bar_one_keymap_changed_items
= Qnil
;
7425 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7429 /* Move to the end those items that should be at the end. */
7431 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7434 int end
= menu_bar_items_index
;
7436 for (i
= 0; i
< end
; i
+= 4)
7437 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7439 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7440 /* Move the item at index I to the end,
7441 shifting all the others forward. */
7442 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7443 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7444 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7445 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7447 memmove (aref_addr (menu_bar_items_vector
, i
),
7448 aref_addr (menu_bar_items_vector
, i
+ 4),
7449 (end
- i
- 4) * word_size
);
7450 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7451 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7452 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7453 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7458 /* Add nil, nil, nil, nil at the end. */
7460 int i
= menu_bar_items_index
;
7461 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7462 menu_bar_items_vector
=
7463 larger_vector (menu_bar_items_vector
, 4, -1);
7464 /* Add this item. */
7465 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7466 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7467 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7468 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7469 menu_bar_items_index
= i
;
7472 Vinhibit_quit
= oquit
;
7473 return menu_bar_items_vector
;
7476 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7477 If there's already an item for KEY, add this DEF to it. */
7479 Lisp_Object item_properties
;
7482 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7484 struct gcpro gcpro1
;
7489 if (EQ (item
, Qundefined
))
7491 /* If a map has an explicit `undefined' as definition,
7492 discard any previously made menu bar item. */
7494 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7495 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7497 if (menu_bar_items_index
> i
+ 4)
7498 memmove (aref_addr (menu_bar_items_vector
, i
),
7499 aref_addr (menu_bar_items_vector
, i
+ 4),
7500 (menu_bar_items_index
- i
- 4) * word_size
);
7501 menu_bar_items_index
-= 4;
7505 /* If this keymap has already contributed to this KEY,
7506 don't contribute to it a second time. */
7507 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7508 if (!NILP (tem
) || NILP (item
))
7511 menu_bar_one_keymap_changed_items
7512 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7514 /* We add to menu_bar_one_keymap_changed_items before doing the
7515 parse_menu_item, so that if it turns out it wasn't a menu item,
7516 it still correctly hides any further menu item. */
7518 parsed
= parse_menu_item (item
, 1);
7523 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7525 /* Find any existing item for this KEY. */
7526 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7527 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7530 /* If we did not find this KEY, add it at the end. */
7531 if (i
== menu_bar_items_index
)
7533 /* If vector is too small, get a bigger one. */
7534 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7535 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7536 /* Add this item. */
7537 ASET (menu_bar_items_vector
, i
, key
); i
++;
7538 ASET (menu_bar_items_vector
, i
,
7539 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7540 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7541 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7542 menu_bar_items_index
= i
;
7544 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7548 old
= AREF (menu_bar_items_vector
, i
+ 2);
7549 /* If the new and the old items are not both keymaps,
7550 the lookup will only find `item'. */
7551 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7552 ASET (menu_bar_items_vector
, i
+ 2, item
);
7556 /* This is used as the handler when calling menu_item_eval_property. */
7558 menu_item_eval_property_1 (Lisp_Object arg
)
7560 /* If we got a quit from within the menu computation,
7561 quit all the way out of it. This takes care of C-] in the debugger. */
7562 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7563 Fsignal (Qquit
, Qnil
);
7569 eval_dyn (Lisp_Object form
)
7571 return Feval (form
, Qnil
);
7574 /* Evaluate an expression and return the result (or nil if something
7575 went wrong). Used to evaluate dynamic parts of menu items. */
7577 menu_item_eval_property (Lisp_Object sexpr
)
7579 ptrdiff_t count
= SPECPDL_INDEX ();
7581 specbind (Qinhibit_redisplay
, Qt
);
7582 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7583 menu_item_eval_property_1
);
7584 return unbind_to (count
, val
);
7587 /* This function parses a menu item and leaves the result in the
7588 vector item_properties.
7589 ITEM is a key binding, a possible menu item.
7590 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7592 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7593 parse_menu_item returns true if the item is a menu item and false
7597 parse_menu_item (Lisp_Object item
, int inmenubar
)
7599 Lisp_Object def
, tem
, item_string
, start
;
7601 Lisp_Object keyhint
;
7610 /* Create item_properties vector if necessary. */
7611 if (NILP (item_properties
))
7613 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7615 /* Initialize optional entries. */
7616 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7617 ASET (item_properties
, i
, Qnil
);
7618 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7620 /* Save the item here to protect it from GC. */
7621 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7623 item_string
= XCAR (item
);
7627 if (STRINGP (item_string
))
7629 /* Old format menu item. */
7630 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7632 /* Maybe help string. */
7633 if (CONSP (item
) && STRINGP (XCAR (item
)))
7635 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7640 /* Maybe an obsolete key binding cache. */
7641 if (CONSP (item
) && CONSP (XCAR (item
))
7642 && (NILP (XCAR (XCAR (item
)))
7643 || VECTORP (XCAR (XCAR (item
)))))
7646 /* This is the real definition--the function to run. */
7647 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7649 /* Get enable property, if any. */
7652 tem
= Fget (item
, Qmenu_enable
);
7653 if (!NILP (Venable_disabled_menus_and_buttons
))
7654 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7655 else if (!NILP (tem
))
7656 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7659 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7661 /* New format menu item. */
7662 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7663 start
= XCDR (item
);
7666 /* We have a real binding. */
7667 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7669 item
= XCDR (start
);
7670 /* Is there an obsolete cache list with key equivalences. */
7671 if (CONSP (item
) && CONSP (XCAR (item
)))
7674 /* Parse properties. */
7675 while (CONSP (item
) && CONSP (XCDR (item
)))
7680 if (EQ (tem
, QCenable
))
7682 if (!NILP (Venable_disabled_menus_and_buttons
))
7683 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7685 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7687 else if (EQ (tem
, QCvisible
))
7689 /* If got a visible property and that evaluates to nil
7690 then ignore this item. */
7691 tem
= menu_item_eval_property (XCAR (item
));
7695 else if (EQ (tem
, QChelp
))
7696 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7697 else if (EQ (tem
, QCfilter
))
7699 else if (EQ (tem
, QCkey_sequence
))
7702 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7703 /* Be GC protected. Set keyhint to item instead of tem. */
7706 else if (EQ (tem
, QCkeys
))
7709 if (CONSP (tem
) || STRINGP (tem
))
7710 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7712 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7717 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7719 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7721 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7727 else if (inmenubar
|| !NILP (start
))
7731 return 0; /* not a menu item */
7733 /* If item string is not a string, evaluate it to get string.
7734 If we don't get a string, skip this item. */
7735 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7736 if (!(STRINGP (item_string
)))
7738 item_string
= menu_item_eval_property (item_string
);
7739 if (!STRINGP (item_string
))
7741 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7744 /* If got a filter apply it on definition. */
7745 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7748 def
= menu_item_eval_property (list2 (XCAR (filter
),
7749 list2 (Qquote
, def
)));
7751 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7754 /* Enable or disable selection of item. */
7755 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7758 tem
= menu_item_eval_property (tem
);
7759 if (inmenubar
&& NILP (tem
))
7760 return 0; /* Ignore disabled items in menu bar. */
7761 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7764 /* If we got no definition, this item is just unselectable text which
7765 is OK in a submenu but not in the menubar. */
7767 return (!inmenubar
);
7769 /* See if this is a separate pane or a submenu. */
7770 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7771 tem
= get_keymap (def
, 0, 1);
7772 /* For a subkeymap, just record its details and exit. */
7775 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7776 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7780 /* At the top level in the menu bar, do likewise for commands also.
7781 The menu bar does not display equivalent key bindings anyway.
7782 ITEM_PROPERTY_DEF is already set up properly. */
7786 { /* This is a command. See if there is an equivalent key binding. */
7787 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7789 /* The previous code preferred :key-sequence to :keys, so we
7790 preserve this behavior. */
7791 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7792 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7795 Lisp_Object prefix
= keyeq
;
7796 Lisp_Object keys
= Qnil
;
7800 def
= XCAR (prefix
);
7801 prefix
= XCDR (prefix
);
7804 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7806 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7808 keys
= XCAR (keyhint
);
7809 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7811 /* We have a suggested key. Is it bound to the command? */
7814 /* If the command is an alias for another
7815 (such as lmenu.el set it up), check if the
7816 original command matches the cached command. */
7818 && EQ (tem
, XSYMBOL (def
)->function
))))
7823 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7827 tem
= Fkey_description (keys
, Qnil
);
7830 if (STRINGP (XCAR (prefix
)))
7831 tem
= concat2 (XCAR (prefix
), tem
);
7832 if (STRINGP (XCDR (prefix
)))
7833 tem
= concat2 (tem
, XCDR (prefix
));
7835 keyeq
= concat2 (build_string (" "), tem
);
7836 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7842 /* If we have an equivalent key binding, use that. */
7843 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7846 /* Include this when menu help is implemented.
7847 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7848 if (!(NILP (tem) || STRINGP (tem)))
7850 tem = menu_item_eval_property (tem);
7853 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7857 /* Handle radio buttons or toggle boxes. */
7858 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7860 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7861 menu_item_eval_property (tem
));
7868 /***********************************************************************
7870 ***********************************************************************/
7872 /* A vector holding tool bar items while they are parsed in function
7873 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7876 static Lisp_Object tool_bar_items_vector
;
7878 /* A vector holding the result of parse_tool_bar_item. Layout is like
7879 the one for a single item in tool_bar_items_vector. */
7881 static Lisp_Object tool_bar_item_properties
;
7883 /* Next free index in tool_bar_items_vector. */
7885 static int ntool_bar_items
;
7887 /* The symbols `:image' and `:rtl'. */
7889 static Lisp_Object QCimage
;
7890 static Lisp_Object QCrtl
;
7892 /* Function prototypes. */
7894 static void init_tool_bar_items (Lisp_Object
);
7895 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7896 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7897 static void append_tool_bar_item (void);
7900 /* Return a vector of tool bar items for keymaps currently in effect.
7901 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7902 tool bar items found. */
7905 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7914 /* In order to build the menus, we need to call the keymap
7915 accessors. They all call QUIT. But this function is called
7916 during redisplay, during which a quit is fatal. So inhibit
7917 quitting while building the menus. We do this instead of
7918 specbind because (1) errors will clear it anyway and (2) this
7919 avoids risk of specpdl overflow. */
7920 oquit
= Vinhibit_quit
;
7923 /* Initialize tool_bar_items_vector and protect it from GC. */
7924 init_tool_bar_items (reuse
);
7926 /* Build list of keymaps in maps. Set nmaps to the number of maps
7929 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7930 if (!NILP (Voverriding_local_map_menu_flag
))
7932 /* Yes, use them (if non-nil) as well as the global map. */
7933 maps
= alloca (3 * sizeof *maps
);
7935 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7936 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7937 if (!NILP (Voverriding_local_map
))
7938 maps
[nmaps
++] = Voverriding_local_map
;
7942 /* No, so use major and minor mode keymaps and keymap property.
7943 Note that tool-bar bindings in the local-map and keymap
7944 properties may not work reliable, as they are only
7945 recognized when the tool-bar (or mode-line) is updated,
7946 which does not normally happen after every command. */
7949 nminor
= current_minor_maps (NULL
, &tmaps
);
7950 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7952 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7953 maps
[nmaps
++] = tem
;
7954 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7956 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7959 /* Add global keymap at the end. */
7960 maps
[nmaps
++] = current_global_map
;
7962 /* Process maps in reverse order and look up in each map the prefix
7964 for (i
= nmaps
- 1; i
>= 0; --i
)
7965 if (!NILP (maps
[i
]))
7969 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7971 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7974 Vinhibit_quit
= oquit
;
7975 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7976 return tool_bar_items_vector
;
7980 /* Process the definition of KEY which is DEF. */
7983 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7986 struct gcpro gcpro1
, gcpro2
;
7988 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7992 if (EQ (def
, Qundefined
))
7994 /* If a map has an explicit `undefined' as definition,
7995 discard any previously made item. */
7996 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7998 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8000 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8002 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8003 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8004 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8006 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8011 else if (parse_tool_bar_item (key
, def
))
8012 /* Append a new tool bar item to tool_bar_items_vector. Accept
8013 more than one definition for the same key. */
8014 append_tool_bar_item ();
8019 /* Access slot with index IDX of vector tool_bar_item_properties. */
8020 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8022 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8024 ASET (tool_bar_item_properties
, idx
, val
);
8028 /* Parse a tool bar item specification ITEM for key KEY and return the
8029 result in tool_bar_item_properties. Value is false if ITEM is
8032 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8034 CAPTION is the caption of the item, If it's not a string, it is
8035 evaluated to get a string.
8037 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8038 as binding are currently ignored.
8040 The following properties are recognized:
8044 FORM is evaluated and specifies whether the tool bar item is
8045 enabled or disabled.
8049 FORM is evaluated and specifies whether the tool bar item is visible.
8051 - `:filter FUNCTION'
8053 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8054 result is stored as the new binding.
8056 - `:button (TYPE SELECTED)'
8058 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8059 and specifies whether the button is selected (pressed) or not.
8063 IMAGES is either a single image specification or a vector of four
8064 image specifications. See enum tool_bar_item_images.
8066 - `:help HELP-STRING'.
8068 Gives a help string to display for the tool bar item.
8070 - `:label LABEL-STRING'.
8072 A text label to show with the tool bar button if labels are enabled. */
8075 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8077 Lisp_Object filter
= Qnil
;
8078 Lisp_Object caption
;
8080 bool have_label
= 0;
8082 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8083 Rule out items that aren't lists, don't start with
8084 `menu-item' or whose rest following `tool-bar-item' is not a
8089 /* As an exception, allow old-style menu separators. */
8090 if (STRINGP (XCAR (item
)))
8091 item
= Fcons (XCAR (item
), Qnil
);
8092 else if (!EQ (XCAR (item
), Qmenu_item
)
8093 || (item
= XCDR (item
), !CONSP (item
)))
8096 /* Create tool_bar_item_properties vector if necessary. Reset it to
8098 if (VECTORP (tool_bar_item_properties
))
8100 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8104 tool_bar_item_properties
8105 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8108 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8109 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8111 /* Get the caption of the item. If the caption is not a string,
8112 evaluate it to get a string. If we don't get a string, skip this
8114 caption
= XCAR (item
);
8115 if (!STRINGP (caption
))
8117 caption
= menu_item_eval_property (caption
);
8118 if (!STRINGP (caption
))
8121 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8123 /* If the rest following the caption is not a list, the menu item is
8124 either a separator, or invalid. */
8128 if (menu_separator_name_p (SSDATA (caption
)))
8130 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8131 #if !defined (USE_GTK) && !defined (HAVE_NS)
8132 /* If we use build_desired_tool_bar_string to render the
8133 tool bar, the separator is rendered as an image. */
8134 PROP (TOOL_BAR_ITEM_IMAGES
)
8135 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8136 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8137 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8138 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8145 /* Store the binding. */
8146 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8149 /* Ignore cached key binding, if any. */
8150 if (CONSP (item
) && CONSP (XCAR (item
)))
8153 /* Process the rest of the properties. */
8154 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8156 Lisp_Object ikey
, value
;
8159 value
= XCAR (XCDR (item
));
8161 if (EQ (ikey
, QCenable
))
8163 /* `:enable FORM'. */
8164 if (!NILP (Venable_disabled_menus_and_buttons
))
8165 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8167 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8169 else if (EQ (ikey
, QCvisible
))
8171 /* `:visible FORM'. If got a visible property and that
8172 evaluates to nil then ignore this item. */
8173 if (NILP (menu_item_eval_property (value
)))
8176 else if (EQ (ikey
, QChelp
))
8177 /* `:help HELP-STRING'. */
8178 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8179 else if (EQ (ikey
, QCvert_only
))
8180 /* `:vert-only t/nil'. */
8181 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8182 else if (EQ (ikey
, QClabel
))
8184 const char *bad_label
= "!!?GARBLED ITEM?!!";
8185 /* `:label LABEL-STRING'. */
8186 set_prop (TOOL_BAR_ITEM_LABEL
,
8187 STRINGP (value
) ? value
: build_string (bad_label
));
8190 else if (EQ (ikey
, QCfilter
))
8191 /* ':filter FORM'. */
8193 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8195 /* `:button (TYPE . SELECTED)'. */
8196 Lisp_Object type
, selected
;
8198 type
= XCAR (value
);
8199 selected
= XCDR (value
);
8200 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8202 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8203 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8206 else if (EQ (ikey
, QCimage
)
8208 || (VECTORP (value
) && ASIZE (value
) == 4)))
8209 /* Value is either a single image specification or a vector
8210 of 4 such specifications for the different button states. */
8211 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8212 else if (EQ (ikey
, QCrtl
))
8214 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8220 /* Try to make one from caption and key. */
8221 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8222 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8223 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8224 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8226 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8227 char *buf
= xmalloc (max_lbl
+ 1);
8228 Lisp_Object new_lbl
;
8229 ptrdiff_t caption_len
= strlen (capt
);
8231 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8234 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8236 buf
[caption_len
] = '\0';
8240 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8244 strcpy (buf
, label
);
8246 for (j
= 0; buf
[j
] != '\0'; ++j
)
8254 new_lbl
= Fupcase_initials (build_string (label
));
8255 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8256 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8258 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8262 /* If got a filter apply it on binding. */
8264 set_prop (TOOL_BAR_ITEM_BINDING
,
8265 (menu_item_eval_property
8268 PROP (TOOL_BAR_ITEM_BINDING
))))));
8270 /* See if the binding is a keymap. Give up if it is. */
8271 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8274 /* Enable or disable selection of item. */
8275 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8276 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8277 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8279 /* Handle radio buttons or toggle boxes. */
8280 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8281 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8282 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8290 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8291 that can be reused. */
8294 init_tool_bar_items (Lisp_Object reuse
)
8296 if (VECTORP (reuse
))
8297 tool_bar_items_vector
= reuse
;
8299 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8300 ntool_bar_items
= 0;
8304 /* Append parsed tool bar item properties from
8305 tool_bar_item_properties */
8308 append_tool_bar_item (void)
8312 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8314 /* Enlarge tool_bar_items_vector if necessary. */
8316 tool_bar_items_vector
8317 = larger_vector (tool_bar_items_vector
, incr
, -1);
8319 /* Append entries from tool_bar_item_properties to the end of
8320 tool_bar_items_vector. */
8321 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8322 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8323 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8330 /* Read a character using menus based on maps in the array MAPS.
8331 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8332 Return t if we displayed a menu but the user rejected it.
8334 PREV_EVENT is the previous input event, or nil if we are reading
8335 the first event of a key sequence.
8337 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8338 if we used a mouse menu to read the input, or false otherwise. If
8339 USED_MOUSE_MENU is null, don't dereference it.
8341 The prompting is done based on the prompt-string of the map
8342 and the strings associated with various map elements.
8344 This can be done with X menus or with menus put in the minibuf.
8345 These are done in different ways, depending on how the input will be read.
8346 Menus using X are done after auto-saving in read-char, getting the input
8347 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8348 and do auto-saving in the inner call of read_char. */
8351 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8352 Lisp_Object prev_event
, bool *used_mouse_menu
)
8358 if (used_mouse_menu
)
8359 *used_mouse_menu
= 0;
8361 /* Use local over global Menu maps */
8363 if (! menu_prompting
)
8366 /* Optionally disregard all but the global map. */
8367 if (inhibit_local_menu_bar_menus
)
8369 maps
+= (nmaps
- 1);
8374 /* If we got to this point via a mouse click,
8375 use a real menu for mouse selection. */
8376 if (EVENT_HAS_PARAMETERS (prev_event
)
8377 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8378 && !EQ (XCAR (prev_event
), Qtool_bar
))
8380 /* Display the menu and get the selection. */
8381 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8383 ptrdiff_t nmaps1
= 0;
8385 /* Use the maps that are not nil. */
8386 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8387 if (!NILP (maps
[mapno
]))
8388 realmaps
[nmaps1
++] = maps
[mapno
];
8390 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8395 record_menu_key (XCAR (value
));
8397 /* If we got multiple events, unread all but
8399 There is no way to prevent those unread events
8400 from showing up later in last_nonmenu_event.
8401 So turn symbol and integer events into lists,
8402 to indicate that they came from a mouse menu,
8403 so that when present in last_nonmenu_event
8404 they won't confuse things. */
8405 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8407 record_menu_key (XCAR (tem
));
8408 if (SYMBOLP (XCAR (tem
))
8409 || INTEGERP (XCAR (tem
)))
8410 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8413 /* If we got more than one event, put all but the first
8414 onto this list to be read later.
8415 Return just the first event now. */
8416 Vunread_command_events
8417 = nconc2 (XCDR (value
), Vunread_command_events
);
8418 value
= XCAR (value
);
8420 else if (NILP (value
))
8422 if (used_mouse_menu
)
8423 *used_mouse_menu
= 1;
8426 #endif /* HAVE_MENUS */
8430 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8431 We make this bigger when necessary, and never free it. */
8432 static char *read_char_minibuf_menu_text
;
8433 /* Size of that buffer. */
8434 static ptrdiff_t read_char_minibuf_menu_width
;
8437 read_char_minibuf_menu_prompt (int commandflag
,
8438 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8441 register Lisp_Object name
;
8443 /* FIXME: Use the minibuffer's frame width. */
8444 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8446 bool nobindings
= 1;
8447 Lisp_Object rest
, vector
;
8453 if (! menu_prompting
)
8456 /* Get the menu name from the first map that has one (a prompt string). */
8457 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8459 name
= Fkeymap_prompt (maps
[mapno
]);
8464 /* If we don't have any menus, just read a character normally. */
8465 if (!STRINGP (name
))
8468 /* Make sure we have a big enough buffer for the menu text. */
8469 width
= max (width
, SBYTES (name
));
8470 if (STRING_BYTES_BOUND
- 4 < width
)
8471 memory_full (SIZE_MAX
);
8472 if (width
+ 4 > read_char_minibuf_menu_width
)
8474 read_char_minibuf_menu_text
8475 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8476 read_char_minibuf_menu_width
= width
+ 4;
8478 menu
= read_char_minibuf_menu_text
;
8480 /* Prompt string always starts with map's prompt, and a space. */
8481 strcpy (menu
, SSDATA (name
));
8482 nlength
= SBYTES (name
);
8483 menu
[nlength
++] = ':';
8484 menu
[nlength
++] = ' ';
8487 /* Start prompting at start of first map. */
8491 /* Present the documented bindings, a line at a time. */
8495 ptrdiff_t i
= nlength
;
8497 Lisp_Object orig_defn_macro
;
8499 /* Loop over elements of map. */
8504 /* If reached end of map, start at beginning of next map. */
8508 /* At end of last map, wrap around to first map if just starting,
8509 or end this line if already have something on it. */
8513 if (notfirst
|| nobindings
) break;
8518 /* Look at the next element of the map. */
8520 elt
= AREF (vector
, idx
);
8522 elt
= Fcar_safe (rest
);
8524 if (idx
< 0 && VECTORP (elt
))
8526 /* If we found a dense table in the keymap,
8527 advanced past it, but start scanning its contents. */
8528 rest
= Fcdr_safe (rest
);
8534 /* An ordinary element. */
8535 Lisp_Object event
, tem
;
8539 event
= Fcar_safe (elt
); /* alist */
8540 elt
= Fcdr_safe (elt
);
8544 XSETINT (event
, idx
); /* vector */
8547 /* Ignore the element if it has no prompt string. */
8548 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8550 /* True if the char to type matches the string. */
8552 Lisp_Object upcased_event
, downcased_event
;
8553 Lisp_Object desc
= Qnil
;
8555 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8557 upcased_event
= Fupcase (event
);
8558 downcased_event
= Fdowncase (event
);
8559 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8560 || XINT (downcased_event
) == SREF (s
, 0));
8562 desc
= Fsingle_key_description (event
, Qnil
);
8564 #if 0 /* It is redundant to list the equivalent key bindings because
8565 the prefix is what the user has already typed. */
8567 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8569 /* Insert equivalent keybinding. */
8570 s
= concat2 (s
, tem
);
8573 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8574 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8576 /* Insert button prefix. */
8577 Lisp_Object selected
8578 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8579 if (EQ (tem
, QCradio
))
8580 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8582 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8583 s
= concat2 (tem
, s
);
8587 /* If we have room for the prompt string, add it to this line.
8588 If this is the first on the line, always add it. */
8589 if ((SCHARS (s
) + i
+ 2
8590 + (char_matches
? 0 : SCHARS (desc
) + 3))
8594 ptrdiff_t thiswidth
;
8596 /* Punctuate between strings. */
8599 strcpy (menu
+ i
, ", ");
8605 /* If the char to type doesn't match the string's
8606 first char, explicitly show what char to type. */
8609 /* Add as much of string as fits. */
8610 thiswidth
= min (SCHARS (desc
), width
- i
);
8611 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8613 strcpy (menu
+ i
, " = ");
8617 /* Add as much of string as fits. */
8618 thiswidth
= min (SCHARS (s
), width
- i
);
8619 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8625 /* If this element does not fit, end the line now,
8626 and save the element for the next line. */
8627 strcpy (menu
+ i
, "...");
8632 /* Move past this element. */
8633 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8634 /* Handle reaching end of dense table. */
8639 rest
= Fcdr_safe (rest
);
8643 /* Prompt with that and read response. */
8644 message2_nolog (menu
, strlen (menu
),
8645 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8647 /* Make believe its not a keyboard macro in case the help char
8648 is pressed. Help characters are not recorded because menu prompting
8649 is not used on replay.
8651 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8652 kset_defining_kbd_macro (current_kboard
, Qnil
);
8654 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8655 while (BUFFERP (obj
));
8656 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8658 if (!INTEGERP (obj
))
8660 else if (XINT (obj
) == -2)
8663 if (! EQ (obj
, menu_prompt_more_char
)
8664 && (!INTEGERP (menu_prompt_more_char
)
8665 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8667 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8668 store_kbd_macro_char (obj
);
8671 /* Help char - go round again */
8675 /* Reading key sequences. */
8677 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8678 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8679 keymap, or nil otherwise. Return the index of the first keymap in
8680 which KEY has any binding, or NMAPS if no map has a binding.
8682 If KEY is a meta ASCII character, treat it like meta-prefix-char
8683 followed by the corresponding non-meta character. Keymaps in
8684 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8687 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8690 NEXT may be the same array as CURRENT. */
8693 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8694 Lisp_Object
*defs
, Lisp_Object
*next
)
8696 ptrdiff_t i
, first_binding
;
8698 first_binding
= nmaps
;
8699 for (i
= nmaps
- 1; i
>= 0; i
--)
8701 if (! NILP (current
[i
]))
8703 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8704 if (! NILP (defs
[i
]))
8711 /* Given the set of bindings we've found, produce the next set of maps. */
8712 if (first_binding
< nmaps
)
8713 for (i
= 0; i
< nmaps
; i
++)
8714 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8716 return first_binding
;
8719 /* Structure used to keep track of partial application of key remapping
8720 such as Vfunction_key_map and Vkey_translation_map. */
8721 typedef struct keyremap
8723 /* This is the map originally specified for this use. */
8725 /* This is a submap reached by looking up, in PARENT,
8726 the events from START to END. */
8728 /* Positions [START, END) in the key sequence buffer
8729 are the key that we have scanned so far.
8730 Those events are the ones that we will replace
8731 if PARENT maps them into a key sequence. */
8735 /* Lookup KEY in MAP.
8736 MAP is a keymap mapping keys to key vectors or functions.
8737 If the mapping is a function and DO_FUNCALL is true,
8738 the function is called with PROMPT as parameter and its return
8739 value is used as the return value of this function (after checking
8740 that it is indeed a vector). */
8743 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8748 next
= access_keymap (map
, key
, 1, 0, 1);
8750 /* Handle a symbol whose function definition is a keymap
8752 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8753 && (ARRAYP (XSYMBOL (next
)->function
)
8754 || KEYMAPP (XSYMBOL (next
)->function
)))
8755 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8757 /* If the keymap gives a function, not an
8758 array, then call the function with one arg and use
8759 its value instead. */
8760 if (do_funcall
&& FUNCTIONP (next
))
8765 next
= call1 (next
, prompt
);
8766 /* If the function returned something invalid,
8767 barf--don't ignore it.
8768 (To ignore it safely, we would need to gcpro a bunch of
8769 other variables.) */
8770 if (! (VECTORP (next
) || STRINGP (next
)))
8771 error ("Function %s returns invalid key sequence",
8772 SSDATA (SYMBOL_NAME (tem
)));
8777 /* Do one step of the key remapping used for function-key-map and
8778 key-translation-map:
8779 KEYBUF is the buffer holding the input events.
8780 BUFSIZE is its maximum size.
8781 FKEY is a pointer to the keyremap structure to use.
8782 INPUT is the index of the last element in KEYBUF.
8783 DOIT if true says that the remapping can actually take place.
8784 DIFF is used to return the number of keys added/removed by the remapping.
8785 PARENT is the root of the keymap.
8786 PROMPT is the prompt to use if the remapping happens through a function.
8787 Return true if the remapping actually took place. */
8790 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8791 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8793 Lisp_Object next
, key
;
8795 key
= keybuf
[fkey
->end
++];
8797 if (KEYMAPP (fkey
->parent
))
8798 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8802 /* If keybuf[fkey->start..fkey->end] is bound in the
8803 map and we're in a position to do the key remapping, replace it with
8804 the binding and restart with fkey->start at the end. */
8805 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8807 int len
= XFASTINT (Flength (next
));
8810 *diff
= len
- (fkey
->end
- fkey
->start
);
8812 if (bufsize
- input
<= *diff
)
8813 error ("Key sequence too long");
8815 /* Shift the keys that follow fkey->end. */
8817 for (i
= fkey
->end
; i
< input
; i
++)
8818 keybuf
[i
+ *diff
] = keybuf
[i
];
8820 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8821 keybuf
[i
+ *diff
] = keybuf
[i
];
8822 /* Overwrite the old keys with the new ones. */
8823 for (i
= 0; i
< len
; i
++)
8824 keybuf
[fkey
->start
+ i
]
8825 = Faref (next
, make_number (i
));
8827 fkey
->start
= fkey
->end
+= *diff
;
8828 fkey
->map
= fkey
->parent
;
8833 fkey
->map
= get_keymap (next
, 0, 1);
8835 /* If we no longer have a bound suffix, try a new position for
8837 if (!CONSP (fkey
->map
))
8839 fkey
->end
= ++fkey
->start
;
8840 fkey
->map
= fkey
->parent
;
8846 test_undefined (Lisp_Object binding
)
8848 return (EQ (binding
, Qundefined
)
8849 || (!NILP (binding
) && SYMBOLP (binding
)
8850 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8853 /* Read a sequence of keys that ends with a non prefix character,
8854 storing it in KEYBUF, a buffer of size BUFSIZE.
8856 Return the length of the key sequence stored.
8857 Return -1 if the user rejected a command menu.
8859 Echo starting immediately unless `prompt' is 0.
8861 Where a key sequence ends depends on the currently active keymaps.
8862 These include any minor mode keymaps active in the current buffer,
8863 the current buffer's local map, and the global map.
8865 If a key sequence has no other bindings, we check Vfunction_key_map
8866 to see if some trailing subsequence might be the beginning of a
8867 function key's sequence. If so, we try to read the whole function
8868 key, and substitute its symbolic name into the key sequence.
8870 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8871 `double-' events into similar click events, if that would make them
8872 bound. We try to turn `triple-' events first into `double-' events,
8875 If we get a mouse click in a mode line, vertical divider, or other
8876 non-text area, we treat the click as if it were prefixed by the
8877 symbol denoting that area - `mode-line', `vertical-line', or
8880 If the sequence starts with a mouse click, we read the key sequence
8881 with respect to the buffer clicked on, not the current buffer.
8883 If the user switches frames in the midst of a key sequence, we put
8884 off the switch-frame event until later; the next call to
8885 read_char will return it.
8887 If FIX_CURRENT_BUFFER, we restore current_buffer
8888 from the selected window's buffer. */
8891 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8892 bool dont_downcase_last
, bool can_return_switch_frame
,
8893 bool fix_current_buffer
)
8895 Lisp_Object from_string
;
8896 ptrdiff_t count
= SPECPDL_INDEX ();
8898 /* How many keys there are in the current key sequence. */
8901 /* The length of the echo buffer when we started reading, and
8902 the length of this_command_keys when we started reading. */
8903 ptrdiff_t echo_start
IF_LINT (= 0);
8904 ptrdiff_t keys_start
;
8906 /* The number of keymaps we're scanning right now, and the number of
8907 keymaps we have allocated space for. */
8909 ptrdiff_t nmaps_allocated
= 0;
8911 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8912 the current keymaps. */
8913 Lisp_Object
*defs
= NULL
;
8915 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8916 in the current keymaps, or nil where it is not a prefix. */
8917 Lisp_Object
*submaps
= NULL
;
8919 /* The local map to start out with at start of key sequence. */
8920 Lisp_Object orig_local_map
;
8922 /* The map from the `keymap' property to start out with at start of
8924 Lisp_Object orig_keymap
;
8926 /* Positive if we have already considered switching to the local-map property
8927 of the place where a mouse click occurred. */
8928 int localized_local_map
= 0;
8930 /* The index in submaps[] of the first keymap that has a binding for
8931 this key sequence. In other words, the lowest i such that
8932 submaps[i] is non-nil. */
8933 ptrdiff_t first_binding
;
8934 /* Index of the first key that has no binding.
8935 It is useless to try fkey.start larger than that. */
8938 /* If t < mock_input, then KEYBUF[t] should be read as the next
8941 We use this to recover after recognizing a function key. Once we
8942 realize that a suffix of the current key sequence is actually a
8943 function key's escape sequence, we replace the suffix with the
8944 function key's binding from Vfunction_key_map. Now keybuf
8945 contains a new and different key sequence, so the echo area,
8946 this_command_keys, and the submaps and defs arrays are wrong. In
8947 this situation, we set mock_input to t, set t to 0, and jump to
8948 restart_sequence; the loop will read keys from keybuf up until
8949 mock_input, thus rebuilding the state; and then it will resume
8950 reading characters from the keyboard. */
8953 /* If the sequence is unbound in submaps[], then
8954 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8955 and fkey.map is its binding.
8957 These might be > t, indicating that all function key scanning
8958 should hold off until t reaches them. We do this when we've just
8959 recognized a function key, to avoid searching for the function
8960 key's again in Vfunction_key_map. */
8963 /* Likewise, for key_translation_map and input-decode-map. */
8964 keyremap keytran
, indec
;
8966 /* True if we are trying to map a key by changing an upper-case
8967 letter to lower case, or a shifted function key to an unshifted
8969 bool shift_translated
= 0;
8971 /* If we receive a `switch-frame' or `select-window' event in the middle of
8972 a key sequence, we put it off for later.
8973 While we're reading, we keep the event here. */
8974 Lisp_Object delayed_switch_frame
;
8976 /* See the comment below... */
8977 #if defined (GOBBLE_FIRST_EVENT)
8978 Lisp_Object first_event
;
8981 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8982 int original_uppercase_position
= -1;
8984 /* Gets around Microsoft compiler limitations. */
8987 struct buffer
*starting_buffer
;
8989 /* List of events for which a fake prefix key has been generated. */
8990 Lisp_Object fake_prefixed_keys
= Qnil
;
8992 #if defined (GOBBLE_FIRST_EVENT)
8996 struct gcpro gcpro1
;
8998 GCPRO1 (fake_prefixed_keys
);
8999 raw_keybuf_count
= 0;
9001 last_nonmenu_event
= Qnil
;
9003 delayed_switch_frame
= Qnil
;
9009 /* Install the string STR as the beginning of the string of
9010 echoing, so that it serves as a prompt for the next
9012 kset_echo_string (current_kboard
, prompt
);
9013 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9016 else if (cursor_in_echo_area
9017 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9018 && NILP (Fzerop (Vecho_keystrokes
)))
9019 /* This doesn't put in a dash if the echo buffer is empty, so
9020 you don't always see a dash hanging out in the minibuffer. */
9024 /* Record the initial state of the echo area and this_command_keys;
9025 we will need to restore them if we replay a key sequence. */
9027 echo_start
= echo_length ();
9028 keys_start
= this_command_key_count
;
9029 this_single_command_key_start
= keys_start
;
9031 #if defined (GOBBLE_FIRST_EVENT)
9032 /* This doesn't quite work, because some of the things that read_char
9033 does cannot safely be bypassed. It seems too risky to try to make
9036 /* Read the first char of the sequence specially, before setting
9037 up any keymaps, in case a filter runs and switches buffers on us. */
9038 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9040 #endif /* GOBBLE_FIRST_EVENT */
9042 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9043 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9046 /* We jump here when we need to reinitialize fkey and keytran; this
9047 happens if we switch keyboards between rescans. */
9048 replay_entire_sequence
:
9050 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9051 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9052 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9053 indec
.start
= indec
.end
= 0;
9054 fkey
.start
= fkey
.end
= 0;
9055 keytran
.start
= keytran
.end
= 0;
9057 /* We jump here when the key sequence has been thoroughly changed, and
9058 we need to rescan it starting from the beginning. When we jump here,
9059 keybuf[0..mock_input] holds the sequence we should reread. */
9062 starting_buffer
= current_buffer
;
9063 first_unbound
= bufsize
+ 1;
9065 /* Build our list of keymaps.
9066 If we recognize a function key and replace its escape sequence in
9067 keybuf with its symbol, or if the sequence starts with a mouse
9068 click and we need to switch buffers, we jump back here to rebuild
9069 the initial keymaps from the current buffer. */
9072 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9074 if (2 > nmaps_allocated
)
9076 submaps
= alloca (2 * sizeof *submaps
);
9077 defs
= alloca (2 * sizeof *defs
);
9078 nmaps_allocated
= 2;
9080 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9082 else if (!NILP (Voverriding_local_map
))
9084 if (2 > nmaps_allocated
)
9086 submaps
= alloca (2 * sizeof *submaps
);
9087 defs
= alloca (2 * sizeof *defs
);
9088 nmaps_allocated
= 2;
9090 submaps
[nmaps
++] = Voverriding_local_map
;
9098 nminor
= current_minor_maps (0, &maps
);
9099 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9101 if (total
> nmaps_allocated
)
9103 submaps
= alloca (total
* sizeof *submaps
);
9104 defs
= alloca (total
* sizeof *defs
);
9105 nmaps_allocated
= total
;
9108 if (!NILP (orig_keymap
))
9109 submaps
[nmaps
++] = orig_keymap
;
9111 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9115 submaps
[nmaps
++] = orig_local_map
;
9117 submaps
[nmaps
++] = current_global_map
;
9119 /* Find an accurate initial value for first_binding. */
9120 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9121 if (! NILP (submaps
[first_binding
]))
9124 /* Start from the beginning in keybuf. */
9127 /* These are no-ops the first time through, but if we restart, they
9128 revert the echo area and this_command_keys to their original state. */
9129 this_command_key_count
= keys_start
;
9130 if (INTERACTIVE
&& t
< mock_input
)
9131 echo_truncate (echo_start
);
9133 /* If the best binding for the current key sequence is a keymap, or
9134 we may be looking at a function key's escape sequence, keep on
9136 while (first_binding
< nmaps
9137 /* Keep reading as long as there's a prefix binding. */
9138 ? !NILP (submaps
[first_binding
])
9139 /* Don't return in the middle of a possible function key sequence,
9140 if the only bindings we found were via case conversion.
9141 Thus, if ESC O a has a function-key-map translation
9142 and ESC o has a binding, don't return after ESC O,
9143 so that we can translate ESC O plus the next character. */
9144 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9147 bool used_mouse_menu
= 0;
9149 /* Where the last real key started. If we need to throw away a
9150 key that has expanded into more than one element of keybuf
9151 (say, a mouse click on the mode line which is being treated
9152 as [mode-line (mouse-...)], then we backtrack to this point
9154 int last_real_key_start
;
9156 /* These variables are analogous to echo_start and keys_start;
9157 while those allow us to restart the entire key sequence,
9158 echo_local_start and keys_local_start allow us to throw away
9160 ptrdiff_t echo_local_start
IF_LINT (= 0);
9161 int keys_local_start
;
9162 ptrdiff_t local_first_binding
;
9164 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9165 eassert (indec
.start
<= indec
.end
);
9166 eassert (fkey
.start
<= fkey
.end
);
9167 eassert (keytran
.start
<= keytran
.end
);
9168 /* key-translation-map is applied *after* function-key-map
9169 which is itself applied *after* input-decode-map. */
9170 eassert (fkey
.end
<= indec
.start
);
9171 eassert (keytran
.end
<= fkey
.start
);
9173 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9174 first_unbound
< keytran
.start
)
9175 { /* The prefix upto first_unbound has no binding and has
9176 no translation left to do either, so we know it's unbound.
9177 If we don't stop now, we risk staying here indefinitely
9178 (if the user keeps entering fkey or keytran prefixes
9179 like C-c ESC ESC ESC ESC ...) */
9181 for (i
= first_unbound
+ 1; i
< t
; i
++)
9182 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9183 mock_input
= t
- first_unbound
- 1;
9184 indec
.end
= indec
.start
-= first_unbound
+ 1;
9185 indec
.map
= indec
.parent
;
9186 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9187 fkey
.map
= fkey
.parent
;
9188 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9189 keytran
.map
= keytran
.parent
;
9190 goto replay_sequence
;
9194 error ("Key sequence too long");
9197 echo_local_start
= echo_length ();
9198 keys_local_start
= this_command_key_count
;
9199 local_first_binding
= first_binding
;
9202 /* These are no-ops, unless we throw away a keystroke below and
9203 jumped back up to replay_key; in that case, these restore the
9204 variables to their original state, allowing us to replay the
9206 if (INTERACTIVE
&& t
< mock_input
)
9207 echo_truncate (echo_local_start
);
9208 this_command_key_count
= keys_local_start
;
9209 first_binding
= local_first_binding
;
9211 /* By default, assume each event is "real". */
9212 last_real_key_start
= t
;
9214 /* Does mock_input indicate that we are re-reading a key sequence? */
9218 add_command_key (key
);
9219 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9220 && NILP (Fzerop (Vecho_keystrokes
)))
9224 /* If not, we should actually read a character. */
9228 KBOARD
*interrupted_kboard
= current_kboard
;
9229 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9230 key
= read_char (NILP (prompt
), nmaps
,
9231 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9232 &used_mouse_menu
, NULL
);
9233 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9234 /* When switching to a new tty (with a new keyboard),
9235 read_char returns the new buffer, rather than -2
9236 (Bug#5095). This is because `terminal-init-xterm'
9237 calls read-char, which eats the wrong_kboard_jmpbuf
9238 return. Any better way to fix this? -- cyd */
9239 || (interrupted_kboard
!= current_kboard
))
9244 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9245 if (k
== interrupted_kboard
)
9250 /* Don't touch interrupted_kboard when it's been
9252 delayed_switch_frame
= Qnil
;
9253 goto replay_entire_sequence
;
9256 if (!NILP (delayed_switch_frame
))
9259 (interrupted_kboard
,
9260 Fcons (delayed_switch_frame
,
9261 KVAR (interrupted_kboard
, kbd_queue
)));
9262 delayed_switch_frame
= Qnil
;
9267 (interrupted_kboard
,
9268 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9270 /* If the side queue is non-empty, ensure it begins with a
9271 switch-frame, so we'll replay it in the right context. */
9272 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9273 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9274 !(EVENT_HAS_PARAMETERS (key
)
9275 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9279 XSETFRAME (frame
, interrupted_frame
);
9281 (interrupted_kboard
,
9282 Fcons (make_lispy_switch_frame (frame
),
9283 KVAR (interrupted_kboard
, kbd_queue
)));
9286 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9287 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9288 goto replay_entire_sequence
;
9292 /* read_char returns t when it shows a menu and the user rejects it.
9296 unbind_to (count
, Qnil
);
9301 /* read_char returns -1 at the end of a macro.
9302 Emacs 18 handles this by returning immediately with a
9303 zero, so that's what we'll do. */
9304 if (INTEGERP (key
) && XINT (key
) == -1)
9307 /* The Microsoft C compiler can't handle the goto that
9313 /* If the current buffer has been changed from under us, the
9314 keymap may have changed, so replay the sequence. */
9317 timer_resume_idle ();
9320 /* Reset the current buffer from the selected window
9321 in case something changed the former and not the latter.
9322 This is to be more consistent with the behavior
9323 of the command_loop_1. */
9324 if (fix_current_buffer
)
9326 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9328 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9329 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9332 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9333 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9334 goto replay_sequence
;
9337 /* If we have a quit that was typed in another frame, and
9338 quit_throw_to_read_char switched buffers,
9339 replay to get the right keymap. */
9341 && XINT (key
) == quit_char
9342 && current_buffer
!= starting_buffer
)
9345 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9350 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9351 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9352 goto replay_sequence
;
9357 if (EVENT_HAS_PARAMETERS (key
)
9358 /* Either a `switch-frame' or a `select-window' event. */
9359 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9361 /* If we're at the beginning of a key sequence, and the caller
9362 says it's okay, go ahead and return this event. If we're
9363 in the midst of a key sequence, delay it until the end. */
9364 if (t
> 0 || !can_return_switch_frame
)
9366 delayed_switch_frame
= key
;
9372 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9376 /* Clicks in non-text areas get prefixed by the symbol
9377 in their CHAR-ADDRESS field. For example, a click on
9378 the mode line is prefixed by the symbol `mode-line'.
9380 Furthermore, key sequences beginning with mouse clicks
9381 are read using the keymaps of the buffer clicked on, not
9382 the current buffer. So we may have to switch the buffer
9385 When we turn one event into two events, we must make sure
9386 that neither of the two looks like the original--so that,
9387 if we replay the events, they won't be expanded again.
9388 If not for this, such reexpansion could happen either here
9389 or when user programs play with this-command-keys. */
9390 if (EVENT_HAS_PARAMETERS (key
))
9395 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9396 if (EQ (kind
, Qmouse_click
))
9398 Lisp_Object window
, posn
;
9400 window
= POSN_WINDOW (EVENT_START (key
));
9401 posn
= POSN_POSN (EVENT_START (key
));
9404 || (!NILP (fake_prefixed_keys
)
9405 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9407 /* We're looking a second time at an event for which
9408 we generated a fake prefix key. Set
9409 last_real_key_start appropriately. */
9411 last_real_key_start
= t
- 1;
9414 if (last_real_key_start
== 0)
9416 /* Key sequences beginning with mouse clicks are
9417 read using the keymaps in the buffer clicked on,
9418 not the current buffer. If we're at the
9419 beginning of a key sequence, switch buffers. */
9420 if (WINDOWP (window
)
9421 && BUFFERP (XWINDOW (window
)->buffer
)
9422 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9424 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9429 /* Arrange to go back to the original buffer once we're
9430 done reading the key sequence. Note that we can't
9431 use save_excursion_{save,restore} here, because they
9432 save point as well as the current buffer; we don't
9433 want to save point, because redisplay may change it,
9434 to accommodate a Fset_window_start or something. We
9435 don't want to do this at the top of the function,
9436 because we may get input from a subprocess which
9437 wants to change the selected window and stuff (say,
9439 record_unwind_current_buffer ();
9441 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9443 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9444 orig_local_map
= get_local_map (PT
, current_buffer
,
9446 orig_keymap
= get_local_map (PT
, current_buffer
,
9448 goto replay_sequence
;
9451 /* For a mouse click, get the local text-property keymap
9452 of the place clicked on, rather than point. */
9453 if (CONSP (XCDR (key
))
9454 && ! localized_local_map
)
9456 Lisp_Object map_here
, start
, pos
;
9458 localized_local_map
= 1;
9459 start
= EVENT_START (key
);
9461 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9463 pos
= POSN_BUFFER_POSN (start
);
9465 && XINT (pos
) >= BEGV
9466 && XINT (pos
) <= ZV
)
9468 map_here
= get_local_map (XINT (pos
),
9471 if (!EQ (map_here
, orig_local_map
))
9473 orig_local_map
= map_here
;
9474 ++localized_local_map
;
9477 map_here
= get_local_map (XINT (pos
),
9480 if (!EQ (map_here
, orig_keymap
))
9482 orig_keymap
= map_here
;
9483 ++localized_local_map
;
9486 if (localized_local_map
> 1)
9491 goto replay_sequence
;
9498 /* Expand mode-line and scroll-bar events into two events:
9499 use posn as a fake prefix key. */
9501 && (NILP (fake_prefixed_keys
)
9502 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9504 if (bufsize
- t
<= 1)
9505 error ("Key sequence too long");
9508 keybuf
[t
+ 1] = key
;
9511 /* Record that a fake prefix key has been generated
9512 for KEY. Don't modify the event; this would
9513 prevent proper action when the event is pushed
9514 back into unread-command-events. */
9515 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9517 /* If on a mode line string with a local keymap,
9518 reconsider the key sequence with that keymap. */
9519 if (string
= POSN_STRING (EVENT_START (key
)),
9520 (CONSP (string
) && STRINGP (XCAR (string
))))
9522 Lisp_Object pos
, map
, map2
;
9524 pos
= XCDR (string
);
9525 string
= XCAR (string
);
9527 && XINT (pos
) < SCHARS (string
))
9529 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9531 orig_local_map
= map
;
9532 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9535 if (!NILP (map
) || !NILP (map2
))
9536 goto replay_sequence
;
9542 else if (NILP (from_string
)
9543 && (string
= POSN_STRING (EVENT_START (key
)),
9544 (CONSP (string
) && STRINGP (XCAR (string
)))))
9546 /* For a click on a string, i.e. overlay string or a
9547 string displayed via the `display' property,
9548 consider `local-map' and `keymap' properties of
9550 Lisp_Object pos
, map
, map2
;
9552 pos
= XCDR (string
);
9553 string
= XCAR (string
);
9555 && XINT (pos
) < SCHARS (string
))
9557 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9559 orig_local_map
= map
;
9560 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9564 if (!NILP (map
) || !NILP (map2
))
9566 from_string
= string
;
9569 goto replay_sequence
;
9574 else if (CONSP (XCDR (key
))
9575 && CONSP (EVENT_START (key
))
9576 && CONSP (XCDR (EVENT_START (key
))))
9580 posn
= POSN_POSN (EVENT_START (key
));
9581 /* Handle menu-bar events:
9582 insert the dummy prefix event `menu-bar'. */
9583 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9585 if (bufsize
- t
<= 1)
9586 error ("Key sequence too long");
9590 /* Zap the position in key, so we know that we've
9591 expanded it, and don't try to do so again. */
9592 POSN_SET_POSN (EVENT_START (key
),
9593 Fcons (posn
, Qnil
));
9596 goto replay_sequence
;
9598 else if (CONSP (posn
))
9600 /* We're looking at the second event of a
9601 sequence which we expanded before. Set
9602 last_real_key_start appropriately. */
9603 if (last_real_key_start
== t
&& t
> 0)
9604 last_real_key_start
= t
- 1;
9609 /* We have finally decided that KEY is something we might want
9611 first_binding
= (follow_key (key
,
9612 nmaps
- first_binding
,
9613 submaps
+ first_binding
,
9614 defs
+ first_binding
,
9615 submaps
+ first_binding
)
9618 /* If KEY wasn't bound, we'll try some fallbacks. */
9619 if (first_binding
< nmaps
)
9620 /* This is needed for the following scenario:
9621 event 0: a down-event that gets dropped by calling replay_key.
9622 event 1: some normal prefix like C-h.
9623 After event 0, first_unbound is 0, after event 1 indec.start,
9624 fkey.start, and keytran.start are all 1, so when we see that
9625 C-h is bound, we need to update first_unbound. */
9626 first_unbound
= max (t
+ 1, first_unbound
);
9631 /* Remember the position to put an upper bound on indec.start. */
9632 first_unbound
= min (t
, first_unbound
);
9634 head
= EVENT_HEAD (key
);
9635 if (help_char_p (head
) && t
> 0)
9637 read_key_sequence_cmd
= Vprefix_help_command
;
9639 last_nonmenu_event
= key
;
9640 /* The Microsoft C compiler can't handle the goto that
9648 Lisp_Object breakdown
;
9651 breakdown
= parse_modifiers (head
);
9652 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9653 /* Attempt to reduce an unbound mouse event to a simpler
9654 event that is bound:
9655 Drags reduce to clicks.
9656 Double-clicks reduce to clicks.
9657 Triple-clicks reduce to double-clicks, then to clicks.
9658 Down-clicks are eliminated.
9659 Double-downs reduce to downs, then are eliminated.
9660 Triple-downs reduce to double-downs, then to downs,
9661 then are eliminated. */
9662 if (modifiers
& (down_modifier
| drag_modifier
9663 | double_modifier
| triple_modifier
))
9665 while (modifiers
& (down_modifier
| drag_modifier
9666 | double_modifier
| triple_modifier
))
9668 Lisp_Object new_head
, new_click
;
9669 if (modifiers
& triple_modifier
)
9670 modifiers
^= (double_modifier
| triple_modifier
);
9671 else if (modifiers
& double_modifier
)
9672 modifiers
&= ~double_modifier
;
9673 else if (modifiers
& drag_modifier
)
9674 modifiers
&= ~drag_modifier
;
9677 /* Dispose of this `down' event by simply jumping
9678 back to replay_key, to get another event.
9680 Note that if this event came from mock input,
9681 then just jumping back to replay_key will just
9682 hand it to us again. So we have to wipe out any
9685 We could delete keybuf[t] and shift everything
9686 after that to the left by one spot, but we'd also
9687 have to fix up any variable that points into
9688 keybuf, and shifting isn't really necessary
9691 Adding prefixes for non-textual mouse clicks
9692 creates two characters of mock input, and both
9693 must be thrown away. If we're only looking at
9694 the prefix now, we can just jump back to
9695 replay_key. On the other hand, if we've already
9696 processed the prefix, and now the actual click
9697 itself is giving us trouble, then we've lost the
9698 state of the keymaps we want to backtrack to, and
9699 we need to replay the whole sequence to rebuild
9702 Beyond that, only function key expansion could
9703 create more than two keys, but that should never
9704 generate mouse events, so it's okay to zero
9705 mock_input in that case too.
9707 FIXME: The above paragraph seems just plain
9708 wrong, if you consider things like
9709 xterm-mouse-mode. -stef
9711 Isn't this just the most wonderful code ever? */
9713 /* If mock_input > t + 1, the above simplification
9714 will actually end up dropping keys on the floor.
9715 This is probably OK for now, but even
9716 if mock_input <= t + 1, we need to adjust indec,
9718 Typical case [header-line down-mouse-N]:
9719 mock_input = 2, t = 1, fkey.end = 1,
9720 last_real_key_start = 0. */
9721 if (indec
.end
> last_real_key_start
)
9723 indec
.end
= indec
.start
9724 = min (last_real_key_start
, indec
.start
);
9725 indec
.map
= indec
.parent
;
9726 if (fkey
.end
> last_real_key_start
)
9728 fkey
.end
= fkey
.start
9729 = min (last_real_key_start
, fkey
.start
);
9730 fkey
.map
= fkey
.parent
;
9731 if (keytran
.end
> last_real_key_start
)
9733 keytran
.end
= keytran
.start
9734 = min (last_real_key_start
, keytran
.start
);
9735 keytran
.map
= keytran
.parent
;
9739 if (t
== last_real_key_start
)
9746 mock_input
= last_real_key_start
;
9747 goto replay_sequence
;
9752 = apply_modifiers (modifiers
, XCAR (breakdown
));
9754 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9756 /* Look for a binding for this new key. follow_key
9757 promises that it didn't munge submaps the
9758 last time we called it, since key was unbound. */
9760 = (follow_key (new_click
,
9761 nmaps
- local_first_binding
,
9762 submaps
+ local_first_binding
,
9763 defs
+ local_first_binding
,
9764 submaps
+ local_first_binding
)
9765 + local_first_binding
);
9767 /* If that click is bound, go for it. */
9768 if (first_binding
< nmaps
)
9773 /* Otherwise, we'll leave key set to the drag event. */
9780 /* Normally, last_nonmenu_event gets the previous key we read.
9781 But when a mouse popup menu is being used,
9782 we don't update last_nonmenu_event; it continues to hold the mouse
9783 event that preceded the first level of menu. */
9784 if (!used_mouse_menu
)
9785 last_nonmenu_event
= key
;
9787 /* Record what part of this_command_keys is the current key sequence. */
9788 this_single_command_key_start
= this_command_key_count
- t
;
9790 /* Look for this sequence in input-decode-map.
9791 Scan from indec.end until we find a bound suffix. */
9792 while (indec
.end
< t
)
9794 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9798 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9799 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9804 mock_input
= diff
+ max (t
, mock_input
);
9805 goto replay_sequence
;
9809 if (first_binding
< nmaps
9810 && NILP (submaps
[first_binding
])
9811 && !test_undefined (defs
[first_binding
])
9812 && indec
.start
>= t
)
9813 /* There is a binding and it's not a prefix.
9814 (and it doesn't have any input-decode-map translation pending).
9815 There is thus no function-key in this sequence.
9816 Moving fkey.start is important in this case to allow keytran.start
9817 to go over the sequence before we return (since we keep the
9818 invariant that keytran.end <= fkey.start). */
9821 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9824 /* If the sequence is unbound, see if we can hang a function key
9825 off the end of it. */
9826 /* Continue scan from fkey.end until we find a bound suffix. */
9827 while (fkey
.end
< indec
.start
)
9829 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9833 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9834 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9835 max (t
, mock_input
),
9836 /* If there's a binding (i.e.
9837 first_binding >= nmaps) we don't want
9838 to apply this function-key-mapping. */
9840 && (first_binding
>= nmaps
9841 || test_undefined (defs
[first_binding
])),
9846 mock_input
= diff
+ max (t
, mock_input
);
9847 /* Adjust the input-decode-map counters. */
9849 indec
.start
+= diff
;
9851 goto replay_sequence
;
9855 /* Look for this sequence in key-translation-map.
9856 Scan from keytran.end until we find a bound suffix. */
9857 while (keytran
.end
< fkey
.start
)
9859 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9863 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9864 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9869 mock_input
= diff
+ max (t
, mock_input
);
9870 /* Adjust the function-key-map and input-decode-map counters. */
9872 indec
.start
+= diff
;
9876 goto replay_sequence
;
9880 /* If KEY is not defined in any of the keymaps,
9881 and cannot be part of a function key or translation,
9882 and is an upper case letter
9883 use the corresponding lower-case letter instead. */
9884 if (first_binding
>= nmaps
9885 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9887 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9888 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9889 || (XINT (key
) & shift_modifier
)))
9891 Lisp_Object new_key
;
9893 original_uppercase
= key
;
9894 original_uppercase_position
= t
- 1;
9896 if (XINT (key
) & shift_modifier
)
9897 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9899 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9900 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9902 /* We have to do this unconditionally, regardless of whether
9903 the lower-case char is defined in the keymaps, because they
9904 might get translated through function-key-map. */
9905 keybuf
[t
- 1] = new_key
;
9906 mock_input
= max (t
, mock_input
);
9907 shift_translated
= 1;
9909 goto replay_sequence
;
9911 /* If KEY is not defined in any of the keymaps,
9912 and cannot be part of a function key or translation,
9913 and is a shifted function key,
9914 use the corresponding unshifted function key instead. */
9915 if (first_binding
>= nmaps
9916 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9918 Lisp_Object breakdown
= parse_modifiers (key
);
9920 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9922 if (modifiers
& shift_modifier
9923 /* Treat uppercase keys as shifted. */
9925 && (KEY_TO_CHAR (key
)
9926 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9927 && uppercasep (KEY_TO_CHAR (key
))))
9930 = (modifiers
& shift_modifier
9931 ? apply_modifiers (modifiers
& ~shift_modifier
,
9933 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9935 original_uppercase
= key
;
9936 original_uppercase_position
= t
- 1;
9938 /* We have to do this unconditionally, regardless of whether
9939 the lower-case char is defined in the keymaps, because they
9940 might get translated through function-key-map. */
9941 keybuf
[t
- 1] = new_key
;
9942 mock_input
= max (t
, mock_input
);
9943 /* Reset fkey (and consequently keytran) to apply
9944 function-key-map on the result, so that S-backspace is
9945 correctly mapped to DEL (via backspace). OTOH,
9946 input-decode-map doesn't need to go through it again. */
9947 fkey
.start
= fkey
.end
= 0;
9948 keytran
.start
= keytran
.end
= 0;
9949 shift_translated
= 1;
9951 goto replay_sequence
;
9956 read_key_sequence_cmd
= (first_binding
< nmaps
9957 ? defs
[first_binding
]
9959 read_key_sequence_remapped
9960 /* Remap command through active keymaps.
9961 Do the remapping here, before the unbind_to so it uses the keymaps
9962 of the appropriate buffer. */
9963 = SYMBOLP (read_key_sequence_cmd
)
9964 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9967 unread_switch_frame
= delayed_switch_frame
;
9968 unbind_to (count
, Qnil
);
9970 /* Don't downcase the last character if the caller says don't.
9971 Don't downcase it if the result is undefined, either. */
9972 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9974 && t
- 1 == original_uppercase_position
)
9976 keybuf
[t
- 1] = original_uppercase
;
9977 shift_translated
= 0;
9980 if (shift_translated
)
9981 Vthis_command_keys_shift_translated
= Qt
;
9983 /* Occasionally we fabricate events, perhaps by expanding something
9984 according to function-key-map, or by adding a prefix symbol to a
9985 mouse click in the scroll bar or modeline. In this cases, return
9986 the entire generated key sequence, even if we hit an unbound
9987 prefix or a definition before the end. This means that you will
9988 be able to push back the event properly, and also means that
9989 read-key-sequence will always return a logical unit.
9992 for (; t
< mock_input
; t
++)
9994 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9995 && NILP (Fzerop (Vecho_keystrokes
)))
9996 echo_char (keybuf
[t
]);
9997 add_command_key (keybuf
[t
]);
10004 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10005 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10006 The sequence is sufficient to specify a non-prefix command in the
10007 current local and global maps.
10009 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10010 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10011 as a continuation of the previous key.
10013 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10014 convert the last event to lower case. (Normally any upper case event
10015 is converted to lower case if the original event is undefined and the lower
10016 case equivalent is defined.) A non-nil value is appropriate for reading
10017 a key sequence to be defined.
10019 A C-g typed while in this function is treated like any other character,
10020 and `quit-flag' is not set.
10022 If the key sequence starts with a mouse click, then the sequence is read
10023 using the keymaps of the buffer of the window clicked in, not the buffer
10024 of the selected window as normal.
10026 `read-key-sequence' drops unbound button-down events, since you normally
10027 only care about the click or drag events which follow them. If a drag
10028 or multi-click event is unbound, but the corresponding click event would
10029 be bound, `read-key-sequence' turns the event into a click event at the
10030 drag's starting position. This means that you don't have to distinguish
10031 between click and drag, double, or triple events unless you want to.
10033 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10034 lines separating windows, and scroll bars with imaginary keys
10035 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10037 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10038 function will process a switch-frame event if the user switches frames
10039 before typing anything. If the user switches frames in the middle of a
10040 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10041 is nil, then the event will be put off until after the current key sequence.
10043 `read-key-sequence' checks `function-key-map' for function key
10044 sequences, where they wouldn't conflict with ordinary bindings. See
10045 `function-key-map' for more details.
10047 The optional fifth argument CMD-LOOP, if non-nil, means
10048 that this key sequence is being read by something that will
10049 read commands one after another. It should be nil if the caller
10050 will read just one key sequence. */)
10051 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10053 Lisp_Object keybuf
[30];
10055 struct gcpro gcpro1
;
10056 ptrdiff_t count
= SPECPDL_INDEX ();
10058 if (!NILP (prompt
))
10059 CHECK_STRING (prompt
);
10062 specbind (Qinput_method_exit_on_first_char
,
10063 (NILP (cmd_loop
) ? Qt
: Qnil
));
10064 specbind (Qinput_method_use_echo_area
,
10065 (NILP (cmd_loop
) ? Qt
: Qnil
));
10067 memset (keybuf
, 0, sizeof keybuf
);
10068 GCPRO1 (keybuf
[0]);
10069 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10071 if (NILP (continue_echo
))
10073 this_command_key_count
= 0;
10074 this_command_key_count_reset
= 0;
10075 this_single_command_key_start
= 0;
10078 #ifdef HAVE_WINDOW_SYSTEM
10079 if (display_hourglass_p
)
10080 cancel_hourglass ();
10083 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10084 prompt
, ! NILP (dont_downcase_last
),
10085 ! NILP (can_return_switch_frame
), 0);
10087 #if 0 /* The following is fine for code reading a key sequence and
10088 then proceeding with a lengthy computation, but it's not good
10089 for code reading keys in a loop, like an input method. */
10090 #ifdef HAVE_WINDOW_SYSTEM
10091 if (display_hourglass_p
)
10092 start_hourglass ();
10102 return unbind_to (count
, make_event_array (i
, keybuf
));
10105 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10106 Sread_key_sequence_vector
, 1, 5, 0,
10107 doc
: /* Like `read-key-sequence' but always return a vector. */)
10108 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10110 Lisp_Object keybuf
[30];
10112 struct gcpro gcpro1
;
10113 ptrdiff_t count
= SPECPDL_INDEX ();
10115 if (!NILP (prompt
))
10116 CHECK_STRING (prompt
);
10119 specbind (Qinput_method_exit_on_first_char
,
10120 (NILP (cmd_loop
) ? Qt
: Qnil
));
10121 specbind (Qinput_method_use_echo_area
,
10122 (NILP (cmd_loop
) ? Qt
: Qnil
));
10124 memset (keybuf
, 0, sizeof keybuf
);
10125 GCPRO1 (keybuf
[0]);
10126 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10128 if (NILP (continue_echo
))
10130 this_command_key_count
= 0;
10131 this_command_key_count_reset
= 0;
10132 this_single_command_key_start
= 0;
10135 #ifdef HAVE_WINDOW_SYSTEM
10136 if (display_hourglass_p
)
10137 cancel_hourglass ();
10140 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10141 prompt
, ! NILP (dont_downcase_last
),
10142 ! NILP (can_return_switch_frame
), 0);
10144 #ifdef HAVE_WINDOW_SYSTEM
10145 if (display_hourglass_p
)
10146 start_hourglass ();
10155 return unbind_to (count
, Fvector (i
, keybuf
));
10158 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10159 doc
: /* Execute CMD as an editor command.
10160 CMD must be a symbol that satisfies the `commandp' predicate.
10161 Optional second arg RECORD-FLAG non-nil
10162 means unconditionally put this command in `command-history'.
10163 Otherwise, that is done only if an arg is read using the minibuffer.
10164 The argument KEYS specifies the value to use instead of (this-command-keys)
10165 when reading the arguments; if it is nil, (this-command-keys) is used.
10166 The argument SPECIAL, if non-nil, means that this command is executing
10167 a special event, so ignore the prefix argument and don't clear it. */)
10168 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10170 register Lisp_Object final
;
10171 register Lisp_Object tem
;
10172 Lisp_Object prefixarg
;
10174 debug_on_next_call
= 0;
10176 if (NILP (special
))
10178 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10179 Vcurrent_prefix_arg
= prefixarg
;
10180 kset_prefix_arg (current_kboard
, Qnil
);
10187 tem
= Fget (cmd
, Qdisabled
);
10190 tem
= Fsymbol_value (Qdisabled_command_function
);
10192 return Frun_hooks (1, &Qdisabled_command_function
);
10198 final
= Findirect_function (cmd
, Qnil
);
10200 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10202 struct gcpro gcpro1
, gcpro2
;
10204 GCPRO2 (cmd
, prefixarg
);
10205 Fautoload_do_load (final
, cmd
, Qnil
);
10212 if (STRINGP (final
) || VECTORP (final
))
10214 /* If requested, place the macro in the command history. For
10215 other sorts of commands, call-interactively takes care of
10217 if (!NILP (record_flag
))
10220 = Fcons (Fcons (Qexecute_kbd_macro
,
10221 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10224 /* Don't keep command history around forever. */
10225 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10227 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10229 XSETCDR (tem
, Qnil
);
10233 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10236 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10237 /* Don't call Fcall_interactively directly because we want to make
10238 sure the backtrace has an entry for `call-interactively'.
10239 For the same reason, pass `cmd' rather than `final'. */
10240 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10247 /* Return true if input events are pending. */
10250 detect_input_pending (void)
10252 return input_pending
|| get_input_pending (0);
10255 /* Return true if input events other than mouse movements are
10259 detect_input_pending_ignore_squeezables (void)
10261 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10264 /* Return true if input events are pending, and run any pending timers. */
10267 detect_input_pending_run_timers (bool do_display
)
10269 unsigned old_timers_run
= timers_run
;
10271 if (!input_pending
)
10272 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10274 if (old_timers_run
!= timers_run
&& do_display
)
10276 redisplay_preserve_echo_area (8);
10277 /* The following fixes a bug when using lazy-lock with
10278 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10279 from an idle timer function. The symptom of the bug is that
10280 the cursor sometimes doesn't become visible until the next X
10281 event is processed. --gerd. */
10283 Lisp_Object tail
, frame
;
10284 FOR_EACH_FRAME (tail
, frame
)
10285 if (FRAME_RIF (XFRAME (frame
)))
10286 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10290 return input_pending
;
10293 /* This is called in some cases before a possible quit.
10294 It cases the next call to detect_input_pending to recompute input_pending.
10295 So calling this function unnecessarily can't do any harm. */
10298 clear_input_pending (void)
10303 /* Return true if there are pending requeued events.
10304 This isn't used yet. The hope is to make wait_reading_process_output
10305 call it, and return if it runs Lisp code that unreads something.
10306 The problem is, kbd_buffer_get_event needs to be fixed to know what
10307 to do in that case. It isn't trivial. */
10310 requeued_events_pending_p (void)
10312 return (!NILP (Vunread_command_events
));
10316 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10317 doc
: /* Return t if command input is currently available with no wait.
10318 Actually, the value is nil only if we can be sure that no input is available;
10319 if there is a doubt, the value is t. */)
10322 if (!NILP (Vunread_command_events
)
10323 || !NILP (Vunread_post_input_method_events
)
10324 || !NILP (Vunread_input_method_events
))
10327 /* Process non-user-visible events (Bug#10195). */
10328 process_special_events ();
10330 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10331 | READABLE_EVENTS_FILTER_EVENTS
)
10335 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10336 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10339 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10342 if (total_keys
< NUM_RECENT_KEYS
)
10343 return Fvector (total_keys
, keys
);
10346 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10347 vcopy (val
, 0, keys
+ recent_keys_index
,
10348 NUM_RECENT_KEYS
- recent_keys_index
);
10349 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10350 keys
, recent_keys_index
);
10355 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10356 doc
: /* Return the key sequence that invoked this command.
10357 However, if the command has called `read-key-sequence', it returns
10358 the last key sequence that has been read.
10359 The value is a string or a vector.
10361 See also `this-command-keys-vector'. */)
10364 return make_event_array (this_command_key_count
,
10365 XVECTOR (this_command_keys
)->contents
);
10368 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10369 doc
: /* Return the key sequence that invoked this command, as a vector.
10370 However, if the command has called `read-key-sequence', it returns
10371 the last key sequence that has been read.
10373 See also `this-command-keys'. */)
10376 return Fvector (this_command_key_count
,
10377 XVECTOR (this_command_keys
)->contents
);
10380 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10381 Sthis_single_command_keys
, 0, 0, 0,
10382 doc
: /* Return the key sequence that invoked this command.
10383 More generally, it returns the last key sequence read, either by
10384 the command loop or by `read-key-sequence'.
10385 Unlike `this-command-keys', this function's value
10386 does not include prefix arguments.
10387 The value is always a vector. */)
10390 return Fvector (this_command_key_count
10391 - this_single_command_key_start
,
10392 (XVECTOR (this_command_keys
)->contents
10393 + this_single_command_key_start
));
10396 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10397 Sthis_single_command_raw_keys
, 0, 0, 0,
10398 doc
: /* Return the raw events that were read for 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-single-command-keys', this function's value
10402 shows the events before all translations (except for input methods).
10403 The value is always a vector. */)
10406 return Fvector (raw_keybuf_count
,
10407 (XVECTOR (raw_keybuf
)->contents
));
10410 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10411 Sreset_this_command_lengths
, 0, 0, 0,
10412 doc
: /* Make the unread events replace the last command and echo.
10413 Used in `universal-argument-other-key'.
10415 `universal-argument-other-key' rereads the event just typed.
10416 It then gets translated through `function-key-map'.
10417 The translated event has to replace the real events,
10418 both in the value of (this-command-keys) and in echoing.
10419 To achieve this, `universal-argument-other-key' calls
10420 `reset-this-command-lengths', which discards the record of reading
10421 these events the first time. */)
10424 this_command_key_count
= before_command_key_count
;
10425 if (this_command_key_count
< this_single_command_key_start
)
10426 this_single_command_key_start
= this_command_key_count
;
10428 echo_truncate (before_command_echo_length
);
10430 /* Cause whatever we put into unread-command-events
10431 to echo as if it were being freshly read from the keyboard. */
10432 this_command_key_count_reset
= 1;
10437 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10438 Sclear_this_command_keys
, 0, 1, 0,
10439 doc
: /* Clear out the vector that `this-command-keys' returns.
10440 Also clear the record of the last 100 events, unless optional arg
10441 KEEP-RECORD is non-nil. */)
10442 (Lisp_Object keep_record
)
10446 this_command_key_count
= 0;
10447 this_command_key_count_reset
= 0;
10449 if (NILP (keep_record
))
10451 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10452 ASET (recent_keys
, i
, Qnil
);
10454 recent_keys_index
= 0;
10459 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10460 doc
: /* Return the current depth in recursive edits. */)
10464 /* Wrap around reliably on integer overflow. */
10465 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10466 XSETINT (temp
, sum
);
10470 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10471 "FOpen dribble file: ",
10472 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10473 If FILE is nil, close any open dribble file.
10474 The file will be closed when Emacs exits. */)
10486 file
= Fexpand_file_name (file
, Qnil
);
10487 dribble
= fopen (SSDATA (file
), "w");
10489 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10494 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10495 doc
: /* Discard the contents of the terminal input buffer.
10496 Also end any kbd macro being defined. */)
10499 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10501 /* Discard the last command from the macro. */
10502 Fcancel_kbd_macro_events ();
10506 update_mode_lines
++;
10508 Vunread_command_events
= Qnil
;
10510 discard_tty_input ();
10512 kbd_fetch_ptr
= kbd_store_ptr
;
10518 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10519 doc
: /* Stop Emacs and return to superior process. You can resume later.
10520 If `cannot-suspend' is non-nil, or if the system doesn't support job
10521 control, run a subshell instead.
10523 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10524 to be read as terminal input by Emacs's parent, after suspension.
10526 Before suspending, run the normal hook `suspend-hook'.
10527 After resumption run the normal hook `suspend-resume-hook'.
10529 Some operating systems cannot stop the Emacs process and resume it later.
10530 On such systems, Emacs starts a subshell instead of suspending. */)
10531 (Lisp_Object stuffstring
)
10533 ptrdiff_t count
= SPECPDL_INDEX ();
10534 int old_height
, old_width
;
10536 struct gcpro gcpro1
;
10539 if (tty_list
&& tty_list
->next
)
10540 error ("There are other tty frames open; close them before suspending Emacs");
10542 if (!NILP (stuffstring
))
10543 CHECK_STRING (stuffstring
);
10545 /* Run the functions in suspend-hook. */
10546 hook
= intern ("suspend-hook");
10547 Frun_hooks (1, &hook
);
10549 GCPRO1 (stuffstring
);
10550 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10551 reset_all_sys_modes ();
10552 /* sys_suspend can get an error if it tries to fork a subshell
10553 and the system resources aren't available for that. */
10554 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10556 stuff_buffered_input (stuffstring
);
10557 if (cannot_suspend
)
10561 unbind_to (count
, Qnil
);
10563 /* Check if terminal/window size has changed.
10564 Note that this is not useful when we are running directly
10565 with a window system; but suspend should be disabled in that case. */
10566 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10567 if (width
!= old_width
|| height
!= old_height
)
10568 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10570 /* Run suspend-resume-hook. */
10571 hook
= intern ("suspend-resume-hook");
10572 Frun_hooks (1, &hook
);
10578 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10579 Then in any case stuff anything Emacs has read ahead and not used. */
10582 stuff_buffered_input (Lisp_Object stuffstring
)
10584 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10585 register unsigned char *p
;
10587 if (STRINGP (stuffstring
))
10589 register ptrdiff_t count
;
10591 p
= SDATA (stuffstring
);
10592 count
= SBYTES (stuffstring
);
10593 while (count
-- > 0)
10598 /* Anything we have read ahead, put back for the shell to read. */
10599 /* ?? What should this do when we have multiple keyboards??
10600 Should we ignore anything that was typed in at the "wrong" kboard?
10602 rms: we should stuff everything back into the kboard
10604 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10607 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10608 kbd_fetch_ptr
= kbd_buffer
;
10609 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10610 stuff_char (kbd_fetch_ptr
->code
);
10612 clear_event (kbd_fetch_ptr
);
10616 #endif /* SIGTSTP */
10620 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10622 input_available_clear_time
= time_to_clear
;
10624 /* Tell handle_interrupt to throw back to read_char, */
10625 waiting_for_input
= 1;
10627 /* If handle_interrupt was called before and buffered a C-g,
10628 make it run again now, to avoid timing error. */
10629 if (!NILP (Vquit_flag
))
10630 quit_throw_to_read_char (0);
10634 clear_waiting_for_input (void)
10636 /* Tell handle_interrupt not to throw back to read_char, */
10637 waiting_for_input
= 0;
10638 input_available_clear_time
= 0;
10641 /* The SIGINT handler.
10643 If we have a frame on the controlling tty, we assume that the
10644 SIGINT was generated by C-g, so we call handle_interrupt.
10645 Otherwise, tell QUIT to kill Emacs. */
10648 handle_interrupt_signal (int sig
)
10650 /* See if we have an active terminal on our controlling tty. */
10651 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10654 /* If there are no frames there, let's pretend that we are a
10655 well-behaving UN*X program and quit. We must not call Lisp
10656 in a signal handler, so tell QUIT to exit when it is
10658 Vquit_flag
= Qkill_emacs
;
10662 /* Otherwise, the SIGINT was probably generated by C-g. */
10664 /* Set internal_last_event_frame to the top frame of the
10665 controlling tty, if we have a frame there. We disable the
10666 interrupt key on secondary ttys, so the SIGINT must have come
10667 from the controlling tty. */
10668 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10670 handle_interrupt (1);
10675 deliver_interrupt_signal (int sig
)
10677 deliver_process_signal (sig
, handle_interrupt_signal
);
10681 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10682 of the number of times C-g has been requested. If C-g is pressed
10683 enough times, then quit anyway. See bug#6585. */
10684 static int volatile force_quit_count
;
10686 /* This routine is called at interrupt level in response to C-g.
10688 It is called from the SIGINT handler or kbd_buffer_store_event.
10690 If `waiting_for_input' is non zero, then unless `echoing' is
10691 nonzero, immediately throw back to read_char.
10693 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10694 eval to throw, when it gets a chance. If quit-flag is already
10695 non-nil, it stops the job right away. */
10698 handle_interrupt (bool in_signal_handler
)
10704 /* XXX This code needs to be revised for multi-tty support. */
10705 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10707 if (! in_signal_handler
)
10709 /* If SIGINT isn't blocked, don't let us be interrupted by
10710 a SIGINT. It might be harmful due to non-reentrancy
10711 in I/O functions. */
10713 sigemptyset (&blocked
);
10714 sigaddset (&blocked
, SIGINT
);
10715 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10719 reset_all_sys_modes ();
10723 * On systems which can suspend the current process and return to the original
10724 * shell, this command causes the user to end up back at the shell.
10725 * The "Auto-save" and "Abort" questions are not asked until
10726 * the user elects to return to emacs, at which point he can save the current
10727 * job and either dump core or continue.
10731 /* Perhaps should really fork an inferior shell?
10732 But that would not provide any way to get back
10733 to the original shell, ever. */
10734 printf ("No support for stopping a process on this operating system;\n");
10735 printf ("you can continue or abort.\n");
10736 #endif /* not SIGTSTP */
10738 /* We must remain inside the screen area when the internal terminal
10739 is used. Note that [Enter] is not echoed by dos. */
10740 cursor_to (SELECTED_FRAME (), 0, 0);
10742 /* It doesn't work to autosave while GC is in progress;
10743 the code used for auto-saving doesn't cope with the mark bit. */
10744 if (!gc_in_progress
)
10746 printf ("Auto-save? (y or n) ");
10748 if (((c
= getchar ()) & ~040) == 'Y')
10750 Fdo_auto_save (Qt
, Qnil
);
10752 printf ("\r\nAuto-save done");
10753 #else /* not MSDOS */
10754 printf ("Auto-save done\n");
10755 #endif /* not MSDOS */
10757 while (c
!= '\n') c
= getchar ();
10761 /* During GC, it must be safe to reenable quitting again. */
10762 Vinhibit_quit
= Qnil
;
10765 #endif /* not MSDOS */
10766 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10767 printf ("but will instead do a real quit after garbage collection ends\r\n");
10772 printf ("\r\nAbort? (y or n) ");
10773 #else /* not MSDOS */
10774 printf ("Abort (and dump core)? (y or n) ");
10775 #endif /* not MSDOS */
10777 if (((c
= getchar ()) & ~040) == 'Y')
10779 while (c
!= '\n') c
= getchar ();
10781 printf ("\r\nContinuing...\r\n");
10782 #else /* not MSDOS */
10783 printf ("Continuing...\n");
10784 #endif /* not MSDOS */
10786 init_all_sys_modes ();
10790 /* If executing a function that wants to be interrupted out of
10791 and the user has not deferred quitting by binding `inhibit-quit'
10792 then quit right away. */
10793 if (immediate_quit
&& NILP (Vinhibit_quit
))
10795 struct gl_state_s saved
;
10796 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10798 immediate_quit
= 0;
10799 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10801 GCPRO4 (saved
.object
, saved
.global_code
,
10802 saved
.current_syntax_table
, saved
.old_prop
);
10803 Fsignal (Qquit
, Qnil
);
10808 { /* Else request quit when it's safe. */
10809 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10810 force_quit_count
= count
;
10813 immediate_quit
= 1;
10814 Vinhibit_quit
= Qnil
;
10820 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10822 /* TODO: The longjmp in this call throws the NS event loop integration off,
10823 and it seems to do fine without this. Probably some attention
10824 needs to be paid to the setting of waiting_for_input in
10825 wait_reading_process_output() under HAVE_NS because of the call
10826 to ns_select there (needed because otherwise events aren't picked up
10827 outside of polling since we don't get SIGIO like X and we don't have a
10828 separate event loop thread like W32. */
10830 if (waiting_for_input
&& !echoing
)
10831 quit_throw_to_read_char (in_signal_handler
);
10835 /* Handle a C-g by making read_char return C-g. */
10838 quit_throw_to_read_char (bool from_signal
)
10840 /* When not called from a signal handler it is safe to call
10842 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10843 Fkill_emacs (Qnil
);
10845 /* Prevent another signal from doing this before we finish. */
10846 clear_waiting_for_input ();
10849 Vunread_command_events
= Qnil
;
10851 if (FRAMEP (internal_last_event_frame
)
10852 && !EQ (internal_last_event_frame
, selected_frame
))
10853 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10856 sys_longjmp (getcjmp
, 1);
10859 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10860 Sset_input_interrupt_mode
, 1, 1, 0,
10861 doc
: /* Set interrupt mode of reading keyboard input.
10862 If INTERRUPT is non-nil, Emacs will use input interrupts;
10863 otherwise Emacs uses CBREAK mode.
10865 See also `current-input-mode'. */)
10866 (Lisp_Object interrupt
)
10868 bool new_interrupt_input
;
10869 #ifdef USABLE_SIGIO
10870 #ifdef HAVE_X_WINDOWS
10871 if (x_display_list
!= NULL
)
10873 /* When using X, don't give the user a real choice,
10874 because we haven't implemented the mechanisms to support it. */
10875 new_interrupt_input
= 1;
10878 #endif /* HAVE_X_WINDOWS */
10879 new_interrupt_input
= !NILP (interrupt
);
10880 #else /* not USABLE_SIGIO */
10881 new_interrupt_input
= 0;
10882 #endif /* not USABLE_SIGIO */
10884 if (new_interrupt_input
!= interrupt_input
)
10886 #ifdef POLL_FOR_INPUT
10890 /* this causes startup screen to be restored and messes with the mouse */
10891 reset_all_sys_modes ();
10892 interrupt_input
= new_interrupt_input
;
10893 init_all_sys_modes ();
10895 interrupt_input
= new_interrupt_input
;
10898 #ifdef POLL_FOR_INPUT
10899 poll_suppress_count
= 1;
10906 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10907 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10908 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10909 C-q in key sequences.
10911 This setting only has an effect on tty terminals and only when
10912 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10914 See also `current-input-mode'. */)
10915 (Lisp_Object flow
, Lisp_Object terminal
)
10917 struct terminal
*t
= get_terminal (terminal
, 1);
10918 struct tty_display_info
*tty
;
10919 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10921 tty
= t
->display_info
.tty
;
10923 if (tty
->flow_control
!= !NILP (flow
))
10926 /* this causes startup screen to be restored and messes with the mouse */
10927 reset_sys_modes (tty
);
10930 tty
->flow_control
= !NILP (flow
);
10933 init_sys_modes (tty
);
10939 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10940 doc
: /* Enable or disable 8-bit input on TERMINAL.
10941 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10942 bit as the Meta modifier.
10944 If META is nil, Emacs will ignore the top bit, on the assumption it is
10947 Otherwise, Emacs will accept and pass through 8-bit input without
10948 specially interpreting the top bit.
10950 This setting only has an effect on tty terminal devices.
10952 Optional parameter TERMINAL specifies the tty terminal device to use.
10953 It may be a terminal object, a frame, or nil for the terminal used by
10954 the currently selected frame.
10956 See also `current-input-mode'. */)
10957 (Lisp_Object meta
, Lisp_Object terminal
)
10959 struct terminal
*t
= get_terminal (terminal
, 1);
10960 struct tty_display_info
*tty
;
10963 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10965 tty
= t
->display_info
.tty
;
10969 else if (EQ (meta
, Qt
))
10974 if (tty
->meta_key
!= new_meta
)
10977 /* this causes startup screen to be restored and messes with the mouse */
10978 reset_sys_modes (tty
);
10981 tty
->meta_key
= new_meta
;
10984 init_sys_modes (tty
);
10990 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10991 doc
: /* Specify character used for quitting.
10992 QUIT must be an ASCII character.
10994 This function only has an effect on the controlling tty of the Emacs
10997 See also `current-input-mode'. */)
11000 struct terminal
*t
= get_named_tty ("/dev/tty");
11001 struct tty_display_info
*tty
;
11002 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11004 tty
= t
->display_info
.tty
;
11006 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11007 error ("QUIT must be an ASCII character");
11010 /* this causes startup screen to be restored and messes with the mouse */
11011 reset_sys_modes (tty
);
11014 /* Don't let this value be out of range. */
11015 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11018 init_sys_modes (tty
);
11024 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11025 doc
: /* Set mode of reading keyboard input.
11026 First arg INTERRUPT non-nil means use input interrupts;
11027 nil means use CBREAK mode.
11028 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11029 (no effect except in CBREAK mode).
11030 Third arg META t means accept 8-bit input (for a Meta key).
11031 META nil means ignore the top bit, on the assumption it is parity.
11032 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11033 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11034 See also `current-input-mode'. */)
11035 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11037 Fset_input_interrupt_mode (interrupt
);
11038 Fset_output_flow_control (flow
, Qnil
);
11039 Fset_input_meta_mode (meta
, Qnil
);
11041 Fset_quit_char (quit
);
11045 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11046 doc
: /* Return information about the way Emacs currently reads keyboard input.
11047 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11048 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11049 nil, Emacs is using CBREAK mode.
11050 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11051 terminal; this does not apply if Emacs uses interrupt-driven input.
11052 META is t if accepting 8-bit input with 8th bit as Meta flag.
11053 META nil means ignoring the top bit, on the assumption it is parity.
11054 META is neither t nor nil if accepting 8-bit input and using
11055 all 8 bits as the character code.
11056 QUIT is the character Emacs currently uses to quit.
11057 The elements of this list correspond to the arguments of
11058 `set-input-mode'. */)
11061 Lisp_Object val
[4];
11062 struct frame
*sf
= XFRAME (selected_frame
);
11064 val
[0] = interrupt_input
? Qt
: Qnil
;
11065 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11067 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11068 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11070 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11077 XSETFASTINT (val
[3], quit_char
);
11079 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11082 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11083 doc
: /* Return position information for pixel coordinates X and Y.
11084 By default, X and Y are relative to text area of the selected window.
11085 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11086 If optional fourth arg WHOLE is non-nil, X is relative to the left
11087 edge of the window.
11089 The return value is similar to a mouse click position:
11090 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11091 IMAGE (DX . DY) (WIDTH . HEIGHT))
11092 The `posn-' functions access elements of such lists. */)
11093 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11098 if (NILP (frame_or_window
))
11099 frame_or_window
= selected_window
;
11101 if (WINDOWP (frame_or_window
))
11103 struct window
*w
= decode_live_window (frame_or_window
);
11105 XSETINT (x
, (XINT (x
)
11106 + WINDOW_LEFT_EDGE_X (w
)
11108 ? window_box_left_offset (w
, TEXT_AREA
)
11110 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11111 frame_or_window
= w
->frame
;
11114 CHECK_LIVE_FRAME (frame_or_window
);
11116 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11119 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11120 doc
: /* Return position information for buffer POS in WINDOW.
11121 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11123 Return nil if position is not visible in window. Otherwise,
11124 the return value is similar to that returned by `event-start' for
11125 a mouse click at the upper left corner of the glyph corresponding
11126 to the given buffer position:
11127 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11128 IMAGE (DX . DY) (WIDTH . HEIGHT))
11129 The `posn-' functions access elements of such lists. */)
11130 (Lisp_Object pos
, Lisp_Object window
)
11135 window
= selected_window
;
11137 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11140 Lisp_Object x
= XCAR (tem
);
11141 Lisp_Object y
= XCAR (XCDR (tem
));
11143 /* Point invisible due to hscrolling? */
11146 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11154 * Set up a new kboard object with reasonable initial values.
11157 init_kboard (KBOARD
*kb
)
11159 kset_overriding_terminal_local_map (kb
, Qnil
);
11160 kset_last_command (kb
, Qnil
);
11161 kset_real_last_command (kb
, Qnil
);
11162 kset_keyboard_translate_table (kb
, Qnil
);
11163 kset_last_repeatable_command (kb
, Qnil
);
11164 kset_prefix_arg (kb
, Qnil
);
11165 kset_last_prefix_arg (kb
, Qnil
);
11166 kset_kbd_queue (kb
, Qnil
);
11167 kb
->kbd_queue_has_data
= 0;
11168 kb
->immediate_echo
= 0;
11169 kset_echo_string (kb
, Qnil
);
11170 kb
->echo_after_prompt
= -1;
11171 kb
->kbd_macro_buffer
= 0;
11172 kb
->kbd_macro_bufsize
= 0;
11173 kset_defining_kbd_macro (kb
, Qnil
);
11174 kset_last_kbd_macro (kb
, Qnil
);
11175 kb
->reference_count
= 0;
11176 kset_system_key_alist (kb
, Qnil
);
11177 kset_system_key_syms (kb
, Qnil
);
11178 kset_window_system (kb
, Qt
); /* Unset. */
11179 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11180 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11181 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11182 kset_default_minibuffer_frame (kb
, Qnil
);
11186 * Destroy the contents of a kboard object, but not the object itself.
11187 * We use this just before deleting it, or if we're going to initialize
11188 * it a second time.
11191 wipe_kboard (KBOARD
*kb
)
11193 xfree (kb
->kbd_macro_buffer
);
11196 /* Free KB and memory referenced from it. */
11199 delete_kboard (KBOARD
*kb
)
11203 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11206 *kbp
= kb
->next_kboard
;
11208 /* Prevent a dangling reference to KB. */
11209 if (kb
== current_kboard
11210 && FRAMEP (selected_frame
)
11211 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11213 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11215 if (current_kboard
== kb
)
11224 init_keyboard (void)
11226 /* This is correct before outermost invocation of the editor loop. */
11227 command_loop_level
= -1;
11228 immediate_quit
= 0;
11229 quit_char
= Ctl ('g');
11230 Vunread_command_events
= Qnil
;
11231 timer_idleness_start_time
= invalid_emacs_time ();
11233 recent_keys_index
= 0;
11234 kbd_fetch_ptr
= kbd_buffer
;
11235 kbd_store_ptr
= kbd_buffer
;
11236 do_mouse_tracking
= Qnil
;
11238 interrupt_input_blocked
= 0;
11239 pending_signals
= 0;
11241 /* This means that command_loop_1 won't try to select anything the first
11243 internal_last_event_frame
= Qnil
;
11244 Vlast_event_frame
= internal_last_event_frame
;
11246 current_kboard
= initial_kboard
;
11247 /* Re-initialize the keyboard again. */
11248 wipe_kboard (current_kboard
);
11249 init_kboard (current_kboard
);
11250 /* A value of nil for Vwindow_system normally means a tty, but we also use
11251 it for the initial terminal since there is no window system there. */
11252 kset_window_system (current_kboard
, Qnil
);
11254 if (!noninteractive
)
11256 /* Before multi-tty support, these handlers used to be installed
11257 only if the current session was a tty session. Now an Emacs
11258 session may have multiple display types, so we always handle
11259 SIGINT. There is special code in handle_interrupt_signal to exit
11260 Emacs on SIGINT when there are no termcap frames on the
11261 controlling terminal. */
11262 struct sigaction action
;
11263 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11264 sigaction (SIGINT
, &action
, 0);
11266 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11267 SIGQUIT and we can't tell which one it will give us. */
11268 sigaction (SIGQUIT
, &action
, 0);
11269 #endif /* not DOS_NT */
11271 #ifdef USABLE_SIGIO
11272 if (!noninteractive
)
11274 struct sigaction action
;
11275 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11276 sigaction (SIGIO
, &action
, 0);
11280 /* Use interrupt input by default, if it works and noninterrupt input
11281 has deficiencies. */
11283 #ifdef INTERRUPT_INPUT
11284 interrupt_input
= 1;
11286 interrupt_input
= 0;
11289 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11292 if (keyboard_init_hook
)
11293 (*keyboard_init_hook
) ();
11295 #ifdef POLL_FOR_INPUT
11297 poll_suppress_count
= 1;
11302 /* This type's only use is in syms_of_keyboard, to initialize the
11303 event header symbols and put properties on them. */
11304 struct event_head
{
11310 static const struct event_head head_table
[] = {
11311 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11312 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11313 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11314 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11315 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11316 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11317 /* `select-window' should be handled just like `switch-frame'
11318 in read_key_sequence. */
11319 {&Qselect_window
, "select-window", &Qswitch_frame
}
11323 syms_of_keyboard (void)
11325 pending_funcalls
= Qnil
;
11326 staticpro (&pending_funcalls
);
11328 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11329 staticpro (&Vlispy_mouse_stem
);
11332 DEFSYM (QCimage
, ":image");
11333 DEFSYM (Qhelp_echo
, "help-echo");
11334 DEFSYM (QCrtl
, ":rtl");
11336 staticpro (&item_properties
);
11337 item_properties
= Qnil
;
11339 staticpro (&tool_bar_item_properties
);
11340 tool_bar_item_properties
= Qnil
;
11341 staticpro (&tool_bar_items_vector
);
11342 tool_bar_items_vector
= Qnil
;
11344 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11345 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11346 DEFSYM (Qself_insert_command
, "self-insert-command");
11347 DEFSYM (Qforward_char
, "forward-char");
11348 DEFSYM (Qbackward_char
, "backward-char");
11349 DEFSYM (Qdisabled
, "disabled");
11350 DEFSYM (Qundefined
, "undefined");
11351 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11352 DEFSYM (Qpost_command_hook
, "post-command-hook");
11353 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11354 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11355 DEFSYM (Qfunction_key
, "function-key");
11356 DEFSYM (Qmouse_click
, "mouse-click");
11357 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11358 DEFSYM (Qsave_session
, "save-session");
11359 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11360 DEFSYM (Qmenu_enable
, "menu-enable");
11363 DEFSYM (Qlanguage_change
, "language-change");
11364 DEFSYM (Qfile_w32notify
, "file-w32notify");
11368 DEFSYM (Qdbus_event
, "dbus-event");
11371 #ifdef HAVE_INOTIFY
11372 DEFSYM (Qfile_inotify
, "file-inotify");
11373 #endif /* HAVE_INOTIFY */
11375 DEFSYM (QCenable
, ":enable");
11376 DEFSYM (QCvisible
, ":visible");
11377 DEFSYM (QChelp
, ":help");
11378 DEFSYM (QCfilter
, ":filter");
11379 DEFSYM (QCbutton
, ":button");
11380 DEFSYM (QCkeys
, ":keys");
11381 DEFSYM (QCkey_sequence
, ":key-sequence");
11382 DEFSYM (QCtoggle
, ":toggle");
11383 DEFSYM (QCradio
, ":radio");
11384 DEFSYM (QClabel
, ":label");
11385 DEFSYM (QCvert_only
, ":vert-only");
11387 DEFSYM (Qmode_line
, "mode-line");
11388 DEFSYM (Qvertical_line
, "vertical-line");
11389 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11390 DEFSYM (Qmenu_bar
, "menu-bar");
11392 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11394 DEFSYM (Qabove_handle
, "above-handle");
11395 DEFSYM (Qhandle
, "handle");
11396 DEFSYM (Qbelow_handle
, "below-handle");
11397 DEFSYM (Qup
, "up");
11398 DEFSYM (Qdown
, "down");
11399 DEFSYM (Qtop
, "top");
11400 DEFSYM (Qbottom
, "bottom");
11401 DEFSYM (Qend_scroll
, "end-scroll");
11402 DEFSYM (Qratio
, "ratio");
11404 DEFSYM (Qevent_kind
, "event-kind");
11405 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11406 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11407 DEFSYM (Qmodifier_cache
, "modifier-cache");
11409 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11410 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11412 DEFSYM (Qpolling_period
, "polling-period");
11414 DEFSYM (Qx_set_selection
, "x-set-selection");
11415 DEFSYM (QPRIMARY
, "PRIMARY");
11416 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11417 DEFSYM (Qhandle_select_window
, "handle-select-window");
11419 DEFSYM (Qinput_method_function
, "input-method-function");
11420 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11421 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11423 DEFSYM (Qhelp_form_show
, "help-form-show");
11425 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11426 Fset (Qinput_method_use_echo_area
, Qnil
);
11428 last_point_position_buffer
= Qnil
;
11429 last_point_position_window
= Qnil
;
11433 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11435 for (i
= 0; i
< len
; i
++)
11437 const struct event_head
*p
= &head_table
[i
];
11438 *p
->var
= intern_c_string (p
->name
);
11439 staticpro (p
->var
);
11440 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11441 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11445 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11446 staticpro (&button_down_location
);
11447 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11448 staticpro (&mouse_syms
);
11449 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11450 / sizeof (lispy_wheel_names
[0])),
11452 staticpro (&wheel_syms
);
11456 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11458 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11459 for (i
= 0; i
< len
; i
++)
11460 if (modifier_names
[i
])
11461 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11462 staticpro (&modifier_symbols
);
11465 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11466 staticpro (&recent_keys
);
11468 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11469 staticpro (&this_command_keys
);
11471 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11472 staticpro (&raw_keybuf
);
11474 DEFSYM (Qextended_command_history
, "extended-command-history");
11475 Fset (Qextended_command_history
, Qnil
);
11477 accent_key_syms
= Qnil
;
11478 staticpro (&accent_key_syms
);
11480 func_key_syms
= Qnil
;
11481 staticpro (&func_key_syms
);
11483 drag_n_drop_syms
= Qnil
;
11484 staticpro (&drag_n_drop_syms
);
11486 unread_switch_frame
= Qnil
;
11487 staticpro (&unread_switch_frame
);
11489 internal_last_event_frame
= Qnil
;
11490 staticpro (&internal_last_event_frame
);
11492 read_key_sequence_cmd
= Qnil
;
11493 staticpro (&read_key_sequence_cmd
);
11494 read_key_sequence_remapped
= Qnil
;
11495 staticpro (&read_key_sequence_remapped
);
11497 menu_bar_one_keymap_changed_items
= Qnil
;
11498 staticpro (&menu_bar_one_keymap_changed_items
);
11500 menu_bar_items_vector
= Qnil
;
11501 staticpro (&menu_bar_items_vector
);
11503 help_form_saved_window_configs
= Qnil
;
11504 staticpro (&help_form_saved_window_configs
);
11506 defsubr (&Scurrent_idle_time
);
11507 defsubr (&Sevent_symbol_parse_modifiers
);
11508 defsubr (&Sevent_convert_list
);
11509 defsubr (&Sread_key_sequence
);
11510 defsubr (&Sread_key_sequence_vector
);
11511 defsubr (&Srecursive_edit
);
11512 defsubr (&Strack_mouse
);
11513 defsubr (&Sinput_pending_p
);
11514 defsubr (&Scommand_execute
);
11515 defsubr (&Srecent_keys
);
11516 defsubr (&Sthis_command_keys
);
11517 defsubr (&Sthis_command_keys_vector
);
11518 defsubr (&Sthis_single_command_keys
);
11519 defsubr (&Sthis_single_command_raw_keys
);
11520 defsubr (&Sreset_this_command_lengths
);
11521 defsubr (&Sclear_this_command_keys
);
11522 defsubr (&Ssuspend_emacs
);
11523 defsubr (&Sabort_recursive_edit
);
11524 defsubr (&Sexit_recursive_edit
);
11525 defsubr (&Srecursion_depth
);
11526 defsubr (&Stop_level
);
11527 defsubr (&Sdiscard_input
);
11528 defsubr (&Sopen_dribble_file
);
11529 defsubr (&Sset_input_interrupt_mode
);
11530 defsubr (&Sset_output_flow_control
);
11531 defsubr (&Sset_input_meta_mode
);
11532 defsubr (&Sset_quit_char
);
11533 defsubr (&Sset_input_mode
);
11534 defsubr (&Scurrent_input_mode
);
11535 defsubr (&Sposn_at_point
);
11536 defsubr (&Sposn_at_x_y
);
11538 DEFVAR_LISP ("last-command-event", last_command_event
,
11539 doc
: /* Last input event that was part of a command. */);
11541 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11542 doc
: /* Last input event in a command, except for mouse menu events.
11543 Mouse menus give back keys that don't look like mouse events;
11544 this variable holds the actual mouse event that led to the menu,
11545 so that you can determine whether the command was run by mouse or not. */);
11547 DEFVAR_LISP ("last-input-event", last_input_event
,
11548 doc
: /* Last input event. */);
11550 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11551 doc
: /* List of events to be read as the command input.
11552 These events are processed first, before actual keyboard input.
11553 Events read from this list are not normally added to `this-command-keys',
11554 as they will already have been added once as they were read for the first time.
11555 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11556 Vunread_command_events
= Qnil
;
11558 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11559 doc
: /* List of events to be processed as input by input methods.
11560 These events are processed before `unread-command-events'
11561 and actual keyboard input, but are not given to `input-method-function'. */);
11562 Vunread_post_input_method_events
= Qnil
;
11564 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11565 doc
: /* List of events to be processed as input by input methods.
11566 These events are processed after `unread-command-events', but
11567 before actual keyboard input.
11568 If there's an active input method, the events are given to
11569 `input-method-function'. */);
11570 Vunread_input_method_events
= Qnil
;
11572 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11573 doc
: /* Meta-prefix character code.
11574 Meta-foo as command input turns into this character followed by foo. */);
11575 XSETINT (meta_prefix_char
, 033);
11577 DEFVAR_KBOARD ("last-command", Vlast_command
,
11578 doc
: /* The last command executed.
11579 Normally a symbol with a function definition, but can be whatever was found
11580 in the keymap, or whatever the variable `this-command' was set to by that
11583 The value `mode-exit' is special; it means that the previous command
11584 read an event that told it to exit, and it did so and unread that event.
11585 In other words, the present command is the event that made the previous
11588 The value `kill-region' is special; it means that the previous command
11589 was a kill command.
11591 `last-command' has a separate binding for each terminal device.
11592 See Info node `(elisp)Multiple Terminals'. */);
11594 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11595 doc
: /* Same as `last-command', but never altered by Lisp code.
11596 Taken from the previous value of `real-this-command'. */);
11598 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11599 doc
: /* Last command that may be repeated.
11600 The last command executed that was not bound to an input event.
11601 This is the command `repeat' will try to repeat.
11602 Taken from a previous value of `real-this-command'. */);
11604 DEFVAR_LISP ("this-command", Vthis_command
,
11605 doc
: /* The command now being executed.
11606 The command can set this variable; whatever is put here
11607 will be in `last-command' during the following command. */);
11608 Vthis_command
= Qnil
;
11610 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11611 doc
: /* This is like `this-command', except that commands should never modify it. */);
11612 Vreal_this_command
= Qnil
;
11614 DEFVAR_LISP ("this-command-keys-shift-translated",
11615 Vthis_command_keys_shift_translated
,
11616 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11617 Shift-translation occurs when there is no binding for the key sequence
11618 as entered, but a binding was found by changing an upper-case letter
11619 to lower-case, or a shifted function key to an unshifted one. */);
11620 Vthis_command_keys_shift_translated
= Qnil
;
11622 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11623 doc
: /* The command bound to the current key sequence before remapping.
11624 It equals `this-command' if the original command was not remapped through
11625 any of the active keymaps. Otherwise, the value of `this-command' is the
11626 result of looking up the original command in the active keymaps. */);
11627 Vthis_original_command
= Qnil
;
11629 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11630 doc
: /* Number of input events between auto-saves.
11631 Zero means disable autosaving due to number of characters typed. */);
11632 auto_save_interval
= 300;
11634 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11635 doc
: /* Number of seconds idle time before auto-save.
11636 Zero or nil means disable auto-saving due to idleness.
11637 After auto-saving due to this many seconds of idle time,
11638 Emacs also does a garbage collection if that seems to be warranted. */);
11639 XSETFASTINT (Vauto_save_timeout
, 30);
11641 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11642 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11643 The value may be integer or floating point.
11644 If the value is zero, don't echo at all. */);
11645 Vecho_keystrokes
= make_number (1);
11647 DEFVAR_INT ("polling-period", polling_period
,
11648 doc
: /* Interval between polling for input during Lisp execution.
11649 The reason for polling is to make C-g work to stop a running program.
11650 Polling is needed only when using X windows and SIGIO does not work.
11651 Polling is automatically disabled in all other cases. */);
11652 polling_period
= 2;
11654 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11655 doc
: /* Maximum time between mouse clicks to make a double-click.
11656 Measured in milliseconds. The value nil means disable double-click
11657 recognition; t means double-clicks have no time limit and are detected
11658 by position only. */);
11659 Vdouble_click_time
= make_number (500);
11661 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11662 doc
: /* Maximum mouse movement between clicks to make a double-click.
11663 On window-system frames, value is the number of pixels the mouse may have
11664 moved horizontally or vertically between two clicks to make a double-click.
11665 On non window-system frames, value is interpreted in units of 1/8 characters
11668 This variable is also the threshold for motion of the mouse
11669 to count as a drag. */);
11670 double_click_fuzz
= 3;
11672 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11673 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11674 inhibit_local_menu_bar_menus
= 0;
11676 DEFVAR_INT ("num-input-keys", num_input_keys
,
11677 doc
: /* Number of complete key sequences read as input so far.
11678 This includes key sequences read from keyboard macros.
11679 The number is effectively the number of interactive command invocations. */);
11680 num_input_keys
= 0;
11682 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11683 doc
: /* Number of input events read from the keyboard so far.
11684 This does not include events generated by keyboard macros. */);
11685 num_nonmacro_input_events
= 0;
11687 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11688 doc
: /* The frame in which the most recently read event occurred.
11689 If the last event came from a keyboard macro, this is set to `macro'. */);
11690 Vlast_event_frame
= Qnil
;
11692 /* This variable is set up in sysdep.c. */
11693 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11694 doc
: /* The ERASE character as set by the user with stty. */);
11696 DEFVAR_LISP ("help-char", Vhelp_char
,
11697 doc
: /* Character to recognize as meaning Help.
11698 When it is read, do `(eval help-form)', and display result if it's a string.
11699 If the value of `help-form' is nil, this char can be read normally. */);
11700 XSETINT (Vhelp_char
, Ctl ('H'));
11702 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11703 doc
: /* List of input events to recognize as meaning Help.
11704 These work just like the value of `help-char' (see that). */);
11705 Vhelp_event_list
= Qnil
;
11707 DEFVAR_LISP ("help-form", Vhelp_form
,
11708 doc
: /* Form to execute when character `help-char' is read.
11709 If the form returns a string, that string is displayed.
11710 If `help-form' is nil, the help char is not recognized. */);
11713 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11714 doc
: /* Command to run when `help-char' character follows a prefix key.
11715 This command is used only when there is no actual binding
11716 for that character after that prefix key. */);
11717 Vprefix_help_command
= Qnil
;
11719 DEFVAR_LISP ("top-level", Vtop_level
,
11720 doc
: /* Form to evaluate when Emacs starts up.
11721 Useful to set before you dump a modified Emacs. */);
11724 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11725 doc
: /* Translate table for local keyboard input, or nil.
11726 If non-nil, the value should be a char-table. Each character read
11727 from the keyboard is looked up in this char-table. If the value found
11728 there is non-nil, then it is used instead of the actual input character.
11730 The value can also be a string or vector, but this is considered obsolete.
11731 If it is a string or vector of length N, character codes N and up are left
11732 untranslated. In a vector, an element which is nil means "no translation".
11734 This is applied to the characters supplied to input methods, not their
11735 output. See also `translation-table-for-input'.
11737 This variable has a separate binding for each terminal.
11738 See Info node `(elisp)Multiple Terminals'. */);
11740 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11741 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11742 \(Even if the operating system has support for stopping a process.\) */);
11743 cannot_suspend
= 0;
11745 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11746 doc
: /* Non-nil means prompt with menus when appropriate.
11747 This is done when reading from a keymap that has a prompt string,
11748 for elements that have prompt strings.
11749 The menu is displayed on the screen
11750 if X menus were enabled at configuration
11751 time and the previous event was a mouse click prefix key.
11752 Otherwise, menu prompting uses the echo area. */);
11753 menu_prompting
= 1;
11755 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11756 doc
: /* Character to see next line of menu prompt.
11757 Type this character while in a menu prompt to rotate around the lines of it. */);
11758 XSETINT (menu_prompt_more_char
, ' ');
11760 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11761 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11762 Emacs applies the modifiers of the character stored here to each keyboard
11763 character it reads. For example, after evaluating the expression
11764 (setq extra-keyboard-modifiers ?\\C-x)
11765 all input characters will have the control modifier applied to them.
11767 Note that the character ?\\C-@, equivalent to the integer zero, does
11768 not count as a control character; rather, it counts as a character
11769 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11770 cancels any modification. */);
11771 extra_keyboard_modifiers
= 0;
11773 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11774 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11775 The command loop sets this to nil before each command,
11776 and tests the value when the command returns.
11777 Buffer modification stores t in this variable. */);
11778 Vdeactivate_mark
= Qnil
;
11779 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11781 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11782 doc
: /* Normal hook run before each command is executed.
11783 If an unhandled error happens in running this hook,
11784 the function in which the error occurred is unconditionally removed, since
11785 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11786 Vpre_command_hook
= Qnil
;
11788 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11789 doc
: /* Normal hook run after each command is executed.
11790 If an unhandled error happens in running this hook,
11791 the function in which the error occurred is unconditionally removed, since
11792 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11793 Vpost_command_hook
= Qnil
;
11796 DEFVAR_LISP ("echo-area-clear-hook", ...,
11797 doc
: /* Normal hook run when clearing the echo area. */);
11799 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11800 Fset (Qecho_area_clear_hook
, Qnil
);
11802 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11803 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11804 Vlucid_menu_bar_dirty_flag
= Qnil
;
11806 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11807 doc
: /* List of menu bar items to move to the end of the menu bar.
11808 The elements of the list are event types that may have menu bar bindings. */);
11809 Vmenu_bar_final_items
= Qnil
;
11811 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11812 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11813 This is used internally by graphical displays that do not render
11814 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11815 Vtool_bar_separator_image_expression
= Qnil
;
11817 DEFVAR_KBOARD ("overriding-terminal-local-map",
11818 Voverriding_terminal_local_map
,
11819 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11820 If this variable is non-nil, it is used as a keymap instead of the
11821 buffer's local map, and the minor mode keymaps and text property keymaps.
11822 It also replaces `overriding-local-map'.
11824 This variable is intended to let commands such as `universal-argument'
11825 set up a different keymap for reading the next command.
11827 `overriding-terminal-local-map' has a separate binding for each
11829 See Info node `(elisp)Multiple Terminals'. */);
11831 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11832 doc
: /* Keymap that overrides all other local keymaps.
11833 If this variable is non-nil, it is used as a keymap--replacing the
11834 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11835 Voverriding_local_map
= Qnil
;
11837 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11838 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11839 Otherwise, the menu bar continues to reflect the buffer's local map
11840 and the minor mode maps regardless of `overriding-local-map'. */);
11841 Voverriding_local_map_menu_flag
= Qnil
;
11843 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11844 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11845 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11847 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11848 doc
: /* Non-nil means generate motion events for mouse motion. */);
11850 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11851 doc
: /* Alist of system-specific X windows key symbols.
11852 Each element should have the form (N . SYMBOL) where N is the
11853 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11854 and SYMBOL is its name.
11856 `system-key-alist' has a separate binding for each terminal device.
11857 See Info node `(elisp)Multiple Terminals'. */);
11859 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11860 doc
: /* Keymap that translates key sequences to key sequences during input.
11861 This is used mainly for mapping key sequences into some preferred
11862 key events (symbols).
11864 The `read-key-sequence' function replaces any subsequence bound by
11865 `local-function-key-map' with its binding. More precisely, when the
11866 active keymaps have no binding for the current key sequence but
11867 `local-function-key-map' binds a suffix of the sequence to a vector or
11868 string, `read-key-sequence' replaces the matching suffix with its
11869 binding, and continues with the new sequence.
11871 If the binding is a function, it is called with one argument (the prompt)
11872 and its return value (a key sequence) is used.
11874 The events that come from bindings in `local-function-key-map' are not
11875 themselves looked up in `local-function-key-map'.
11877 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11878 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11879 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11880 typing `ESC O P x' would return [f1 x].
11882 `local-function-key-map' has a separate binding for each terminal
11883 device. See Info node `(elisp)Multiple Terminals'. If you need to
11884 define a binding on all terminals, change `function-key-map'
11885 instead. Initially, `local-function-key-map' is an empty keymap that
11886 has `function-key-map' as its parent on all terminal devices. */);
11888 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11889 doc
: /* Keymap that decodes input escape sequences.
11890 This is used mainly for mapping ASCII function key sequences into
11891 real Emacs function key events (symbols).
11893 The `read-key-sequence' function replaces any subsequence bound by
11894 `input-decode-map' with its binding. Contrary to `function-key-map',
11895 this map applies its rebinding regardless of the presence of an ordinary
11896 binding. So it is more like `key-translation-map' except that it applies
11897 before `function-key-map' rather than after.
11899 If the binding is a function, it is called with one argument (the prompt)
11900 and its return value (a key sequence) is used.
11902 The events that come from bindings in `input-decode-map' are not
11903 themselves looked up in `input-decode-map'.
11905 This variable is keyboard-local. */);
11907 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11908 doc
: /* The parent keymap of all `local-function-key-map' instances.
11909 Function key definitions that apply to all terminal devices should go
11910 here. If a mapping is defined in both the current
11911 `local-function-key-map' binding and this variable, then the local
11912 definition will take precedence. */);
11913 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11915 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11916 doc
: /* Keymap of key translations that can override keymaps.
11917 This keymap works like `function-key-map', but comes after that,
11918 and its non-prefix bindings override ordinary bindings.
11919 Another difference is that it is global rather than keyboard-local. */);
11920 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11922 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11923 doc
: /* List of deferred actions to be performed at a later time.
11924 The precise format isn't relevant here; we just check whether it is nil. */);
11925 Vdeferred_action_list
= Qnil
;
11927 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11928 doc
: /* Function to call to handle deferred actions, after each command.
11929 This function is called with no arguments after each command
11930 whenever `deferred-action-list' is non-nil. */);
11931 Vdeferred_action_function
= Qnil
;
11933 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11934 doc
: /* List of warnings to be displayed after this command.
11935 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11936 as per the args of `display-warning' (which see).
11937 If this variable is non-nil, `delayed-warnings-hook' will be run
11938 immediately after running `post-command-hook'. */);
11939 Vdelayed_warnings_list
= Qnil
;
11941 DEFVAR_LISP ("timer-list", Vtimer_list
,
11942 doc
: /* List of active absolute time timers in order of increasing time. */);
11943 Vtimer_list
= Qnil
;
11945 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11946 doc
: /* List of active idle-time timers in order of increasing time. */);
11947 Vtimer_idle_list
= Qnil
;
11949 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11950 doc
: /* If non-nil, the function that implements the current input method.
11951 It's called with one argument, a printing character that was just read.
11952 \(That means a character with code 040...0176.)
11953 Typically this function uses `read-event' to read additional events.
11954 When it does so, it should first bind `input-method-function' to nil
11955 so it will not be called recursively.
11957 The function should return a list of zero or more events
11958 to be used as input. If it wants to put back some events
11959 to be reconsidered, separately, by the input method,
11960 it can add them to the beginning of `unread-command-events'.
11962 The input method function can find in `input-method-previous-message'
11963 the previous echo area message.
11965 The input method function should refer to the variables
11966 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11967 for guidance on what to do. */);
11968 Vinput_method_function
= Qnil
;
11970 DEFVAR_LISP ("input-method-previous-message",
11971 Vinput_method_previous_message
,
11972 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11973 This variable exists because `read-event' clears the echo area
11974 before running the input method. It is nil if there was no message. */);
11975 Vinput_method_previous_message
= Qnil
;
11977 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11978 doc
: /* If non-nil, the function that implements the display of help.
11979 It's called with one argument, the help string to display. */);
11980 Vshow_help_function
= Qnil
;
11982 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11983 doc
: /* If non-nil, suppress point adjustment after executing a command.
11985 After a command is executed, if point is moved into a region that has
11986 special properties (e.g. composition, display), we adjust point to
11987 the boundary of the region. But, when a command sets this variable to
11988 non-nil, we suppress the point adjustment.
11990 This variable is set to nil before reading a command, and is checked
11991 just after executing the command. */);
11992 Vdisable_point_adjustment
= Qnil
;
11994 DEFVAR_LISP ("global-disable-point-adjustment",
11995 Vglobal_disable_point_adjustment
,
11996 doc
: /* If non-nil, always suppress point adjustment.
11998 The default value is nil, in which case, point adjustment are
11999 suppressed only after special commands that set
12000 `disable-point-adjustment' (which see) to non-nil. */);
12001 Vglobal_disable_point_adjustment
= Qnil
;
12003 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12004 doc
: /* How long to display an echo-area message when the minibuffer is active.
12005 If the value is not a number, such messages don't time out. */);
12006 Vminibuffer_message_timeout
= make_number (2);
12008 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12009 doc
: /* If non-nil, any keyboard input throws to this symbol.
12010 The value of that variable is passed to `quit-flag' and later causes a
12011 peculiar kind of quitting. */);
12012 Vthrow_on_input
= Qnil
;
12014 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12015 doc
: /* If non-nil, function to output error messages.
12016 The arguments are the error data, a list of the form
12017 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12018 such as just as `condition-case' would bind its variable to,
12019 the context (a string which normally goes at the start of the message),
12020 and the Lisp function within which the error was signaled. */);
12021 Vcommand_error_function
= Qnil
;
12023 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12024 Venable_disabled_menus_and_buttons
,
12025 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12027 Help functions bind this to allow help on disabled menu items
12028 and tool-bar buttons. */);
12029 Venable_disabled_menus_and_buttons
= Qnil
;
12031 DEFVAR_LISP ("select-active-regions",
12032 Vselect_active_regions
,
12033 doc
: /* If non-nil, an active region automatically sets the primary selection.
12034 If the value is `only', only temporarily active regions (usually made
12035 by mouse-dragging or shift-selection) set the window selection.
12037 This takes effect only when Transient Mark mode is enabled. */);
12038 Vselect_active_regions
= Qt
;
12040 DEFVAR_LISP ("saved-region-selection",
12041 Vsaved_region_selection
,
12042 doc
: /* Contents of active region prior to buffer modification.
12043 If `select-active-regions' is non-nil, Emacs sets this to the
12044 text in the region before modifying the buffer. The next
12045 `deactivate-mark' call uses this to set the window selection. */);
12046 Vsaved_region_selection
= Qnil
;
12048 DEFVAR_LISP ("selection-inhibit-update-commands",
12049 Vselection_inhibit_update_commands
,
12050 doc
: /* List of commands which should not update the selection.
12051 Normally, if `select-active-regions' is non-nil and the mark remains
12052 active after a command (i.e. the mark was not deactivated), the Emacs
12053 command loop sets the selection to the text in the region. However,
12054 if the command is in this list, the selection is not updated. */);
12055 Vselection_inhibit_update_commands
12056 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12058 DEFVAR_LISP ("debug-on-event",
12060 doc
: /* Enter debugger on this event. When Emacs
12061 receives the special event specified by this variable, it will try to
12062 break into the debugger as soon as possible instead of processing the
12063 event normally through `special-event-map'.
12065 Currently, the only supported values for this
12066 variable are `sigusr1' and `sigusr2'. */);
12067 Vdebug_on_event
= intern_c_string ("sigusr2");
12069 /* Create the initial keyboard. */
12070 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12071 init_kboard (initial_kboard
);
12072 /* Vwindow_system is left at t for now. */
12073 initial_kboard
->next_kboard
= all_kboards
;
12074 all_kboards
= initial_kboard
;
12078 keys_of_keyboard (void)
12080 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12081 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12082 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12083 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12084 initial_define_key (meta_map
, 'x', "execute-extended-command");
12086 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12087 "handle-delete-frame");
12088 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12089 "ns-put-working-text");
12090 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12091 "ns-unput-working-text");
12092 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12093 current-prefix-arg, as is done in `handle-switch-frame'.
12094 But `handle-switch-frame is not run from the special-map.
12095 Commands from that map are run in a special way that automatically
12096 preserves the prefix-arg. Restoring the prefix arg here is not just
12097 redundant but harmful:
12099 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12100 - after the first prompt, the exit-minibuffer-hook is run which may
12101 iconify a frame and thus push a `iconify-frame' event.
12102 - after running exit-minibuffer-hook, current-prefix-arg is
12103 restored to the non-nil value it had before the prompt.
12104 - we enter the second prompt.
12105 current-prefix-arg is non-nil, prefix-arg is nil.
12106 - before running the first real event, we run the special iconify-frame
12107 event, but we pass the `special' arg to execute-command so
12108 current-prefix-arg and prefix-arg are left untouched.
12109 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12110 - the next key event will have a spuriously non-nil current-prefix-arg. */
12111 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12113 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12115 /* Handling it at such a low-level causes read_key_sequence to get
12116 * confused because it doesn't realize that the current_buffer was
12117 * changed by read_char.
12119 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12120 * "handle-select-window"); */
12121 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12122 "handle-save-session");
12125 /* Define a special event which is raised for dbus callback
12127 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12128 "dbus-handle-event");
12131 #ifdef HAVE_INOTIFY
12132 /* Define a special event which is raised for inotify callback
12134 initial_define_lispy_key (Vspecial_event_map
, "file-inotify",
12135 "inotify-handle-event");
12136 #endif /* HAVE_INOTIFY */
12138 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12140 #if defined (WINDOWSNT)
12141 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12143 initial_define_lispy_key (Vspecial_event_map
, "file-w32notify",
12144 "w32notify-handle-event");
12148 /* Mark the pointers in the kboard objects.
12149 Called by Fgarbage_collect. */
12151 mark_kboards (void)
12155 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12157 if (kb
->kbd_macro_buffer
)
12158 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12160 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12161 mark_object (KVAR (kb
, Vlast_command
));
12162 mark_object (KVAR (kb
, Vreal_last_command
));
12163 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12164 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12165 mark_object (KVAR (kb
, Vprefix_arg
));
12166 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12167 mark_object (KVAR (kb
, kbd_queue
));
12168 mark_object (KVAR (kb
, defining_kbd_macro
));
12169 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12170 mark_object (KVAR (kb
, Vsystem_key_alist
));
12171 mark_object (KVAR (kb
, system_key_syms
));
12172 mark_object (KVAR (kb
, Vwindow_system
));
12173 mark_object (KVAR (kb
, Vinput_decode_map
));
12174 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12175 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12176 mark_object (KVAR (kb
, echo_string
));
12179 struct input_event
*event
;
12180 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12182 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12183 event
= kbd_buffer
;
12184 /* These two special event types has no Lisp_Objects to mark. */
12185 if (event
->kind
!= SELECTION_REQUEST_EVENT
12186 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12188 mark_object (event
->x
);
12189 mark_object (event
->y
);
12190 mark_object (event
->frame_or_window
);
12191 mark_object (event
->arg
);