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 static Lisp_Object Qdrag_n_drop
;
318 static Lisp_Object Qsave_session
;
320 static Lisp_Object Qdbus_event
;
323 static Lisp_Object Qfile_inotify
;
324 #endif /* HAVE_INOTIFY */
325 static Lisp_Object Qconfig_changed_event
;
327 /* Lisp_Object Qmouse_movement; - also an event header */
329 /* Properties of event headers. */
330 Lisp_Object Qevent_kind
;
331 static Lisp_Object Qevent_symbol_elements
;
333 /* Menu and tool bar item parts. */
334 static Lisp_Object Qmenu_enable
;
335 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
336 Lisp_Object QCfilter
;
338 /* Non-nil disable property on a command means
339 do not execute it; call disabled-command-function's value instead. */
340 Lisp_Object QCtoggle
, QCradio
;
341 static Lisp_Object QCbutton
, QClabel
;
343 static Lisp_Object QCvert_only
;
345 /* An event header symbol HEAD may have a property named
346 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
347 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
348 mask of modifiers applied to it. If present, this is used to help
349 speed up parse_modifiers. */
350 Lisp_Object Qevent_symbol_element_mask
;
352 /* An unmodified event header BASE may have a property named
353 Qmodifier_cache, which is an alist mapping modifier masks onto
354 modified versions of BASE. If present, this helps speed up
356 static Lisp_Object Qmodifier_cache
;
358 /* Symbols to use for parts of windows. */
359 Lisp_Object Qmode_line
;
360 Lisp_Object Qvertical_line
;
361 static Lisp_Object Qvertical_scroll_bar
;
362 Lisp_Object Qmenu_bar
;
364 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
365 static Lisp_Object
command_loop (void);
366 static Lisp_Object Qextended_command_history
;
367 EMACS_TIME
timer_check (void);
369 static void echo_now (void);
370 static ptrdiff_t echo_length (void);
372 static Lisp_Object Qpolling_period
;
374 /* Incremented whenever a timer is run. */
377 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
379 EMACS_TIME
*input_available_clear_time
;
381 /* True means use SIGIO interrupts; false means use CBREAK mode.
382 Default is true if INTERRUPT_INPUT is defined. */
383 bool interrupt_input
;
385 /* Nonzero while interrupts are temporarily deferred during redisplay. */
386 bool interrupts_deferred
;
388 /* If we support a window system, turn on the code to poll periodically
389 to detect C-g. It isn't actually used when doing interrupt input. */
390 #ifdef HAVE_WINDOW_SYSTEM
391 #define POLL_FOR_INPUT
394 /* The time when Emacs started being idle. */
396 static EMACS_TIME timer_idleness_start_time
;
398 /* After Emacs stops being idle, this saves the last value
399 of timer_idleness_start_time from when it was idle. */
401 static EMACS_TIME timer_last_idleness_start_time
;
404 /* Global variable declarations. */
406 /* Flags for readable_events. */
407 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
408 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
409 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
411 /* Function for init_keyboard to call with no args (if nonzero). */
412 static void (*keyboard_init_hook
) (void);
414 static bool get_input_pending (int);
415 static bool readable_events (int);
416 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
417 Lisp_Object
, bool *);
418 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
420 static Lisp_Object
make_lispy_event (struct input_event
*);
421 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
422 enum scroll_bar_part
,
423 Lisp_Object
, Lisp_Object
,
425 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
426 Lisp_Object
, const char *const *,
427 Lisp_Object
*, ptrdiff_t);
428 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
429 static bool help_char_p (Lisp_Object
);
430 static void save_getcjmp (sys_jmp_buf
);
431 static void restore_getcjmp (sys_jmp_buf
);
432 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
433 static void clear_event (struct input_event
*);
434 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
436 static void deliver_input_available_signal (int signo
);
438 static void handle_interrupt (bool);
439 static _Noreturn
void quit_throw_to_read_char (bool);
440 static void process_special_events (void);
441 static void timer_start_idle (void);
442 static void timer_stop_idle (void);
443 static void timer_resume_idle (void);
444 static void deliver_user_signal (int);
445 static char *find_user_signal_name (int);
446 static void store_user_signal_events (void);
448 /* These setters are used only in this file, so they can be private. */
450 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (echo_string
) = val
;
455 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
460 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
465 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
470 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
475 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
480 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
485 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
490 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
492 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
496 /* Add C to the echo string, if echoing is going on.
497 C can be a character, which is printed prettily ("M-C-x" and all that
498 jazz), or a symbol, whose name is printed. */
501 echo_char (Lisp_Object c
)
503 if (current_kboard
->immediate_echo
)
505 int size
= KEY_DESCRIPTION_SIZE
+ 100;
506 char *buffer
= alloca (size
);
508 Lisp_Object echo_string
;
510 echo_string
= KVAR (current_kboard
, echo_string
);
512 /* If someone has passed us a composite event, use its head symbol. */
517 ptr
= push_key_description (XINT (c
), ptr
);
519 else if (SYMBOLP (c
))
521 Lisp_Object name
= SYMBOL_NAME (c
);
522 int nbytes
= SBYTES (name
);
524 if (size
- (ptr
- buffer
) < nbytes
)
526 int offset
= ptr
- buffer
;
527 size
= max (2 * size
, size
+ nbytes
);
528 buffer
= alloca (size
);
529 ptr
= buffer
+ offset
;
532 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
533 STRING_MULTIBYTE (name
), 1);
536 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
539 const char *text
= " (Type ? for further options)";
540 int len
= strlen (text
);
542 if (size
- (ptr
- buffer
) < len
)
544 int offset
= ptr
- buffer
;
546 buffer
= alloca (size
);
547 ptr
= buffer
+ offset
;
550 memcpy (ptr
, text
, len
);
554 /* Replace a dash from echo_dash with a space, otherwise
555 add a space at the end as a separator between keys. */
556 if (STRINGP (echo_string
)
557 && SCHARS (echo_string
) > 1)
559 Lisp_Object last_char
, prev_char
, idx
;
561 idx
= make_number (SCHARS (echo_string
) - 2);
562 prev_char
= Faref (echo_string
, idx
);
564 idx
= make_number (SCHARS (echo_string
) - 1);
565 last_char
= Faref (echo_string
, idx
);
567 /* We test PREV_CHAR to make sure this isn't the echoing
569 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
570 Faset (echo_string
, idx
, make_number (' '));
572 echo_string
= concat2 (echo_string
, build_string (" "));
574 else if (STRINGP (echo_string
))
575 echo_string
= concat2 (echo_string
, build_string (" "));
579 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
585 /* Temporarily add a dash to the end of the echo string if it's not
586 empty, so that it serves as a mini-prompt for the very next character. */
591 /* Do nothing if not echoing at all. */
592 if (NILP (KVAR (current_kboard
, echo_string
)))
595 if (this_command_key_count
== 0)
598 if (!current_kboard
->immediate_echo
599 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
602 /* Do nothing if we just printed a prompt. */
603 if (current_kboard
->echo_after_prompt
604 == SCHARS (KVAR (current_kboard
, echo_string
)))
607 /* Do nothing if we have already put a dash at the end. */
608 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
610 Lisp_Object last_char
, prev_char
, idx
;
612 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
613 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
615 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
616 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
618 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
622 /* Put a dash at the end of the buffer temporarily,
623 but make it go away when the next character is added. */
626 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
630 /* Display the current echo string, and begin echoing if not already
636 if (!current_kboard
->immediate_echo
)
639 current_kboard
->immediate_echo
= 1;
641 for (i
= 0; i
< this_command_key_count
; i
++)
645 /* Set before_command_echo_length to the value that would
646 have been saved before the start of this subcommand in
647 command_loop_1, if we had already been echoing then. */
648 if (i
== this_single_command_key_start
)
649 before_command_echo_length
= echo_length ();
651 c
= AREF (this_command_keys
, i
);
652 if (! (EVENT_HAS_PARAMETERS (c
)
653 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
657 /* Set before_command_echo_length to the value that would
658 have been saved before the start of this subcommand in
659 command_loop_1, if we had already been echoing then. */
660 if (this_command_key_count
== this_single_command_key_start
)
661 before_command_echo_length
= echo_length ();
663 /* Put a dash at the end to invite the user to type more. */
668 message3_nolog (KVAR (current_kboard
, echo_string
),
669 SBYTES (KVAR (current_kboard
, echo_string
)),
670 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
673 /* Record in what buffer we echoed, and from which kboard. */
674 echo_message_buffer
= echo_area_buffer
[0];
675 echo_kboard
= current_kboard
;
677 if (waiting_for_input
&& !NILP (Vquit_flag
))
678 quit_throw_to_read_char (0);
681 /* Turn off echoing, for the start of a new command. */
684 cancel_echoing (void)
686 current_kboard
->immediate_echo
= 0;
687 current_kboard
->echo_after_prompt
= -1;
688 kset_echo_string (current_kboard
, Qnil
);
689 ok_to_echo_at_next_pause
= NULL
;
691 echo_message_buffer
= Qnil
;
694 /* Return the length of the current echo string. */
699 return (STRINGP (KVAR (current_kboard
, echo_string
))
700 ? SCHARS (KVAR (current_kboard
, echo_string
))
704 /* Truncate the current echo message to its first LEN chars.
705 This and echo_char get used by read_key_sequence when the user
706 switches frames while entering a key sequence. */
709 echo_truncate (ptrdiff_t nchars
)
711 if (STRINGP (KVAR (current_kboard
, echo_string
)))
712 kset_echo_string (current_kboard
,
713 Fsubstring (KVAR (current_kboard
, echo_string
),
714 make_number (0), make_number (nchars
)));
715 truncate_echo_area (nchars
);
719 /* Functions for manipulating this_command_keys. */
721 add_command_key (Lisp_Object key
)
723 #if 0 /* Not needed after we made Freset_this_command_lengths
724 do the job immediately. */
725 /* If reset-this-command-length was called recently, obey it now.
726 See the doc string of that function for an explanation of why. */
727 if (before_command_restore_flag
)
729 this_command_key_count
= before_command_key_count_1
;
730 if (this_command_key_count
< this_single_command_key_start
)
731 this_single_command_key_start
= this_command_key_count
;
732 echo_truncate (before_command_echo_length_1
);
733 before_command_restore_flag
= 0;
737 if (this_command_key_count
>= ASIZE (this_command_keys
))
738 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
740 ASET (this_command_keys
, this_command_key_count
, key
);
741 ++this_command_key_count
;
746 recursive_edit_1 (void)
748 ptrdiff_t count
= SPECPDL_INDEX ();
751 if (command_loop_level
> 0)
753 specbind (Qstandard_output
, Qt
);
754 specbind (Qstandard_input
, Qt
);
757 #ifdef HAVE_WINDOW_SYSTEM
758 /* The command loop has started an hourglass timer, so we have to
759 cancel it here, otherwise it will fire because the recursive edit
760 can take some time. Do not check for display_hourglass_p here,
761 because it could already be nil. */
765 /* This function may have been called from a debugger called from
766 within redisplay, for instance by Edebugging a function called
767 from fontification-functions. We want to allow redisplay in
768 the debugging session.
770 The recursive edit is left with a `(throw exit ...)'. The `exit'
771 tag is not caught anywhere in redisplay, i.e. when we leave the
772 recursive edit, the original redisplay leading to the recursive
773 edit will be unwound. The outcome should therefore be safe. */
774 specbind (Qinhibit_redisplay
, Qnil
);
777 val
= command_loop ();
779 Fsignal (Qquit
, Qnil
);
780 /* Handle throw from read_minibuf when using minibuffer
781 while it's active but we're in another window. */
783 xsignal1 (Qerror
, val
);
785 return unbind_to (count
, Qnil
);
788 /* When an auto-save happens, record the "time", and don't do again soon. */
791 record_auto_save (void)
793 last_auto_save
= num_nonmacro_input_events
;
796 /* Make an auto save happen as soon as possible at command level. */
800 force_auto_save_soon (void)
802 last_auto_save
= - auto_save_interval
- 1;
804 record_asynch_buffer_change ();
808 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
809 doc
: /* Invoke the editor command loop recursively.
810 To get out of the recursive edit, a command can do `(throw 'exit nil)';
811 that tells this function to return.
812 Alternatively, `(throw 'exit t)' makes this function signal an error.
813 This function is called by the editor initialization to begin editing. */)
816 ptrdiff_t count
= SPECPDL_INDEX ();
819 /* If we enter while input is blocked, don't lock up here.
820 This may happen through the debugger during redisplay. */
821 if (input_blocked_p ())
824 command_loop_level
++;
825 update_mode_lines
= 1;
827 if (command_loop_level
828 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
829 buffer
= Fcurrent_buffer ();
833 /* If we leave recursive_edit_1 below with a `throw' for instance,
834 like it is done in the splash screen display, we have to
835 make sure that we restore single_kboard as command_loop_1
836 would have done if it were left normally. */
837 if (command_loop_level
> 0)
838 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
839 record_unwind_protect (recursive_edit_unwind
, buffer
);
842 return unbind_to (count
, Qnil
);
846 recursive_edit_unwind (Lisp_Object buffer
)
848 if (BUFFERP (buffer
))
849 Fset_buffer (buffer
);
851 command_loop_level
--;
852 update_mode_lines
= 1;
857 #if 0 /* These two functions are now replaced with
858 temporarily_switch_to_single_kboard. */
862 #if 0 /* Theory: if there's anything in Vunread_command_events,
863 it will right away be read by read_key_sequence,
864 and then if we do switch KBOARDS, it will go into the side
865 queue then. So we don't need to do anything special here -- rms. */
866 if (CONSP (Vunread_command_events
))
868 current_kboard
->kbd_queue
869 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
870 current_kboard
->kbd_queue_has_data
= 1;
872 Vunread_command_events
= Qnil
;
877 /* Switch to the single-kboard state, making current_kboard
878 the only KBOARD from which further input is accepted. */
881 single_kboard_state ()
887 /* If we're in single_kboard state for kboard KBOARD,
891 not_single_kboard_state (KBOARD
*kboard
)
893 if (kboard
== current_kboard
)
897 /* Maintain a stack of kboards, so other parts of Emacs
898 can switch temporarily to the kboard of a given frame
899 and then revert to the previous status. */
904 struct kboard_stack
*next
;
907 static struct kboard_stack
*kboard_stack
;
910 push_kboard (struct kboard
*k
)
912 struct kboard_stack
*p
= xmalloc (sizeof *p
);
914 p
->next
= kboard_stack
;
915 p
->kboard
= current_kboard
;
925 struct kboard_stack
*p
= kboard_stack
;
927 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
929 if (t
->kboard
== p
->kboard
)
931 current_kboard
= p
->kboard
;
938 /* The terminal we remembered has been deleted. */
939 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
942 kboard_stack
= p
->next
;
946 /* Switch to single_kboard mode, making current_kboard the only KBOARD
947 from which further input is accepted. If F is non-nil, set its
948 KBOARD as the current keyboard.
950 This function uses record_unwind_protect to return to the previous
953 If Emacs is already in single_kboard mode, and F's keyboard is
954 locked, then this function will throw an error. */
957 temporarily_switch_to_single_kboard (struct frame
*f
)
959 bool was_locked
= single_kboard
;
962 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
963 /* We can not switch keyboards while in single_kboard mode.
964 In rare cases, Lisp code may call `recursive-edit' (or
965 `read-minibuffer' or `y-or-n-p') after it switched to a
966 locked frame. For example, this is likely to happen
967 when server.el connects to a new terminal while Emacs is in
968 single_kboard mode. It is best to throw an error instead
969 of presenting the user with a frozen screen. */
970 error ("Terminal %d is locked, cannot read from it",
971 FRAME_TERMINAL (f
)->id
);
973 /* This call is unnecessary, but helps
974 `restore_kboard_configuration' discover if somebody changed
975 `current_kboard' behind our back. */
976 push_kboard (current_kboard
);
979 current_kboard
= FRAME_KBOARD (f
);
981 record_unwind_protect (restore_kboard_configuration
,
982 (was_locked
? Qt
: Qnil
));
985 #if 0 /* This function is not needed anymore. */
987 record_single_kboard_state ()
990 push_kboard (current_kboard
);
991 record_unwind_protect (restore_kboard_configuration
,
992 (single_kboard
? Qt
: Qnil
));
997 restore_kboard_configuration (Lisp_Object was_locked
)
999 if (NILP (was_locked
))
1003 struct kboard
*prev
= current_kboard
;
1006 /* The pop should not change the kboard. */
1007 if (single_kboard
&& current_kboard
!= prev
)
1014 /* Handle errors that are not handled at inner levels
1015 by printing an error message and returning to the editor command loop. */
1018 cmd_error (Lisp_Object data
)
1020 Lisp_Object old_level
, old_length
;
1021 char macroerror
[sizeof "After..kbd macro iterations: "
1022 + INT_STRLEN_BOUND (EMACS_INT
)];
1024 #ifdef HAVE_WINDOW_SYSTEM
1025 if (display_hourglass_p
)
1026 cancel_hourglass ();
1029 if (!NILP (executing_kbd_macro
))
1031 if (executing_kbd_macro_iterations
== 1)
1032 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1034 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1035 executing_kbd_macro_iterations
);
1040 Vstandard_output
= Qt
;
1041 Vstandard_input
= Qt
;
1042 Vexecuting_kbd_macro
= Qnil
;
1043 executing_kbd_macro
= Qnil
;
1044 kset_prefix_arg (current_kboard
, Qnil
);
1045 kset_last_prefix_arg (current_kboard
, Qnil
);
1048 /* Avoid unquittable loop if data contains a circular list. */
1049 old_level
= Vprint_level
;
1050 old_length
= Vprint_length
;
1051 XSETFASTINT (Vprint_level
, 10);
1052 XSETFASTINT (Vprint_length
, 10);
1053 cmd_error_internal (data
, macroerror
);
1054 Vprint_level
= old_level
;
1055 Vprint_length
= old_length
;
1058 Vinhibit_quit
= Qnil
;
1060 return make_number (0);
1063 /* Take actions on handling an error. DATA is the data that describes
1066 CONTEXT is a C-string containing ASCII characters only which
1067 describes the context in which the error happened. If we need to
1068 generalize CONTEXT to allow multibyte characters, make it a Lisp
1072 cmd_error_internal (Lisp_Object data
, const char *context
)
1074 struct frame
*sf
= SELECTED_FRAME ();
1076 /* The immediate context is not interesting for Quits,
1077 since they are asynchronous. */
1078 if (EQ (XCAR (data
), Qquit
))
1079 Vsignaling_function
= Qnil
;
1084 /* Use user's specified output function if any. */
1085 if (!NILP (Vcommand_error_function
))
1086 call3 (Vcommand_error_function
, data
,
1087 context
? build_string (context
) : empty_unibyte_string
,
1088 Vsignaling_function
);
1089 /* If the window system or terminal frame hasn't been initialized
1090 yet, or we're not interactive, write the message to stderr and exit. */
1091 else if (!sf
->glyphs_initialized_p
1092 /* The initial frame is a special non-displaying frame. It
1093 will be current in daemon mode when there are no frames
1094 to display, and in non-daemon mode before the real frame
1095 has finished initializing. If an error is thrown in the
1096 latter case while creating the frame, then the frame
1097 will never be displayed, so the safest thing to do is
1098 write to stderr and quit. In daemon mode, there are
1099 many other potential errors that do not prevent frames
1100 from being created, so continuing as normal is better in
1102 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1105 print_error_message (data
, Qexternal_debugging_output
,
1106 context
, Vsignaling_function
);
1107 Fterpri (Qexternal_debugging_output
);
1108 Fkill_emacs (make_number (-1));
1112 clear_message (1, 0);
1114 message_log_maybe_newline ();
1117 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1120 Vsignaling_function
= Qnil
;
1123 static Lisp_Object
command_loop_2 (Lisp_Object
);
1124 static Lisp_Object
top_level_1 (Lisp_Object
);
1126 /* Entry to editor-command-loop.
1127 This level has the catches for exiting/returning to editor command loop.
1128 It returns nil to exit recursive edit, t to abort it. */
1133 if (command_loop_level
> 0 || minibuf_level
> 0)
1136 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1137 executing_kbd_macro
= Qnil
;
1143 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1144 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1145 executing_kbd_macro
= Qnil
;
1147 /* End of file in -batch run causes exit here. */
1153 /* Here we catch errors in execution of commands within the
1154 editing loop, and reenter the editing loop.
1155 When there is an error, cmd_error runs and returns a non-nil
1156 value to us. A value of nil means that command_loop_1 itself
1157 returned due to end of file (or end of kbd macro). */
1160 command_loop_2 (Lisp_Object ignore
)
1162 register Lisp_Object val
;
1165 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1166 while (!NILP (val
));
1174 return Feval (Vtop_level
, Qnil
);
1178 top_level_1 (Lisp_Object ignore
)
1180 /* On entry to the outer level, run the startup file */
1181 if (!NILP (Vtop_level
))
1182 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1183 else if (!NILP (Vpurify_flag
))
1184 message ("Bare impure Emacs (standard Lisp code not loaded)");
1186 message ("Bare Emacs (standard Lisp code not loaded)");
1190 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1191 doc
: /* Exit all recursive editing levels.
1192 This also exits all active minibuffers. */)
1195 #ifdef HAVE_WINDOW_SYSTEM
1196 if (display_hourglass_p
)
1197 cancel_hourglass ();
1200 /* Unblock input if we enter with input blocked. This may happen if
1201 redisplay traps e.g. during tool-bar update with input blocked. */
1202 totally_unblock_input ();
1204 Fthrow (Qtop_level
, Qnil
);
1207 static _Noreturn
void
1208 user_error (const char *msg
)
1210 xsignal1 (Quser_error
, build_string (msg
));
1214 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1215 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1218 if (command_loop_level
> 0 || minibuf_level
> 0)
1219 Fthrow (Qexit
, Qnil
);
1221 user_error ("No recursive edit is in progress");
1225 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1226 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1229 if (command_loop_level
> 0 || minibuf_level
> 0)
1232 user_error ("No recursive edit is in progress");
1235 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1236 of this function. */
1239 tracking_off (Lisp_Object old_value
)
1241 do_mouse_tracking
= old_value
;
1242 if (NILP (old_value
))
1244 /* Redisplay may have been preempted because there was input
1245 available, and it assumes it will be called again after the
1246 input has been processed. If the only input available was
1247 the sort that we have just disabled, then we need to call
1249 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1251 redisplay_preserve_echo_area (6);
1252 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1258 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1259 doc
: /* Evaluate BODY with mouse movement events enabled.
1260 Within a `track-mouse' form, mouse motion generates input events that
1261 you can read with `read-event'.
1262 Normally, mouse motion is ignored.
1263 usage: (track-mouse BODY...) */)
1266 ptrdiff_t count
= SPECPDL_INDEX ();
1269 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1271 do_mouse_tracking
= Qt
;
1273 val
= Fprogn (args
);
1274 return unbind_to (count
, val
);
1277 /* If mouse has moved on some frame, return one of those frames.
1281 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1282 after resizing the tool-bar window. */
1284 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1287 bool ignore_mouse_drag_p
;
1290 some_mouse_moved (void)
1292 Lisp_Object tail
, frame
;
1294 if (ignore_mouse_drag_p
)
1296 /* ignore_mouse_drag_p = 0; */
1300 FOR_EACH_FRAME (tail
, frame
)
1302 if (XFRAME (frame
)->mouse_moved
)
1303 return XFRAME (frame
);
1310 /* This is the actual command reading loop,
1311 sans error-handling encapsulation. */
1313 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1315 void safe_run_hooks (Lisp_Object
);
1316 static void adjust_point_for_property (ptrdiff_t, bool);
1318 /* Cancel hourglass from protect_unwind.
1320 #ifdef HAVE_WINDOW_SYSTEM
1322 cancel_hourglass_unwind (Lisp_Object arg
)
1324 cancel_hourglass ();
1329 /* The last boundary auto-added to buffer-undo-list. */
1330 Lisp_Object last_undo_boundary
;
1332 /* FIXME: This is wrong rather than test window-system, we should call
1333 a new set-selection, which will then dispatch to x-set-selection, or
1334 tty-set-selection, or w32-set-selection, ... */
1337 command_loop_1 (void)
1340 Lisp_Object keybuf
[30];
1342 EMACS_INT prev_modiff
= 0;
1343 struct buffer
*prev_buffer
= NULL
;
1344 bool already_adjusted
= 0;
1346 kset_prefix_arg (current_kboard
, Qnil
);
1347 kset_last_prefix_arg (current_kboard
, Qnil
);
1348 Vdeactivate_mark
= Qnil
;
1349 waiting_for_input
= 0;
1352 this_command_key_count
= 0;
1353 this_command_key_count_reset
= 0;
1354 this_single_command_key_start
= 0;
1356 if (NILP (Vmemory_full
))
1358 /* Make sure this hook runs after commands that get errors and
1359 throw to top level. */
1360 /* Note that the value cell will never directly contain nil
1361 if the symbol is a local variable. */
1362 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1363 safe_run_hooks (Qpost_command_hook
);
1365 /* If displaying a message, resize the echo area window to fit
1366 that message's size exactly. */
1367 if (!NILP (echo_area_buffer
[0]))
1368 resize_echo_area_exactly ();
1370 /* If there are warnings waiting, process them. */
1371 if (!NILP (Vdelayed_warnings_list
))
1372 safe_run_hooks (Qdelayed_warnings_hook
);
1374 if (!NILP (Vdeferred_action_list
))
1375 safe_run_hooks (Qdeferred_action_function
);
1378 /* Do this after running Vpost_command_hook, for consistency. */
1379 kset_last_command (current_kboard
, Vthis_command
);
1380 kset_real_last_command (current_kboard
, Vreal_this_command
);
1381 if (!CONSP (last_command_event
))
1382 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1386 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1389 /* Make sure the current window's buffer is selected. */
1390 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1392 /* Display any malloc warning that just came out. Use while because
1393 displaying one warning can cause another. */
1395 while (pending_malloc_warning
)
1396 display_malloc_warning ();
1398 Vdeactivate_mark
= Qnil
;
1400 /* Don't ignore mouse movements for more than a single command
1401 loop. (This flag is set in xdisp.c whenever the tool bar is
1402 resized, because the resize moves text up or down, and would
1403 generate false mouse drag events if we don't ignore them.) */
1404 ignore_mouse_drag_p
= 0;
1406 /* If minibuffer on and echo area in use,
1407 wait a short time and redraw minibuffer. */
1410 && !NILP (echo_area_buffer
[0])
1411 && EQ (minibuf_window
, echo_area_window
)
1412 && NUMBERP (Vminibuffer_message_timeout
))
1414 /* Bind inhibit-quit to t so that C-g gets read in
1415 rather than quitting back to the minibuffer. */
1416 ptrdiff_t count
= SPECPDL_INDEX ();
1417 specbind (Qinhibit_quit
, Qt
);
1419 sit_for (Vminibuffer_message_timeout
, 0, 2);
1421 /* Clear the echo area. */
1423 safe_run_hooks (Qecho_area_clear_hook
);
1425 unbind_to (count
, Qnil
);
1427 /* If a C-g came in before, treat it as input now. */
1428 if (!NILP (Vquit_flag
))
1431 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1435 /* If it has changed current-menubar from previous value,
1436 really recompute the menubar from the value. */
1437 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1438 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1439 call0 (Qrecompute_lucid_menubar
);
1441 before_command_key_count
= this_command_key_count
;
1442 before_command_echo_length
= echo_length ();
1444 Vthis_command
= Qnil
;
1445 Vreal_this_command
= Qnil
;
1446 Vthis_original_command
= Qnil
;
1447 Vthis_command_keys_shift_translated
= Qnil
;
1449 /* Read next key sequence; i gets its length. */
1450 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1453 /* A filter may have run while we were reading the input. */
1454 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1456 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1460 /* Now we have read a key sequence of length I,
1461 or else I is 0 and we found end of file. */
1463 if (i
== 0) /* End of file -- happens only in */
1464 return Qnil
; /* a kbd macro, at the end. */
1465 /* -1 means read_key_sequence got a menu that was rejected.
1466 Just loop around and read another command. */
1470 this_command_key_count
= 0;
1471 this_command_key_count_reset
= 0;
1472 this_single_command_key_start
= 0;
1476 last_command_event
= keybuf
[i
- 1];
1478 /* If the previous command tried to force a specific window-start,
1479 forget about that, in case this command moves point far away
1480 from that position. But also throw away beg_unchanged and
1481 end_unchanged information in that case, so that redisplay will
1482 update the whole window properly. */
1483 if (XWINDOW (selected_window
)->force_start
)
1486 XWINDOW (selected_window
)->force_start
= 0;
1487 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1488 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1491 cmd
= read_key_sequence_cmd
;
1492 if (!NILP (Vexecuting_kbd_macro
))
1494 if (!NILP (Vquit_flag
))
1496 Vexecuting_kbd_macro
= Qt
;
1497 QUIT
; /* Make some noise. */
1498 /* Will return since macro now empty. */
1502 /* Do redisplay processing after this command except in special
1503 cases identified below. */
1504 prev_buffer
= current_buffer
;
1505 prev_modiff
= MODIFF
;
1506 last_point_position
= PT
;
1507 last_point_position_window
= selected_window
;
1508 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1510 /* By default, we adjust point to a boundary of a region that
1511 has such a property that should be treated intangible
1512 (e.g. composition, display). But, some commands will set
1513 this variable differently. */
1514 Vdisable_point_adjustment
= Qnil
;
1516 /* Process filters and timers may have messed with deactivate-mark.
1517 reset it before we execute the command. */
1518 Vdeactivate_mark
= Qnil
;
1520 /* Remap command through active keymaps. */
1521 Vthis_original_command
= cmd
;
1522 if (!NILP (read_key_sequence_remapped
))
1523 cmd
= read_key_sequence_remapped
;
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 Vreal_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1535 /* nil means key is undefined. */
1536 Lisp_Object keys
= Fvector (i
, keybuf
);
1537 keys
= Fkey_description (keys
, Qnil
);
1539 message_with_string ("%s is undefined", keys
, 0);
1540 kset_defining_kbd_macro (current_kboard
, Qnil
);
1541 update_mode_lines
= 1;
1542 /* If this is a down-mouse event, don't reset prefix-arg;
1543 pass it to the command run by the up event. */
1544 if (EVENT_HAS_PARAMETERS (last_command_event
))
1546 Lisp_Object breakdown
1547 = parse_modifiers (EVENT_HEAD (last_command_event
));
1548 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1549 if (!(modifiers
& down_modifier
))
1550 kset_prefix_arg (current_kboard
, Qnil
);
1553 kset_prefix_arg (current_kboard
, Qnil
);
1557 /* Here for a command that isn't executed directly. */
1559 #ifdef HAVE_WINDOW_SYSTEM
1560 ptrdiff_t scount
= SPECPDL_INDEX ();
1562 if (display_hourglass_p
1563 && NILP (Vexecuting_kbd_macro
))
1565 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1570 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1572 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1575 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1576 ? Qnil
: BVAR (current_buffer
, undo_list
));
1578 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1580 #ifdef HAVE_WINDOW_SYSTEM
1581 /* Do not check display_hourglass_p here, because
1582 Fcommand_execute could change it, but we should cancel
1583 hourglass cursor anyway.
1584 But don't cancel the hourglass within a macro
1585 just because a command in the macro finishes. */
1586 if (NILP (Vexecuting_kbd_macro
))
1587 unbind_to (scount
, Qnil
);
1590 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1592 safe_run_hooks (Qpost_command_hook
);
1594 /* If displaying a message, resize the echo area window to fit
1595 that message's size exactly. */
1596 if (!NILP (echo_area_buffer
[0]))
1597 resize_echo_area_exactly ();
1599 /* If there are warnings waiting, process them. */
1600 if (!NILP (Vdelayed_warnings_list
))
1601 safe_run_hooks (Qdelayed_warnings_hook
);
1603 safe_run_hooks (Qdeferred_action_function
);
1605 /* If there is a prefix argument,
1606 1) We don't want Vlast_command to be ``universal-argument''
1607 (that would be dumb), so don't set Vlast_command,
1608 2) we want to leave echoing on so that the prefix will be
1609 echoed as part of this key sequence, so don't call
1611 3) we want to leave this_command_key_count non-zero, so that
1612 read_char will realize that it is re-reading a character, and
1613 not echo it a second time.
1615 If the command didn't actually create a prefix arg,
1616 but is merely a frame event that is transparent to prefix args,
1617 then the above doesn't apply. */
1618 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1619 || CONSP (last_command_event
))
1621 kset_last_command (current_kboard
, Vthis_command
);
1622 kset_real_last_command (current_kboard
, Vreal_this_command
);
1623 if (!CONSP (last_command_event
))
1624 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1626 this_command_key_count
= 0;
1627 this_command_key_count_reset
= 0;
1628 this_single_command_key_start
= 0;
1631 if (!NILP (BVAR (current_buffer
, mark_active
))
1632 && !NILP (Vrun_hooks
))
1634 /* In Emacs 22, setting transient-mark-mode to `only' was a
1635 way of turning it on for just one command. This usage is
1636 obsolete, but support it anyway. */
1637 if (EQ (Vtransient_mark_mode
, Qidentity
))
1638 Vtransient_mark_mode
= Qnil
;
1639 else if (EQ (Vtransient_mark_mode
, Qonly
))
1640 Vtransient_mark_mode
= Qidentity
;
1642 if (!NILP (Vdeactivate_mark
))
1643 /* If `select-active-regions' is non-nil, this call to
1644 `deactivate-mark' also sets the PRIMARY selection. */
1645 call0 (Qdeactivate_mark
);
1648 /* Even if not deactivating the mark, set PRIMARY if
1649 `select-active-regions' is non-nil. */
1650 if (!NILP (Fwindow_system (Qnil
))
1651 /* Even if mark_active is non-nil, the actual buffer
1652 marker may not have been set yet (Bug#7044). */
1653 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1654 && (EQ (Vselect_active_regions
, Qonly
)
1655 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1656 : (!NILP (Vselect_active_regions
)
1657 && !NILP (Vtransient_mark_mode
)))
1658 && NILP (Fmemq (Vthis_command
,
1659 Vselection_inhibit_update_commands
)))
1662 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1665 call2 (Qx_set_selection
, QPRIMARY
,
1666 make_buffer_string (beg
, end
, 0));
1668 call2 (Qx_set_selection
, QPRIMARY
,
1669 make_buffer_string (end
, beg
, 0));
1670 /* Don't set empty selections. */
1673 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1675 Lisp_Object hook
= intern ("activate-mark-hook");
1676 Frun_hooks (1, &hook
);
1680 Vsaved_region_selection
= Qnil
;
1685 if (current_buffer
== prev_buffer
1686 && last_point_position
!= PT
1687 && NILP (Vdisable_point_adjustment
)
1688 && NILP (Vglobal_disable_point_adjustment
))
1690 if (last_point_position
> BEGV
1691 && last_point_position
< ZV
1692 && (composition_adjust_point (last_point_position
,
1693 last_point_position
)
1694 != last_point_position
))
1695 /* The last point was temporarily set within a grapheme
1696 cluster to prevent automatic composition. To recover
1697 the automatic composition, we must update the
1699 windows_or_buffers_changed
++;
1700 if (!already_adjusted
)
1701 adjust_point_for_property (last_point_position
,
1702 MODIFF
!= prev_modiff
);
1705 /* Install chars successfully executed in kbd macro. */
1707 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1708 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1709 finalize_kbd_macro_chars ();
1713 /* Adjust point to a boundary of a region that has such a property
1714 that should be treated intangible. For the moment, we check
1715 `composition', `display' and `invisible' properties.
1716 LAST_PT is the last position of point. */
1719 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1722 Lisp_Object val
, overlay
, tmp
;
1723 /* When called after buffer modification, we should temporarily
1724 suppress the point adjustment for automatic composition so that a
1725 user can keep inserting another character at point or keep
1726 deleting characters around point. */
1727 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1728 ptrdiff_t orig_pt
= PT
;
1730 /* FIXME: cycling is probably not necessary because these properties
1731 can't be usefully combined anyway. */
1732 while (check_composition
|| check_display
|| check_invisible
)
1734 /* FIXME: check `intangible'. */
1735 if (check_composition
1736 && PT
> BEGV
&& PT
< ZV
1737 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1740 check_display
= check_invisible
= 1;
1742 check_composition
= 0;
1744 && PT
> BEGV
&& PT
< ZV
1745 && !NILP (val
= get_char_property_and_overlay
1746 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1747 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1748 && (!OVERLAYP (overlay
)
1749 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1750 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1751 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1752 && (beg
< PT
/* && end > PT <- It's always the case. */
1753 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1756 SET_PT (PT
< last_pt
1757 ? (STRINGP (val
) && SCHARS (val
) == 0
1758 ? max (beg
- 1, BEGV
)
1761 check_composition
= check_invisible
= 1;
1764 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1770 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1773 /* FIXME: We should stop if we find a spot between
1774 two runs of `invisible' where inserted text would
1775 be visible. This is important when we have two
1776 invisible boundaries that enclose an area: if the
1777 area is empty, we need this test in order to make
1778 it possible to place point in the middle rather
1779 than skip both boundaries. However, this code
1780 also stops anywhere in a non-sticky text-property,
1781 which breaks (e.g.) Org mode. */
1782 && (val
= get_pos_property (make_number (end
),
1784 TEXT_PROP_MEANS_INVISIBLE (val
))
1786 && !NILP (val
= get_char_property_and_overlay
1787 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1788 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1790 ellipsis
= ellipsis
|| inv
> 1
1791 || (OVERLAYP (overlay
)
1792 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1793 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1794 tmp
= Fnext_single_char_property_change
1795 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1796 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1800 && (val
= get_pos_property (make_number (beg
),
1802 TEXT_PROP_MEANS_INVISIBLE (val
))
1804 && !NILP (val
= get_char_property_and_overlay
1805 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1806 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1808 ellipsis
= ellipsis
|| inv
> 1
1809 || (OVERLAYP (overlay
)
1810 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1811 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1812 tmp
= Fprevious_single_char_property_change
1813 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1814 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1817 /* Move away from the inside area. */
1818 if (beg
< PT
&& end
> PT
)
1820 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1821 /* We haven't moved yet (so we don't need to fear
1822 infinite-looping) and we were outside the range
1823 before (so either end of the range still corresponds
1824 to a move in the right direction): pretend we moved
1825 less than we actually did, so that we still have
1826 more freedom below in choosing which end of the range
1828 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1829 /* We either have moved already or the last point
1830 was already in the range: we don't get to choose
1831 which end of the range we have to go to. */
1832 : (PT
< last_pt
? beg
: end
));
1833 check_composition
= check_display
= 1;
1835 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1836 the point to something other than its argument, due to
1837 point-motion hooks, intangibility, etc. */
1838 eassert (PT
== beg
|| PT
== end
);
1841 /* Pretend the area doesn't exist if the buffer is not
1843 if (!modified
&& !ellipsis
&& beg
< end
)
1845 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1846 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1847 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1848 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1849 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1850 /* We've already moved as far as we can. Trying to go
1851 to the other end would mean moving backwards and thus
1852 could lead to an infinite loop. */
1854 else if (val
= get_pos_property (make_number (PT
),
1856 TEXT_PROP_MEANS_INVISIBLE (val
)
1857 && (val
= get_pos_property
1858 (make_number (PT
== beg
? end
: beg
),
1860 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1861 (check_composition
= check_display
= 1,
1862 SET_PT (PT
== beg
? end
: beg
));
1865 check_invisible
= 0;
1869 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1872 safe_run_hooks_1 (void)
1874 eassert (CONSP (Vinhibit_quit
));
1875 return call0 (XCDR (Vinhibit_quit
));
1878 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1882 safe_run_hooks_error (Lisp_Object error_data
)
1885 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1886 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1887 Lisp_Object args
[4];
1888 args
[0] = build_string ("Error in %s (%s): %S");
1891 args
[3] = error_data
;
1897 Lisp_Object newval
= Qnil
;
1898 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1899 if (EQ (fun
, XCAR (val
)))
1902 newval
= Fcons (XCAR (val
), newval
);
1904 return Fset (hook
, Fnreverse (newval
));
1905 /* Not found in the local part of the hook. Let's look at the global
1908 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1909 : Fdefault_value (hook
));
1910 CONSP (val
); val
= XCDR (val
))
1911 if (EQ (fun
, XCAR (val
)))
1914 newval
= Fcons (XCAR (val
), newval
);
1916 return Fset_default (hook
, Fnreverse (newval
));
1922 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1924 eassert (nargs
== 1);
1925 if (CONSP (Vinhibit_quit
))
1926 XSETCDR (Vinhibit_quit
, args
[0]);
1928 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1930 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1934 /* If we get an error while running the hook, cause the hook variable
1935 to be nil. Also inhibit quits, so that C-g won't cause the hook
1936 to mysteriously evaporate. */
1939 safe_run_hooks (Lisp_Object hook
)
1941 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1942 to its body or to its handlers other than via globals such as
1943 dynamically-bound variables ;-) */
1944 ptrdiff_t count
= SPECPDL_INDEX ();
1945 specbind (Qinhibit_quit
, hook
);
1947 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1949 unbind_to (count
, Qnil
);
1953 /* Nonzero means polling for input is temporarily suppressed. */
1955 int poll_suppress_count
;
1958 #ifdef POLL_FOR_INPUT
1960 /* Asynchronous timer for polling. */
1962 static struct atimer
*poll_timer
;
1964 /* Poll for input, so that we catch a C-g if it comes in. This
1965 function is called from x_make_frame_visible, see comment
1969 poll_for_input_1 (void)
1971 if (! input_blocked_p ()
1972 && !waiting_for_input
)
1976 /* Timer callback function for poll_timer. TIMER is equal to
1980 poll_for_input (struct atimer
*timer
)
1982 if (poll_suppress_count
== 0)
1983 pending_signals
= 1;
1986 #endif /* POLL_FOR_INPUT */
1988 /* Begin signals to poll for input, if they are appropriate.
1989 This function is called unconditionally from various places. */
1992 start_polling (void)
1994 #ifdef POLL_FOR_INPUT
1995 /* XXX This condition was (read_socket_hook && !interrupt_input),
1996 but read_socket_hook is not global anymore. Let's pretend that
1998 if (!interrupt_input
)
2000 /* Turn alarm handling on unconditionally. It might have
2001 been turned off in process.c. */
2002 turn_on_atimers (1);
2004 /* If poll timer doesn't exist, are we need one with
2005 a different interval, start a new one. */
2006 if (poll_timer
== NULL
2007 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2009 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2010 EMACS_TIME interval
= make_emacs_time (period
, 0);
2013 cancel_atimer (poll_timer
);
2015 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2016 poll_for_input
, NULL
);
2019 /* Let the timer's callback function poll for input
2020 if this becomes zero. */
2021 --poll_suppress_count
;
2026 /* True if we are using polling to handle input asynchronously. */
2029 input_polling_used (void)
2031 #ifdef POLL_FOR_INPUT
2032 /* XXX This condition was (read_socket_hook && !interrupt_input),
2033 but read_socket_hook is not global anymore. Let's pretend that
2035 return !interrupt_input
;
2041 /* Turn off polling. */
2046 #ifdef POLL_FOR_INPUT
2047 /* XXX This condition was (read_socket_hook && !interrupt_input),
2048 but read_socket_hook is not global anymore. Let's pretend that
2050 if (!interrupt_input
)
2051 ++poll_suppress_count
;
2055 /* Set the value of poll_suppress_count to COUNT
2056 and start or stop polling accordingly. */
2059 set_poll_suppress_count (int count
)
2061 #ifdef POLL_FOR_INPUT
2062 if (count
== 0 && poll_suppress_count
!= 0)
2064 poll_suppress_count
= 1;
2067 else if (count
!= 0 && poll_suppress_count
== 0)
2071 poll_suppress_count
= count
;
2075 /* Bind polling_period to a value at least N.
2076 But don't decrease it. */
2079 bind_polling_period (int n
)
2081 #ifdef POLL_FOR_INPUT
2082 EMACS_INT
new = polling_period
;
2087 stop_other_atimers (poll_timer
);
2089 specbind (Qpolling_period
, make_number (new));
2090 /* Start a new alarm with the new period. */
2095 /* Apply the control modifier to CHARACTER. */
2098 make_ctrl_char (int c
)
2100 /* Save the upper bits here. */
2101 int upper
= c
& ~0177;
2103 if (! ASCII_BYTE_P (c
))
2104 return c
|= ctrl_modifier
;
2108 /* Everything in the columns containing the upper-case letters
2109 denotes a control character. */
2110 if (c
>= 0100 && c
< 0140)
2114 /* Set the shift modifier for a control char
2115 made from a shifted letter. But only for letters! */
2116 if (oc
>= 'A' && oc
<= 'Z')
2117 c
|= shift_modifier
;
2120 /* The lower-case letters denote control characters too. */
2121 else if (c
>= 'a' && c
<= 'z')
2124 /* Include the bits for control and shift
2125 only if the basic ASCII code can't indicate them. */
2129 /* Replace the high bits. */
2130 c
|= (upper
& ~ctrl_modifier
);
2135 /* Display the help-echo property of the character after the mouse pointer.
2136 Either show it in the echo area, or call show-help-function to display
2137 it by other means (maybe in a tooltip).
2139 If HELP is nil, that means clear the previous help echo.
2141 If HELP is a string, display that string. If HELP is a function,
2142 call it with OBJECT and POS as arguments; the function should
2143 return a help string or nil for none. For all other types of HELP,
2144 evaluate it to obtain a string.
2146 WINDOW is the window in which the help was generated, if any.
2147 It is nil if not in a window.
2149 If OBJECT is a buffer, POS is the position in the buffer where the
2150 `help-echo' text property was found.
2152 If OBJECT is an overlay, that overlay has a `help-echo' property,
2153 and POS is the position in the overlay's buffer under the mouse.
2155 If OBJECT is a string (an overlay string or a string displayed with
2156 the `display' property). POS is the position in that string under
2159 Note: this function may only be called with HELP nil or a string
2160 from X code running asynchronously. */
2163 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2166 if (!NILP (help
) && !STRINGP (help
))
2168 if (FUNCTIONP (help
))
2169 help
= safe_call (4, help
, window
, object
, pos
);
2171 help
= safe_eval (help
);
2173 if (!STRINGP (help
))
2177 if (!noninteractive
&& STRINGP (help
))
2179 /* The mouse-fixup-help-message Lisp function can call
2180 mouse_position_hook, which resets the mouse_moved flags.
2181 This causes trouble if we are trying to read a mouse motion
2182 event (i.e., if we are inside a `track-mouse' form), so we
2183 restore the mouse_moved flag. */
2184 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2185 help
= call1 (Qmouse_fixup_help_message
, help
);
2190 if (STRINGP (help
) || NILP (help
))
2192 if (!NILP (Vshow_help_function
))
2193 call1 (Vshow_help_function
, help
);
2194 help_echo_showing_p
= STRINGP (help
);
2200 /* Input of single characters from keyboard */
2202 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2203 EMACS_TIME
*end_time
);
2204 static void record_char (Lisp_Object c
);
2206 static Lisp_Object help_form_saved_window_configs
;
2208 read_char_help_form_unwind (Lisp_Object arg
)
2210 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2211 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2212 if (!NILP (window_config
))
2213 Fset_window_configuration (window_config
);
2217 #define STOP_POLLING \
2218 do { if (! polling_stopped_here) stop_polling (); \
2219 polling_stopped_here = 1; } while (0)
2221 #define RESUME_POLLING \
2222 do { if (polling_stopped_here) start_polling (); \
2223 polling_stopped_here = 0; } while (0)
2225 /* read a character from the keyboard; call the redisplay if needed */
2226 /* commandflag 0 means do not autosave, but do redisplay.
2227 -1 means do not redisplay, but do autosave.
2230 /* The arguments MAPS and NMAPS are for menu prompting.
2231 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2233 PREV_EVENT is the previous input event, or nil if we are reading
2234 the first event of a key sequence (or not reading a key sequence).
2235 If PREV_EVENT is t, that is a "magic" value that says
2236 not to run input methods, but in other respects to act as if
2237 not reading a key sequence.
2239 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2240 if we used a mouse menu to read the input, or false otherwise. If
2241 USED_MOUSE_MENU is null, don't dereference it.
2243 Value is -2 when we find input on another keyboard. A second call
2244 to read_char will read it.
2246 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2247 specifying the maximum time to wait until. If no input arrives by
2248 that time, stop waiting and return nil.
2250 Value is t if we showed a menu and the user rejected it. */
2253 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2254 Lisp_Object prev_event
,
2255 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2259 sys_jmp_buf local_getcjmp
;
2260 sys_jmp_buf save_jump
;
2261 Lisp_Object tem
, save
;
2262 volatile Lisp_Object previous_echo_area_message
;
2263 volatile Lisp_Object also_record
;
2264 volatile bool reread
;
2265 struct gcpro gcpro1
, gcpro2
;
2266 bool volatile polling_stopped_here
= 0;
2267 struct kboard
*orig_kboard
= current_kboard
;
2271 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2272 before_command_key_count
= this_command_key_count
;
2273 before_command_echo_length
= echo_length ();
2276 previous_echo_area_message
= Qnil
;
2278 GCPRO2 (c
, previous_echo_area_message
);
2283 if (CONSP (Vunread_post_input_method_events
))
2285 c
= XCAR (Vunread_post_input_method_events
);
2286 Vunread_post_input_method_events
2287 = XCDR (Vunread_post_input_method_events
);
2289 /* Undo what read_char_x_menu_prompt did when it unread
2290 additional keys returned by Fx_popup_menu. */
2292 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2300 if (CONSP (Vunread_command_events
))
2302 bool was_disabled
= 0;
2304 c
= XCAR (Vunread_command_events
);
2305 Vunread_command_events
= XCDR (Vunread_command_events
);
2309 /* Undo what sit-for did when it unread additional keys
2310 inside universal-argument. */
2313 && EQ (XCAR (c
), Qt
))
2319 /* Undo what read_char_x_menu_prompt did when it unread
2320 additional keys returned by Fx_popup_menu. */
2322 && EQ (XCDR (c
), Qdisabled
)
2323 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2329 /* If the queued event is something that used the mouse,
2330 set used_mouse_menu accordingly. */
2332 /* Also check was_disabled so last-nonmenu-event won't return
2333 a bad value when submenus are involved. (Bug#447) */
2334 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2335 *used_mouse_menu
= 1;
2337 goto reread_for_input_method
;
2340 if (CONSP (Vunread_input_method_events
))
2342 c
= XCAR (Vunread_input_method_events
);
2343 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2345 /* Undo what read_char_x_menu_prompt did when it unread
2346 additional keys returned by Fx_popup_menu. */
2348 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2352 goto reread_for_input_method
;
2355 this_command_key_count_reset
= 0;
2357 if (!NILP (Vexecuting_kbd_macro
))
2359 /* We set this to Qmacro; since that's not a frame, nobody will
2360 try to switch frames on us, and the selected window will
2363 Since this event came from a macro, it would be misleading to
2364 leave internal_last_event_frame set to wherever the last
2365 real event came from. Normally, a switch-frame event selects
2366 internal_last_event_frame after each command is read, but
2367 events read from a macro should never cause a new frame to be
2369 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2371 /* Exit the macro if we are at the end.
2372 Also, some things replace the macro with t
2373 to force an early exit. */
2374 if (EQ (Vexecuting_kbd_macro
, Qt
)
2375 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2381 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2382 if (STRINGP (Vexecuting_kbd_macro
)
2383 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2384 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2386 executing_kbd_macro_index
++;
2391 if (!NILP (unread_switch_frame
))
2393 c
= unread_switch_frame
;
2394 unread_switch_frame
= Qnil
;
2396 /* This event should make it into this_command_keys, and get echoed
2397 again, so we do not set `reread'. */
2401 /* if redisplay was requested */
2402 if (commandflag
>= 0)
2404 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2406 /* If there is pending input, process any events which are not
2407 user-visible, such as X selection_request events. */
2409 || detect_input_pending_run_timers (0))
2410 swallow_events (0); /* may clear input_pending */
2412 /* Redisplay if no pending input. */
2413 while (!input_pending
)
2415 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2416 redisplay_preserve_echo_area (5);
2421 /* Normal case: no input arrived during redisplay. */
2424 /* Input arrived and pre-empted redisplay.
2425 Process any events which are not user-visible. */
2427 /* If that cleared input_pending, try again to redisplay. */
2430 /* Prevent the redisplay we just did
2431 from messing up echoing of the input after the prompt. */
2432 if (commandflag
== 0 && echo_current
)
2433 echo_message_buffer
= echo_area_buffer
[0];
2437 /* Message turns off echoing unless more keystrokes turn it on again.
2439 The code in 20.x for the condition was
2441 1. echo_area_glyphs && *echo_area_glyphs
2442 2. && echo_area_glyphs != current_kboard->echobuf
2443 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2445 (1) means there's a current message displayed
2447 (2) means it's not the message from echoing from the current
2450 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2451 is set to a non-null value. This is done in read_char and it is
2452 set to echo_area_glyphs after a call to echo_char. That means
2453 ok_to_echo_at_next_pause is either null or
2454 current_kboard->echobuf with the appropriate current_kboard at
2457 So, condition (3) means in clear text ok_to_echo_at_next_pause
2458 must be either null, or the current message isn't from echoing at
2459 all, or it's from echoing from a different kboard than the
2462 if (/* There currently is something in the echo area. */
2463 !NILP (echo_area_buffer
[0])
2464 && (/* And it's either not from echoing. */
2465 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2466 /* Or it's an echo from a different kboard. */
2467 || echo_kboard
!= current_kboard
2468 /* Or we explicitly allow overwriting whatever there is. */
2469 || ok_to_echo_at_next_pause
== NULL
))
2474 /* Try reading a character via menu prompting in the minibuf.
2475 Try this before the sit-for, because the sit-for
2476 would do the wrong thing if we are supposed to do
2477 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2478 after a mouse event so don't try a minibuf menu. */
2480 if (nmaps
> 0 && INTERACTIVE
2481 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2482 /* Don't bring up a menu if we already have another event. */
2483 && NILP (Vunread_command_events
)
2484 && !detect_input_pending_run_timers (0))
2486 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2488 if (INTEGERP (c
) && XINT (c
) == -2)
2489 return c
; /* wrong_kboard_jmpbuf */
2495 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2496 We will do that below, temporarily for short sections of code,
2497 when appropriate. local_getcjmp must be in effect
2498 around any call to sit_for or kbd_buffer_get_event;
2499 it *must not* be in effect when we call redisplay. */
2501 jmpcount
= SPECPDL_INDEX ();
2502 if (sys_setjmp (local_getcjmp
))
2504 /* Handle quits while reading the keyboard. */
2505 /* We must have saved the outer value of getcjmp here,
2506 so restore it now. */
2507 restore_getcjmp (save_jump
);
2508 unbind_to (jmpcount
, Qnil
);
2509 XSETINT (c
, quit_char
);
2510 internal_last_event_frame
= selected_frame
;
2511 Vlast_event_frame
= internal_last_event_frame
;
2512 /* If we report the quit char as an event,
2513 don't do so more than once. */
2514 if (!NILP (Vinhibit_quit
))
2518 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2519 if (kb
!= current_kboard
)
2521 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2522 /* We shouldn't get here if we were in single-kboard mode! */
2527 while (CONSP (XCDR (last
)))
2529 if (!NILP (XCDR (last
)))
2533 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2535 XSETCDR (last
, Fcons (c
, Qnil
));
2536 kb
->kbd_queue_has_data
= 1;
2537 current_kboard
= kb
;
2538 /* This is going to exit from read_char
2539 so we had better get rid of this frame's stuff. */
2541 return make_number (-2); /* wrong_kboard_jmpbuf */
2547 /* Start idle timers if no time limit is supplied. We don't do it
2548 if a time limit is supplied to avoid an infinite recursion in the
2549 situation where an idle timer calls `sit-for'. */
2552 timer_start_idle ();
2554 /* If in middle of key sequence and minibuffer not active,
2555 start echoing if enough time elapses. */
2557 if (minibuf_level
== 0
2559 && !current_kboard
->immediate_echo
2560 && this_command_key_count
> 0
2562 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2563 && NILP (Fzerop (Vecho_keystrokes
))
2564 && (/* No message. */
2565 NILP (echo_area_buffer
[0])
2566 /* Or empty message. */
2567 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2568 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2569 /* Or already echoing from same kboard. */
2570 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2571 /* Or not echoing before and echoing allowed. */
2572 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2574 /* After a mouse event, start echoing right away.
2575 This is because we are probably about to display a menu,
2576 and we don't want to delay before doing so. */
2577 if (EVENT_HAS_PARAMETERS (prev_event
))
2583 save_getcjmp (save_jump
);
2584 restore_getcjmp (local_getcjmp
);
2585 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2586 restore_getcjmp (save_jump
);
2588 && ! CONSP (Vunread_command_events
))
2593 /* Maybe auto save due to number of keystrokes. */
2595 if (commandflag
!= 0
2596 && auto_save_interval
> 0
2597 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2598 && !detect_input_pending_run_timers (0))
2600 Fdo_auto_save (Qnil
, Qnil
);
2601 /* Hooks can actually change some buffers in auto save. */
2605 /* Try reading using an X menu.
2606 This is never confused with reading using the minibuf
2607 because the recursive call of read_char in read_char_minibuf_menu_prompt
2608 does not pass on any keymaps. */
2610 if (nmaps
> 0 && INTERACTIVE
2611 && !NILP (prev_event
)
2612 && EVENT_HAS_PARAMETERS (prev_event
)
2613 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2614 && !EQ (XCAR (prev_event
), Qtool_bar
)
2615 /* Don't bring up a menu if we already have another event. */
2616 && NILP (Vunread_command_events
))
2618 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2620 /* Now that we have read an event, Emacs is not idle. */
2627 /* Maybe autosave and/or garbage collect due to idleness. */
2629 if (INTERACTIVE
&& NILP (c
))
2632 ptrdiff_t buffer_size
;
2634 /* Slow down auto saves logarithmically in size of current buffer,
2635 and garbage collect while we're at it. */
2636 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2637 last_non_minibuf_size
= Z
- BEG
;
2638 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2640 while (buffer_size
> 64)
2641 delay_level
++, buffer_size
-= buffer_size
>> 2;
2642 if (delay_level
< 4) delay_level
= 4;
2643 /* delay_level is 4 for files under around 50k, 7 at 100k,
2644 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2646 /* Auto save if enough time goes by without input. */
2647 if (commandflag
!= 0
2648 && num_nonmacro_input_events
> last_auto_save
2649 && INTEGERP (Vauto_save_timeout
)
2650 && XINT (Vauto_save_timeout
) > 0)
2653 EMACS_INT timeout
= (delay_level
2654 * min (XFASTINT (Vauto_save_timeout
) / 4,
2655 MOST_POSITIVE_FIXNUM
/ delay_level
));
2656 save_getcjmp (save_jump
);
2657 restore_getcjmp (local_getcjmp
);
2658 tem0
= sit_for (make_number (timeout
), 1, 1);
2659 restore_getcjmp (save_jump
);
2662 && ! CONSP (Vunread_command_events
))
2664 Fdo_auto_save (Qnil
, Qnil
);
2669 /* If there is still no input available, ask for GC. */
2670 if (!detect_input_pending_run_timers (0))
2674 /* Notify the caller if an autosave hook, or a timer, sentinel or
2675 filter in the sit_for calls above have changed the current
2676 kboard. This could happen if they use the minibuffer or start a
2677 recursive edit, like the fancy splash screen in server.el's
2678 filter. If this longjmp wasn't here, read_key_sequence would
2679 interpret the next key sequence using the wrong translation
2680 tables and function keymaps. */
2681 if (NILP (c
) && current_kboard
!= orig_kboard
)
2684 return make_number (-2); /* wrong_kboard_jmpbuf */
2687 /* If this has become non-nil here, it has been set by a timer
2688 or sentinel or filter. */
2689 if (CONSP (Vunread_command_events
))
2691 c
= XCAR (Vunread_command_events
);
2692 Vunread_command_events
= XCDR (Vunread_command_events
);
2695 /* Read something from current KBOARD's side queue, if possible. */
2699 if (current_kboard
->kbd_queue_has_data
)
2701 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2703 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2704 kset_kbd_queue (current_kboard
,
2705 XCDR (KVAR (current_kboard
, kbd_queue
)));
2706 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2707 current_kboard
->kbd_queue_has_data
= 0;
2708 input_pending
= readable_events (0);
2709 if (EVENT_HAS_PARAMETERS (c
)
2710 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2711 internal_last_event_frame
= XCAR (XCDR (c
));
2712 Vlast_event_frame
= internal_last_event_frame
;
2716 /* If current_kboard's side queue is empty check the other kboards.
2717 If one of them has data that we have not yet seen here,
2718 switch to it and process the data waiting for it.
2720 Note: if the events queued up for another kboard
2721 have already been seen here, and therefore are not a complete command,
2722 the kbd_queue_has_data field is 0, so we skip that kboard here.
2723 That's to avoid an infinite loop switching between kboards here. */
2724 if (NILP (c
) && !single_kboard
)
2727 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2728 if (kb
->kbd_queue_has_data
)
2730 current_kboard
= kb
;
2731 /* This is going to exit from read_char
2732 so we had better get rid of this frame's stuff. */
2734 return make_number (-2); /* wrong_kboard_jmpbuf */
2742 /* Finally, we read from the main queue,
2743 and if that gives us something we can't use yet, we put it on the
2744 appropriate side queue and try again. */
2748 KBOARD
*kb
IF_LINT (= NULL
);
2750 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2753 /* Actually read a character, waiting if necessary. */
2754 save_getcjmp (save_jump
);
2755 restore_getcjmp (local_getcjmp
);
2757 timer_start_idle ();
2758 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2759 restore_getcjmp (save_jump
);
2761 if (! NILP (c
) && (kb
!= current_kboard
))
2763 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2766 while (CONSP (XCDR (last
)))
2768 if (!NILP (XCDR (last
)))
2772 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2774 XSETCDR (last
, Fcons (c
, Qnil
));
2775 kb
->kbd_queue_has_data
= 1;
2779 current_kboard
= kb
;
2780 /* This is going to exit from read_char
2781 so we had better get rid of this frame's stuff. */
2783 return make_number (-2);
2787 /* Terminate Emacs in batch mode if at eof. */
2788 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2789 Fkill_emacs (make_number (1));
2793 /* Add in any extra modifiers, where appropriate. */
2794 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2795 || ((extra_keyboard_modifiers
& 0177) < ' '
2796 && (extra_keyboard_modifiers
& 0177) != 0))
2797 XSETINT (c
, make_ctrl_char (XINT (c
)));
2799 /* Transfer any other modifier bits directly from
2800 extra_keyboard_modifiers to c. Ignore the actual character code
2801 in the low 16 bits of extra_keyboard_modifiers. */
2802 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2813 if (commandflag
>= 0
2814 && !input_pending
&& !detect_input_pending_run_timers (0))
2820 /* Buffer switch events are only for internal wakeups
2821 so don't show them to the user.
2822 Also, don't record a key if we already did. */
2826 /* Process special events within read_char
2827 and loop around to read another event. */
2830 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2835 struct buffer
*prev_buffer
= current_buffer
;
2836 last_input_event
= c
;
2837 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2839 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2840 /* We stopped being idle for this event; undo that. This
2841 prevents automatic window selection (under
2842 mouse_autoselect_window from acting as a real input event, for
2843 example banishing the mouse under mouse-avoidance-mode. */
2844 timer_resume_idle ();
2846 if (current_buffer
!= prev_buffer
)
2848 /* The command may have changed the keymaps. Pretend there
2849 is input in another keyboard and return. This will
2850 recalculate keymaps. */
2851 c
= make_number (-2);
2858 /* Handle things that only apply to characters. */
2861 /* If kbd_buffer_get_event gave us an EOF, return that. */
2865 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2866 && UNSIGNED_CMP (XFASTINT (c
), <,
2867 SCHARS (KVAR (current_kboard
,
2868 Vkeyboard_translate_table
))))
2869 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2870 && UNSIGNED_CMP (XFASTINT (c
), <,
2871 ASIZE (KVAR (current_kboard
,
2872 Vkeyboard_translate_table
))))
2873 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2877 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2878 /* nil in keyboard-translate-table means no translation. */
2884 /* If this event is a mouse click in the menu bar,
2885 return just menu-bar for now. Modify the mouse click event
2886 so we won't do this twice, then queue it up. */
2887 if (EVENT_HAS_PARAMETERS (c
)
2889 && CONSP (EVENT_START (c
))
2890 && CONSP (XCDR (EVENT_START (c
))))
2894 posn
= POSN_POSN (EVENT_START (c
));
2895 /* Handle menu-bar events:
2896 insert the dummy prefix event `menu-bar'. */
2897 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2899 /* Change menu-bar to (menu-bar) as the event "position". */
2900 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2903 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2908 /* Store these characters into recent_keys, the dribble file if any,
2909 and the keyboard macro being defined, if any. */
2911 if (! NILP (also_record
))
2912 record_char (also_record
);
2914 /* Wipe the echo area.
2915 But first, if we are about to use an input method,
2916 save the echo area contents for it to refer to. */
2918 && ! NILP (Vinput_method_function
)
2919 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2921 previous_echo_area_message
= Fcurrent_message ();
2922 Vinput_method_previous_message
= previous_echo_area_message
;
2925 /* Now wipe the echo area, except for help events which do their
2926 own stuff with the echo area. */
2928 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2929 && !(EQ (Qswitch_frame
, XCAR (c
)))
2930 /* Don't wipe echo area for select window events: These might
2931 get delayed via `mouse-autoselect-window' (Bug#11304). */
2932 && !(EQ (Qselect_window
, XCAR (c
)))))
2934 if (!NILP (echo_area_buffer
[0]))
2936 safe_run_hooks (Qecho_area_clear_hook
);
2937 clear_message (1, 0);
2941 reread_for_input_method
:
2943 /* Pass this to the input method, if appropriate. */
2945 && ! NILP (Vinput_method_function
)
2946 /* Don't run the input method within a key sequence,
2947 after the first event of the key sequence. */
2948 && NILP (prev_event
)
2949 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2952 ptrdiff_t key_count
;
2953 bool key_count_reset
;
2954 struct gcpro gcpro1
;
2955 ptrdiff_t count
= SPECPDL_INDEX ();
2957 /* Save the echo status. */
2958 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2959 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2960 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2961 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2964 if (before_command_restore_flag
)
2966 this_command_key_count
= before_command_key_count_1
;
2967 if (this_command_key_count
< this_single_command_key_start
)
2968 this_single_command_key_start
= this_command_key_count
;
2969 echo_truncate (before_command_echo_length_1
);
2970 before_command_restore_flag
= 0;
2974 /* Save the this_command_keys status. */
2975 key_count
= this_command_key_count
;
2976 key_count_reset
= this_command_key_count_reset
;
2979 keys
= Fcopy_sequence (this_command_keys
);
2984 /* Clear out this_command_keys. */
2985 this_command_key_count
= 0;
2986 this_command_key_count_reset
= 0;
2988 /* Now wipe the echo area. */
2989 if (!NILP (echo_area_buffer
[0]))
2990 safe_run_hooks (Qecho_area_clear_hook
);
2991 clear_message (1, 0);
2994 /* If we are not reading a key sequence,
2995 never use the echo area. */
2998 specbind (Qinput_method_use_echo_area
, Qt
);
3001 /* Call the input method. */
3002 tem
= call1 (Vinput_method_function
, c
);
3004 tem
= unbind_to (count
, tem
);
3006 /* Restore the saved echoing state
3007 and this_command_keys state. */
3008 this_command_key_count
= key_count
;
3009 this_command_key_count_reset
= key_count_reset
;
3011 this_command_keys
= keys
;
3014 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3015 kset_echo_string (current_kboard
, saved_echo_string
);
3016 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3017 if (saved_immediate_echo
)
3022 /* The input method can return no events. */
3025 /* Bring back the previous message, if any. */
3026 if (! NILP (previous_echo_area_message
))
3027 message_with_string ("%s", previous_echo_area_message
, 0);
3030 /* It returned one event or more. */
3032 Vunread_post_input_method_events
3033 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3038 /* Display help if not echoing. */
3039 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3041 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3042 Lisp_Object help
, object
, position
, window
, htem
;
3044 htem
= Fcdr (XCDR (c
));
3047 window
= Fcar (htem
);
3049 object
= Fcar (htem
);
3051 position
= Fcar (htem
);
3053 show_help_echo (help
, window
, object
, position
);
3055 /* We stopped being idle for this event; undo that. */
3057 timer_resume_idle ();
3061 if ((! reread
|| this_command_key_count
== 0
3062 || this_command_key_count_reset
)
3066 /* Don't echo mouse motion events. */
3067 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3068 && NILP (Fzerop (Vecho_keystrokes
))
3069 && ! (EVENT_HAS_PARAMETERS (c
)
3070 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3073 if (! NILP (also_record
))
3074 echo_char (also_record
);
3075 /* Once we reread a character, echoing can happen
3076 the next time we pause to read a new one. */
3077 ok_to_echo_at_next_pause
= current_kboard
;
3080 /* Record this character as part of the current key. */
3081 add_command_key (c
);
3082 if (! NILP (also_record
))
3083 add_command_key (also_record
);
3086 last_input_event
= c
;
3089 /* Process the help character specially if enabled */
3090 if (!NILP (Vhelp_form
) && help_char_p (c
))
3092 ptrdiff_t count
= SPECPDL_INDEX ();
3094 help_form_saved_window_configs
3095 = Fcons (Fcurrent_window_configuration (Qnil
),
3096 help_form_saved_window_configs
);
3097 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3098 call0 (Qhelp_form_show
);
3103 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3104 if (EVENT_HAS_PARAMETERS (c
)
3105 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3106 XSETCAR (help_form_saved_window_configs
, Qnil
);
3108 while (BUFFERP (c
));
3109 /* Remove the help from the frame */
3110 unbind_to (count
, Qnil
);
3113 if (EQ (c
, make_number (040)))
3117 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3118 while (BUFFERP (c
));
3127 /* Record a key that came from a mouse menu.
3128 Record it for echoing, for this-command-keys, and so on. */
3131 record_menu_key (Lisp_Object c
)
3133 /* Wipe the echo area. */
3134 clear_message (1, 0);
3139 before_command_key_count
= this_command_key_count
;
3140 before_command_echo_length
= echo_length ();
3143 /* Don't echo mouse motion events. */
3144 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3145 && NILP (Fzerop (Vecho_keystrokes
)))
3149 /* Once we reread a character, echoing can happen
3150 the next time we pause to read a new one. */
3151 ok_to_echo_at_next_pause
= 0;
3154 /* Record this character as part of the current key. */
3155 add_command_key (c
);
3157 /* Re-reading in the middle of a command */
3158 last_input_event
= c
;
3162 /* Return true if should recognize C as "the help character". */
3165 help_char_p (Lisp_Object c
)
3169 if (EQ (c
, Vhelp_char
))
3171 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3172 if (EQ (c
, XCAR (tail
)))
3177 /* Record the input event C in various ways. */
3180 record_char (Lisp_Object c
)
3184 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3186 /* To avoid filling recent_keys with help-echo and mouse-movement
3187 events, we filter out repeated help-echo events, only store the
3188 first and last in a series of mouse-movement events, and don't
3189 store repeated help-echo events which are only separated by
3190 mouse-movement events. */
3192 Lisp_Object ev1
, ev2
, ev3
;
3195 if ((ix1
= recent_keys_index
- 1) < 0)
3196 ix1
= NUM_RECENT_KEYS
- 1;
3197 ev1
= AREF (recent_keys
, ix1
);
3199 if ((ix2
= ix1
- 1) < 0)
3200 ix2
= NUM_RECENT_KEYS
- 1;
3201 ev2
= AREF (recent_keys
, ix2
);
3203 if ((ix3
= ix2
- 1) < 0)
3204 ix3
= NUM_RECENT_KEYS
- 1;
3205 ev3
= AREF (recent_keys
, ix3
);
3207 if (EQ (XCAR (c
), Qhelp_echo
))
3209 /* Don't record `help-echo' in recent_keys unless it shows some help
3210 message, and a different help than the previously recorded
3212 Lisp_Object help
, last_help
;
3214 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3215 if (!STRINGP (help
))
3217 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3218 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3220 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3221 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3222 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3224 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3225 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3226 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3227 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3230 else if (EQ (XCAR (c
), Qmouse_movement
))
3232 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3233 So additional mouse movement events replace the last element. */
3234 Lisp_Object last_window
, window
;
3236 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3237 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3238 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3239 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3240 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3242 ASET (recent_keys
, ix1
, c
);
3248 store_kbd_macro_char (c
);
3252 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3253 ASET (recent_keys
, recent_keys_index
, c
);
3254 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3255 recent_keys_index
= 0;
3257 else if (recorded
< 0)
3259 /* We need to remove one or two events from recent_keys.
3260 To do this, we simply put nil at those events and move the
3261 recent_keys_index backwards over those events. Usually,
3262 users will never see those nil events, as they will be
3263 overwritten by the command keys entered to see recent_keys
3266 while (recorded
++ < 0 && total_keys
> 0)
3268 if (total_keys
< NUM_RECENT_KEYS
)
3270 if (--recent_keys_index
< 0)
3271 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3272 ASET (recent_keys
, recent_keys_index
, Qnil
);
3276 num_nonmacro_input_events
++;
3278 /* Write c to the dribble file. If c is a lispy event, write
3279 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3280 If you, dear reader, have a better idea, you've got the source. :-) */
3286 if (XUINT (c
) < 0x100)
3287 putc (XUINT (c
), dribble
);
3289 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3293 Lisp_Object dribblee
;
3295 /* If it's a structured event, take the event header. */
3296 dribblee
= EVENT_HEAD (c
);
3298 if (SYMBOLP (dribblee
))
3300 putc ('<', dribble
);
3301 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3302 SBYTES (SYMBOL_NAME (dribblee
)),
3304 putc ('>', dribble
);
3313 /* Copy out or in the info on where C-g should throw to.
3314 This is used when running Lisp code from within get_char,
3315 in case get_char is called recursively.
3316 See read_process_output. */
3319 save_getcjmp (sys_jmp_buf temp
)
3321 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3325 restore_getcjmp (sys_jmp_buf temp
)
3327 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3330 /* Low level keyboard/mouse input.
3331 kbd_buffer_store_event places events in kbd_buffer, and
3332 kbd_buffer_get_event retrieves them. */
3334 /* Return true if there are any events in the queue that read-char
3335 would return. If this returns false, a read-char would block. */
3337 readable_events (int flags
)
3339 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3342 /* If the buffer contains only FOCUS_IN_EVENT events, and
3343 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3344 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3346 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3347 #ifdef USE_TOOLKIT_SCROLL_BARS
3348 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3352 struct input_event
*event
;
3354 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3361 #ifdef USE_TOOLKIT_SCROLL_BARS
3362 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3364 event
->kind
== FOCUS_IN_EVENT
)
3365 #ifdef USE_TOOLKIT_SCROLL_BARS
3366 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3367 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3368 && event
->part
== scroll_bar_handle
3369 && event
->modifiers
== 0)
3374 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3377 while (event
!= kbd_store_ptr
);
3383 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3384 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3388 if (current_kboard
->kbd_queue_has_data
)
3394 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3395 if (kb
->kbd_queue_has_data
)
3401 /* Set this for debugging, to have a way to get out */
3402 int stop_character EXTERNALLY_VISIBLE
;
3405 event_to_kboard (struct input_event
*event
)
3407 /* Not applicable for these special events. */
3408 if (event
->kind
== SELECTION_REQUEST_EVENT
3409 || event
->kind
== SELECTION_CLEAR_EVENT
)
3413 Lisp_Object obj
= event
->frame_or_window
;
3414 /* There are some events that set this field to nil or string. */
3416 obj
= WINDOW_FRAME (XWINDOW (obj
));
3417 /* Also ignore dead frames here. */
3418 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3419 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3424 /* Return the number of slots occupied in kbd_buffer. */
3427 kbd_buffer_nr_stored (void)
3429 return kbd_fetch_ptr
== kbd_store_ptr
3431 : (kbd_fetch_ptr
< kbd_store_ptr
3432 ? kbd_store_ptr
- kbd_fetch_ptr
3433 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3434 + (kbd_store_ptr
- kbd_buffer
)));
3436 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3439 kbd_buffer_store_event (register struct input_event
*event
)
3441 kbd_buffer_store_event_hold (event
, 0);
3444 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3446 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3447 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3448 Else, if EVENT is a quit event, store the quit event
3449 in HOLD_QUIT, and return (thus ignoring further events).
3451 This is used to postpone the processing of the quit event until all
3452 subsequent input events have been parsed (and discarded). */
3455 kbd_buffer_store_event_hold (register struct input_event
*event
,
3456 struct input_event
*hold_quit
)
3458 if (event
->kind
== NO_EVENT
)
3461 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3464 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3466 register int c
= event
->code
& 0377;
3468 if (event
->modifiers
& ctrl_modifier
)
3469 c
= make_ctrl_char (c
);
3471 c
|= (event
->modifiers
3472 & (meta_modifier
| alt_modifier
3473 | hyper_modifier
| super_modifier
));
3477 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3478 struct input_event
*sp
;
3480 if (single_kboard
&& kb
!= current_kboard
)
3483 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3484 Fcons (make_number (c
), Qnil
)));
3485 kb
->kbd_queue_has_data
= 1;
3486 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3488 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3491 if (event_to_kboard (sp
) == kb
)
3493 sp
->kind
= NO_EVENT
;
3494 sp
->frame_or_window
= Qnil
;
3503 *hold_quit
= *event
;
3507 /* If this results in a quit_char being returned to Emacs as
3508 input, set Vlast_event_frame properly. If this doesn't
3509 get returned to Emacs as an event, the next event read
3510 will set Vlast_event_frame again, so this is safe to do. */
3514 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3516 focus
= event
->frame_or_window
;
3517 internal_last_event_frame
= focus
;
3518 Vlast_event_frame
= focus
;
3521 last_event_timestamp
= event
->timestamp
;
3523 handle_interrupt (0);
3527 if (c
&& c
== stop_character
)
3533 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3534 Just ignore the second one. */
3535 else if (event
->kind
== BUFFER_SWITCH_EVENT
3536 && kbd_fetch_ptr
!= kbd_store_ptr
3537 && ((kbd_store_ptr
== kbd_buffer
3538 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3539 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3542 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3543 kbd_store_ptr
= kbd_buffer
;
3545 /* Don't let the very last slot in the buffer become full,
3546 since that would make the two pointers equal,
3547 and that is indistinguishable from an empty buffer.
3548 Discard the event if it would fill the last slot. */
3549 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3551 *kbd_store_ptr
= *event
;
3554 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3556 /* Don't read keyboard input until we have processed kbd_buffer.
3557 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3558 hold_keyboard_input ();
3559 if (!noninteractive
)
3563 #endif /* subprocesses */
3566 /* If we're inside while-no-input, and this event qualifies
3567 as input, set quit-flag to cause an interrupt. */
3568 if (!NILP (Vthrow_on_input
)
3569 && event
->kind
!= FOCUS_IN_EVENT
3570 && event
->kind
!= HELP_EVENT
3571 && event
->kind
!= DEICONIFY_EVENT
)
3573 Vquit_flag
= Vthrow_on_input
;
3574 /* If we're inside a function that wants immediate quits,
3576 if (immediate_quit
&& NILP (Vinhibit_quit
))
3585 /* Put an input event back in the head of the event queue. */
3588 kbd_buffer_unget_event (register struct input_event
*event
)
3590 if (kbd_fetch_ptr
== kbd_buffer
)
3591 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3593 /* Don't let the very last slot in the buffer become full, */
3594 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3597 *kbd_fetch_ptr
= *event
;
3602 /* Generate a HELP_EVENT input_event and store it in the keyboard
3605 HELP is the help form.
3607 FRAME and WINDOW are the frame and window where the help is
3608 generated. OBJECT is the Lisp object where the help was found (a
3609 buffer, a string, an overlay, or nil if neither from a string nor
3610 from a buffer). POS is the position within OBJECT where the help
3614 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3615 Lisp_Object object
, ptrdiff_t pos
)
3617 struct input_event event
;
3621 event
.kind
= HELP_EVENT
;
3622 event
.frame_or_window
= frame
;
3624 event
.x
= WINDOWP (window
) ? window
: frame
;
3627 kbd_buffer_store_event (&event
);
3631 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3634 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3636 struct input_event event
;
3638 event
.kind
= HELP_EVENT
;
3639 event
.frame_or_window
= frame
;
3644 kbd_buffer_store_event (&event
);
3648 /* Discard any mouse events in the event buffer by setting them to
3651 discard_mouse_events (void)
3653 struct input_event
*sp
;
3654 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3656 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3659 if (sp
->kind
== MOUSE_CLICK_EVENT
3660 || sp
->kind
== WHEEL_EVENT
3661 || sp
->kind
== HORIZ_WHEEL_EVENT
3663 || sp
->kind
== GPM_CLICK_EVENT
3665 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3667 sp
->kind
= NO_EVENT
;
3673 /* Return true if there are any real events waiting in the event
3674 buffer, not counting `NO_EVENT's.
3676 Discard NO_EVENT events at the front of the input queue, possibly
3677 leaving the input queue empty if there are no real input events. */
3680 kbd_buffer_events_waiting (void)
3682 struct input_event
*sp
;
3684 for (sp
= kbd_fetch_ptr
;
3685 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3688 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3693 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3697 /* Clear input event EVENT. */
3700 clear_event (struct input_event
*event
)
3702 event
->kind
= NO_EVENT
;
3706 /* Read one event from the event buffer, waiting if necessary.
3707 The value is a Lisp object representing the event.
3708 The value is nil for an event that should be ignored,
3709 or that was handled here.
3710 We always read and discard one event. */
3713 kbd_buffer_get_event (KBOARD
**kbp
,
3714 bool *used_mouse_menu
,
3715 EMACS_TIME
*end_time
)
3720 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3722 /* Start reading input again because we have processed enough to
3723 be able to accept new events again. */
3724 unhold_keyboard_input ();
3727 #endif /* subprocesses */
3729 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3731 /* In case we are running as a daemon, only do this before
3732 detaching from the terminal. */
3733 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3737 *kbp
= current_kboard
;
3740 #endif /* ! HAVE_DBUS */
3742 /* Wait until there is input available. */
3745 /* Break loop if there's an unread command event. Needed in
3746 moused window autoselection which uses a timer to insert such
3748 if (CONSP (Vunread_command_events
))
3751 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3753 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3756 /* If the quit flag is set, then read_char will return
3757 quit_char, so that counts as "available input." */
3758 if (!NILP (Vquit_flag
))
3759 quit_throw_to_read_char (0);
3761 /* One way or another, wait until input is available; then, if
3762 interrupt handlers have not read it, read it now. */
3767 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3769 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3773 EMACS_TIME now
= current_emacs_time ();
3774 if (EMACS_TIME_LE (*end_time
, now
))
3775 return Qnil
; /* Finished waiting. */
3778 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3779 wait_reading_process_output (min (EMACS_SECS (duration
),
3781 EMACS_NSECS (duration
),
3782 -1, 1, Qnil
, NULL
, 0);
3786 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3788 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3792 if (CONSP (Vunread_command_events
))
3795 first
= XCAR (Vunread_command_events
);
3796 Vunread_command_events
= XCDR (Vunread_command_events
);
3797 *kbp
= current_kboard
;
3801 /* At this point, we know that there is a readable event available
3802 somewhere. If the event queue is empty, then there must be a
3803 mouse movement enabled and available. */
3804 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3806 struct input_event
*event
;
3808 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3812 last_event_timestamp
= event
->timestamp
;
3814 *kbp
= event_to_kboard (event
);
3816 *kbp
= current_kboard
; /* Better than returning null ptr? */
3820 /* These two kinds of events get special handling
3821 and don't actually appear to the command loop.
3822 We return nil for them. */
3823 if (event
->kind
== SELECTION_REQUEST_EVENT
3824 || event
->kind
== SELECTION_CLEAR_EVENT
)
3827 struct input_event copy
;
3829 /* Remove it from the buffer before processing it,
3830 since otherwise swallow_events will see it
3831 and process it again. */
3833 kbd_fetch_ptr
= event
+ 1;
3834 input_pending
= readable_events (0);
3835 x_handle_selection_event (©
);
3837 /* We're getting selection request events, but we don't have
3843 #if defined (HAVE_NS)
3844 else if (event
->kind
== NS_TEXT_EVENT
)
3846 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3847 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3849 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3850 kbd_fetch_ptr
= event
+ 1;
3851 if (used_mouse_menu
)
3852 *used_mouse_menu
= 1;
3856 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3857 || defined (HAVE_NS)
3858 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3860 /* Make an event (delete-frame (FRAME)). */
3861 obj
= Fcons (event
->frame_or_window
, Qnil
);
3862 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3863 kbd_fetch_ptr
= event
+ 1;
3866 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3867 || defined (HAVE_NS)
3868 else if (event
->kind
== ICONIFY_EVENT
)
3870 /* Make an event (iconify-frame (FRAME)). */
3871 obj
= Fcons (event
->frame_or_window
, Qnil
);
3872 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3873 kbd_fetch_ptr
= event
+ 1;
3875 else if (event
->kind
== DEICONIFY_EVENT
)
3877 /* Make an event (make-frame-visible (FRAME)). */
3878 obj
= Fcons (event
->frame_or_window
, Qnil
);
3879 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3880 kbd_fetch_ptr
= event
+ 1;
3883 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3885 /* The value doesn't matter here; only the type is tested. */
3886 XSETBUFFER (obj
, current_buffer
);
3887 kbd_fetch_ptr
= event
+ 1;
3889 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3890 || defined (HAVE_NS) || defined (USE_GTK)
3891 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3893 kbd_fetch_ptr
= event
+ 1;
3894 input_pending
= readable_events (0);
3895 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3896 x_activate_menubar (XFRAME (event
->frame_or_window
));
3900 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3902 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3903 obj
= Fcons (Qlanguage_change
,
3904 list3 (event
->frame_or_window
,
3905 make_number (event
->code
),
3906 make_number (event
->modifiers
)));
3907 kbd_fetch_ptr
= event
+ 1;
3910 else if (event
->kind
== SAVE_SESSION_EVENT
)
3912 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3913 kbd_fetch_ptr
= event
+ 1;
3915 /* Just discard these, by returning nil.
3916 With MULTI_KBOARD, these events are used as placeholders
3917 when we need to randomly delete events from the queue.
3918 (They shouldn't otherwise be found in the buffer,
3919 but on some machines it appears they do show up
3920 even without MULTI_KBOARD.) */
3921 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3922 mouse events during a popup-menu call. */
3923 else if (event
->kind
== NO_EVENT
)
3924 kbd_fetch_ptr
= event
+ 1;
3925 else if (event
->kind
== HELP_EVENT
)
3927 Lisp_Object object
, position
, help
, frame
, window
;
3929 frame
= event
->frame_or_window
;
3930 object
= event
->arg
;
3931 position
= make_number (event
->code
);
3934 clear_event (event
);
3936 kbd_fetch_ptr
= event
+ 1;
3937 if (!WINDOWP (window
))
3939 obj
= Fcons (Qhelp_echo
,
3940 list5 (frame
, help
, window
, object
, position
));
3942 else if (event
->kind
== FOCUS_IN_EVENT
)
3944 /* Notification of a FocusIn event. The frame receiving the
3945 focus is in event->frame_or_window. Generate a
3946 switch-frame event if necessary. */
3947 Lisp_Object frame
, focus
;
3949 frame
= event
->frame_or_window
;
3950 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3954 if (!EQ (frame
, internal_last_event_frame
)
3955 && !EQ (frame
, selected_frame
))
3956 obj
= make_lispy_switch_frame (frame
);
3957 internal_last_event_frame
= frame
;
3958 kbd_fetch_ptr
= event
+ 1;
3961 else if (event
->kind
== DBUS_EVENT
)
3963 obj
= make_lispy_event (event
);
3964 kbd_fetch_ptr
= event
+ 1;
3968 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3970 obj
= make_lispy_event (event
);
3971 kbd_fetch_ptr
= event
+ 1;
3974 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3976 obj
= make_lispy_event (event
);
3977 kbd_fetch_ptr
= event
+ 1;
3981 /* If this event is on a different frame, return a switch-frame this
3982 time, and leave the event in the queue for next time. */
3986 frame
= event
->frame_or_window
;
3988 frame
= XCAR (frame
);
3989 else if (WINDOWP (frame
))
3990 frame
= WINDOW_FRAME (XWINDOW (frame
));
3992 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3996 if (! EQ (frame
, internal_last_event_frame
)
3997 && !EQ (frame
, selected_frame
))
3998 obj
= make_lispy_switch_frame (frame
);
3999 internal_last_event_frame
= frame
;
4001 /* If we didn't decide to make a switch-frame event, go ahead
4002 and build a real event from the queue entry. */
4006 obj
= make_lispy_event (event
);
4008 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4009 || defined (HAVE_NS) || defined (USE_GTK)
4010 /* If this was a menu selection, then set the flag to inhibit
4011 writing to last_nonmenu_event. Don't do this if the event
4012 we're returning is (menu-bar), though; that indicates the
4013 beginning of the menu sequence, and we might as well leave
4014 that as the `event with parameters' for this selection. */
4016 && !EQ (event
->frame_or_window
, event
->arg
)
4017 && (event
->kind
== MENU_BAR_EVENT
4018 || event
->kind
== TOOL_BAR_EVENT
))
4019 *used_mouse_menu
= 1;
4022 /* Certain system events are non-key events. */
4024 && event
->kind
== NS_NONKEY_EVENT
)
4025 *used_mouse_menu
= 1;
4028 /* Wipe out this event, to catch bugs. */
4029 clear_event (event
);
4030 kbd_fetch_ptr
= event
+ 1;
4034 /* Try generating a mouse motion event. */
4035 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4037 FRAME_PTR f
= some_mouse_moved ();
4038 Lisp_Object bar_window
;
4039 enum scroll_bar_part part
;
4043 *kbp
= current_kboard
;
4044 /* Note that this uses F to determine which terminal to look at.
4045 If there is no valid info, it does not store anything
4046 so x remains nil. */
4049 /* XXX Can f or mouse_position_hook be NULL here? */
4050 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4051 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4056 /* Decide if we should generate a switch-frame event. Don't
4057 generate switch-frame events for motion outside of all Emacs
4063 frame
= FRAME_FOCUS_FRAME (f
);
4065 XSETFRAME (frame
, f
);
4067 if (! EQ (frame
, internal_last_event_frame
)
4068 && !EQ (frame
, selected_frame
))
4069 obj
= make_lispy_switch_frame (frame
);
4070 internal_last_event_frame
= frame
;
4073 /* If we didn't decide to make a switch-frame event, go ahead and
4074 return a mouse-motion event. */
4075 if (!NILP (x
) && NILP (obj
))
4076 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4079 /* We were promised by the above while loop that there was
4080 something for us to read! */
4083 input_pending
= readable_events (0);
4085 Vlast_event_frame
= internal_last_event_frame
;
4090 /* Process any non-user-visible events (currently X selection events),
4091 without reading any user-visible events. */
4094 process_special_events (void)
4096 struct input_event
*event
;
4098 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4100 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4103 if (event
== kbd_store_ptr
)
4107 /* If we find a stored X selection request, handle it now. */
4108 if (event
->kind
== SELECTION_REQUEST_EVENT
4109 || event
->kind
== SELECTION_CLEAR_EVENT
)
4113 /* Remove the event from the fifo buffer before processing;
4114 otherwise swallow_events called recursively could see it
4115 and process it again. To do this, we move the events
4116 between kbd_fetch_ptr and EVENT one slot to the right,
4119 struct input_event copy
= *event
;
4120 struct input_event
*beg
4121 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4122 ? kbd_buffer
: kbd_fetch_ptr
;
4125 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4126 else if (event
< beg
)
4128 if (event
> kbd_buffer
)
4129 memmove (kbd_buffer
+ 1, kbd_buffer
,
4130 (event
- kbd_buffer
) * sizeof (struct input_event
));
4131 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4132 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4133 memmove (beg
+ 1, beg
,
4134 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4135 * sizeof (struct input_event
));
4138 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4139 kbd_fetch_ptr
= kbd_buffer
+ 1;
4143 /* X wants last_event_timestamp for selection ownership. */
4144 last_event_timestamp
= copy
.timestamp
;
4145 input_pending
= readable_events (0);
4146 x_handle_selection_event (©
);
4148 /* We're getting selection request events, but we don't have
4156 /* Process any events that are not user-visible, run timer events that
4157 are ripe, and return, without reading any user-visible events. */
4160 swallow_events (bool do_display
)
4162 unsigned old_timers_run
;
4164 process_special_events ();
4166 old_timers_run
= timers_run
;
4167 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4169 if (timers_run
!= old_timers_run
&& do_display
)
4170 redisplay_preserve_echo_area (7);
4173 /* Record the start of when Emacs is idle,
4174 for the sake of running idle-time timers. */
4177 timer_start_idle (void)
4181 /* If we are already in the idle state, do nothing. */
4182 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4185 timer_idleness_start_time
= current_emacs_time ();
4186 timer_last_idleness_start_time
= timer_idleness_start_time
;
4188 /* Mark all idle-time timers as once again candidates for running. */
4189 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4193 timer
= XCAR (timers
);
4195 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4197 ASET (timer
, 0, Qnil
);
4201 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4204 timer_stop_idle (void)
4206 timer_idleness_start_time
= invalid_emacs_time ();
4209 /* Resume idle timer from last idle start time. */
4212 timer_resume_idle (void)
4214 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4217 timer_idleness_start_time
= timer_last_idleness_start_time
;
4220 /* This is only for debugging. */
4221 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4223 /* List of elisp functions to call, delayed because they were generated in
4224 a context where Elisp could not be safely run (e.g. redisplay, signal,
4225 ...). Each element has the form (FUN . ARGS). */
4226 Lisp_Object pending_funcalls
;
4228 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4230 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4232 Lisp_Object
*vector
;
4234 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4236 vector
= XVECTOR (timer
)->contents
;
4237 if (! NILP (vector
[0]))
4240 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4245 /* Check whether a timer has fired. To prevent larger problems we simply
4246 disregard elements that are not proper timers. Do not make a circular
4247 timer list for the time being.
4249 Returns the time to wait until the next timer fires. If a
4250 timer is triggering now, return zero.
4251 If no timer is active, return -1.
4253 If a timer is ripe, we run it, with quitting turned off.
4254 In that case we return 0 to indicate that a new timer_check_2 call
4258 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4260 EMACS_TIME nexttime
;
4262 EMACS_TIME idleness_now
;
4263 Lisp_Object chosen_timer
;
4264 struct gcpro gcpro1
;
4266 nexttime
= invalid_emacs_time ();
4268 chosen_timer
= Qnil
;
4269 GCPRO1 (chosen_timer
);
4271 /* First run the code that was delayed. */
4272 while (CONSP (pending_funcalls
))
4274 Lisp_Object funcall
= XCAR (pending_funcalls
);
4275 pending_funcalls
= XCDR (pending_funcalls
);
4276 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4279 if (CONSP (timers
) || CONSP (idle_timers
))
4281 now
= current_emacs_time ();
4282 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4283 ? sub_emacs_time (now
, timer_idleness_start_time
)
4284 : make_emacs_time (0, 0));
4287 while (CONSP (timers
) || CONSP (idle_timers
))
4289 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4290 EMACS_TIME timer_time
, idle_timer_time
;
4291 EMACS_TIME difference
;
4292 EMACS_TIME timer_difference
= invalid_emacs_time ();
4293 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4294 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4296 /* Set TIMER and TIMER_DIFFERENCE
4297 based on the next ordinary timer.
4298 TIMER_DIFFERENCE is the distance in time from NOW to when
4299 this timer becomes ripe (negative if it's already ripe).
4300 Skip past invalid timers and timers already handled. */
4303 timer
= XCAR (timers
);
4304 if (! decode_timer (timer
, &timer_time
))
4306 timers
= XCDR (timers
);
4310 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4311 timer_difference
= (timer_ripe
4312 ? sub_emacs_time (now
, timer_time
)
4313 : sub_emacs_time (timer_time
, now
));
4316 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4317 based on the next idle timer. */
4318 if (CONSP (idle_timers
))
4320 idle_timer
= XCAR (idle_timers
);
4321 if (! decode_timer (idle_timer
, &idle_timer_time
))
4323 idle_timers
= XCDR (idle_timers
);
4327 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4328 idle_timer_difference
=
4330 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4331 : sub_emacs_time (idle_timer_time
, idleness_now
));
4334 /* Decide which timer is the next timer,
4335 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4336 Also step down the list where we found that timer. */
4338 if (EMACS_TIME_VALID_P (timer_difference
)
4339 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4340 || idle_timer_ripe
< timer_ripe
4341 || (idle_timer_ripe
== timer_ripe
4343 ? EMACS_TIME_LT (idle_timer_difference
,
4345 : EMACS_TIME_LT (timer_difference
,
4346 idle_timer_difference
)))))
4348 chosen_timer
= timer
;
4349 timers
= XCDR (timers
);
4350 difference
= timer_difference
;
4355 chosen_timer
= idle_timer
;
4356 idle_timers
= XCDR (idle_timers
);
4357 difference
= idle_timer_difference
;
4358 ripe
= idle_timer_ripe
;
4361 /* If timer is ripe, run it if it hasn't been run. */
4364 if (NILP (AREF (chosen_timer
, 0)))
4366 ptrdiff_t count
= SPECPDL_INDEX ();
4367 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4369 /* Mark the timer as triggered to prevent problems if the lisp
4370 code fails to reschedule it right. */
4371 ASET (chosen_timer
, 0, Qt
);
4373 specbind (Qinhibit_quit
, Qt
);
4375 call1 (Qtimer_event_handler
, chosen_timer
);
4376 Vdeactivate_mark
= old_deactivate_mark
;
4378 unbind_to (count
, Qnil
);
4380 /* Since we have handled the event,
4381 we don't need to tell the caller to wake up and do it. */
4382 /* But the caller must still wait for the next timer, so
4383 return 0 to indicate that. */
4386 nexttime
= make_emacs_time (0, 0);
4390 /* When we encounter a timer that is still waiting,
4391 return the amount of time to wait before it is ripe. */
4398 /* No timers are pending in the future. */
4399 /* Return 0 if we generated an event, and -1 if not. */
4405 /* Check whether a timer has fired. To prevent larger problems we simply
4406 disregard elements that are not proper timers. Do not make a circular
4407 timer list for the time being.
4409 Returns the time to wait until the next timer fires.
4410 If no timer is active, return an invalid value.
4412 As long as any timer is ripe, we run it. */
4417 EMACS_TIME nexttime
;
4418 Lisp_Object timers
, idle_timers
;
4419 struct gcpro gcpro1
, gcpro2
;
4421 Lisp_Object tem
= Vinhibit_quit
;
4424 /* We use copies of the timers' lists to allow a timer to add itself
4425 again, without locking up Emacs if the newly added timer is
4426 already ripe when added. */
4428 /* Always consider the ordinary timers. */
4429 timers
= Fcopy_sequence (Vtimer_list
);
4430 /* Consider the idle timers only if Emacs is idle. */
4431 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4432 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4436 Vinhibit_quit
= tem
;
4438 GCPRO2 (timers
, idle_timers
);
4442 nexttime
= timer_check_2 (timers
, idle_timers
);
4444 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4450 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4451 doc
: /* Return the current length of Emacs idleness, or nil.
4452 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4453 in the same style as (current-time).
4455 The value when Emacs is not idle is nil.
4457 PSEC is a multiple of the system clock resolution. */)
4460 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4461 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4462 timer_idleness_start_time
));
4467 /* Caches for modify_event_symbol. */
4468 static Lisp_Object accent_key_syms
;
4469 static Lisp_Object func_key_syms
;
4470 static Lisp_Object mouse_syms
;
4471 static Lisp_Object wheel_syms
;
4472 static Lisp_Object drag_n_drop_syms
;
4474 /* This is a list of keysym codes for special "accent" characters.
4475 It parallels lispy_accent_keys. */
4477 static const int lispy_accent_codes
[] =
4479 #ifdef XK_dead_circumflex
4484 #ifdef XK_dead_grave
4489 #ifdef XK_dead_tilde
4494 #ifdef XK_dead_diaeresis
4499 #ifdef XK_dead_macron
4504 #ifdef XK_dead_degree
4509 #ifdef XK_dead_acute
4514 #ifdef XK_dead_cedilla
4519 #ifdef XK_dead_breve
4524 #ifdef XK_dead_ogonek
4529 #ifdef XK_dead_caron
4534 #ifdef XK_dead_doubleacute
4535 XK_dead_doubleacute
,
4539 #ifdef XK_dead_abovedot
4544 #ifdef XK_dead_abovering
4554 #ifdef XK_dead_belowdot
4559 #ifdef XK_dead_voiced_sound
4560 XK_dead_voiced_sound
,
4564 #ifdef XK_dead_semivoiced_sound
4565 XK_dead_semivoiced_sound
,
4581 /* This is a list of Lisp names for special "accent" characters.
4582 It parallels lispy_accent_codes. */
4584 static const char *const lispy_accent_keys
[] =
4602 "dead-voiced-sound",
4603 "dead-semivoiced-sound",
4609 #define FUNCTION_KEY_OFFSET 0x0
4611 const char *const lispy_function_keys
[] =
4615 0, /* VK_LBUTTON 0x01 */
4616 0, /* VK_RBUTTON 0x02 */
4617 "cancel", /* VK_CANCEL 0x03 */
4618 0, /* VK_MBUTTON 0x04 */
4620 0, 0, 0, /* 0x05 .. 0x07 */
4622 "backspace", /* VK_BACK 0x08 */
4623 "tab", /* VK_TAB 0x09 */
4625 0, 0, /* 0x0A .. 0x0B */
4627 "clear", /* VK_CLEAR 0x0C */
4628 "return", /* VK_RETURN 0x0D */
4630 0, 0, /* 0x0E .. 0x0F */
4632 0, /* VK_SHIFT 0x10 */
4633 0, /* VK_CONTROL 0x11 */
4634 0, /* VK_MENU 0x12 */
4635 "pause", /* VK_PAUSE 0x13 */
4636 "capslock", /* VK_CAPITAL 0x14 */
4637 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4639 "junja", /* VK_JUNJA 0x17 */
4640 "final", /* VK_FINAL 0x18 */
4641 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4643 "escape", /* VK_ESCAPE 0x1B */
4644 "convert", /* VK_CONVERT 0x1C */
4645 "non-convert", /* VK_NONCONVERT 0x1D */
4646 "accept", /* VK_ACCEPT 0x1E */
4647 "mode-change", /* VK_MODECHANGE 0x1F */
4648 0, /* VK_SPACE 0x20 */
4649 "prior", /* VK_PRIOR 0x21 */
4650 "next", /* VK_NEXT 0x22 */
4651 "end", /* VK_END 0x23 */
4652 "home", /* VK_HOME 0x24 */
4653 "left", /* VK_LEFT 0x25 */
4654 "up", /* VK_UP 0x26 */
4655 "right", /* VK_RIGHT 0x27 */
4656 "down", /* VK_DOWN 0x28 */
4657 "select", /* VK_SELECT 0x29 */
4658 "print", /* VK_PRINT 0x2A */
4659 "execute", /* VK_EXECUTE 0x2B */
4660 "snapshot", /* VK_SNAPSHOT 0x2C */
4661 "insert", /* VK_INSERT 0x2D */
4662 "delete", /* VK_DELETE 0x2E */
4663 "help", /* VK_HELP 0x2F */
4665 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4667 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4669 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4671 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4673 0, 0, 0, 0, 0, 0, 0, 0, 0,
4674 0, 0, 0, 0, 0, 0, 0, 0, 0,
4675 0, 0, 0, 0, 0, 0, 0, 0,
4677 "lwindow", /* VK_LWIN 0x5B */
4678 "rwindow", /* VK_RWIN 0x5C */
4679 "apps", /* VK_APPS 0x5D */
4682 "kp-0", /* VK_NUMPAD0 0x60 */
4683 "kp-1", /* VK_NUMPAD1 0x61 */
4684 "kp-2", /* VK_NUMPAD2 0x62 */
4685 "kp-3", /* VK_NUMPAD3 0x63 */
4686 "kp-4", /* VK_NUMPAD4 0x64 */
4687 "kp-5", /* VK_NUMPAD5 0x65 */
4688 "kp-6", /* VK_NUMPAD6 0x66 */
4689 "kp-7", /* VK_NUMPAD7 0x67 */
4690 "kp-8", /* VK_NUMPAD8 0x68 */
4691 "kp-9", /* VK_NUMPAD9 0x69 */
4692 "kp-multiply", /* VK_MULTIPLY 0x6A */
4693 "kp-add", /* VK_ADD 0x6B */
4694 "kp-separator", /* VK_SEPARATOR 0x6C */
4695 "kp-subtract", /* VK_SUBTRACT 0x6D */
4696 "kp-decimal", /* VK_DECIMAL 0x6E */
4697 "kp-divide", /* VK_DIVIDE 0x6F */
4698 "f1", /* VK_F1 0x70 */
4699 "f2", /* VK_F2 0x71 */
4700 "f3", /* VK_F3 0x72 */
4701 "f4", /* VK_F4 0x73 */
4702 "f5", /* VK_F5 0x74 */
4703 "f6", /* VK_F6 0x75 */
4704 "f7", /* VK_F7 0x76 */
4705 "f8", /* VK_F8 0x77 */
4706 "f9", /* VK_F9 0x78 */
4707 "f10", /* VK_F10 0x79 */
4708 "f11", /* VK_F11 0x7A */
4709 "f12", /* VK_F12 0x7B */
4710 "f13", /* VK_F13 0x7C */
4711 "f14", /* VK_F14 0x7D */
4712 "f15", /* VK_F15 0x7E */
4713 "f16", /* VK_F16 0x7F */
4714 "f17", /* VK_F17 0x80 */
4715 "f18", /* VK_F18 0x81 */
4716 "f19", /* VK_F19 0x82 */
4717 "f20", /* VK_F20 0x83 */
4718 "f21", /* VK_F21 0x84 */
4719 "f22", /* VK_F22 0x85 */
4720 "f23", /* VK_F23 0x86 */
4721 "f24", /* VK_F24 0x87 */
4723 0, 0, 0, 0, /* 0x88 .. 0x8B */
4724 0, 0, 0, 0, /* 0x8C .. 0x8F */
4726 "kp-numlock", /* VK_NUMLOCK 0x90 */
4727 "scroll", /* VK_SCROLL 0x91 */
4728 /* Not sure where the following block comes from.
4729 Windows headers have NEC and Fujitsu specific keys in
4730 this block, but nothing generic. */
4731 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4732 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4733 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4734 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4735 "kp-end", /* VK_NUMPAD_END 0x96 */
4736 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4737 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4738 "kp-up", /* VK_NUMPAD_UP 0x99 */
4739 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4740 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4741 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4742 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4744 0, 0, /* 0x9E .. 0x9F */
4747 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4748 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4749 * No other API or message will distinguish left and right keys this way.
4754 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4755 to enable them selectively, and gives access to a few more functions.
4756 See lispy_multimedia_keys below. */
4757 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4758 0, 0, 0, /* 0xAD .. 0xAF Volume */
4759 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4760 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4762 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4763 0, 0, 0, 0, 0, 0, 0, 0, 0,
4765 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4766 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4767 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4770 "ax", /* VK_OEM_AX 0xE1 */
4771 0, /* VK_OEM_102 0xE2 */
4772 "ico-help", /* VK_ICO_HELP 0xE3 */
4773 "ico-00", /* VK_ICO_00 0xE4 */
4774 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4775 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4776 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4778 "reset", /* VK_OEM_RESET 0xE9 */
4779 "jump", /* VK_OEM_JUMP 0xEA */
4780 "oem-pa1", /* VK_OEM_PA1 0xEB */
4781 "oem-pa2", /* VK_OEM_PA2 0xEC */
4782 "oem-pa3", /* VK_OEM_PA3 0xED */
4783 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4784 "cusel", /* VK_OEM_CUSEL 0xEF */
4785 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4786 "finish", /* VK_OEM_FINISH 0xF1 */
4787 "copy", /* VK_OEM_COPY 0xF2 */
4788 "auto", /* VK_OEM_AUTO 0xF3 */
4789 "enlw", /* VK_OEM_ENLW 0xF4 */
4790 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4791 "attn", /* VK_ATTN 0xF6 */
4792 "crsel", /* VK_CRSEL 0xF7 */
4793 "exsel", /* VK_EXSEL 0xF8 */
4794 "ereof", /* VK_EREOF 0xF9 */
4795 "play", /* VK_PLAY 0xFA */
4796 "zoom", /* VK_ZOOM 0xFB */
4797 "noname", /* VK_NONAME 0xFC */
4798 "pa1", /* VK_PA1 0xFD */
4799 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4803 /* Some of these duplicate the "Media keys" on newer keyboards,
4804 but they are delivered to the application in a different way. */
4805 static const char *const lispy_multimedia_keys
[] =
4813 "browser-favorites",
4850 "toggle-dictate-command",
4856 "media-fast-forward",
4859 "media-channel-down"
4862 #else /* not HAVE_NTGUI */
4864 /* This should be dealt with in XTread_socket now, and that doesn't
4865 depend on the client system having the Kana syms defined. See also
4866 the XK_kana_A case below. */
4869 static const char *const lispy_kana_keys
[] =
4871 /* X Keysym value */
4872 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4873 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4874 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4875 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4876 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4877 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4878 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4879 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4880 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4881 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4882 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4883 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4884 "kana-i", "kana-u", "kana-e", "kana-o",
4885 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4886 "prolongedsound", "kana-A", "kana-I", "kana-U",
4887 "kana-E", "kana-O", "kana-KA", "kana-KI",
4888 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4889 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4890 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4891 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4892 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4893 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4894 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4895 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4896 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4897 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4901 #endif /* XK_kana_A */
4904 #define FUNCTION_KEY_OFFSET 0xff00
4906 /* You'll notice that this table is arranged to be conveniently
4907 indexed by X Windows keysym values. */
4908 static const char *const lispy_function_keys
[] =
4910 /* X Keysym value */
4912 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4913 "backspace", "tab", "linefeed", "clear",
4915 0, 0, 0, "pause", /* 0xff10...1f */
4916 0, 0, 0, 0, 0, 0, 0, "escape",
4918 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4919 "romaji", "hiragana", "katakana", "hiragana-katakana",
4920 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4921 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4922 "eisu-toggle", /* 0xff30...3f */
4923 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4924 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4926 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4927 "down", "prior", "next", "end",
4928 "begin", 0, 0, 0, 0, 0, 0, 0,
4929 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4940 "break", /* 0xff6b */
4943 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4944 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4945 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4946 0, 0, 0, 0, 0, 0, 0, 0,
4947 "kp-tab", /* 0xff89 */
4949 "kp-enter", /* 0xff8d */
4951 "kp-f1", /* 0xff91 */
4955 "kp-home", /* 0xff95 */
4960 "kp-prior", /* kp-page-up */
4961 "kp-next", /* kp-page-down */
4967 0, 0, 0, 0, 0, 0, 0, 0, 0,
4968 "kp-multiply", /* 0xffaa */
4973 "kp-divide", /* 0xffaf */
4974 "kp-0", /* 0xffb0 */
4975 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4978 "kp-equal", /* 0xffbd */
4979 "f1", /* 0xffbe */ /* IsFunctionKey */
4981 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4982 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4983 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4984 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4985 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4986 0, 0, 0, 0, 0, 0, 0, 0,
4987 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4988 0, 0, 0, 0, 0, 0, 0, "delete"
4991 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4992 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4994 static const char *const iso_lispy_function_keys
[] =
4996 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4997 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4998 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4999 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5000 "iso-lefttab", /* 0xfe20 */
5001 "iso-move-line-up", "iso-move-line-down",
5002 "iso-partial-line-up", "iso-partial-line-down",
5003 "iso-partial-space-left", "iso-partial-space-right",
5004 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5005 "iso-release-margin-left", "iso-release-margin-right",
5006 "iso-release-both-margins",
5007 "iso-fast-cursor-left", "iso-fast-cursor-right",
5008 "iso-fast-cursor-up", "iso-fast-cursor-down",
5009 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5010 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5013 #endif /* not HAVE_NTGUI */
5015 static Lisp_Object Vlispy_mouse_stem
;
5017 static const char *const lispy_wheel_names
[] =
5019 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5022 /* drag-n-drop events are generated when a set of selected files are
5023 dragged from another application and dropped onto an Emacs window. */
5024 static const char *const lispy_drag_n_drop_names
[] =
5029 /* Scroll bar parts. */
5030 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5031 Lisp_Object Qup
, Qdown
, Qbottom
;
5032 static Lisp_Object Qend_scroll
;
5034 static Lisp_Object Qratio
;
5036 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5037 static Lisp_Object
*const scroll_bar_parts
[] = {
5038 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5039 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5042 /* A vector, indexed by button number, giving the down-going location
5043 of currently depressed buttons, both scroll bar and non-scroll bar.
5045 The elements have the form
5046 (BUTTON-NUMBER MODIFIER-MASK . REST)
5047 where REST is the cdr of a position as it would be reported in the event.
5049 The make_lispy_event function stores positions here to tell the
5050 difference between click and drag events, and to store the starting
5051 location to be included in drag events. */
5053 static Lisp_Object button_down_location
;
5055 /* Information about the most recent up-going button event: Which
5056 button, what location, and what time. */
5058 static int last_mouse_button
;
5059 static int last_mouse_x
;
5060 static int last_mouse_y
;
5061 static Time button_down_time
;
5063 /* The number of clicks in this multiple-click. */
5065 static int double_click_count
;
5067 /* X and Y are frame-relative coordinates for a click or wheel event.
5068 Return a Lisp-style event list. */
5071 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5074 enum window_part part
;
5075 Lisp_Object posn
= Qnil
;
5076 Lisp_Object extra_info
= Qnil
;
5077 /* Coordinate pixel positions to return. */
5078 int xret
= 0, yret
= 0;
5079 /* The window under frame pixel coordinates (x,y) */
5080 Lisp_Object window
= f
5081 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5084 if (WINDOWP (window
))
5086 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5087 struct window
*w
= XWINDOW (window
);
5088 Lisp_Object string_info
= Qnil
;
5089 ptrdiff_t textpos
= -1;
5090 int col
= -1, row
= -1;
5091 int dx
= -1, dy
= -1;
5092 int width
= -1, height
= -1;
5093 Lisp_Object object
= Qnil
;
5095 /* Pixel coordinates relative to the window corner. */
5096 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5097 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5099 /* For text area clicks, return X, Y relative to the corner of
5100 this text area. Note that dX, dY etc are set below, by
5101 buffer_posn_from_coords. */
5102 if (part
== ON_TEXT
)
5104 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5105 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5107 /* For mode line and header line clicks, return X, Y relative to
5108 the left window edge. Use mode_line_string to look for a
5109 string on the click position. */
5110 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5115 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5116 /* Note that mode_line_string takes COL, ROW as pixels and
5117 converts them to characters. */
5120 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5121 &object
, &dx
, &dy
, &width
, &height
);
5122 if (STRINGP (string
))
5123 string_info
= Fcons (string
, make_number (charpos
));
5124 textpos
= (w
== XWINDOW (selected_window
)
5125 && current_buffer
== XBUFFER (w
->buffer
))
5126 ? PT
: XMARKER (w
->pointm
)->charpos
;
5131 /* For fringes and margins, Y is relative to the area's (and the
5132 window's) top edge, while X is meaningless. */
5133 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5138 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5141 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5142 &object
, &dx
, &dy
, &width
, &height
);
5143 if (STRINGP (string
))
5144 string_info
= Fcons (string
, make_number (charpos
));
5145 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5147 else if (part
== ON_LEFT_FRINGE
)
5149 posn
= Qleft_fringe
;
5152 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5153 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5154 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5156 else if (part
== ON_RIGHT_FRINGE
)
5158 posn
= Qright_fringe
;
5161 - window_box_width (w
, LEFT_MARGIN_AREA
)
5162 - window_box_width (w
, TEXT_AREA
)
5163 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5164 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5166 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5168 else if (part
== ON_VERTICAL_BORDER
)
5170 posn
= Qvertical_line
;
5175 /* Nothing special for part == ON_SCROLL_BAR. */
5177 /* For clicks in the text area, fringes, or margins, call
5178 buffer_posn_from_coords to extract TEXTPOS, the buffer
5179 position nearest to the click. */
5182 Lisp_Object string2
, object2
= Qnil
;
5183 struct display_pos p
;
5185 int width2
, height2
;
5186 /* The pixel X coordinate passed to buffer_posn_from_coords
5187 is the X coordinate relative to the text area for
5188 text-area and right-margin clicks, zero otherwise. */
5190 = (part
== ON_TEXT
) ? xret
5191 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5192 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5196 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5197 &object2
, &dx2
, &dy2
,
5199 textpos
= CHARPOS (p
.pos
);
5200 if (col
< 0) col
= x2
;
5201 if (row
< 0) row
= y2
;
5202 if (dx
< 0) dx
= dx2
;
5203 if (dy
< 0) dy
= dy2
;
5204 if (width
< 0) width
= width2
;
5205 if (height
< 0) height
= height2
;
5209 posn
= make_number (textpos
);
5210 if (STRINGP (string2
))
5211 string_info
= Fcons (string2
,
5212 make_number (CHARPOS (p
.string_pos
)));
5218 #ifdef HAVE_WINDOW_SYSTEM
5219 if (IMAGEP (object
))
5221 Lisp_Object image_map
, hotspot
;
5222 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5224 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5226 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5227 posn
= XCAR (hotspot
);
5234 Fcons (make_number (dx
), make_number (dy
)),
5235 Fcons (make_number (width
), make_number (height
)));
5238 extra_info
= Fcons (string_info
,
5239 Fcons (make_number (textpos
),
5240 Fcons (Fcons (make_number (col
),
5245 XSETFRAME (window
, f
);
5249 return Fcons (window
,
5251 Fcons (Fcons (make_number (xret
),
5252 make_number (yret
)),
5253 Fcons (make_number (t
),
5257 /* Given a struct input_event, build the lisp event which represents
5258 it. If EVENT is 0, build a mouse movement event from the mouse
5259 movement buffer, which should have a movement event in it.
5261 Note that events must be passed to this function in the order they
5262 are received; this function stores the location of button presses
5263 in order to build drag events when the button is released. */
5266 make_lispy_event (struct input_event
*event
)
5270 switch (event
->kind
)
5272 /* A simple keystroke. */
5273 case ASCII_KEYSTROKE_EVENT
:
5274 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5276 Lisp_Object lispy_c
;
5277 EMACS_INT c
= event
->code
;
5278 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5281 eassert (c
== event
->code
);
5282 /* Turn ASCII characters into control characters
5284 if (event
->modifiers
& ctrl_modifier
)
5286 c
= make_ctrl_char (c
);
5287 event
->modifiers
&= ~ctrl_modifier
;
5291 /* Add in the other modifier bits. The shift key was taken care
5292 of by the X code. */
5293 c
|= (event
->modifiers
5294 & (meta_modifier
| alt_modifier
5295 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5296 /* Distinguish Shift-SPC from SPC. */
5297 if ((event
->code
) == 040
5298 && event
->modifiers
& shift_modifier
)
5299 c
|= shift_modifier
;
5300 button_down_time
= 0;
5301 XSETFASTINT (lispy_c
, c
);
5306 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5307 except that they are non-key events (last-nonmenu-event is nil). */
5308 case NS_NONKEY_EVENT
:
5311 /* A function key. The symbol may need to have modifier prefixes
5313 case NON_ASCII_KEYSTROKE_EVENT
:
5314 button_down_time
= 0;
5316 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5317 if (event
->code
== lispy_accent_codes
[i
])
5318 return modify_event_symbol (i
,
5320 Qfunction_key
, Qnil
,
5321 lispy_accent_keys
, &accent_key_syms
,
5322 (sizeof (lispy_accent_keys
)
5323 / sizeof (lispy_accent_keys
[0])));
5327 if (event
->code
>= 0x400 && event
->code
< 0x500)
5328 return modify_event_symbol (event
->code
- 0x400,
5329 event
->modifiers
& ~shift_modifier
,
5330 Qfunction_key
, Qnil
,
5331 lispy_kana_keys
, &func_key_syms
,
5332 (sizeof (lispy_kana_keys
)
5333 / sizeof (lispy_kana_keys
[0])));
5334 #endif /* XK_kana_A */
5337 #ifdef ISO_FUNCTION_KEY_OFFSET
5338 if (event
->code
< FUNCTION_KEY_OFFSET
5339 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5340 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5342 Qfunction_key
, Qnil
,
5343 iso_lispy_function_keys
, &func_key_syms
,
5344 (sizeof (iso_lispy_function_keys
)
5345 / sizeof (iso_lispy_function_keys
[0])));
5348 /* Handle system-specific or unknown keysyms. */
5349 if (event
->code
& (1 << 28)
5350 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5351 || (event
->code
- FUNCTION_KEY_OFFSET
5352 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5353 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5355 /* We need to use an alist rather than a vector as the cache
5356 since we can't make a vector long enough. */
5357 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5358 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5359 return modify_event_symbol (event
->code
,
5362 KVAR (current_kboard
, Vsystem_key_alist
),
5363 0, &KVAR (current_kboard
, system_key_syms
),
5367 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5369 Qfunction_key
, Qnil
,
5370 lispy_function_keys
, &func_key_syms
,
5371 (sizeof (lispy_function_keys
)
5372 / sizeof (lispy_function_keys
[0])));
5375 case MULTIMEDIA_KEY_EVENT
:
5376 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5377 / sizeof (lispy_multimedia_keys
[0]))
5378 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5380 return modify_event_symbol (event
->code
, event
->modifiers
,
5381 Qfunction_key
, Qnil
,
5382 lispy_multimedia_keys
, &func_key_syms
,
5383 (sizeof (lispy_multimedia_keys
)
5384 / sizeof (lispy_multimedia_keys
[0])));
5389 /* A mouse click. Figure out where it is, decide whether it's
5390 a press, click or drag, and build the appropriate structure. */
5391 case MOUSE_CLICK_EVENT
:
5392 #ifndef USE_TOOLKIT_SCROLL_BARS
5393 case SCROLL_BAR_CLICK_EVENT
:
5396 int button
= event
->code
;
5398 Lisp_Object position
;
5399 Lisp_Object
*start_pos_ptr
;
5400 Lisp_Object start_pos
;
5404 /* Build the position as appropriate for this mouse click. */
5405 if (event
->kind
== MOUSE_CLICK_EVENT
)
5407 struct frame
*f
= XFRAME (event
->frame_or_window
);
5408 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5412 /* Ignore mouse events that were made on frame that
5413 have been deleted. */
5414 if (! FRAME_LIVE_P (f
))
5417 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5418 /* EVENT->x and EVENT->y are frame-relative pixel
5419 coordinates at this place. Under old redisplay, COLUMN
5420 and ROW are set to frame relative glyph coordinates
5421 which are then used to determine whether this click is
5422 in a menu (non-toolkit version). */
5423 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5424 &column
, &row
, NULL
, 1);
5426 /* In the non-toolkit version, clicks on the menu bar
5427 are ordinary button events in the event buffer.
5428 Distinguish them, and invoke the menu.
5430 (In the toolkit version, the toolkit handles the menu bar
5431 and Emacs doesn't know about it until after the user
5432 makes a selection.) */
5433 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5434 && (event
->modifiers
& down_modifier
))
5436 Lisp_Object items
, item
;
5438 /* Find the menu bar item under `column'. */
5440 items
= FRAME_MENU_BAR_ITEMS (f
);
5441 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5443 Lisp_Object pos
, string
;
5444 string
= AREF (items
, i
+ 1);
5445 pos
= AREF (items
, i
+ 3);
5448 if (column
>= XINT (pos
)
5449 && column
< XINT (pos
) + SCHARS (string
))
5451 item
= AREF (items
, i
);
5456 /* ELisp manual 2.4b says (x y) are window relative but
5457 code says they are frame-relative. */
5459 = Fcons (event
->frame_or_window
,
5461 Fcons (Fcons (event
->x
, event
->y
),
5462 Fcons (make_number (event
->timestamp
),
5465 return Fcons (item
, Fcons (position
, Qnil
));
5467 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5469 position
= make_lispy_position (f
, event
->x
, event
->y
,
5472 #ifndef USE_TOOLKIT_SCROLL_BARS
5475 /* It's a scrollbar click. */
5477 Lisp_Object portion_whole
;
5480 window
= event
->frame_or_window
;
5481 portion_whole
= Fcons (event
->x
, event
->y
);
5482 part
= *scroll_bar_parts
[(int) event
->part
];
5486 Fcons (Qvertical_scroll_bar
,
5487 Fcons (portion_whole
,
5488 Fcons (make_number (event
->timestamp
),
5489 Fcons (part
, Qnil
)))));
5491 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5493 if (button
>= ASIZE (button_down_location
))
5495 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5496 button_down_location
= larger_vector (button_down_location
,
5498 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5501 start_pos_ptr
= aref_addr (button_down_location
, button
);
5502 start_pos
= *start_pos_ptr
;
5503 *start_pos_ptr
= Qnil
;
5506 /* On window-system frames, use the value of
5507 double-click-fuzz as is. On other frames, interpret it
5508 as a multiple of 1/8 characters. */
5512 if (WINDOWP (event
->frame_or_window
))
5513 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5514 else if (FRAMEP (event
->frame_or_window
))
5515 f
= XFRAME (event
->frame_or_window
);
5519 if (FRAME_WINDOW_P (f
))
5520 fuzz
= double_click_fuzz
;
5522 fuzz
= double_click_fuzz
/ 8;
5524 is_double
= (button
== last_mouse_button
5525 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5526 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5527 && button_down_time
!= 0
5528 && (EQ (Vdouble_click_time
, Qt
)
5529 || (NATNUMP (Vdouble_click_time
)
5530 && (event
->timestamp
- button_down_time
5531 < XFASTINT (Vdouble_click_time
)))));
5534 last_mouse_button
= button
;
5535 last_mouse_x
= XINT (event
->x
);
5536 last_mouse_y
= XINT (event
->y
);
5538 /* If this is a button press, squirrel away the location, so
5539 we can decide later whether it was a click or a drag. */
5540 if (event
->modifiers
& down_modifier
)
5544 double_click_count
++;
5545 event
->modifiers
|= ((double_click_count
> 2)
5550 double_click_count
= 1;
5551 button_down_time
= event
->timestamp
;
5552 *start_pos_ptr
= Fcopy_alist (position
);
5553 ignore_mouse_drag_p
= 0;
5556 /* Now we're releasing a button - check the co-ordinates to
5557 see if this was a click or a drag. */
5558 else if (event
->modifiers
& up_modifier
)
5560 /* If we did not see a down before this up, ignore the up.
5561 Probably this happened because the down event chose a
5562 menu item. It would be an annoyance to treat the
5563 release of the button that chose the menu item as a
5566 if (!CONSP (start_pos
))
5569 event
->modifiers
&= ~up_modifier
;
5572 Lisp_Object new_down
, down
;
5573 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5575 /* The third element of every position
5576 should be the (x,y) pair. */
5577 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5578 new_down
= Fcar (Fcdr (Fcdr (position
)));
5581 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5583 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5584 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5587 if (ignore_mouse_drag_p
)
5589 event
->modifiers
|= click_modifier
;
5590 ignore_mouse_drag_p
= 0;
5592 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5593 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5594 /* Maybe the mouse has moved a lot, caused scrolling, and
5595 eventually ended up at the same screen position (but
5596 not buffer position) in which case it is a drag, not
5598 /* FIXME: OTOH if the buffer position has changed
5599 because of a timer or process filter rather than
5600 because of mouse movement, it should be considered as
5601 a click. But mouse-drag-region completely ignores
5602 this case and it hasn't caused any real problem, so
5603 it's probably OK to ignore it as well. */
5604 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5605 /* Mouse hasn't moved (much). */
5606 event
->modifiers
|= click_modifier
;
5609 button_down_time
= 0;
5610 event
->modifiers
|= drag_modifier
;
5613 /* Don't check is_double; treat this as multiple
5614 if the down-event was multiple. */
5615 if (double_click_count
> 1)
5616 event
->modifiers
|= ((double_click_count
> 2)
5622 /* Every mouse event should either have the down_modifier or
5623 the up_modifier set. */
5627 /* Get the symbol we should use for the mouse click. */
5630 head
= modify_event_symbol (button
,
5632 Qmouse_click
, Vlispy_mouse_stem
,
5635 ASIZE (mouse_syms
));
5636 if (event
->modifiers
& drag_modifier
)
5641 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5644 Fcons (make_number (double_click_count
),
5654 case HORIZ_WHEEL_EVENT
:
5656 Lisp_Object position
;
5659 /* Build the position as appropriate for this mouse click. */
5660 struct frame
*f
= XFRAME (event
->frame_or_window
);
5662 /* Ignore wheel events that were made on frame that have been
5664 if (! FRAME_LIVE_P (f
))
5667 position
= make_lispy_position (f
, event
->x
, event
->y
,
5670 /* Set double or triple modifiers to indicate the wheel speed. */
5672 /* On window-system frames, use the value of
5673 double-click-fuzz as is. On other frames, interpret it
5674 as a multiple of 1/8 characters. */
5680 if (WINDOWP (event
->frame_or_window
))
5681 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5682 else if (FRAMEP (event
->frame_or_window
))
5683 fr
= XFRAME (event
->frame_or_window
);
5687 fuzz
= FRAME_WINDOW_P (fr
)
5688 ? double_click_fuzz
: double_click_fuzz
/ 8;
5690 if (event
->modifiers
& up_modifier
)
5692 /* Emit a wheel-up event. */
5693 event
->modifiers
&= ~up_modifier
;
5696 else if (event
->modifiers
& down_modifier
)
5698 /* Emit a wheel-down event. */
5699 event
->modifiers
&= ~down_modifier
;
5703 /* Every wheel event should either have the down_modifier or
5704 the up_modifier set. */
5707 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5710 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5711 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5712 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5713 && button_down_time
!= 0
5714 && (EQ (Vdouble_click_time
, Qt
)
5715 || (NATNUMP (Vdouble_click_time
)
5716 && (event
->timestamp
- button_down_time
5717 < XFASTINT (Vdouble_click_time
)))));
5720 double_click_count
++;
5721 event
->modifiers
|= ((double_click_count
> 2)
5727 double_click_count
= 1;
5728 event
->modifiers
|= click_modifier
;
5731 button_down_time
= event
->timestamp
;
5732 /* Use a negative value to distinguish wheel from mouse button. */
5733 last_mouse_button
= - (1 + symbol_num
);
5734 last_mouse_x
= XINT (event
->x
);
5735 last_mouse_y
= XINT (event
->y
);
5737 /* Get the symbol we should use for the wheel event. */
5738 head
= modify_event_symbol (symbol_num
,
5744 ASIZE (wheel_syms
));
5747 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5750 Fcons (make_number (double_click_count
),
5759 #ifdef USE_TOOLKIT_SCROLL_BARS
5761 /* We don't have down and up events if using toolkit scroll bars,
5762 so make this always a click event. Store in the `part' of
5763 the Lisp event a symbol which maps to the following actions:
5765 `above_handle' page up
5766 `below_handle' page down
5770 `bottom' bottom of buffer
5771 `handle' thumb has been dragged.
5772 `end-scroll' end of interaction with scroll bar
5774 The incoming input_event contains in its `part' member an
5775 index of type `enum scroll_bar_part' which we can use as an
5776 index in scroll_bar_parts to get the appropriate symbol. */
5778 case SCROLL_BAR_CLICK_EVENT
:
5780 Lisp_Object position
, head
, window
, portion_whole
, part
;
5782 window
= event
->frame_or_window
;
5783 portion_whole
= Fcons (event
->x
, event
->y
);
5784 part
= *scroll_bar_parts
[(int) event
->part
];
5788 Fcons (Qvertical_scroll_bar
,
5789 Fcons (portion_whole
,
5790 Fcons (make_number (event
->timestamp
),
5791 Fcons (part
, Qnil
)))));
5793 /* Always treat scroll bar events as clicks. */
5794 event
->modifiers
|= click_modifier
;
5795 event
->modifiers
&= ~up_modifier
;
5797 if (event
->code
>= ASIZE (mouse_syms
))
5798 mouse_syms
= larger_vector (mouse_syms
,
5799 event
->code
- ASIZE (mouse_syms
) + 1,
5802 /* Get the symbol we should use for the mouse click. */
5803 head
= modify_event_symbol (event
->code
,
5808 ASIZE (mouse_syms
));
5809 return Fcons (head
, Fcons (position
, Qnil
));
5812 #endif /* USE_TOOLKIT_SCROLL_BARS */
5814 case DRAG_N_DROP_EVENT
:
5817 Lisp_Object head
, position
;
5820 f
= XFRAME (event
->frame_or_window
);
5823 /* Ignore mouse events that were made on frames that
5824 have been deleted. */
5825 if (! FRAME_LIVE_P (f
))
5828 position
= make_lispy_position (f
, event
->x
, event
->y
,
5831 head
= modify_event_symbol (0, event
->modifiers
,
5833 lispy_drag_n_drop_names
,
5834 &drag_n_drop_syms
, 1);
5841 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5842 || defined (HAVE_NS) || defined (USE_GTK)
5843 case MENU_BAR_EVENT
:
5844 if (EQ (event
->arg
, event
->frame_or_window
))
5845 /* This is the prefix key. We translate this to
5846 `(menu_bar)' because the code in keyboard.c for menu
5847 events, which we use, relies on this. */
5848 return Fcons (Qmenu_bar
, Qnil
);
5852 case SELECT_WINDOW_EVENT
:
5853 /* Make an event (select-window (WINDOW)). */
5854 return Fcons (Qselect_window
,
5855 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5858 case TOOL_BAR_EVENT
:
5859 if (EQ (event
->arg
, event
->frame_or_window
))
5860 /* This is the prefix key. We translate this to
5861 `(tool_bar)' because the code in keyboard.c for tool bar
5862 events, which we use, relies on this. */
5863 return Fcons (Qtool_bar
, Qnil
);
5864 else if (SYMBOLP (event
->arg
))
5865 return apply_modifiers (event
->modifiers
, event
->arg
);
5868 case USER_SIGNAL_EVENT
:
5869 /* A user signal. */
5871 char *name
= find_user_signal_name (event
->code
);
5874 return intern (name
);
5877 case SAVE_SESSION_EVENT
:
5878 return Qsave_session
;
5883 return Fcons (Qdbus_event
, event
->arg
);
5885 #endif /* HAVE_DBUS */
5888 case FILE_NOTIFY_EVENT
:
5890 return Fcons (Qfile_inotify
, event
->arg
);
5892 #endif /* HAVE_INOTIFY */
5894 case CONFIG_CHANGED_EVENT
:
5895 return Fcons (Qconfig_changed_event
,
5897 Fcons (event
->frame_or_window
, Qnil
)));
5899 case GPM_CLICK_EVENT
:
5901 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5902 Lisp_Object head
, position
;
5903 Lisp_Object
*start_pos_ptr
;
5904 Lisp_Object start_pos
;
5905 int button
= event
->code
;
5907 if (button
>= ASIZE (button_down_location
))
5909 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5910 button_down_location
= larger_vector (button_down_location
,
5912 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5915 start_pos_ptr
= aref_addr (button_down_location
, button
);
5916 start_pos
= *start_pos_ptr
;
5918 position
= make_lispy_position (f
, event
->x
, event
->y
,
5921 if (event
->modifiers
& down_modifier
)
5922 *start_pos_ptr
= Fcopy_alist (position
);
5923 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5925 if (!CONSP (start_pos
))
5927 event
->modifiers
&= ~up_modifier
;
5930 head
= modify_event_symbol (button
,
5932 Qmouse_click
, Vlispy_mouse_stem
,
5935 ASIZE (mouse_syms
));
5937 if (event
->modifiers
& drag_modifier
)
5942 else if (event
->modifiers
& double_modifier
)
5945 Fcons (make_number (2),
5947 else if (event
->modifiers
& triple_modifier
)
5950 Fcons (make_number (3),
5957 #endif /* HAVE_GPM */
5959 /* The 'kind' field of the event is something we don't recognize. */
5966 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5967 Lisp_Object x
, Lisp_Object y
, Time t
)
5969 /* Is it a scroll bar movement? */
5970 if (frame
&& ! NILP (bar_window
))
5972 Lisp_Object part_sym
;
5974 part_sym
= *scroll_bar_parts
[(int) part
];
5975 return Fcons (Qscroll_bar_movement
,
5976 Fcons (list5 (bar_window
,
5977 Qvertical_scroll_bar
,
5983 /* Or is it an ordinary mouse movement? */
5986 Lisp_Object position
;
5987 position
= make_lispy_position (frame
, x
, y
, t
);
5988 return list2 (Qmouse_movement
, position
);
5992 /* Construct a switch frame event. */
5994 make_lispy_switch_frame (Lisp_Object frame
)
5996 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5999 /* Manipulating modifiers. */
6001 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6003 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6004 SYMBOL's name of the end of the modifiers; the string from this
6005 position is the unmodified symbol name.
6007 This doesn't use any caches. */
6010 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6016 CHECK_SYMBOL (symbol
);
6019 name
= SYMBOL_NAME (symbol
);
6021 for (i
= 0; i
< SBYTES (name
) - 1; )
6023 ptrdiff_t this_mod_end
= 0;
6026 /* See if the name continues with a modifier word.
6027 Check that the word appears, but don't check what follows it.
6028 Set this_mod and this_mod_end to record what we find. */
6030 switch (SREF (name
, i
))
6032 #define SINGLE_LETTER_MOD(BIT) \
6033 (this_mod_end = i + 1, this_mod = BIT)
6036 SINGLE_LETTER_MOD (alt_modifier
);
6040 SINGLE_LETTER_MOD (ctrl_modifier
);
6044 SINGLE_LETTER_MOD (hyper_modifier
);
6048 SINGLE_LETTER_MOD (meta_modifier
);
6052 SINGLE_LETTER_MOD (shift_modifier
);
6056 SINGLE_LETTER_MOD (super_modifier
);
6059 #undef SINGLE_LETTER_MOD
6061 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6062 if (i + LEN + 1 <= SBYTES (name) \
6063 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6065 this_mod_end = i + LEN; \
6070 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6071 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6072 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6076 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6078 #undef MULTI_LETTER_MOD
6082 /* If we found no modifier, stop looking for them. */
6083 if (this_mod_end
== 0)
6086 /* Check there is a dash after the modifier, so that it
6087 really is a modifier. */
6088 if (this_mod_end
>= SBYTES (name
)
6089 || SREF (name
, this_mod_end
) != '-')
6092 /* This modifier is real; look for another. */
6093 modifiers
|= this_mod
;
6094 i
= this_mod_end
+ 1;
6097 /* Should we include the `click' modifier? */
6098 if (! (modifiers
& (down_modifier
| drag_modifier
6099 | double_modifier
| triple_modifier
))
6100 && i
+ 7 == SBYTES (name
)
6101 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6102 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6103 modifiers
|= click_modifier
;
6105 if (! (modifiers
& (double_modifier
| triple_modifier
))
6106 && i
+ 6 < SBYTES (name
)
6107 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6108 modifiers
|= click_modifier
;
6116 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6117 prepended to the string BASE[0..BASE_LEN-1].
6118 This doesn't use any caches. */
6120 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6122 /* Since BASE could contain nulls, we can't use intern here; we have
6123 to use Fintern, which expects a genuine Lisp_String, and keeps a
6125 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6131 /* Only the event queue may use the `up' modifier; it should always
6132 be turned into a click or drag event before presented to lisp code. */
6133 if (modifiers
& up_modifier
)
6136 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6137 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6138 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6139 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6140 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6141 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6142 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6143 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6144 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6145 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6146 /* The click modifier is denoted by the absence of other modifiers. */
6150 mod_len
= p
- new_mods
;
6154 Lisp_Object new_name
;
6156 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6157 mod_len
+ base_len_byte
);
6158 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6159 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6161 return Fintern (new_name
, Qnil
);
6166 static const char *const modifier_names
[] =
6168 "up", "down", "drag", "click", "double", "triple", 0, 0,
6169 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6170 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6172 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6174 static Lisp_Object modifier_symbols
;
6176 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6178 lispy_modifier_list (int modifiers
)
6180 Lisp_Object modifier_list
;
6183 modifier_list
= Qnil
;
6184 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6185 if (modifiers
& (1<<i
))
6186 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6189 return modifier_list
;
6193 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6194 where UNMODIFIED is the unmodified form of SYMBOL,
6195 MASK is the set of modifiers present in SYMBOL's name.
6196 This is similar to parse_modifiers_uncached, but uses the cache in
6197 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6198 Qevent_symbol_elements property. */
6200 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6203 parse_modifiers (Lisp_Object symbol
)
6205 Lisp_Object elements
;
6207 if (INTEGERP (symbol
))
6208 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6209 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6211 else if (!SYMBOLP (symbol
))
6214 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6215 if (CONSP (elements
))
6220 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6221 Lisp_Object unmodified
;
6224 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6225 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6228 if (modifiers
& ~INTMASK
)
6230 XSETFASTINT (mask
, modifiers
);
6231 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6233 /* Cache the parsing results on SYMBOL. */
6234 Fput (symbol
, Qevent_symbol_element_mask
,
6236 Fput (symbol
, Qevent_symbol_elements
,
6237 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6239 /* Since we know that SYMBOL is modifiers applied to unmodified,
6240 it would be nice to put that in unmodified's cache.
6241 But we can't, since we're not sure that parse_modifiers is
6248 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6249 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6250 doc
: /* Parse the event symbol. For internal use. */)
6251 (Lisp_Object symbol
)
6253 /* Fill the cache if needed. */
6254 parse_modifiers (symbol
);
6255 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6256 and use the Lispier representation stored on Qevent_symbol_elements
6258 return Fget (symbol
, Qevent_symbol_elements
);
6261 /* Apply the modifiers MODIFIERS to the symbol BASE.
6262 BASE must be unmodified.
6264 This is like apply_modifiers_uncached, but uses BASE's
6265 Qmodifier_cache property, if present. It also builds
6266 Qevent_symbol_elements properties, since it has that info anyway.
6268 apply_modifiers copies the value of BASE's Qevent_kind property to
6269 the modified symbol. */
6271 apply_modifiers (int modifiers
, Lisp_Object base
)
6273 Lisp_Object cache
, idx
, entry
, new_symbol
;
6275 /* Mask out upper bits. We don't know where this value's been. */
6276 modifiers
&= INTMASK
;
6278 if (INTEGERP (base
))
6279 return make_number (XINT (base
) | modifiers
);
6281 /* The click modifier never figures into cache indices. */
6282 cache
= Fget (base
, Qmodifier_cache
);
6283 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6284 entry
= assq_no_quit (idx
, cache
);
6287 new_symbol
= XCDR (entry
);
6290 /* We have to create the symbol ourselves. */
6291 new_symbol
= apply_modifiers_uncached (modifiers
,
6292 SSDATA (SYMBOL_NAME (base
)),
6293 SCHARS (SYMBOL_NAME (base
)),
6294 SBYTES (SYMBOL_NAME (base
)));
6296 /* Add the new symbol to the base's cache. */
6297 entry
= Fcons (idx
, new_symbol
);
6298 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6300 /* We have the parsing info now for free, so we could add it to
6302 XSETFASTINT (idx, modifiers);
6303 Fput (new_symbol, Qevent_symbol_element_mask,
6304 Fcons (base, Fcons (idx, Qnil)));
6305 Fput (new_symbol, Qevent_symbol_elements,
6306 Fcons (base, lispy_modifier_list (modifiers)));
6307 Sadly, this is only correct if `base' is indeed a base event,
6308 which is not necessarily the case. -stef */
6311 /* Make sure this symbol is of the same kind as BASE.
6313 You'd think we could just set this once and for all when we
6314 intern the symbol above, but reorder_modifiers may call us when
6315 BASE's property isn't set right; we can't assume that just
6316 because it has a Qmodifier_cache property it must have its
6317 Qevent_kind set right as well. */
6318 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6322 kind
= Fget (base
, Qevent_kind
);
6324 Fput (new_symbol
, Qevent_kind
, kind
);
6331 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6332 return a symbol with the modifiers placed in the canonical order.
6333 Canonical order is alphabetical, except for down and drag, which
6334 always come last. The 'click' modifier is never written out.
6336 Fdefine_key calls this to make sure that (for example) C-M-foo
6337 and M-C-foo end up being equivalent in the keymap. */
6340 reorder_modifiers (Lisp_Object symbol
)
6342 /* It's hopefully okay to write the code this way, since everything
6343 will soon be in caches, and no consing will be done at all. */
6346 parsed
= parse_modifiers (symbol
);
6347 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6352 /* For handling events, we often want to produce a symbol whose name
6353 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6354 to some base, like the name of a function key or mouse button.
6355 modify_event_symbol produces symbols of this sort.
6357 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6358 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6361 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6362 into symbol names, or a string specifying a name stem used to
6363 construct a symbol name or the form `STEM-N', where N is the decimal
6364 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6365 non-nil; otherwise NAME_TABLE is used.
6367 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6368 persist between calls to modify_event_symbol that it can use to
6369 store a cache of the symbols it's generated for this NAME_TABLE
6370 before. The object stored there may be a vector or an alist.
6372 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6374 MODIFIERS is a set of modifier bits (as given in struct input_events)
6375 whose prefixes should be applied to the symbol name.
6377 SYMBOL_KIND is the value to be placed in the event_kind property of
6378 the returned symbol.
6380 The symbols we create are supposed to have an
6381 `event-symbol-elements' property, which lists the modifiers present
6382 in the symbol's name. */
6385 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6386 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6387 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6390 Lisp_Object symbol_int
;
6392 /* Get rid of the "vendor-specific" bit here. */
6393 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6395 /* Is this a request for a valid symbol? */
6396 if (symbol_num
< 0 || symbol_num
>= table_size
)
6399 if (CONSP (*symbol_table
))
6400 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6402 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6403 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6404 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6405 we've never used that symbol before. */
6408 if (! VECTORP (*symbol_table
)
6409 || ASIZE (*symbol_table
) != table_size
)
6413 XSETFASTINT (size
, table_size
);
6414 *symbol_table
= Fmake_vector (size
, Qnil
);
6417 value
= AREF (*symbol_table
, symbol_num
);
6420 /* Have we already used this symbol before? */
6423 /* No; let's create it. */
6424 if (CONSP (name_alist_or_stem
))
6425 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6426 else if (STRINGP (name_alist_or_stem
))
6429 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6430 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6432 buf
= SAFE_ALLOCA (len
);
6433 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6434 XINT (symbol_int
) + 1);
6435 value
= intern (buf
);
6438 else if (name_table
!= 0 && name_table
[symbol_num
])
6439 value
= intern (name_table
[symbol_num
]);
6441 #ifdef HAVE_WINDOW_SYSTEM
6444 char *name
= x_get_keysym_name (symbol_num
);
6446 value
= intern (name
);
6452 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6453 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6454 value
= intern (buf
);
6457 if (CONSP (*symbol_table
))
6458 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6460 ASET (*symbol_table
, symbol_num
, value
);
6462 /* Fill in the cache entries for this symbol; this also
6463 builds the Qevent_symbol_elements property, which the user
6465 apply_modifiers (modifiers
& click_modifier
, value
);
6466 Fput (value
, Qevent_kind
, symbol_kind
);
6469 /* Apply modifiers to that symbol. */
6470 return apply_modifiers (modifiers
, value
);
6473 /* Convert a list that represents an event type,
6474 such as (ctrl meta backspace), into the usual representation of that
6475 event type as a number or a symbol. */
6477 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6478 doc
: /* Convert the event description list EVENT-DESC to an event type.
6479 EVENT-DESC should contain one base event type (a character or symbol)
6480 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6481 drag, down, double or triple). The base must be last.
6482 The return value is an event type (a character or symbol) which
6483 has the same base event type and all the specified modifiers. */)
6484 (Lisp_Object event_desc
)
6492 while (CONSP (rest
))
6500 /* Given a symbol, see if it is a modifier name. */
6501 if (SYMBOLP (elt
) && CONSP (rest
))
6502 this = parse_solitary_modifier (elt
);
6506 else if (!NILP (base
))
6507 error ("Two bases given in one event");
6513 /* Let the symbol A refer to the character A. */
6514 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6515 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6517 if (INTEGERP (base
))
6519 /* Turn (shift a) into A. */
6520 if ((modifiers
& shift_modifier
) != 0
6521 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6523 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6524 modifiers
&= ~shift_modifier
;
6527 /* Turn (control a) into C-a. */
6528 if (modifiers
& ctrl_modifier
)
6529 return make_number ((modifiers
& ~ctrl_modifier
)
6530 | make_ctrl_char (XINT (base
)));
6532 return make_number (modifiers
| XINT (base
));
6534 else if (SYMBOLP (base
))
6535 return apply_modifiers (modifiers
, base
);
6538 error ("Invalid base event");
6543 /* Try to recognize SYMBOL as a modifier name.
6544 Return the modifier flag bit, or 0 if not recognized. */
6547 parse_solitary_modifier (Lisp_Object symbol
)
6549 Lisp_Object name
= SYMBOL_NAME (symbol
);
6551 switch (SREF (name
, 0))
6553 #define SINGLE_LETTER_MOD(BIT) \
6554 if (SBYTES (name) == 1) \
6557 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6558 if (LEN == SBYTES (name) \
6559 && ! memcmp (SDATA (name), NAME, LEN)) \
6563 SINGLE_LETTER_MOD (alt_modifier
);
6567 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6571 SINGLE_LETTER_MOD (ctrl_modifier
);
6575 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6576 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6580 SINGLE_LETTER_MOD (hyper_modifier
);
6584 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6588 SINGLE_LETTER_MOD (meta_modifier
);
6592 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6596 SINGLE_LETTER_MOD (shift_modifier
);
6600 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6601 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6602 SINGLE_LETTER_MOD (super_modifier
);
6606 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6607 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6608 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6612 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6615 #undef SINGLE_LETTER_MOD
6616 #undef MULTI_LETTER_MOD
6622 /* Return true if EVENT is a list whose elements are all integers or symbols.
6623 Such a list is not valid as an event,
6624 but it can be a Lucid-style event type list. */
6627 lucid_event_type_list_p (Lisp_Object object
)
6631 if (! CONSP (object
))
6634 if (EQ (XCAR (object
), Qhelp_echo
)
6635 || EQ (XCAR (object
), Qvertical_line
)
6636 || EQ (XCAR (object
), Qmode_line
)
6637 || EQ (XCAR (object
), Qheader_line
))
6640 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6644 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6651 /* Return true if terminal input chars are available.
6652 Also, store the return value into INPUT_PENDING.
6654 Serves the purpose of ioctl (0, FIONREAD, ...)
6655 but works even if FIONREAD does not exist.
6656 (In fact, this may actually read some input.)
6658 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6659 timer events that are ripe.
6660 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6661 events (FOCUS_IN_EVENT).
6662 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6663 movements and toolkit scroll bar thumb drags. */
6666 get_input_pending (int flags
)
6668 /* First of all, have we already counted some input? */
6669 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6671 /* If input is being read as it arrives, and we have none, there is none. */
6672 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6674 /* Try to read some input and see how much we get. */
6676 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6679 return input_pending
;
6682 /* Put a BUFFER_SWITCH_EVENT in the buffer
6683 so that read_key_sequence will notice the new current buffer. */
6686 record_asynch_buffer_change (void)
6688 struct input_event event
;
6692 event
.kind
= BUFFER_SWITCH_EVENT
;
6693 event
.frame_or_window
= Qnil
;
6696 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6697 The purpose of the event is to make read_key_sequence look up the
6698 keymaps again. If we aren't in read_key_sequence, we don't need one,
6699 and the event could cause trouble by messing up (input-pending-p).
6700 Note: Fwaiting_for_user_input_p always returns nil when async
6701 subprocesses aren't supported. */
6702 tem
= Fwaiting_for_user_input_p ();
6706 /* Make sure no interrupt happens while storing the event. */
6708 if (interrupt_input
)
6709 kbd_buffer_store_event (&event
);
6714 kbd_buffer_store_event (&event
);
6719 /* Read any terminal input already buffered up by the system
6720 into the kbd_buffer, but do not wait.
6722 Return the number of keyboard chars read, or -1 meaning
6723 this is a bad time to try to read input. */
6732 /* Store pending user signal events, if any. */
6733 store_user_signal_events ();
6735 /* Loop through the available terminals, and call their input hooks. */
6739 struct terminal
*next
= t
->next_terminal
;
6741 if (t
->read_socket_hook
)
6744 struct input_event hold_quit
;
6746 if (input_blocked_p ())
6748 pending_signals
= 1;
6752 EVENT_INIT (hold_quit
);
6753 hold_quit
.kind
= NO_EVENT
;
6755 /* No need for FIONREAD or fcntl; just say don't wait. */
6756 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6759 if (nr
== -1) /* Not OK to read input now. */
6763 else if (nr
== -2) /* Non-transient error. */
6765 /* The terminal device terminated; it should be closed. */
6767 /* Kill Emacs if this was our last terminal. */
6768 if (!terminal_list
->next_terminal
)
6769 /* Formerly simply reported no input, but that
6770 sometimes led to a failure of Emacs to terminate.
6771 SIGHUP seems appropriate if we can't reach the
6773 /* ??? Is it really right to send the signal just to
6774 this process rather than to the whole process
6775 group? Perhaps on systems with FIONREAD Emacs is
6776 alone in its group. */
6777 terminate_due_to_signal (SIGHUP
, 10);
6779 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6782 XSETTERMINAL (tmp
, t
);
6783 Fdelete_terminal (tmp
, Qnoelisp
);
6787 if (hold_quit
.kind
!= NO_EVENT
)
6788 kbd_buffer_store_event (&hold_quit
);
6797 frame_make_pointer_visible ();
6803 decode_keyboard_code (struct tty_display_info
*tty
,
6804 struct coding_system
*coding
,
6805 unsigned char *buf
, int nbytes
)
6807 unsigned char *src
= buf
;
6808 const unsigned char *p
;
6813 if (tty
->meta_key
!= 2)
6814 for (i
= 0; i
< nbytes
; i
++)
6816 if (coding
->carryover_bytes
> 0)
6818 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6819 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6820 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6821 nbytes
+= coding
->carryover_bytes
;
6823 coding
->destination
= alloca (nbytes
* 4);
6824 coding
->dst_bytes
= nbytes
* 4;
6825 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6826 if (coding
->produced_char
== 0)
6828 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6830 struct input_event event_buf
;
6832 EVENT_INIT (event_buf
);
6833 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6835 (ASCII_CHAR_P (event_buf
.code
)
6836 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6837 /* See the comment in tty_read_avail_input. */
6838 event_buf
.frame_or_window
= tty
->top_frame
;
6839 event_buf
.arg
= Qnil
;
6840 kbd_buffer_store_event (&event_buf
);
6844 /* This is the tty way of reading available input.
6846 Note that each terminal device has its own `struct terminal' object,
6847 and so this function is called once for each individual termcap
6848 terminal. The first parameter indicates which terminal to read from. */
6851 tty_read_avail_input (struct terminal
*terminal
,
6852 struct input_event
*hold_quit
)
6854 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6855 the kbd_buffer can really hold. That may prevent loss
6856 of characters on some systems when input is stuffed at us. */
6857 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6859 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6862 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6864 if (kbd_on_hold_p () || buffer_free
<= 0)
6866 #endif /* subprocesses */
6868 if (!terminal
->name
) /* Don't read from a dead terminal. */
6871 if (terminal
->type
!= output_termcap
6872 && terminal
->type
!= output_msdos_raw
)
6875 /* XXX I think the following code should be moved to separate hook
6876 functions in system-dependent files. */
6879 #else /* not WINDOWSNT */
6880 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6884 return 0; /* The terminal is suspended. */
6887 n_to_read
= dos_keysns ();
6891 cbuf
[0] = dos_keyread ();
6894 #else /* not MSDOS */
6899 struct input_event gpm_hold_quit
;
6900 int gpm
, fd
= gpm_fd
;
6902 EVENT_INIT (gpm_hold_quit
);
6903 gpm_hold_quit
.kind
= NO_EVENT
;
6905 /* gpm==1 if event received.
6906 gpm==0 if the GPM daemon has closed the connection, in which case
6907 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6908 we save it in `fd' so close_gpm can remove it from the
6910 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6911 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6912 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6915 /* Presumably the GPM daemon has closed the connection. */
6917 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6918 kbd_buffer_store_event (&gpm_hold_quit
);
6922 #endif /* HAVE_GPM */
6924 /* Determine how many characters we should *try* to read. */
6925 #ifdef USABLE_FIONREAD
6926 /* Find out how much input is available. */
6927 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6929 if (! noninteractive
)
6930 return -2; /* Close this terminal. */
6936 if (n_to_read
> sizeof cbuf
)
6937 n_to_read
= sizeof cbuf
;
6938 #elif defined USG || defined CYGWIN
6939 /* Read some input if available, but don't wait. */
6940 n_to_read
= sizeof cbuf
;
6941 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6943 # error "Cannot read without possibly delaying"
6947 /* Don't read more than we can store. */
6948 if (n_to_read
> buffer_free
)
6949 n_to_read
= buffer_free
;
6950 #endif /* subprocesses */
6952 /* Now read; for one reason or another, this will not block.
6953 NREAD is set to the number of chars read. */
6956 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6957 /* POSIX infers that processes which are not in the session leader's
6958 process group won't get SIGHUP's at logout time. BSDI adheres to
6959 this part standard and returns -1 from read (0) with errno==EIO
6960 when the control tty is taken away.
6961 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6962 if (nread
== -1 && errno
== EIO
)
6963 return -2; /* Close this terminal. */
6964 #if defined (AIX) && defined (_BSD)
6965 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6966 This looks incorrect, but it isn't, because _BSD causes
6967 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6968 and that causes a value other than 0 when there is no input. */
6970 return -2; /* Close this terminal. */
6974 /* We used to retry the read if it was interrupted.
6975 But this does the wrong thing when O_NONBLOCK causes
6976 an EAGAIN error. Does anybody know of a situation
6977 where a retry is actually needed? */
6979 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6989 #ifndef USABLE_FIONREAD
6990 #if defined (USG) || defined (CYGWIN)
6991 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6992 #endif /* USG or CYGWIN */
6993 #endif /* no FIONREAD */
6998 #endif /* not MSDOS */
6999 #endif /* not WINDOWSNT */
7001 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7002 & CODING_REQUIRE_DECODING_MASK
)
7004 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7007 /* Decode the key sequence except for those with meta
7009 for (i
= from
= 0; ; i
++)
7010 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7012 struct input_event buf
;
7014 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7019 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7020 buf
.modifiers
= meta_modifier
;
7021 buf
.code
= cbuf
[i
] & ~0x80;
7022 /* See the comment below. */
7023 buf
.frame_or_window
= tty
->top_frame
;
7025 kbd_buffer_store_event (&buf
);
7031 for (i
= 0; i
< nread
; i
++)
7033 struct input_event buf
;
7035 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7037 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7038 buf
.modifiers
= meta_modifier
;
7039 if (tty
->meta_key
!= 2)
7043 /* Set the frame corresponding to the active tty. Note that the
7044 value of selected_frame is not reliable here, redisplay tends
7045 to temporarily change it. */
7046 buf
.frame_or_window
= tty
->top_frame
;
7049 kbd_buffer_store_event (&buf
);
7050 /* Don't look at input that follows a C-g too closely.
7051 This reduces lossage due to autorepeat on C-g. */
7052 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7053 && buf
.code
== quit_char
)
7061 handle_async_input (void)
7066 int nread
= gobble_input ();
7067 /* -1 means it's not ok to read the input now.
7068 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7069 0 means there was no keyboard input available. */
7077 process_pending_signals (void)
7079 pending_signals
= 0;
7080 handle_async_input ();
7081 do_pending_atimers ();
7084 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7085 and also (if the level is now 0) reinvoke any pending signal. */
7088 unblock_input_to (int level
)
7090 interrupt_input_blocked
= level
;
7093 if (pending_signals
)
7094 process_pending_signals ();
7100 /* End critical section.
7102 If doing signal-driven input, and a signal came in when input was
7103 blocked, reinvoke the signal handler now to deal with it. */
7106 unblock_input (void)
7108 unblock_input_to (interrupt_input_blocked
- 1);
7111 /* Undo any number of BLOCK_INPUT calls,
7112 and also reinvoke any pending signal. */
7115 totally_unblock_input (void)
7117 unblock_input_to (0);
7123 handle_input_available_signal (int sig
)
7125 pending_signals
= 1;
7127 if (input_available_clear_time
)
7128 *input_available_clear_time
= make_emacs_time (0, 0);
7132 deliver_input_available_signal (int sig
)
7134 deliver_process_signal (sig
, handle_input_available_signal
);
7136 #endif /* USABLE_SIGIO */
7139 /* User signal events. */
7141 struct user_signal_info
7143 /* Signal number. */
7146 /* Name of the signal. */
7149 /* Number of pending signals. */
7152 struct user_signal_info
*next
;
7155 /* List of user signals. */
7156 static struct user_signal_info
*user_signals
= NULL
;
7159 add_user_signal (int sig
, const char *name
)
7161 struct sigaction action
;
7162 struct user_signal_info
*p
;
7164 for (p
= user_signals
; p
; p
= p
->next
)
7166 /* Already added. */
7169 p
= xmalloc (sizeof *p
);
7171 p
->name
= xstrdup (name
);
7173 p
->next
= user_signals
;
7176 emacs_sigaction_init (&action
, deliver_user_signal
);
7177 sigaction (sig
, &action
, 0);
7181 handle_user_signal (int sig
)
7183 struct user_signal_info
*p
;
7184 const char *special_event_name
= NULL
;
7186 if (SYMBOLP (Vdebug_on_event
))
7187 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7189 for (p
= user_signals
; p
; p
= p
->next
)
7192 if (special_event_name
7193 && strcmp (special_event_name
, p
->name
) == 0)
7195 /* Enter the debugger in many ways. */
7196 debug_on_next_call
= 1;
7199 Vinhibit_quit
= Qnil
;
7201 /* Eat the event. */
7207 if (interrupt_input
)
7208 handle_input_available_signal (sig
);
7212 /* Tell wait_reading_process_output that it needs to wake
7213 up and look around. */
7214 if (input_available_clear_time
)
7215 *input_available_clear_time
= make_emacs_time (0, 0);
7222 deliver_user_signal (int sig
)
7224 deliver_process_signal (sig
, handle_user_signal
);
7228 find_user_signal_name (int sig
)
7230 struct user_signal_info
*p
;
7232 for (p
= user_signals
; p
; p
= p
->next
)
7240 store_user_signal_events (void)
7242 struct user_signal_info
*p
;
7243 struct input_event buf
;
7244 bool buf_initialized
= 0;
7246 for (p
= user_signals
; p
; p
= p
->next
)
7247 if (p
->npending
> 0)
7249 if (! buf_initialized
)
7251 memset (&buf
, 0, sizeof buf
);
7252 buf
.kind
= USER_SIGNAL_EVENT
;
7253 buf
.frame_or_window
= selected_frame
;
7254 buf_initialized
= 1;
7260 kbd_buffer_store_event (&buf
);
7263 while (p
->npending
> 0);
7268 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7269 static Lisp_Object menu_bar_one_keymap_changed_items
;
7271 /* These variables hold the vector under construction within
7272 menu_bar_items and its subroutines, and the current index
7273 for storing into that vector. */
7274 static Lisp_Object menu_bar_items_vector
;
7275 static int menu_bar_items_index
;
7278 static const char* separator_names
[] = {
7283 "single-dashed-line",
7284 "double-dashed-line",
7286 "shadow-etched-out",
7287 "shadow-etched-in-dash",
7288 "shadow-etched-out-dash",
7289 "shadow-double-etched-in",
7290 "shadow-double-etched-out",
7291 "shadow-double-etched-in-dash",
7292 "shadow-double-etched-out-dash",
7296 /* Return true if LABEL specifies a separator. */
7299 menu_separator_name_p (const char *label
)
7303 else if (strlen (label
) > 3
7304 && memcmp (label
, "--", 2) == 0
7309 for (i
= 0; separator_names
[i
]; ++i
)
7310 if (strcmp (label
, separator_names
[i
]) == 0)
7315 /* It's a separator if it contains only dashes. */
7316 while (*label
== '-')
7318 return (*label
== 0);
7325 /* Return a vector of menu items for a menu bar, appropriate
7326 to the current buffer. Each item has three elements in the vector:
7329 OLD is an old vector we can optionally reuse, or nil. */
7332 menu_bar_items (Lisp_Object old
)
7334 /* The number of keymaps we're scanning right now, and the number of
7335 keymaps we have allocated space for. */
7338 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7339 in the current keymaps, or nil where it is not a prefix. */
7342 Lisp_Object def
, tail
;
7347 /* In order to build the menus, we need to call the keymap
7348 accessors. They all call QUIT. But this function is called
7349 during redisplay, during which a quit is fatal. So inhibit
7350 quitting while building the menus.
7351 We do this instead of specbind because (1) errors will clear it anyway
7352 and (2) this avoids risk of specpdl overflow. */
7353 oquit
= Vinhibit_quit
;
7357 menu_bar_items_vector
= old
;
7359 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7360 menu_bar_items_index
= 0;
7362 /* Build our list of keymaps.
7363 If we recognize a function key and replace its escape sequence in
7364 keybuf with its symbol, or if the sequence starts with a mouse
7365 click and we need to switch buffers, we jump back here to rebuild
7366 the initial keymaps from the current buffer. */
7370 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7371 if (!NILP (Voverriding_local_map_menu_flag
))
7373 /* Yes, use them (if non-nil) as well as the global map. */
7374 maps
= alloca (3 * sizeof (maps
[0]));
7376 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7377 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7378 if (!NILP (Voverriding_local_map
))
7379 maps
[nmaps
++] = Voverriding_local_map
;
7383 /* No, so use major and minor mode keymaps and keymap property.
7384 Note that menu-bar bindings in the local-map and keymap
7385 properties may not work reliable, as they are only
7386 recognized when the menu-bar (or mode-line) is updated,
7387 which does not normally happen after every command. */
7390 nminor
= current_minor_maps (NULL
, &tmaps
);
7391 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7393 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7394 maps
[nmaps
++] = tem
;
7395 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7397 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7399 maps
[nmaps
++] = current_global_map
;
7402 /* Look up in each map the dummy prefix key `menu-bar'. */
7404 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7405 if (!NILP (maps
[mapno
]))
7407 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7411 menu_bar_one_keymap_changed_items
= Qnil
;
7412 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7416 /* Move to the end those items that should be at the end. */
7418 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7421 int end
= menu_bar_items_index
;
7423 for (i
= 0; i
< end
; i
+= 4)
7424 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7426 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7427 /* Move the item at index I to the end,
7428 shifting all the others forward. */
7429 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7430 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7431 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7432 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7434 memmove (aref_addr (menu_bar_items_vector
, i
),
7435 aref_addr (menu_bar_items_vector
, i
+ 4),
7436 (end
- i
- 4) * word_size
);
7437 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7438 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7439 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7440 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7445 /* Add nil, nil, nil, nil at the end. */
7447 int i
= menu_bar_items_index
;
7448 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7449 menu_bar_items_vector
=
7450 larger_vector (menu_bar_items_vector
, 4, -1);
7451 /* Add this item. */
7452 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7453 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7454 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7455 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7456 menu_bar_items_index
= i
;
7459 Vinhibit_quit
= oquit
;
7460 return menu_bar_items_vector
;
7463 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7464 If there's already an item for KEY, add this DEF to it. */
7466 Lisp_Object item_properties
;
7469 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7471 struct gcpro gcpro1
;
7476 if (EQ (item
, Qundefined
))
7478 /* If a map has an explicit `undefined' as definition,
7479 discard any previously made menu bar item. */
7481 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7482 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7484 if (menu_bar_items_index
> i
+ 4)
7485 memmove (aref_addr (menu_bar_items_vector
, i
),
7486 aref_addr (menu_bar_items_vector
, i
+ 4),
7487 (menu_bar_items_index
- i
- 4) * word_size
);
7488 menu_bar_items_index
-= 4;
7492 /* If this keymap has already contributed to this KEY,
7493 don't contribute to it a second time. */
7494 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7495 if (!NILP (tem
) || NILP (item
))
7498 menu_bar_one_keymap_changed_items
7499 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7501 /* We add to menu_bar_one_keymap_changed_items before doing the
7502 parse_menu_item, so that if it turns out it wasn't a menu item,
7503 it still correctly hides any further menu item. */
7505 parsed
= parse_menu_item (item
, 1);
7510 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7512 /* Find any existing item for this KEY. */
7513 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7514 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7517 /* If we did not find this KEY, add it at the end. */
7518 if (i
== menu_bar_items_index
)
7520 /* If vector is too small, get a bigger one. */
7521 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7522 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7523 /* Add this item. */
7524 ASET (menu_bar_items_vector
, i
, key
); i
++;
7525 ASET (menu_bar_items_vector
, i
,
7526 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7527 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7528 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7529 menu_bar_items_index
= i
;
7531 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7535 old
= AREF (menu_bar_items_vector
, i
+ 2);
7536 /* If the new and the old items are not both keymaps,
7537 the lookup will only find `item'. */
7538 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7539 ASET (menu_bar_items_vector
, i
+ 2, item
);
7543 /* This is used as the handler when calling menu_item_eval_property. */
7545 menu_item_eval_property_1 (Lisp_Object arg
)
7547 /* If we got a quit from within the menu computation,
7548 quit all the way out of it. This takes care of C-] in the debugger. */
7549 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7550 Fsignal (Qquit
, Qnil
);
7556 eval_dyn (Lisp_Object form
)
7558 return Feval (form
, Qnil
);
7561 /* Evaluate an expression and return the result (or nil if something
7562 went wrong). Used to evaluate dynamic parts of menu items. */
7564 menu_item_eval_property (Lisp_Object sexpr
)
7566 ptrdiff_t count
= SPECPDL_INDEX ();
7568 specbind (Qinhibit_redisplay
, Qt
);
7569 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7570 menu_item_eval_property_1
);
7571 return unbind_to (count
, val
);
7574 /* This function parses a menu item and leaves the result in the
7575 vector item_properties.
7576 ITEM is a key binding, a possible menu item.
7577 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7579 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7580 parse_menu_item returns true if the item is a menu item and false
7584 parse_menu_item (Lisp_Object item
, int inmenubar
)
7586 Lisp_Object def
, tem
, item_string
, start
;
7588 Lisp_Object keyhint
;
7597 /* Create item_properties vector if necessary. */
7598 if (NILP (item_properties
))
7600 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7602 /* Initialize optional entries. */
7603 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7604 ASET (item_properties
, i
, Qnil
);
7605 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7607 /* Save the item here to protect it from GC. */
7608 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7610 item_string
= XCAR (item
);
7614 if (STRINGP (item_string
))
7616 /* Old format menu item. */
7617 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7619 /* Maybe help string. */
7620 if (CONSP (item
) && STRINGP (XCAR (item
)))
7622 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7627 /* Maybe an obsolete key binding cache. */
7628 if (CONSP (item
) && CONSP (XCAR (item
))
7629 && (NILP (XCAR (XCAR (item
)))
7630 || VECTORP (XCAR (XCAR (item
)))))
7633 /* This is the real definition--the function to run. */
7634 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7636 /* Get enable property, if any. */
7639 tem
= Fget (item
, Qmenu_enable
);
7640 if (!NILP (Venable_disabled_menus_and_buttons
))
7641 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7642 else if (!NILP (tem
))
7643 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7646 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7648 /* New format menu item. */
7649 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7650 start
= XCDR (item
);
7653 /* We have a real binding. */
7654 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7656 item
= XCDR (start
);
7657 /* Is there an obsolete cache list with key equivalences. */
7658 if (CONSP (item
) && CONSP (XCAR (item
)))
7661 /* Parse properties. */
7662 while (CONSP (item
) && CONSP (XCDR (item
)))
7667 if (EQ (tem
, QCenable
))
7669 if (!NILP (Venable_disabled_menus_and_buttons
))
7670 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7672 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7674 else if (EQ (tem
, QCvisible
))
7676 /* If got a visible property and that evaluates to nil
7677 then ignore this item. */
7678 tem
= menu_item_eval_property (XCAR (item
));
7682 else if (EQ (tem
, QChelp
))
7683 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7684 else if (EQ (tem
, QCfilter
))
7686 else if (EQ (tem
, QCkey_sequence
))
7689 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7690 /* Be GC protected. Set keyhint to item instead of tem. */
7693 else if (EQ (tem
, QCkeys
))
7696 if (CONSP (tem
) || STRINGP (tem
))
7697 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7699 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7704 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7706 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7708 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7714 else if (inmenubar
|| !NILP (start
))
7718 return 0; /* not a menu item */
7720 /* If item string is not a string, evaluate it to get string.
7721 If we don't get a string, skip this item. */
7722 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7723 if (!(STRINGP (item_string
)))
7725 item_string
= menu_item_eval_property (item_string
);
7726 if (!STRINGP (item_string
))
7728 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7731 /* If got a filter apply it on definition. */
7732 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7735 def
= menu_item_eval_property (list2 (XCAR (filter
),
7736 list2 (Qquote
, def
)));
7738 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7741 /* Enable or disable selection of item. */
7742 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7745 tem
= menu_item_eval_property (tem
);
7746 if (inmenubar
&& NILP (tem
))
7747 return 0; /* Ignore disabled items in menu bar. */
7748 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7751 /* If we got no definition, this item is just unselectable text which
7752 is OK in a submenu but not in the menubar. */
7754 return (!inmenubar
);
7756 /* See if this is a separate pane or a submenu. */
7757 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7758 tem
= get_keymap (def
, 0, 1);
7759 /* For a subkeymap, just record its details and exit. */
7762 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7763 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7767 /* At the top level in the menu bar, do likewise for commands also.
7768 The menu bar does not display equivalent key bindings anyway.
7769 ITEM_PROPERTY_DEF is already set up properly. */
7773 { /* This is a command. See if there is an equivalent key binding. */
7774 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7776 /* The previous code preferred :key-sequence to :keys, so we
7777 preserve this behavior. */
7778 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7779 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7782 Lisp_Object prefix
= keyeq
;
7783 Lisp_Object keys
= Qnil
;
7787 def
= XCAR (prefix
);
7788 prefix
= XCDR (prefix
);
7791 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7793 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7795 keys
= XCAR (keyhint
);
7796 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7798 /* We have a suggested key. Is it bound to the command? */
7801 /* If the command is an alias for another
7802 (such as lmenu.el set it up), check if the
7803 original command matches the cached command. */
7805 && EQ (tem
, XSYMBOL (def
)->function
))))
7810 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7814 tem
= Fkey_description (keys
, Qnil
);
7817 if (STRINGP (XCAR (prefix
)))
7818 tem
= concat2 (XCAR (prefix
), tem
);
7819 if (STRINGP (XCDR (prefix
)))
7820 tem
= concat2 (tem
, XCDR (prefix
));
7822 keyeq
= concat2 (build_string (" "), tem
);
7823 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7829 /* If we have an equivalent key binding, use that. */
7830 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7833 /* Include this when menu help is implemented.
7834 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7835 if (!(NILP (tem) || STRINGP (tem)))
7837 tem = menu_item_eval_property (tem);
7840 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7844 /* Handle radio buttons or toggle boxes. */
7845 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7847 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7848 menu_item_eval_property (tem
));
7855 /***********************************************************************
7857 ***********************************************************************/
7859 /* A vector holding tool bar items while they are parsed in function
7860 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7863 static Lisp_Object tool_bar_items_vector
;
7865 /* A vector holding the result of parse_tool_bar_item. Layout is like
7866 the one for a single item in tool_bar_items_vector. */
7868 static Lisp_Object tool_bar_item_properties
;
7870 /* Next free index in tool_bar_items_vector. */
7872 static int ntool_bar_items
;
7874 /* The symbols `:image' and `:rtl'. */
7876 static Lisp_Object QCimage
;
7877 static Lisp_Object QCrtl
;
7879 /* Function prototypes. */
7881 static void init_tool_bar_items (Lisp_Object
);
7882 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7883 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7884 static void append_tool_bar_item (void);
7887 /* Return a vector of tool bar items for keymaps currently in effect.
7888 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7889 tool bar items found. */
7892 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7901 /* In order to build the menus, we need to call the keymap
7902 accessors. They all call QUIT. But this function is called
7903 during redisplay, during which a quit is fatal. So inhibit
7904 quitting while building the menus. We do this instead of
7905 specbind because (1) errors will clear it anyway and (2) this
7906 avoids risk of specpdl overflow. */
7907 oquit
= Vinhibit_quit
;
7910 /* Initialize tool_bar_items_vector and protect it from GC. */
7911 init_tool_bar_items (reuse
);
7913 /* Build list of keymaps in maps. Set nmaps to the number of maps
7916 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7917 if (!NILP (Voverriding_local_map_menu_flag
))
7919 /* Yes, use them (if non-nil) as well as the global map. */
7920 maps
= alloca (3 * sizeof *maps
);
7922 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7923 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7924 if (!NILP (Voverriding_local_map
))
7925 maps
[nmaps
++] = Voverriding_local_map
;
7929 /* No, so use major and minor mode keymaps and keymap property.
7930 Note that tool-bar bindings in the local-map and keymap
7931 properties may not work reliable, as they are only
7932 recognized when the tool-bar (or mode-line) is updated,
7933 which does not normally happen after every command. */
7936 nminor
= current_minor_maps (NULL
, &tmaps
);
7937 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7939 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7940 maps
[nmaps
++] = tem
;
7941 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7943 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7946 /* Add global keymap at the end. */
7947 maps
[nmaps
++] = current_global_map
;
7949 /* Process maps in reverse order and look up in each map the prefix
7951 for (i
= nmaps
- 1; i
>= 0; --i
)
7952 if (!NILP (maps
[i
]))
7956 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7958 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7961 Vinhibit_quit
= oquit
;
7962 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7963 return tool_bar_items_vector
;
7967 /* Process the definition of KEY which is DEF. */
7970 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7973 struct gcpro gcpro1
, gcpro2
;
7975 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7979 if (EQ (def
, Qundefined
))
7981 /* If a map has an explicit `undefined' as definition,
7982 discard any previously made item. */
7983 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7985 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7987 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7989 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7990 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7991 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7993 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7998 else if (parse_tool_bar_item (key
, def
))
7999 /* Append a new tool bar item to tool_bar_items_vector. Accept
8000 more than one definition for the same key. */
8001 append_tool_bar_item ();
8006 /* Access slot with index IDX of vector tool_bar_item_properties. */
8007 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8009 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8011 ASET (tool_bar_item_properties
, idx
, val
);
8015 /* Parse a tool bar item specification ITEM for key KEY and return the
8016 result in tool_bar_item_properties. Value is false if ITEM is
8019 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8021 CAPTION is the caption of the item, If it's not a string, it is
8022 evaluated to get a string.
8024 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8025 as binding are currently ignored.
8027 The following properties are recognized:
8031 FORM is evaluated and specifies whether the tool bar item is
8032 enabled or disabled.
8036 FORM is evaluated and specifies whether the tool bar item is visible.
8038 - `:filter FUNCTION'
8040 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8041 result is stored as the new binding.
8043 - `:button (TYPE SELECTED)'
8045 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8046 and specifies whether the button is selected (pressed) or not.
8050 IMAGES is either a single image specification or a vector of four
8051 image specifications. See enum tool_bar_item_images.
8053 - `:help HELP-STRING'.
8055 Gives a help string to display for the tool bar item.
8057 - `:label LABEL-STRING'.
8059 A text label to show with the tool bar button if labels are enabled. */
8062 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8064 Lisp_Object filter
= Qnil
;
8065 Lisp_Object caption
;
8067 bool have_label
= 0;
8069 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8070 Rule out items that aren't lists, don't start with
8071 `menu-item' or whose rest following `tool-bar-item' is not a
8076 /* As an exception, allow old-style menu separators. */
8077 if (STRINGP (XCAR (item
)))
8078 item
= Fcons (XCAR (item
), Qnil
);
8079 else if (!EQ (XCAR (item
), Qmenu_item
)
8080 || (item
= XCDR (item
), !CONSP (item
)))
8083 /* Create tool_bar_item_properties vector if necessary. Reset it to
8085 if (VECTORP (tool_bar_item_properties
))
8087 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8091 tool_bar_item_properties
8092 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8095 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8096 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8098 /* Get the caption of the item. If the caption is not a string,
8099 evaluate it to get a string. If we don't get a string, skip this
8101 caption
= XCAR (item
);
8102 if (!STRINGP (caption
))
8104 caption
= menu_item_eval_property (caption
);
8105 if (!STRINGP (caption
))
8108 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8110 /* If the rest following the caption is not a list, the menu item is
8111 either a separator, or invalid. */
8115 if (menu_separator_name_p (SSDATA (caption
)))
8117 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8118 #if !defined (USE_GTK) && !defined (HAVE_NS)
8119 /* If we use build_desired_tool_bar_string to render the
8120 tool bar, the separator is rendered as an image. */
8121 PROP (TOOL_BAR_ITEM_IMAGES
)
8122 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8123 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8124 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8125 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8132 /* Store the binding. */
8133 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8136 /* Ignore cached key binding, if any. */
8137 if (CONSP (item
) && CONSP (XCAR (item
)))
8140 /* Process the rest of the properties. */
8141 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8143 Lisp_Object ikey
, value
;
8146 value
= XCAR (XCDR (item
));
8148 if (EQ (ikey
, QCenable
))
8150 /* `:enable FORM'. */
8151 if (!NILP (Venable_disabled_menus_and_buttons
))
8152 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8154 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8156 else if (EQ (ikey
, QCvisible
))
8158 /* `:visible FORM'. If got a visible property and that
8159 evaluates to nil then ignore this item. */
8160 if (NILP (menu_item_eval_property (value
)))
8163 else if (EQ (ikey
, QChelp
))
8164 /* `:help HELP-STRING'. */
8165 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8166 else if (EQ (ikey
, QCvert_only
))
8167 /* `:vert-only t/nil'. */
8168 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8169 else if (EQ (ikey
, QClabel
))
8171 const char *bad_label
= "!!?GARBLED ITEM?!!";
8172 /* `:label LABEL-STRING'. */
8173 set_prop (TOOL_BAR_ITEM_LABEL
,
8174 STRINGP (value
) ? value
: build_string (bad_label
));
8177 else if (EQ (ikey
, QCfilter
))
8178 /* ':filter FORM'. */
8180 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8182 /* `:button (TYPE . SELECTED)'. */
8183 Lisp_Object type
, selected
;
8185 type
= XCAR (value
);
8186 selected
= XCDR (value
);
8187 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8189 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8190 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8193 else if (EQ (ikey
, QCimage
)
8195 || (VECTORP (value
) && ASIZE (value
) == 4)))
8196 /* Value is either a single image specification or a vector
8197 of 4 such specifications for the different button states. */
8198 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8199 else if (EQ (ikey
, QCrtl
))
8201 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8207 /* Try to make one from caption and key. */
8208 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8209 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8210 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8211 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8213 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8214 char *buf
= xmalloc (max_lbl
+ 1);
8215 Lisp_Object new_lbl
;
8216 ptrdiff_t caption_len
= strlen (capt
);
8218 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8221 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8223 buf
[caption_len
] = '\0';
8227 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8231 strcpy (buf
, label
);
8233 for (j
= 0; buf
[j
] != '\0'; ++j
)
8241 new_lbl
= Fupcase_initials (build_string (label
));
8242 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8243 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8245 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8249 /* If got a filter apply it on binding. */
8251 set_prop (TOOL_BAR_ITEM_BINDING
,
8252 (menu_item_eval_property
8255 PROP (TOOL_BAR_ITEM_BINDING
))))));
8257 /* See if the binding is a keymap. Give up if it is. */
8258 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8261 /* Enable or disable selection of item. */
8262 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8263 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8264 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8266 /* Handle radio buttons or toggle boxes. */
8267 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8268 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8269 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8277 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8278 that can be reused. */
8281 init_tool_bar_items (Lisp_Object reuse
)
8283 if (VECTORP (reuse
))
8284 tool_bar_items_vector
= reuse
;
8286 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8287 ntool_bar_items
= 0;
8291 /* Append parsed tool bar item properties from
8292 tool_bar_item_properties */
8295 append_tool_bar_item (void)
8299 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8301 /* Enlarge tool_bar_items_vector if necessary. */
8303 tool_bar_items_vector
8304 = larger_vector (tool_bar_items_vector
, incr
, -1);
8306 /* Append entries from tool_bar_item_properties to the end of
8307 tool_bar_items_vector. */
8308 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8309 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8310 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8317 /* Read a character using menus based on maps in the array MAPS.
8318 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8319 Return t if we displayed a menu but the user rejected it.
8321 PREV_EVENT is the previous input event, or nil if we are reading
8322 the first event of a key sequence.
8324 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8325 if we used a mouse menu to read the input, or false otherwise. If
8326 USED_MOUSE_MENU is null, don't dereference it.
8328 The prompting is done based on the prompt-string of the map
8329 and the strings associated with various map elements.
8331 This can be done with X menus or with menus put in the minibuf.
8332 These are done in different ways, depending on how the input will be read.
8333 Menus using X are done after auto-saving in read-char, getting the input
8334 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8335 and do auto-saving in the inner call of read_char. */
8338 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8339 Lisp_Object prev_event
, bool *used_mouse_menu
)
8345 if (used_mouse_menu
)
8346 *used_mouse_menu
= 0;
8348 /* Use local over global Menu maps */
8350 if (! menu_prompting
)
8353 /* Optionally disregard all but the global map. */
8354 if (inhibit_local_menu_bar_menus
)
8356 maps
+= (nmaps
- 1);
8361 /* If we got to this point via a mouse click,
8362 use a real menu for mouse selection. */
8363 if (EVENT_HAS_PARAMETERS (prev_event
)
8364 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8365 && !EQ (XCAR (prev_event
), Qtool_bar
))
8367 /* Display the menu and get the selection. */
8368 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8370 ptrdiff_t nmaps1
= 0;
8372 /* Use the maps that are not nil. */
8373 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8374 if (!NILP (maps
[mapno
]))
8375 realmaps
[nmaps1
++] = maps
[mapno
];
8377 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8382 record_menu_key (XCAR (value
));
8384 /* If we got multiple events, unread all but
8386 There is no way to prevent those unread events
8387 from showing up later in last_nonmenu_event.
8388 So turn symbol and integer events into lists,
8389 to indicate that they came from a mouse menu,
8390 so that when present in last_nonmenu_event
8391 they won't confuse things. */
8392 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8394 record_menu_key (XCAR (tem
));
8395 if (SYMBOLP (XCAR (tem
))
8396 || INTEGERP (XCAR (tem
)))
8397 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8400 /* If we got more than one event, put all but the first
8401 onto this list to be read later.
8402 Return just the first event now. */
8403 Vunread_command_events
8404 = nconc2 (XCDR (value
), Vunread_command_events
);
8405 value
= XCAR (value
);
8407 else if (NILP (value
))
8409 if (used_mouse_menu
)
8410 *used_mouse_menu
= 1;
8413 #endif /* HAVE_MENUS */
8417 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8418 We make this bigger when necessary, and never free it. */
8419 static char *read_char_minibuf_menu_text
;
8420 /* Size of that buffer. */
8421 static ptrdiff_t read_char_minibuf_menu_width
;
8424 read_char_minibuf_menu_prompt (int commandflag
,
8425 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8428 register Lisp_Object name
;
8430 /* FIXME: Use the minibuffer's frame width. */
8431 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8433 bool nobindings
= 1;
8434 Lisp_Object rest
, vector
;
8440 if (! menu_prompting
)
8443 /* Get the menu name from the first map that has one (a prompt string). */
8444 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8446 name
= Fkeymap_prompt (maps
[mapno
]);
8451 /* If we don't have any menus, just read a character normally. */
8452 if (!STRINGP (name
))
8455 /* Make sure we have a big enough buffer for the menu text. */
8456 width
= max (width
, SBYTES (name
));
8457 if (STRING_BYTES_BOUND
- 4 < width
)
8458 memory_full (SIZE_MAX
);
8459 if (width
+ 4 > read_char_minibuf_menu_width
)
8461 read_char_minibuf_menu_text
8462 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8463 read_char_minibuf_menu_width
= width
+ 4;
8465 menu
= read_char_minibuf_menu_text
;
8467 /* Prompt string always starts with map's prompt, and a space. */
8468 strcpy (menu
, SSDATA (name
));
8469 nlength
= SBYTES (name
);
8470 menu
[nlength
++] = ':';
8471 menu
[nlength
++] = ' ';
8474 /* Start prompting at start of first map. */
8478 /* Present the documented bindings, a line at a time. */
8482 ptrdiff_t i
= nlength
;
8484 Lisp_Object orig_defn_macro
;
8486 /* Loop over elements of map. */
8491 /* If reached end of map, start at beginning of next map. */
8495 /* At end of last map, wrap around to first map if just starting,
8496 or end this line if already have something on it. */
8500 if (notfirst
|| nobindings
) break;
8505 /* Look at the next element of the map. */
8507 elt
= AREF (vector
, idx
);
8509 elt
= Fcar_safe (rest
);
8511 if (idx
< 0 && VECTORP (elt
))
8513 /* If we found a dense table in the keymap,
8514 advanced past it, but start scanning its contents. */
8515 rest
= Fcdr_safe (rest
);
8521 /* An ordinary element. */
8522 Lisp_Object event
, tem
;
8526 event
= Fcar_safe (elt
); /* alist */
8527 elt
= Fcdr_safe (elt
);
8531 XSETINT (event
, idx
); /* vector */
8534 /* Ignore the element if it has no prompt string. */
8535 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8537 /* True if the char to type matches the string. */
8539 Lisp_Object upcased_event
, downcased_event
;
8540 Lisp_Object desc
= Qnil
;
8542 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8544 upcased_event
= Fupcase (event
);
8545 downcased_event
= Fdowncase (event
);
8546 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8547 || XINT (downcased_event
) == SREF (s
, 0));
8549 desc
= Fsingle_key_description (event
, Qnil
);
8551 #if 0 /* It is redundant to list the equivalent key bindings because
8552 the prefix is what the user has already typed. */
8554 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8556 /* Insert equivalent keybinding. */
8557 s
= concat2 (s
, tem
);
8560 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8561 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8563 /* Insert button prefix. */
8564 Lisp_Object selected
8565 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8566 if (EQ (tem
, QCradio
))
8567 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8569 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8570 s
= concat2 (tem
, s
);
8574 /* If we have room for the prompt string, add it to this line.
8575 If this is the first on the line, always add it. */
8576 if ((SCHARS (s
) + i
+ 2
8577 + (char_matches
? 0 : SCHARS (desc
) + 3))
8581 ptrdiff_t thiswidth
;
8583 /* Punctuate between strings. */
8586 strcpy (menu
+ i
, ", ");
8592 /* If the char to type doesn't match the string's
8593 first char, explicitly show what char to type. */
8596 /* Add as much of string as fits. */
8597 thiswidth
= min (SCHARS (desc
), width
- i
);
8598 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8600 strcpy (menu
+ i
, " = ");
8604 /* Add as much of string as fits. */
8605 thiswidth
= min (SCHARS (s
), width
- i
);
8606 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8612 /* If this element does not fit, end the line now,
8613 and save the element for the next line. */
8614 strcpy (menu
+ i
, "...");
8619 /* Move past this element. */
8620 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8621 /* Handle reaching end of dense table. */
8626 rest
= Fcdr_safe (rest
);
8630 /* Prompt with that and read response. */
8631 message2_nolog (menu
, strlen (menu
),
8632 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8634 /* Make believe its not a keyboard macro in case the help char
8635 is pressed. Help characters are not recorded because menu prompting
8636 is not used on replay.
8638 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8639 kset_defining_kbd_macro (current_kboard
, Qnil
);
8641 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8642 while (BUFFERP (obj
));
8643 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8645 if (!INTEGERP (obj
))
8647 else if (XINT (obj
) == -2)
8650 if (! EQ (obj
, menu_prompt_more_char
)
8651 && (!INTEGERP (menu_prompt_more_char
)
8652 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8654 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8655 store_kbd_macro_char (obj
);
8658 /* Help char - go round again */
8662 /* Reading key sequences. */
8664 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8665 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8666 keymap, or nil otherwise. Return the index of the first keymap in
8667 which KEY has any binding, or NMAPS if no map has a binding.
8669 If KEY is a meta ASCII character, treat it like meta-prefix-char
8670 followed by the corresponding non-meta character. Keymaps in
8671 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8674 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8677 NEXT may be the same array as CURRENT. */
8680 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8681 Lisp_Object
*defs
, Lisp_Object
*next
)
8683 ptrdiff_t i
, first_binding
;
8685 first_binding
= nmaps
;
8686 for (i
= nmaps
- 1; i
>= 0; i
--)
8688 if (! NILP (current
[i
]))
8690 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8691 if (! NILP (defs
[i
]))
8698 /* Given the set of bindings we've found, produce the next set of maps. */
8699 if (first_binding
< nmaps
)
8700 for (i
= 0; i
< nmaps
; i
++)
8701 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8703 return first_binding
;
8706 /* Structure used to keep track of partial application of key remapping
8707 such as Vfunction_key_map and Vkey_translation_map. */
8708 typedef struct keyremap
8710 /* This is the map originally specified for this use. */
8712 /* This is a submap reached by looking up, in PARENT,
8713 the events from START to END. */
8715 /* Positions [START, END) in the key sequence buffer
8716 are the key that we have scanned so far.
8717 Those events are the ones that we will replace
8718 if PARENT maps them into a key sequence. */
8722 /* Lookup KEY in MAP.
8723 MAP is a keymap mapping keys to key vectors or functions.
8724 If the mapping is a function and DO_FUNCALL is true,
8725 the function is called with PROMPT as parameter and its return
8726 value is used as the return value of this function (after checking
8727 that it is indeed a vector). */
8730 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8735 next
= access_keymap (map
, key
, 1, 0, 1);
8737 /* Handle a symbol whose function definition is a keymap
8739 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8740 && (ARRAYP (XSYMBOL (next
)->function
)
8741 || KEYMAPP (XSYMBOL (next
)->function
)))
8742 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8744 /* If the keymap gives a function, not an
8745 array, then call the function with one arg and use
8746 its value instead. */
8747 if (do_funcall
&& FUNCTIONP (next
))
8752 next
= call1 (next
, prompt
);
8753 /* If the function returned something invalid,
8754 barf--don't ignore it.
8755 (To ignore it safely, we would need to gcpro a bunch of
8756 other variables.) */
8757 if (! (VECTORP (next
) || STRINGP (next
)))
8758 error ("Function %s returns invalid key sequence",
8759 SSDATA (SYMBOL_NAME (tem
)));
8764 /* Do one step of the key remapping used for function-key-map and
8765 key-translation-map:
8766 KEYBUF is the buffer holding the input events.
8767 BUFSIZE is its maximum size.
8768 FKEY is a pointer to the keyremap structure to use.
8769 INPUT is the index of the last element in KEYBUF.
8770 DOIT if true says that the remapping can actually take place.
8771 DIFF is used to return the number of keys added/removed by the remapping.
8772 PARENT is the root of the keymap.
8773 PROMPT is the prompt to use if the remapping happens through a function.
8774 Return true if the remapping actually took place. */
8777 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8778 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8780 Lisp_Object next
, key
;
8782 key
= keybuf
[fkey
->end
++];
8784 if (KEYMAPP (fkey
->parent
))
8785 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8789 /* If keybuf[fkey->start..fkey->end] is bound in the
8790 map and we're in a position to do the key remapping, replace it with
8791 the binding and restart with fkey->start at the end. */
8792 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8794 int len
= XFASTINT (Flength (next
));
8797 *diff
= len
- (fkey
->end
- fkey
->start
);
8799 if (bufsize
- input
<= *diff
)
8800 error ("Key sequence too long");
8802 /* Shift the keys that follow fkey->end. */
8804 for (i
= fkey
->end
; i
< input
; i
++)
8805 keybuf
[i
+ *diff
] = keybuf
[i
];
8807 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8808 keybuf
[i
+ *diff
] = keybuf
[i
];
8809 /* Overwrite the old keys with the new ones. */
8810 for (i
= 0; i
< len
; i
++)
8811 keybuf
[fkey
->start
+ i
]
8812 = Faref (next
, make_number (i
));
8814 fkey
->start
= fkey
->end
+= *diff
;
8815 fkey
->map
= fkey
->parent
;
8820 fkey
->map
= get_keymap (next
, 0, 1);
8822 /* If we no longer have a bound suffix, try a new position for
8824 if (!CONSP (fkey
->map
))
8826 fkey
->end
= ++fkey
->start
;
8827 fkey
->map
= fkey
->parent
;
8833 test_undefined (Lisp_Object binding
)
8835 return (EQ (binding
, Qundefined
)
8836 || (!NILP (binding
) && SYMBOLP (binding
)
8837 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8840 /* Read a sequence of keys that ends with a non prefix character,
8841 storing it in KEYBUF, a buffer of size BUFSIZE.
8843 Return the length of the key sequence stored.
8844 Return -1 if the user rejected a command menu.
8846 Echo starting immediately unless `prompt' is 0.
8848 Where a key sequence ends depends on the currently active keymaps.
8849 These include any minor mode keymaps active in the current buffer,
8850 the current buffer's local map, and the global map.
8852 If a key sequence has no other bindings, we check Vfunction_key_map
8853 to see if some trailing subsequence might be the beginning of a
8854 function key's sequence. If so, we try to read the whole function
8855 key, and substitute its symbolic name into the key sequence.
8857 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8858 `double-' events into similar click events, if that would make them
8859 bound. We try to turn `triple-' events first into `double-' events,
8862 If we get a mouse click in a mode line, vertical divider, or other
8863 non-text area, we treat the click as if it were prefixed by the
8864 symbol denoting that area - `mode-line', `vertical-line', or
8867 If the sequence starts with a mouse click, we read the key sequence
8868 with respect to the buffer clicked on, not the current buffer.
8870 If the user switches frames in the midst of a key sequence, we put
8871 off the switch-frame event until later; the next call to
8872 read_char will return it.
8874 If FIX_CURRENT_BUFFER, we restore current_buffer
8875 from the selected window's buffer. */
8878 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8879 bool dont_downcase_last
, bool can_return_switch_frame
,
8880 bool fix_current_buffer
)
8882 Lisp_Object from_string
;
8883 ptrdiff_t count
= SPECPDL_INDEX ();
8885 /* How many keys there are in the current key sequence. */
8888 /* The length of the echo buffer when we started reading, and
8889 the length of this_command_keys when we started reading. */
8890 ptrdiff_t echo_start
IF_LINT (= 0);
8891 ptrdiff_t keys_start
;
8893 /* The number of keymaps we're scanning right now, and the number of
8894 keymaps we have allocated space for. */
8896 ptrdiff_t nmaps_allocated
= 0;
8898 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8899 the current keymaps. */
8900 Lisp_Object
*defs
= NULL
;
8902 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8903 in the current keymaps, or nil where it is not a prefix. */
8904 Lisp_Object
*submaps
= NULL
;
8906 /* The local map to start out with at start of key sequence. */
8907 Lisp_Object orig_local_map
;
8909 /* The map from the `keymap' property to start out with at start of
8911 Lisp_Object orig_keymap
;
8913 /* Positive if we have already considered switching to the local-map property
8914 of the place where a mouse click occurred. */
8915 int localized_local_map
= 0;
8917 /* The index in submaps[] of the first keymap that has a binding for
8918 this key sequence. In other words, the lowest i such that
8919 submaps[i] is non-nil. */
8920 ptrdiff_t first_binding
;
8921 /* Index of the first key that has no binding.
8922 It is useless to try fkey.start larger than that. */
8925 /* If t < mock_input, then KEYBUF[t] should be read as the next
8928 We use this to recover after recognizing a function key. Once we
8929 realize that a suffix of the current key sequence is actually a
8930 function key's escape sequence, we replace the suffix with the
8931 function key's binding from Vfunction_key_map. Now keybuf
8932 contains a new and different key sequence, so the echo area,
8933 this_command_keys, and the submaps and defs arrays are wrong. In
8934 this situation, we set mock_input to t, set t to 0, and jump to
8935 restart_sequence; the loop will read keys from keybuf up until
8936 mock_input, thus rebuilding the state; and then it will resume
8937 reading characters from the keyboard. */
8940 /* If the sequence is unbound in submaps[], then
8941 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8942 and fkey.map is its binding.
8944 These might be > t, indicating that all function key scanning
8945 should hold off until t reaches them. We do this when we've just
8946 recognized a function key, to avoid searching for the function
8947 key's again in Vfunction_key_map. */
8950 /* Likewise, for key_translation_map and input-decode-map. */
8951 keyremap keytran
, indec
;
8953 /* True if we are trying to map a key by changing an upper-case
8954 letter to lower case, or a shifted function key to an unshifted
8956 bool shift_translated
= 0;
8958 /* If we receive a `switch-frame' or `select-window' event in the middle of
8959 a key sequence, we put it off for later.
8960 While we're reading, we keep the event here. */
8961 Lisp_Object delayed_switch_frame
;
8963 /* See the comment below... */
8964 #if defined (GOBBLE_FIRST_EVENT)
8965 Lisp_Object first_event
;
8968 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8969 int original_uppercase_position
= -1;
8971 /* Gets around Microsoft compiler limitations. */
8974 struct buffer
*starting_buffer
;
8976 /* List of events for which a fake prefix key has been generated. */
8977 Lisp_Object fake_prefixed_keys
= Qnil
;
8979 #if defined (GOBBLE_FIRST_EVENT)
8983 struct gcpro gcpro1
;
8985 GCPRO1 (fake_prefixed_keys
);
8986 raw_keybuf_count
= 0;
8988 last_nonmenu_event
= Qnil
;
8990 delayed_switch_frame
= Qnil
;
8996 /* Install the string STR as the beginning of the string of
8997 echoing, so that it serves as a prompt for the next
8999 kset_echo_string (current_kboard
, prompt
);
9000 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9003 else if (cursor_in_echo_area
9004 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9005 && NILP (Fzerop (Vecho_keystrokes
)))
9006 /* This doesn't put in a dash if the echo buffer is empty, so
9007 you don't always see a dash hanging out in the minibuffer. */
9011 /* Record the initial state of the echo area and this_command_keys;
9012 we will need to restore them if we replay a key sequence. */
9014 echo_start
= echo_length ();
9015 keys_start
= this_command_key_count
;
9016 this_single_command_key_start
= keys_start
;
9018 #if defined (GOBBLE_FIRST_EVENT)
9019 /* This doesn't quite work, because some of the things that read_char
9020 does cannot safely be bypassed. It seems too risky to try to make
9023 /* Read the first char of the sequence specially, before setting
9024 up any keymaps, in case a filter runs and switches buffers on us. */
9025 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9027 #endif /* GOBBLE_FIRST_EVENT */
9029 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9030 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9033 /* We jump here when we need to reinitialize fkey and keytran; this
9034 happens if we switch keyboards between rescans. */
9035 replay_entire_sequence
:
9037 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9038 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9039 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9040 indec
.start
= indec
.end
= 0;
9041 fkey
.start
= fkey
.end
= 0;
9042 keytran
.start
= keytran
.end
= 0;
9044 /* We jump here when the key sequence has been thoroughly changed, and
9045 we need to rescan it starting from the beginning. When we jump here,
9046 keybuf[0..mock_input] holds the sequence we should reread. */
9049 starting_buffer
= current_buffer
;
9050 first_unbound
= bufsize
+ 1;
9052 /* Build our list of keymaps.
9053 If we recognize a function key and replace its escape sequence in
9054 keybuf with its symbol, or if the sequence starts with a mouse
9055 click and we need to switch buffers, we jump back here to rebuild
9056 the initial keymaps from the current buffer. */
9059 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9061 if (2 > nmaps_allocated
)
9063 submaps
= alloca (2 * sizeof *submaps
);
9064 defs
= alloca (2 * sizeof *defs
);
9065 nmaps_allocated
= 2;
9067 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9069 else if (!NILP (Voverriding_local_map
))
9071 if (2 > nmaps_allocated
)
9073 submaps
= alloca (2 * sizeof *submaps
);
9074 defs
= alloca (2 * sizeof *defs
);
9075 nmaps_allocated
= 2;
9077 submaps
[nmaps
++] = Voverriding_local_map
;
9085 nminor
= current_minor_maps (0, &maps
);
9086 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9088 if (total
> nmaps_allocated
)
9090 submaps
= alloca (total
* sizeof *submaps
);
9091 defs
= alloca (total
* sizeof *defs
);
9092 nmaps_allocated
= total
;
9095 if (!NILP (orig_keymap
))
9096 submaps
[nmaps
++] = orig_keymap
;
9098 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9102 submaps
[nmaps
++] = orig_local_map
;
9104 submaps
[nmaps
++] = current_global_map
;
9106 /* Find an accurate initial value for first_binding. */
9107 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9108 if (! NILP (submaps
[first_binding
]))
9111 /* Start from the beginning in keybuf. */
9114 /* These are no-ops the first time through, but if we restart, they
9115 revert the echo area and this_command_keys to their original state. */
9116 this_command_key_count
= keys_start
;
9117 if (INTERACTIVE
&& t
< mock_input
)
9118 echo_truncate (echo_start
);
9120 /* If the best binding for the current key sequence is a keymap, or
9121 we may be looking at a function key's escape sequence, keep on
9123 while (first_binding
< nmaps
9124 /* Keep reading as long as there's a prefix binding. */
9125 ? !NILP (submaps
[first_binding
])
9126 /* Don't return in the middle of a possible function key sequence,
9127 if the only bindings we found were via case conversion.
9128 Thus, if ESC O a has a function-key-map translation
9129 and ESC o has a binding, don't return after ESC O,
9130 so that we can translate ESC O plus the next character. */
9131 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9134 bool used_mouse_menu
= 0;
9136 /* Where the last real key started. If we need to throw away a
9137 key that has expanded into more than one element of keybuf
9138 (say, a mouse click on the mode line which is being treated
9139 as [mode-line (mouse-...)], then we backtrack to this point
9141 int last_real_key_start
;
9143 /* These variables are analogous to echo_start and keys_start;
9144 while those allow us to restart the entire key sequence,
9145 echo_local_start and keys_local_start allow us to throw away
9147 ptrdiff_t echo_local_start
IF_LINT (= 0);
9148 int keys_local_start
;
9149 ptrdiff_t local_first_binding
;
9151 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9152 eassert (indec
.start
<= indec
.end
);
9153 eassert (fkey
.start
<= fkey
.end
);
9154 eassert (keytran
.start
<= keytran
.end
);
9155 /* key-translation-map is applied *after* function-key-map
9156 which is itself applied *after* input-decode-map. */
9157 eassert (fkey
.end
<= indec
.start
);
9158 eassert (keytran
.end
<= fkey
.start
);
9160 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9161 first_unbound
< keytran
.start
)
9162 { /* The prefix upto first_unbound has no binding and has
9163 no translation left to do either, so we know it's unbound.
9164 If we don't stop now, we risk staying here indefinitely
9165 (if the user keeps entering fkey or keytran prefixes
9166 like C-c ESC ESC ESC ESC ...) */
9168 for (i
= first_unbound
+ 1; i
< t
; i
++)
9169 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9170 mock_input
= t
- first_unbound
- 1;
9171 indec
.end
= indec
.start
-= first_unbound
+ 1;
9172 indec
.map
= indec
.parent
;
9173 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9174 fkey
.map
= fkey
.parent
;
9175 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9176 keytran
.map
= keytran
.parent
;
9177 goto replay_sequence
;
9181 error ("Key sequence too long");
9184 echo_local_start
= echo_length ();
9185 keys_local_start
= this_command_key_count
;
9186 local_first_binding
= first_binding
;
9189 /* These are no-ops, unless we throw away a keystroke below and
9190 jumped back up to replay_key; in that case, these restore the
9191 variables to their original state, allowing us to replay the
9193 if (INTERACTIVE
&& t
< mock_input
)
9194 echo_truncate (echo_local_start
);
9195 this_command_key_count
= keys_local_start
;
9196 first_binding
= local_first_binding
;
9198 /* By default, assume each event is "real". */
9199 last_real_key_start
= t
;
9201 /* Does mock_input indicate that we are re-reading a key sequence? */
9205 add_command_key (key
);
9206 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9207 && NILP (Fzerop (Vecho_keystrokes
)))
9211 /* If not, we should actually read a character. */
9215 KBOARD
*interrupted_kboard
= current_kboard
;
9216 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9217 key
= read_char (NILP (prompt
), nmaps
,
9218 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9219 &used_mouse_menu
, NULL
);
9220 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9221 /* When switching to a new tty (with a new keyboard),
9222 read_char returns the new buffer, rather than -2
9223 (Bug#5095). This is because `terminal-init-xterm'
9224 calls read-char, which eats the wrong_kboard_jmpbuf
9225 return. Any better way to fix this? -- cyd */
9226 || (interrupted_kboard
!= current_kboard
))
9231 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9232 if (k
== interrupted_kboard
)
9237 /* Don't touch interrupted_kboard when it's been
9239 delayed_switch_frame
= Qnil
;
9240 goto replay_entire_sequence
;
9243 if (!NILP (delayed_switch_frame
))
9246 (interrupted_kboard
,
9247 Fcons (delayed_switch_frame
,
9248 KVAR (interrupted_kboard
, kbd_queue
)));
9249 delayed_switch_frame
= Qnil
;
9254 (interrupted_kboard
,
9255 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9257 /* If the side queue is non-empty, ensure it begins with a
9258 switch-frame, so we'll replay it in the right context. */
9259 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9260 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9261 !(EVENT_HAS_PARAMETERS (key
)
9262 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9266 XSETFRAME (frame
, interrupted_frame
);
9268 (interrupted_kboard
,
9269 Fcons (make_lispy_switch_frame (frame
),
9270 KVAR (interrupted_kboard
, kbd_queue
)));
9273 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9274 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9275 goto replay_entire_sequence
;
9279 /* read_char returns t when it shows a menu and the user rejects it.
9283 unbind_to (count
, Qnil
);
9288 /* read_char returns -1 at the end of a macro.
9289 Emacs 18 handles this by returning immediately with a
9290 zero, so that's what we'll do. */
9291 if (INTEGERP (key
) && XINT (key
) == -1)
9294 /* The Microsoft C compiler can't handle the goto that
9300 /* If the current buffer has been changed from under us, the
9301 keymap may have changed, so replay the sequence. */
9304 timer_resume_idle ();
9307 /* Reset the current buffer from the selected window
9308 in case something changed the former and not the latter.
9309 This is to be more consistent with the behavior
9310 of the command_loop_1. */
9311 if (fix_current_buffer
)
9313 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9315 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9316 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9319 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9320 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9321 goto replay_sequence
;
9324 /* If we have a quit that was typed in another frame, and
9325 quit_throw_to_read_char switched buffers,
9326 replay to get the right keymap. */
9328 && XINT (key
) == quit_char
9329 && current_buffer
!= starting_buffer
)
9332 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9337 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9338 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9339 goto replay_sequence
;
9344 if (EVENT_HAS_PARAMETERS (key
)
9345 /* Either a `switch-frame' or a `select-window' event. */
9346 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9348 /* If we're at the beginning of a key sequence, and the caller
9349 says it's okay, go ahead and return this event. If we're
9350 in the midst of a key sequence, delay it until the end. */
9351 if (t
> 0 || !can_return_switch_frame
)
9353 delayed_switch_frame
= key
;
9359 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9363 /* Clicks in non-text areas get prefixed by the symbol
9364 in their CHAR-ADDRESS field. For example, a click on
9365 the mode line is prefixed by the symbol `mode-line'.
9367 Furthermore, key sequences beginning with mouse clicks
9368 are read using the keymaps of the buffer clicked on, not
9369 the current buffer. So we may have to switch the buffer
9372 When we turn one event into two events, we must make sure
9373 that neither of the two looks like the original--so that,
9374 if we replay the events, they won't be expanded again.
9375 If not for this, such reexpansion could happen either here
9376 or when user programs play with this-command-keys. */
9377 if (EVENT_HAS_PARAMETERS (key
))
9382 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9383 if (EQ (kind
, Qmouse_click
))
9385 Lisp_Object window
, posn
;
9387 window
= POSN_WINDOW (EVENT_START (key
));
9388 posn
= POSN_POSN (EVENT_START (key
));
9391 || (!NILP (fake_prefixed_keys
)
9392 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9394 /* We're looking a second time at an event for which
9395 we generated a fake prefix key. Set
9396 last_real_key_start appropriately. */
9398 last_real_key_start
= t
- 1;
9401 if (last_real_key_start
== 0)
9403 /* Key sequences beginning with mouse clicks are
9404 read using the keymaps in the buffer clicked on,
9405 not the current buffer. If we're at the
9406 beginning of a key sequence, switch buffers. */
9407 if (WINDOWP (window
)
9408 && BUFFERP (XWINDOW (window
)->buffer
)
9409 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9411 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9416 /* Arrange to go back to the original buffer once we're
9417 done reading the key sequence. Note that we can't
9418 use save_excursion_{save,restore} here, because they
9419 save point as well as the current buffer; we don't
9420 want to save point, because redisplay may change it,
9421 to accommodate a Fset_window_start or something. We
9422 don't want to do this at the top of the function,
9423 because we may get input from a subprocess which
9424 wants to change the selected window and stuff (say,
9426 record_unwind_current_buffer ();
9428 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9430 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9431 orig_local_map
= get_local_map (PT
, current_buffer
,
9433 orig_keymap
= get_local_map (PT
, current_buffer
,
9435 goto replay_sequence
;
9438 /* For a mouse click, get the local text-property keymap
9439 of the place clicked on, rather than point. */
9440 if (CONSP (XCDR (key
))
9441 && ! localized_local_map
)
9443 Lisp_Object map_here
, start
, pos
;
9445 localized_local_map
= 1;
9446 start
= EVENT_START (key
);
9448 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9450 pos
= POSN_BUFFER_POSN (start
);
9452 && XINT (pos
) >= BEGV
9453 && XINT (pos
) <= ZV
)
9455 map_here
= get_local_map (XINT (pos
),
9458 if (!EQ (map_here
, orig_local_map
))
9460 orig_local_map
= map_here
;
9461 ++localized_local_map
;
9464 map_here
= get_local_map (XINT (pos
),
9467 if (!EQ (map_here
, orig_keymap
))
9469 orig_keymap
= map_here
;
9470 ++localized_local_map
;
9473 if (localized_local_map
> 1)
9478 goto replay_sequence
;
9485 /* Expand mode-line and scroll-bar events into two events:
9486 use posn as a fake prefix key. */
9488 && (NILP (fake_prefixed_keys
)
9489 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9491 if (bufsize
- t
<= 1)
9492 error ("Key sequence too long");
9495 keybuf
[t
+ 1] = key
;
9498 /* Record that a fake prefix key has been generated
9499 for KEY. Don't modify the event; this would
9500 prevent proper action when the event is pushed
9501 back into unread-command-events. */
9502 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9504 /* If on a mode line string with a local keymap,
9505 reconsider the key sequence with that keymap. */
9506 if (string
= POSN_STRING (EVENT_START (key
)),
9507 (CONSP (string
) && STRINGP (XCAR (string
))))
9509 Lisp_Object pos
, map
, map2
;
9511 pos
= XCDR (string
);
9512 string
= XCAR (string
);
9514 && XINT (pos
) < SCHARS (string
))
9516 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9518 orig_local_map
= map
;
9519 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9522 if (!NILP (map
) || !NILP (map2
))
9523 goto replay_sequence
;
9529 else if (NILP (from_string
)
9530 && (string
= POSN_STRING (EVENT_START (key
)),
9531 (CONSP (string
) && STRINGP (XCAR (string
)))))
9533 /* For a click on a string, i.e. overlay string or a
9534 string displayed via the `display' property,
9535 consider `local-map' and `keymap' properties of
9537 Lisp_Object pos
, map
, map2
;
9539 pos
= XCDR (string
);
9540 string
= XCAR (string
);
9542 && XINT (pos
) < SCHARS (string
))
9544 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9546 orig_local_map
= map
;
9547 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9551 if (!NILP (map
) || !NILP (map2
))
9553 from_string
= string
;
9556 goto replay_sequence
;
9561 else if (CONSP (XCDR (key
))
9562 && CONSP (EVENT_START (key
))
9563 && CONSP (XCDR (EVENT_START (key
))))
9567 posn
= POSN_POSN (EVENT_START (key
));
9568 /* Handle menu-bar events:
9569 insert the dummy prefix event `menu-bar'. */
9570 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9572 if (bufsize
- t
<= 1)
9573 error ("Key sequence too long");
9577 /* Zap the position in key, so we know that we've
9578 expanded it, and don't try to do so again. */
9579 POSN_SET_POSN (EVENT_START (key
),
9580 Fcons (posn
, Qnil
));
9583 goto replay_sequence
;
9585 else if (CONSP (posn
))
9587 /* We're looking at the second event of a
9588 sequence which we expanded before. Set
9589 last_real_key_start appropriately. */
9590 if (last_real_key_start
== t
&& t
> 0)
9591 last_real_key_start
= t
- 1;
9596 /* We have finally decided that KEY is something we might want
9598 first_binding
= (follow_key (key
,
9599 nmaps
- first_binding
,
9600 submaps
+ first_binding
,
9601 defs
+ first_binding
,
9602 submaps
+ first_binding
)
9605 /* If KEY wasn't bound, we'll try some fallbacks. */
9606 if (first_binding
< nmaps
)
9607 /* This is needed for the following scenario:
9608 event 0: a down-event that gets dropped by calling replay_key.
9609 event 1: some normal prefix like C-h.
9610 After event 0, first_unbound is 0, after event 1 indec.start,
9611 fkey.start, and keytran.start are all 1, so when we see that
9612 C-h is bound, we need to update first_unbound. */
9613 first_unbound
= max (t
+ 1, first_unbound
);
9618 /* Remember the position to put an upper bound on indec.start. */
9619 first_unbound
= min (t
, first_unbound
);
9621 head
= EVENT_HEAD (key
);
9622 if (help_char_p (head
) && t
> 0)
9624 read_key_sequence_cmd
= Vprefix_help_command
;
9626 last_nonmenu_event
= key
;
9627 /* The Microsoft C compiler can't handle the goto that
9635 Lisp_Object breakdown
;
9638 breakdown
= parse_modifiers (head
);
9639 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9640 /* Attempt to reduce an unbound mouse event to a simpler
9641 event that is bound:
9642 Drags reduce to clicks.
9643 Double-clicks reduce to clicks.
9644 Triple-clicks reduce to double-clicks, then to clicks.
9645 Down-clicks are eliminated.
9646 Double-downs reduce to downs, then are eliminated.
9647 Triple-downs reduce to double-downs, then to downs,
9648 then are eliminated. */
9649 if (modifiers
& (down_modifier
| drag_modifier
9650 | double_modifier
| triple_modifier
))
9652 while (modifiers
& (down_modifier
| drag_modifier
9653 | double_modifier
| triple_modifier
))
9655 Lisp_Object new_head
, new_click
;
9656 if (modifiers
& triple_modifier
)
9657 modifiers
^= (double_modifier
| triple_modifier
);
9658 else if (modifiers
& double_modifier
)
9659 modifiers
&= ~double_modifier
;
9660 else if (modifiers
& drag_modifier
)
9661 modifiers
&= ~drag_modifier
;
9664 /* Dispose of this `down' event by simply jumping
9665 back to replay_key, to get another event.
9667 Note that if this event came from mock input,
9668 then just jumping back to replay_key will just
9669 hand it to us again. So we have to wipe out any
9672 We could delete keybuf[t] and shift everything
9673 after that to the left by one spot, but we'd also
9674 have to fix up any variable that points into
9675 keybuf, and shifting isn't really necessary
9678 Adding prefixes for non-textual mouse clicks
9679 creates two characters of mock input, and both
9680 must be thrown away. If we're only looking at
9681 the prefix now, we can just jump back to
9682 replay_key. On the other hand, if we've already
9683 processed the prefix, and now the actual click
9684 itself is giving us trouble, then we've lost the
9685 state of the keymaps we want to backtrack to, and
9686 we need to replay the whole sequence to rebuild
9689 Beyond that, only function key expansion could
9690 create more than two keys, but that should never
9691 generate mouse events, so it's okay to zero
9692 mock_input in that case too.
9694 FIXME: The above paragraph seems just plain
9695 wrong, if you consider things like
9696 xterm-mouse-mode. -stef
9698 Isn't this just the most wonderful code ever? */
9700 /* If mock_input > t + 1, the above simplification
9701 will actually end up dropping keys on the floor.
9702 This is probably OK for now, but even
9703 if mock_input <= t + 1, we need to adjust indec,
9705 Typical case [header-line down-mouse-N]:
9706 mock_input = 2, t = 1, fkey.end = 1,
9707 last_real_key_start = 0. */
9708 if (indec
.end
> last_real_key_start
)
9710 indec
.end
= indec
.start
9711 = min (last_real_key_start
, indec
.start
);
9712 indec
.map
= indec
.parent
;
9713 if (fkey
.end
> last_real_key_start
)
9715 fkey
.end
= fkey
.start
9716 = min (last_real_key_start
, fkey
.start
);
9717 fkey
.map
= fkey
.parent
;
9718 if (keytran
.end
> last_real_key_start
)
9720 keytran
.end
= keytran
.start
9721 = min (last_real_key_start
, keytran
.start
);
9722 keytran
.map
= keytran
.parent
;
9726 if (t
== last_real_key_start
)
9733 mock_input
= last_real_key_start
;
9734 goto replay_sequence
;
9739 = apply_modifiers (modifiers
, XCAR (breakdown
));
9741 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9743 /* Look for a binding for this new key. follow_key
9744 promises that it didn't munge submaps the
9745 last time we called it, since key was unbound. */
9747 = (follow_key (new_click
,
9748 nmaps
- local_first_binding
,
9749 submaps
+ local_first_binding
,
9750 defs
+ local_first_binding
,
9751 submaps
+ local_first_binding
)
9752 + local_first_binding
);
9754 /* If that click is bound, go for it. */
9755 if (first_binding
< nmaps
)
9760 /* Otherwise, we'll leave key set to the drag event. */
9767 /* Normally, last_nonmenu_event gets the previous key we read.
9768 But when a mouse popup menu is being used,
9769 we don't update last_nonmenu_event; it continues to hold the mouse
9770 event that preceded the first level of menu. */
9771 if (!used_mouse_menu
)
9772 last_nonmenu_event
= key
;
9774 /* Record what part of this_command_keys is the current key sequence. */
9775 this_single_command_key_start
= this_command_key_count
- t
;
9777 /* Look for this sequence in input-decode-map.
9778 Scan from indec.end until we find a bound suffix. */
9779 while (indec
.end
< t
)
9781 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9785 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9786 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9791 mock_input
= diff
+ max (t
, mock_input
);
9792 goto replay_sequence
;
9796 if (first_binding
< nmaps
9797 && NILP (submaps
[first_binding
])
9798 && !test_undefined (defs
[first_binding
])
9799 && indec
.start
>= t
)
9800 /* There is a binding and it's not a prefix.
9801 (and it doesn't have any input-decode-map translation pending).
9802 There is thus no function-key in this sequence.
9803 Moving fkey.start is important in this case to allow keytran.start
9804 to go over the sequence before we return (since we keep the
9805 invariant that keytran.end <= fkey.start). */
9808 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9811 /* If the sequence is unbound, see if we can hang a function key
9812 off the end of it. */
9813 /* Continue scan from fkey.end until we find a bound suffix. */
9814 while (fkey
.end
< indec
.start
)
9816 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9820 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9821 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9822 max (t
, mock_input
),
9823 /* If there's a binding (i.e.
9824 first_binding >= nmaps) we don't want
9825 to apply this function-key-mapping. */
9827 && (first_binding
>= nmaps
9828 || test_undefined (defs
[first_binding
])),
9833 mock_input
= diff
+ max (t
, mock_input
);
9834 /* Adjust the input-decode-map counters. */
9836 indec
.start
+= diff
;
9838 goto replay_sequence
;
9842 /* Look for this sequence in key-translation-map.
9843 Scan from keytran.end until we find a bound suffix. */
9844 while (keytran
.end
< fkey
.start
)
9846 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9850 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9851 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9856 mock_input
= diff
+ max (t
, mock_input
);
9857 /* Adjust the function-key-map and input-decode-map counters. */
9859 indec
.start
+= diff
;
9863 goto replay_sequence
;
9867 /* If KEY is not defined in any of the keymaps,
9868 and cannot be part of a function key or translation,
9869 and is an upper case letter
9870 use the corresponding lower-case letter instead. */
9871 if (first_binding
>= nmaps
9872 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9874 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9875 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9876 || (XINT (key
) & shift_modifier
)))
9878 Lisp_Object new_key
;
9880 original_uppercase
= key
;
9881 original_uppercase_position
= t
- 1;
9883 if (XINT (key
) & shift_modifier
)
9884 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9886 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9887 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9889 /* We have to do this unconditionally, regardless of whether
9890 the lower-case char is defined in the keymaps, because they
9891 might get translated through function-key-map. */
9892 keybuf
[t
- 1] = new_key
;
9893 mock_input
= max (t
, mock_input
);
9894 shift_translated
= 1;
9896 goto replay_sequence
;
9898 /* If KEY is not defined in any of the keymaps,
9899 and cannot be part of a function key or translation,
9900 and is a shifted function key,
9901 use the corresponding unshifted function key instead. */
9902 if (first_binding
>= nmaps
9903 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9905 Lisp_Object breakdown
= parse_modifiers (key
);
9907 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9909 if (modifiers
& shift_modifier
9910 /* Treat uppercase keys as shifted. */
9912 && (KEY_TO_CHAR (key
)
9913 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9914 && uppercasep (KEY_TO_CHAR (key
))))
9917 = (modifiers
& shift_modifier
9918 ? apply_modifiers (modifiers
& ~shift_modifier
,
9920 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9922 original_uppercase
= key
;
9923 original_uppercase_position
= t
- 1;
9925 /* We have to do this unconditionally, regardless of whether
9926 the lower-case char is defined in the keymaps, because they
9927 might get translated through function-key-map. */
9928 keybuf
[t
- 1] = new_key
;
9929 mock_input
= max (t
, mock_input
);
9930 /* Reset fkey (and consequently keytran) to apply
9931 function-key-map on the result, so that S-backspace is
9932 correctly mapped to DEL (via backspace). OTOH,
9933 input-decode-map doesn't need to go through it again. */
9934 fkey
.start
= fkey
.end
= 0;
9935 keytran
.start
= keytran
.end
= 0;
9936 shift_translated
= 1;
9938 goto replay_sequence
;
9943 read_key_sequence_cmd
= (first_binding
< nmaps
9944 ? defs
[first_binding
]
9946 read_key_sequence_remapped
9947 /* Remap command through active keymaps.
9948 Do the remapping here, before the unbind_to so it uses the keymaps
9949 of the appropriate buffer. */
9950 = SYMBOLP (read_key_sequence_cmd
)
9951 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9954 unread_switch_frame
= delayed_switch_frame
;
9955 unbind_to (count
, Qnil
);
9957 /* Don't downcase the last character if the caller says don't.
9958 Don't downcase it if the result is undefined, either. */
9959 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9961 && t
- 1 == original_uppercase_position
)
9963 keybuf
[t
- 1] = original_uppercase
;
9964 shift_translated
= 0;
9967 if (shift_translated
)
9968 Vthis_command_keys_shift_translated
= Qt
;
9970 /* Occasionally we fabricate events, perhaps by expanding something
9971 according to function-key-map, or by adding a prefix symbol to a
9972 mouse click in the scroll bar or modeline. In this cases, return
9973 the entire generated key sequence, even if we hit an unbound
9974 prefix or a definition before the end. This means that you will
9975 be able to push back the event properly, and also means that
9976 read-key-sequence will always return a logical unit.
9979 for (; t
< mock_input
; t
++)
9981 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9982 && NILP (Fzerop (Vecho_keystrokes
)))
9983 echo_char (keybuf
[t
]);
9984 add_command_key (keybuf
[t
]);
9991 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9992 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9993 The sequence is sufficient to specify a non-prefix command in the
9994 current local and global maps.
9996 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9997 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9998 as a continuation of the previous key.
10000 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10001 convert the last event to lower case. (Normally any upper case event
10002 is converted to lower case if the original event is undefined and the lower
10003 case equivalent is defined.) A non-nil value is appropriate for reading
10004 a key sequence to be defined.
10006 A C-g typed while in this function is treated like any other character,
10007 and `quit-flag' is not set.
10009 If the key sequence starts with a mouse click, then the sequence is read
10010 using the keymaps of the buffer of the window clicked in, not the buffer
10011 of the selected window as normal.
10013 `read-key-sequence' drops unbound button-down events, since you normally
10014 only care about the click or drag events which follow them. If a drag
10015 or multi-click event is unbound, but the corresponding click event would
10016 be bound, `read-key-sequence' turns the event into a click event at the
10017 drag's starting position. This means that you don't have to distinguish
10018 between click and drag, double, or triple events unless you want to.
10020 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10021 lines separating windows, and scroll bars with imaginary keys
10022 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10024 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10025 function will process a switch-frame event if the user switches frames
10026 before typing anything. If the user switches frames in the middle of a
10027 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10028 is nil, then the event will be put off until after the current key sequence.
10030 `read-key-sequence' checks `function-key-map' for function key
10031 sequences, where they wouldn't conflict with ordinary bindings. See
10032 `function-key-map' for more details.
10034 The optional fifth argument CMD-LOOP, if non-nil, means
10035 that this key sequence is being read by something that will
10036 read commands one after another. It should be nil if the caller
10037 will read just one key sequence. */)
10038 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10040 Lisp_Object keybuf
[30];
10042 struct gcpro gcpro1
;
10043 ptrdiff_t count
= SPECPDL_INDEX ();
10045 if (!NILP (prompt
))
10046 CHECK_STRING (prompt
);
10049 specbind (Qinput_method_exit_on_first_char
,
10050 (NILP (cmd_loop
) ? Qt
: Qnil
));
10051 specbind (Qinput_method_use_echo_area
,
10052 (NILP (cmd_loop
) ? Qt
: Qnil
));
10054 memset (keybuf
, 0, sizeof keybuf
);
10055 GCPRO1 (keybuf
[0]);
10056 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10058 if (NILP (continue_echo
))
10060 this_command_key_count
= 0;
10061 this_command_key_count_reset
= 0;
10062 this_single_command_key_start
= 0;
10065 #ifdef HAVE_WINDOW_SYSTEM
10066 if (display_hourglass_p
)
10067 cancel_hourglass ();
10070 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10071 prompt
, ! NILP (dont_downcase_last
),
10072 ! NILP (can_return_switch_frame
), 0);
10074 #if 0 /* The following is fine for code reading a key sequence and
10075 then proceeding with a lengthy computation, but it's not good
10076 for code reading keys in a loop, like an input method. */
10077 #ifdef HAVE_WINDOW_SYSTEM
10078 if (display_hourglass_p
)
10079 start_hourglass ();
10089 return unbind_to (count
, make_event_array (i
, keybuf
));
10092 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10093 Sread_key_sequence_vector
, 1, 5, 0,
10094 doc
: /* Like `read-key-sequence' but always return a vector. */)
10095 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10097 Lisp_Object keybuf
[30];
10099 struct gcpro gcpro1
;
10100 ptrdiff_t count
= SPECPDL_INDEX ();
10102 if (!NILP (prompt
))
10103 CHECK_STRING (prompt
);
10106 specbind (Qinput_method_exit_on_first_char
,
10107 (NILP (cmd_loop
) ? Qt
: Qnil
));
10108 specbind (Qinput_method_use_echo_area
,
10109 (NILP (cmd_loop
) ? Qt
: Qnil
));
10111 memset (keybuf
, 0, sizeof keybuf
);
10112 GCPRO1 (keybuf
[0]);
10113 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10115 if (NILP (continue_echo
))
10117 this_command_key_count
= 0;
10118 this_command_key_count_reset
= 0;
10119 this_single_command_key_start
= 0;
10122 #ifdef HAVE_WINDOW_SYSTEM
10123 if (display_hourglass_p
)
10124 cancel_hourglass ();
10127 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10128 prompt
, ! NILP (dont_downcase_last
),
10129 ! NILP (can_return_switch_frame
), 0);
10131 #ifdef HAVE_WINDOW_SYSTEM
10132 if (display_hourglass_p
)
10133 start_hourglass ();
10142 return unbind_to (count
, Fvector (i
, keybuf
));
10145 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10146 doc
: /* Execute CMD as an editor command.
10147 CMD must be a symbol that satisfies the `commandp' predicate.
10148 Optional second arg RECORD-FLAG non-nil
10149 means unconditionally put this command in `command-history'.
10150 Otherwise, that is done only if an arg is read using the minibuffer.
10151 The argument KEYS specifies the value to use instead of (this-command-keys)
10152 when reading the arguments; if it is nil, (this-command-keys) is used.
10153 The argument SPECIAL, if non-nil, means that this command is executing
10154 a special event, so ignore the prefix argument and don't clear it. */)
10155 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10157 register Lisp_Object final
;
10158 register Lisp_Object tem
;
10159 Lisp_Object prefixarg
;
10161 debug_on_next_call
= 0;
10163 if (NILP (special
))
10165 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10166 Vcurrent_prefix_arg
= prefixarg
;
10167 kset_prefix_arg (current_kboard
, Qnil
);
10174 tem
= Fget (cmd
, Qdisabled
);
10177 tem
= Fsymbol_value (Qdisabled_command_function
);
10179 return Frun_hooks (1, &Qdisabled_command_function
);
10185 final
= Findirect_function (cmd
, Qnil
);
10187 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10189 struct gcpro gcpro1
, gcpro2
;
10191 GCPRO2 (cmd
, prefixarg
);
10192 Fautoload_do_load (final
, cmd
, Qnil
);
10199 if (STRINGP (final
) || VECTORP (final
))
10201 /* If requested, place the macro in the command history. For
10202 other sorts of commands, call-interactively takes care of
10204 if (!NILP (record_flag
))
10207 = Fcons (Fcons (Qexecute_kbd_macro
,
10208 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10211 /* Don't keep command history around forever. */
10212 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10214 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10216 XSETCDR (tem
, Qnil
);
10220 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10223 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10224 /* Don't call Fcall_interactively directly because we want to make
10225 sure the backtrace has an entry for `call-interactively'.
10226 For the same reason, pass `cmd' rather than `final'. */
10227 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10234 /* Return true if input events are pending. */
10237 detect_input_pending (void)
10239 return input_pending
|| get_input_pending (0);
10242 /* Return true if input events other than mouse movements are
10246 detect_input_pending_ignore_squeezables (void)
10248 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10251 /* Return true if input events are pending, and run any pending timers. */
10254 detect_input_pending_run_timers (bool do_display
)
10256 unsigned old_timers_run
= timers_run
;
10258 if (!input_pending
)
10259 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10261 if (old_timers_run
!= timers_run
&& do_display
)
10263 redisplay_preserve_echo_area (8);
10264 /* The following fixes a bug when using lazy-lock with
10265 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10266 from an idle timer function. The symptom of the bug is that
10267 the cursor sometimes doesn't become visible until the next X
10268 event is processed. --gerd. */
10270 Lisp_Object tail
, frame
;
10271 FOR_EACH_FRAME (tail
, frame
)
10272 if (FRAME_RIF (XFRAME (frame
)))
10273 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10277 return input_pending
;
10280 /* This is called in some cases before a possible quit.
10281 It cases the next call to detect_input_pending to recompute input_pending.
10282 So calling this function unnecessarily can't do any harm. */
10285 clear_input_pending (void)
10290 /* Return true if there are pending requeued events.
10291 This isn't used yet. The hope is to make wait_reading_process_output
10292 call it, and return if it runs Lisp code that unreads something.
10293 The problem is, kbd_buffer_get_event needs to be fixed to know what
10294 to do in that case. It isn't trivial. */
10297 requeued_events_pending_p (void)
10299 return (!NILP (Vunread_command_events
));
10303 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10304 doc
: /* Return t if command input is currently available with no wait.
10305 Actually, the value is nil only if we can be sure that no input is available;
10306 if there is a doubt, the value is t. */)
10309 if (!NILP (Vunread_command_events
)
10310 || !NILP (Vunread_post_input_method_events
)
10311 || !NILP (Vunread_input_method_events
))
10314 /* Process non-user-visible events (Bug#10195). */
10315 process_special_events ();
10317 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10318 | READABLE_EVENTS_FILTER_EVENTS
)
10322 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10323 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10326 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10329 if (total_keys
< NUM_RECENT_KEYS
)
10330 return Fvector (total_keys
, keys
);
10333 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10334 vcopy (val
, 0, keys
+ recent_keys_index
,
10335 NUM_RECENT_KEYS
- recent_keys_index
);
10336 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10337 keys
, recent_keys_index
);
10342 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10343 doc
: /* Return the key sequence that invoked this command.
10344 However, if the command has called `read-key-sequence', it returns
10345 the last key sequence that has been read.
10346 The value is a string or a vector.
10348 See also `this-command-keys-vector'. */)
10351 return make_event_array (this_command_key_count
,
10352 XVECTOR (this_command_keys
)->contents
);
10355 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10356 doc
: /* Return the key sequence that invoked this command, as a vector.
10357 However, if the command has called `read-key-sequence', it returns
10358 the last key sequence that has been read.
10360 See also `this-command-keys'. */)
10363 return Fvector (this_command_key_count
,
10364 XVECTOR (this_command_keys
)->contents
);
10367 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10368 Sthis_single_command_keys
, 0, 0, 0,
10369 doc
: /* Return the key sequence that invoked this command.
10370 More generally, it returns the last key sequence read, either by
10371 the command loop or by `read-key-sequence'.
10372 Unlike `this-command-keys', this function's value
10373 does not include prefix arguments.
10374 The value is always a vector. */)
10377 return Fvector (this_command_key_count
10378 - this_single_command_key_start
,
10379 (XVECTOR (this_command_keys
)->contents
10380 + this_single_command_key_start
));
10383 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10384 Sthis_single_command_raw_keys
, 0, 0, 0,
10385 doc
: /* Return the raw events that were read for this command.
10386 More generally, it returns the last key sequence read, either by
10387 the command loop or by `read-key-sequence'.
10388 Unlike `this-single-command-keys', this function's value
10389 shows the events before all translations (except for input methods).
10390 The value is always a vector. */)
10393 return Fvector (raw_keybuf_count
,
10394 (XVECTOR (raw_keybuf
)->contents
));
10397 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10398 Sreset_this_command_lengths
, 0, 0, 0,
10399 doc
: /* Make the unread events replace the last command and echo.
10400 Used in `universal-argument-other-key'.
10402 `universal-argument-other-key' rereads the event just typed.
10403 It then gets translated through `function-key-map'.
10404 The translated event has to replace the real events,
10405 both in the value of (this-command-keys) and in echoing.
10406 To achieve this, `universal-argument-other-key' calls
10407 `reset-this-command-lengths', which discards the record of reading
10408 these events the first time. */)
10411 this_command_key_count
= before_command_key_count
;
10412 if (this_command_key_count
< this_single_command_key_start
)
10413 this_single_command_key_start
= this_command_key_count
;
10415 echo_truncate (before_command_echo_length
);
10417 /* Cause whatever we put into unread-command-events
10418 to echo as if it were being freshly read from the keyboard. */
10419 this_command_key_count_reset
= 1;
10424 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10425 Sclear_this_command_keys
, 0, 1, 0,
10426 doc
: /* Clear out the vector that `this-command-keys' returns.
10427 Also clear the record of the last 100 events, unless optional arg
10428 KEEP-RECORD is non-nil. */)
10429 (Lisp_Object keep_record
)
10433 this_command_key_count
= 0;
10434 this_command_key_count_reset
= 0;
10436 if (NILP (keep_record
))
10438 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10439 ASET (recent_keys
, i
, Qnil
);
10441 recent_keys_index
= 0;
10446 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10447 doc
: /* Return the current depth in recursive edits. */)
10451 /* Wrap around reliably on integer overflow. */
10452 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10453 XSETINT (temp
, sum
);
10457 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10458 "FOpen dribble file: ",
10459 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10460 If FILE is nil, close any open dribble file.
10461 The file will be closed when Emacs exits. */)
10473 file
= Fexpand_file_name (file
, Qnil
);
10474 dribble
= fopen (SSDATA (file
), "w");
10476 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10481 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10482 doc
: /* Discard the contents of the terminal input buffer.
10483 Also end any kbd macro being defined. */)
10486 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10488 /* Discard the last command from the macro. */
10489 Fcancel_kbd_macro_events ();
10493 update_mode_lines
++;
10495 Vunread_command_events
= Qnil
;
10497 discard_tty_input ();
10499 kbd_fetch_ptr
= kbd_store_ptr
;
10505 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10506 doc
: /* Stop Emacs and return to superior process. You can resume later.
10507 If `cannot-suspend' is non-nil, or if the system doesn't support job
10508 control, run a subshell instead.
10510 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10511 to be read as terminal input by Emacs's parent, after suspension.
10513 Before suspending, run the normal hook `suspend-hook'.
10514 After resumption run the normal hook `suspend-resume-hook'.
10516 Some operating systems cannot stop the Emacs process and resume it later.
10517 On such systems, Emacs starts a subshell instead of suspending. */)
10518 (Lisp_Object stuffstring
)
10520 ptrdiff_t count
= SPECPDL_INDEX ();
10521 int old_height
, old_width
;
10523 struct gcpro gcpro1
;
10526 if (tty_list
&& tty_list
->next
)
10527 error ("There are other tty frames open; close them before suspending Emacs");
10529 if (!NILP (stuffstring
))
10530 CHECK_STRING (stuffstring
);
10532 /* Run the functions in suspend-hook. */
10533 hook
= intern ("suspend-hook");
10534 Frun_hooks (1, &hook
);
10536 GCPRO1 (stuffstring
);
10537 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10538 reset_all_sys_modes ();
10539 /* sys_suspend can get an error if it tries to fork a subshell
10540 and the system resources aren't available for that. */
10541 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10543 stuff_buffered_input (stuffstring
);
10544 if (cannot_suspend
)
10548 unbind_to (count
, Qnil
);
10550 /* Check if terminal/window size has changed.
10551 Note that this is not useful when we are running directly
10552 with a window system; but suspend should be disabled in that case. */
10553 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10554 if (width
!= old_width
|| height
!= old_height
)
10555 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10557 /* Run suspend-resume-hook. */
10558 hook
= intern ("suspend-resume-hook");
10559 Frun_hooks (1, &hook
);
10565 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10566 Then in any case stuff anything Emacs has read ahead and not used. */
10569 stuff_buffered_input (Lisp_Object stuffstring
)
10571 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10572 register unsigned char *p
;
10574 if (STRINGP (stuffstring
))
10576 register ptrdiff_t count
;
10578 p
= SDATA (stuffstring
);
10579 count
= SBYTES (stuffstring
);
10580 while (count
-- > 0)
10585 /* Anything we have read ahead, put back for the shell to read. */
10586 /* ?? What should this do when we have multiple keyboards??
10587 Should we ignore anything that was typed in at the "wrong" kboard?
10589 rms: we should stuff everything back into the kboard
10591 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10594 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10595 kbd_fetch_ptr
= kbd_buffer
;
10596 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10597 stuff_char (kbd_fetch_ptr
->code
);
10599 clear_event (kbd_fetch_ptr
);
10603 #endif /* SIGTSTP */
10607 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10609 input_available_clear_time
= time_to_clear
;
10611 /* Tell handle_interrupt to throw back to read_char, */
10612 waiting_for_input
= 1;
10614 /* If handle_interrupt was called before and buffered a C-g,
10615 make it run again now, to avoid timing error. */
10616 if (!NILP (Vquit_flag
))
10617 quit_throw_to_read_char (0);
10621 clear_waiting_for_input (void)
10623 /* Tell handle_interrupt not to throw back to read_char, */
10624 waiting_for_input
= 0;
10625 input_available_clear_time
= 0;
10628 /* The SIGINT handler.
10630 If we have a frame on the controlling tty, we assume that the
10631 SIGINT was generated by C-g, so we call handle_interrupt.
10632 Otherwise, tell QUIT to kill Emacs. */
10635 handle_interrupt_signal (int sig
)
10637 /* See if we have an active terminal on our controlling tty. */
10638 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10641 /* If there are no frames there, let's pretend that we are a
10642 well-behaving UN*X program and quit. We must not call Lisp
10643 in a signal handler, so tell QUIT to exit when it is
10645 Vquit_flag
= Qkill_emacs
;
10649 /* Otherwise, the SIGINT was probably generated by C-g. */
10651 /* Set internal_last_event_frame to the top frame of the
10652 controlling tty, if we have a frame there. We disable the
10653 interrupt key on secondary ttys, so the SIGINT must have come
10654 from the controlling tty. */
10655 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10657 handle_interrupt (1);
10662 deliver_interrupt_signal (int sig
)
10664 deliver_process_signal (sig
, handle_interrupt_signal
);
10668 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10669 of the number of times C-g has been requested. If C-g is pressed
10670 enough times, then quit anyway. See bug#6585. */
10671 static int volatile force_quit_count
;
10673 /* This routine is called at interrupt level in response to C-g.
10675 It is called from the SIGINT handler or kbd_buffer_store_event.
10677 If `waiting_for_input' is non zero, then unless `echoing' is
10678 nonzero, immediately throw back to read_char.
10680 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10681 eval to throw, when it gets a chance. If quit-flag is already
10682 non-nil, it stops the job right away. */
10685 handle_interrupt (bool in_signal_handler
)
10691 /* XXX This code needs to be revised for multi-tty support. */
10692 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10694 if (! in_signal_handler
)
10696 /* If SIGINT isn't blocked, don't let us be interrupted by
10697 a SIGINT. It might be harmful due to non-reentrancy
10698 in I/O functions. */
10700 sigemptyset (&blocked
);
10701 sigaddset (&blocked
, SIGINT
);
10702 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10706 reset_all_sys_modes ();
10710 * On systems which can suspend the current process and return to the original
10711 * shell, this command causes the user to end up back at the shell.
10712 * The "Auto-save" and "Abort" questions are not asked until
10713 * the user elects to return to emacs, at which point he can save the current
10714 * job and either dump core or continue.
10718 /* Perhaps should really fork an inferior shell?
10719 But that would not provide any way to get back
10720 to the original shell, ever. */
10721 printf ("No support for stopping a process on this operating system;\n");
10722 printf ("you can continue or abort.\n");
10723 #endif /* not SIGTSTP */
10725 /* We must remain inside the screen area when the internal terminal
10726 is used. Note that [Enter] is not echoed by dos. */
10727 cursor_to (SELECTED_FRAME (), 0, 0);
10729 /* It doesn't work to autosave while GC is in progress;
10730 the code used for auto-saving doesn't cope with the mark bit. */
10731 if (!gc_in_progress
)
10733 printf ("Auto-save? (y or n) ");
10735 if (((c
= getchar ()) & ~040) == 'Y')
10737 Fdo_auto_save (Qt
, Qnil
);
10739 printf ("\r\nAuto-save done");
10740 #else /* not MSDOS */
10741 printf ("Auto-save done\n");
10742 #endif /* not MSDOS */
10744 while (c
!= '\n') c
= getchar ();
10748 /* During GC, it must be safe to reenable quitting again. */
10749 Vinhibit_quit
= Qnil
;
10752 #endif /* not MSDOS */
10753 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10754 printf ("but will instead do a real quit after garbage collection ends\r\n");
10759 printf ("\r\nAbort? (y or n) ");
10760 #else /* not MSDOS */
10761 printf ("Abort (and dump core)? (y or n) ");
10762 #endif /* not MSDOS */
10764 if (((c
= getchar ()) & ~040) == 'Y')
10766 while (c
!= '\n') c
= getchar ();
10768 printf ("\r\nContinuing...\r\n");
10769 #else /* not MSDOS */
10770 printf ("Continuing...\n");
10771 #endif /* not MSDOS */
10773 init_all_sys_modes ();
10777 /* If executing a function that wants to be interrupted out of
10778 and the user has not deferred quitting by binding `inhibit-quit'
10779 then quit right away. */
10780 if (immediate_quit
&& NILP (Vinhibit_quit
))
10782 struct gl_state_s saved
;
10783 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10785 immediate_quit
= 0;
10786 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10788 GCPRO4 (saved
.object
, saved
.global_code
,
10789 saved
.current_syntax_table
, saved
.old_prop
);
10790 Fsignal (Qquit
, Qnil
);
10795 { /* Else request quit when it's safe. */
10796 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10797 force_quit_count
= count
;
10800 immediate_quit
= 1;
10801 Vinhibit_quit
= Qnil
;
10807 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10809 /* TODO: The longjmp in this call throws the NS event loop integration off,
10810 and it seems to do fine without this. Probably some attention
10811 needs to be paid to the setting of waiting_for_input in
10812 wait_reading_process_output() under HAVE_NS because of the call
10813 to ns_select there (needed because otherwise events aren't picked up
10814 outside of polling since we don't get SIGIO like X and we don't have a
10815 separate event loop thread like W32. */
10817 if (waiting_for_input
&& !echoing
)
10818 quit_throw_to_read_char (in_signal_handler
);
10822 /* Handle a C-g by making read_char return C-g. */
10825 quit_throw_to_read_char (bool from_signal
)
10827 /* When not called from a signal handler it is safe to call
10829 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10830 Fkill_emacs (Qnil
);
10832 /* Prevent another signal from doing this before we finish. */
10833 clear_waiting_for_input ();
10836 Vunread_command_events
= Qnil
;
10838 if (FRAMEP (internal_last_event_frame
)
10839 && !EQ (internal_last_event_frame
, selected_frame
))
10840 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10843 sys_longjmp (getcjmp
, 1);
10846 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10847 Sset_input_interrupt_mode
, 1, 1, 0,
10848 doc
: /* Set interrupt mode of reading keyboard input.
10849 If INTERRUPT is non-nil, Emacs will use input interrupts;
10850 otherwise Emacs uses CBREAK mode.
10852 See also `current-input-mode'. */)
10853 (Lisp_Object interrupt
)
10855 bool new_interrupt_input
;
10856 #ifdef USABLE_SIGIO
10857 #ifdef HAVE_X_WINDOWS
10858 if (x_display_list
!= NULL
)
10860 /* When using X, don't give the user a real choice,
10861 because we haven't implemented the mechanisms to support it. */
10862 new_interrupt_input
= 1;
10865 #endif /* HAVE_X_WINDOWS */
10866 new_interrupt_input
= !NILP (interrupt
);
10867 #else /* not USABLE_SIGIO */
10868 new_interrupt_input
= 0;
10869 #endif /* not USABLE_SIGIO */
10871 if (new_interrupt_input
!= interrupt_input
)
10873 #ifdef POLL_FOR_INPUT
10877 /* this causes startup screen to be restored and messes with the mouse */
10878 reset_all_sys_modes ();
10879 interrupt_input
= new_interrupt_input
;
10880 init_all_sys_modes ();
10882 interrupt_input
= new_interrupt_input
;
10885 #ifdef POLL_FOR_INPUT
10886 poll_suppress_count
= 1;
10893 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10894 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10895 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10896 C-q in key sequences.
10898 This setting only has an effect on tty terminals and only when
10899 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10901 See also `current-input-mode'. */)
10902 (Lisp_Object flow
, Lisp_Object terminal
)
10904 struct terminal
*t
= get_terminal (terminal
, 1);
10905 struct tty_display_info
*tty
;
10906 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10908 tty
= t
->display_info
.tty
;
10910 if (tty
->flow_control
!= !NILP (flow
))
10913 /* this causes startup screen to be restored and messes with the mouse */
10914 reset_sys_modes (tty
);
10917 tty
->flow_control
= !NILP (flow
);
10920 init_sys_modes (tty
);
10926 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10927 doc
: /* Enable or disable 8-bit input on TERMINAL.
10928 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10929 bit as the Meta modifier.
10931 If META is nil, Emacs will ignore the top bit, on the assumption it is
10934 Otherwise, Emacs will accept and pass through 8-bit input without
10935 specially interpreting the top bit.
10937 This setting only has an effect on tty terminal devices.
10939 Optional parameter TERMINAL specifies the tty terminal device to use.
10940 It may be a terminal object, a frame, or nil for the terminal used by
10941 the currently selected frame.
10943 See also `current-input-mode'. */)
10944 (Lisp_Object meta
, Lisp_Object terminal
)
10946 struct terminal
*t
= get_terminal (terminal
, 1);
10947 struct tty_display_info
*tty
;
10950 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10952 tty
= t
->display_info
.tty
;
10956 else if (EQ (meta
, Qt
))
10961 if (tty
->meta_key
!= new_meta
)
10964 /* this causes startup screen to be restored and messes with the mouse */
10965 reset_sys_modes (tty
);
10968 tty
->meta_key
= new_meta
;
10971 init_sys_modes (tty
);
10977 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10978 doc
: /* Specify character used for quitting.
10979 QUIT must be an ASCII character.
10981 This function only has an effect on the controlling tty of the Emacs
10984 See also `current-input-mode'. */)
10987 struct terminal
*t
= get_named_tty ("/dev/tty");
10988 struct tty_display_info
*tty
;
10989 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10991 tty
= t
->display_info
.tty
;
10993 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10994 error ("QUIT must be an ASCII character");
10997 /* this causes startup screen to be restored and messes with the mouse */
10998 reset_sys_modes (tty
);
11001 /* Don't let this value be out of range. */
11002 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11005 init_sys_modes (tty
);
11011 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11012 doc
: /* Set mode of reading keyboard input.
11013 First arg INTERRUPT non-nil means use input interrupts;
11014 nil means use CBREAK mode.
11015 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11016 (no effect except in CBREAK mode).
11017 Third arg META t means accept 8-bit input (for a Meta key).
11018 META nil means ignore the top bit, on the assumption it is parity.
11019 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11020 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11021 See also `current-input-mode'. */)
11022 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11024 Fset_input_interrupt_mode (interrupt
);
11025 Fset_output_flow_control (flow
, Qnil
);
11026 Fset_input_meta_mode (meta
, Qnil
);
11028 Fset_quit_char (quit
);
11032 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11033 doc
: /* Return information about the way Emacs currently reads keyboard input.
11034 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11035 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11036 nil, Emacs is using CBREAK mode.
11037 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11038 terminal; this does not apply if Emacs uses interrupt-driven input.
11039 META is t if accepting 8-bit input with 8th bit as Meta flag.
11040 META nil means ignoring the top bit, on the assumption it is parity.
11041 META is neither t nor nil if accepting 8-bit input and using
11042 all 8 bits as the character code.
11043 QUIT is the character Emacs currently uses to quit.
11044 The elements of this list correspond to the arguments of
11045 `set-input-mode'. */)
11048 Lisp_Object val
[4];
11049 struct frame
*sf
= XFRAME (selected_frame
);
11051 val
[0] = interrupt_input
? Qt
: Qnil
;
11052 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11054 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11055 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11057 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11064 XSETFASTINT (val
[3], quit_char
);
11066 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11069 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11070 doc
: /* Return position information for pixel coordinates X and Y.
11071 By default, X and Y are relative to text area of the selected window.
11072 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11073 If optional fourth arg WHOLE is non-nil, X is relative to the left
11074 edge of the window.
11076 The return value is similar to a mouse click position:
11077 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11078 IMAGE (DX . DY) (WIDTH . HEIGHT))
11079 The `posn-' functions access elements of such lists. */)
11080 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11085 if (NILP (frame_or_window
))
11086 frame_or_window
= selected_window
;
11088 if (WINDOWP (frame_or_window
))
11090 struct window
*w
= decode_live_window (frame_or_window
);
11092 XSETINT (x
, (XINT (x
)
11093 + WINDOW_LEFT_EDGE_X (w
)
11095 ? window_box_left_offset (w
, TEXT_AREA
)
11097 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11098 frame_or_window
= w
->frame
;
11101 CHECK_LIVE_FRAME (frame_or_window
);
11103 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11106 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11107 doc
: /* Return position information for buffer POS in WINDOW.
11108 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11110 Return nil if position is not visible in window. Otherwise,
11111 the return value is similar to that returned by `event-start' for
11112 a mouse click at the upper left corner of the glyph corresponding
11113 to the given buffer position:
11114 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11115 IMAGE (DX . DY) (WIDTH . HEIGHT))
11116 The `posn-' functions access elements of such lists. */)
11117 (Lisp_Object pos
, Lisp_Object window
)
11122 window
= selected_window
;
11124 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11127 Lisp_Object x
= XCAR (tem
);
11128 Lisp_Object y
= XCAR (XCDR (tem
));
11130 /* Point invisible due to hscrolling? */
11133 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11141 * Set up a new kboard object with reasonable initial values.
11144 init_kboard (KBOARD
*kb
)
11146 kset_overriding_terminal_local_map (kb
, Qnil
);
11147 kset_last_command (kb
, Qnil
);
11148 kset_real_last_command (kb
, Qnil
);
11149 kset_keyboard_translate_table (kb
, Qnil
);
11150 kset_last_repeatable_command (kb
, Qnil
);
11151 kset_prefix_arg (kb
, Qnil
);
11152 kset_last_prefix_arg (kb
, Qnil
);
11153 kset_kbd_queue (kb
, Qnil
);
11154 kb
->kbd_queue_has_data
= 0;
11155 kb
->immediate_echo
= 0;
11156 kset_echo_string (kb
, Qnil
);
11157 kb
->echo_after_prompt
= -1;
11158 kb
->kbd_macro_buffer
= 0;
11159 kb
->kbd_macro_bufsize
= 0;
11160 kset_defining_kbd_macro (kb
, Qnil
);
11161 kset_last_kbd_macro (kb
, Qnil
);
11162 kb
->reference_count
= 0;
11163 kset_system_key_alist (kb
, Qnil
);
11164 kset_system_key_syms (kb
, Qnil
);
11165 kset_window_system (kb
, Qt
); /* Unset. */
11166 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11167 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11168 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11169 kset_default_minibuffer_frame (kb
, Qnil
);
11173 * Destroy the contents of a kboard object, but not the object itself.
11174 * We use this just before deleting it, or if we're going to initialize
11175 * it a second time.
11178 wipe_kboard (KBOARD
*kb
)
11180 xfree (kb
->kbd_macro_buffer
);
11183 /* Free KB and memory referenced from it. */
11186 delete_kboard (KBOARD
*kb
)
11190 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11193 *kbp
= kb
->next_kboard
;
11195 /* Prevent a dangling reference to KB. */
11196 if (kb
== current_kboard
11197 && FRAMEP (selected_frame
)
11198 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11200 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11202 if (current_kboard
== kb
)
11211 init_keyboard (void)
11213 /* This is correct before outermost invocation of the editor loop. */
11214 command_loop_level
= -1;
11215 immediate_quit
= 0;
11216 quit_char
= Ctl ('g');
11217 Vunread_command_events
= Qnil
;
11218 timer_idleness_start_time
= invalid_emacs_time ();
11220 recent_keys_index
= 0;
11221 kbd_fetch_ptr
= kbd_buffer
;
11222 kbd_store_ptr
= kbd_buffer
;
11223 do_mouse_tracking
= Qnil
;
11225 interrupt_input_blocked
= 0;
11226 pending_signals
= 0;
11228 /* This means that command_loop_1 won't try to select anything the first
11230 internal_last_event_frame
= Qnil
;
11231 Vlast_event_frame
= internal_last_event_frame
;
11233 current_kboard
= initial_kboard
;
11234 /* Re-initialize the keyboard again. */
11235 wipe_kboard (current_kboard
);
11236 init_kboard (current_kboard
);
11237 /* A value of nil for Vwindow_system normally means a tty, but we also use
11238 it for the initial terminal since there is no window system there. */
11239 kset_window_system (current_kboard
, Qnil
);
11241 if (!noninteractive
)
11243 /* Before multi-tty support, these handlers used to be installed
11244 only if the current session was a tty session. Now an Emacs
11245 session may have multiple display types, so we always handle
11246 SIGINT. There is special code in handle_interrupt_signal to exit
11247 Emacs on SIGINT when there are no termcap frames on the
11248 controlling terminal. */
11249 struct sigaction action
;
11250 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11251 sigaction (SIGINT
, &action
, 0);
11253 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11254 SIGQUIT and we can't tell which one it will give us. */
11255 sigaction (SIGQUIT
, &action
, 0);
11256 #endif /* not DOS_NT */
11258 #ifdef USABLE_SIGIO
11259 if (!noninteractive
)
11261 struct sigaction action
;
11262 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11263 sigaction (SIGIO
, &action
, 0);
11267 /* Use interrupt input by default, if it works and noninterrupt input
11268 has deficiencies. */
11270 #ifdef INTERRUPT_INPUT
11271 interrupt_input
= 1;
11273 interrupt_input
= 0;
11276 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11279 if (keyboard_init_hook
)
11280 (*keyboard_init_hook
) ();
11282 #ifdef POLL_FOR_INPUT
11284 poll_suppress_count
= 1;
11289 /* This type's only use is in syms_of_keyboard, to initialize the
11290 event header symbols and put properties on them. */
11291 struct event_head
{
11297 static const struct event_head head_table
[] = {
11298 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11299 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11300 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11301 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11302 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11303 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11304 /* `select-window' should be handled just like `switch-frame'
11305 in read_key_sequence. */
11306 {&Qselect_window
, "select-window", &Qswitch_frame
}
11310 syms_of_keyboard (void)
11312 pending_funcalls
= Qnil
;
11313 staticpro (&pending_funcalls
);
11315 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11316 staticpro (&Vlispy_mouse_stem
);
11319 DEFSYM (QCimage
, ":image");
11320 DEFSYM (Qhelp_echo
, "help-echo");
11321 DEFSYM (QCrtl
, ":rtl");
11323 staticpro (&item_properties
);
11324 item_properties
= Qnil
;
11326 staticpro (&tool_bar_item_properties
);
11327 tool_bar_item_properties
= Qnil
;
11328 staticpro (&tool_bar_items_vector
);
11329 tool_bar_items_vector
= Qnil
;
11331 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11332 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11333 DEFSYM (Qself_insert_command
, "self-insert-command");
11334 DEFSYM (Qforward_char
, "forward-char");
11335 DEFSYM (Qbackward_char
, "backward-char");
11336 DEFSYM (Qdisabled
, "disabled");
11337 DEFSYM (Qundefined
, "undefined");
11338 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11339 DEFSYM (Qpost_command_hook
, "post-command-hook");
11340 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11341 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11342 DEFSYM (Qfunction_key
, "function-key");
11343 DEFSYM (Qmouse_click
, "mouse-click");
11344 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11345 DEFSYM (Qsave_session
, "save-session");
11346 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11347 DEFSYM (Qmenu_enable
, "menu-enable");
11350 DEFSYM (Qlanguage_change
, "language-change");
11354 DEFSYM (Qdbus_event
, "dbus-event");
11357 #ifdef HAVE_INOTIFY
11358 DEFSYM (Qfile_inotify
, "file-inotify");
11359 #endif /* HAVE_INOTIFY */
11361 DEFSYM (QCenable
, ":enable");
11362 DEFSYM (QCvisible
, ":visible");
11363 DEFSYM (QChelp
, ":help");
11364 DEFSYM (QCfilter
, ":filter");
11365 DEFSYM (QCbutton
, ":button");
11366 DEFSYM (QCkeys
, ":keys");
11367 DEFSYM (QCkey_sequence
, ":key-sequence");
11368 DEFSYM (QCtoggle
, ":toggle");
11369 DEFSYM (QCradio
, ":radio");
11370 DEFSYM (QClabel
, ":label");
11371 DEFSYM (QCvert_only
, ":vert-only");
11373 DEFSYM (Qmode_line
, "mode-line");
11374 DEFSYM (Qvertical_line
, "vertical-line");
11375 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11376 DEFSYM (Qmenu_bar
, "menu-bar");
11378 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11380 DEFSYM (Qabove_handle
, "above-handle");
11381 DEFSYM (Qhandle
, "handle");
11382 DEFSYM (Qbelow_handle
, "below-handle");
11383 DEFSYM (Qup
, "up");
11384 DEFSYM (Qdown
, "down");
11385 DEFSYM (Qtop
, "top");
11386 DEFSYM (Qbottom
, "bottom");
11387 DEFSYM (Qend_scroll
, "end-scroll");
11388 DEFSYM (Qratio
, "ratio");
11390 DEFSYM (Qevent_kind
, "event-kind");
11391 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11392 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11393 DEFSYM (Qmodifier_cache
, "modifier-cache");
11395 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11396 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11398 DEFSYM (Qpolling_period
, "polling-period");
11400 DEFSYM (Qx_set_selection
, "x-set-selection");
11401 DEFSYM (QPRIMARY
, "PRIMARY");
11402 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11403 DEFSYM (Qhandle_select_window
, "handle-select-window");
11405 DEFSYM (Qinput_method_function
, "input-method-function");
11406 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11407 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11409 DEFSYM (Qhelp_form_show
, "help-form-show");
11411 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11412 Fset (Qinput_method_use_echo_area
, Qnil
);
11414 last_point_position_buffer
= Qnil
;
11415 last_point_position_window
= Qnil
;
11419 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11421 for (i
= 0; i
< len
; i
++)
11423 const struct event_head
*p
= &head_table
[i
];
11424 *p
->var
= intern_c_string (p
->name
);
11425 staticpro (p
->var
);
11426 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11427 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11431 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11432 staticpro (&button_down_location
);
11433 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11434 staticpro (&mouse_syms
);
11435 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11436 / sizeof (lispy_wheel_names
[0])),
11438 staticpro (&wheel_syms
);
11442 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11444 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11445 for (i
= 0; i
< len
; i
++)
11446 if (modifier_names
[i
])
11447 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11448 staticpro (&modifier_symbols
);
11451 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11452 staticpro (&recent_keys
);
11454 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11455 staticpro (&this_command_keys
);
11457 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11458 staticpro (&raw_keybuf
);
11460 DEFSYM (Qextended_command_history
, "extended-command-history");
11461 Fset (Qextended_command_history
, Qnil
);
11463 accent_key_syms
= Qnil
;
11464 staticpro (&accent_key_syms
);
11466 func_key_syms
= Qnil
;
11467 staticpro (&func_key_syms
);
11469 drag_n_drop_syms
= Qnil
;
11470 staticpro (&drag_n_drop_syms
);
11472 unread_switch_frame
= Qnil
;
11473 staticpro (&unread_switch_frame
);
11475 internal_last_event_frame
= Qnil
;
11476 staticpro (&internal_last_event_frame
);
11478 read_key_sequence_cmd
= Qnil
;
11479 staticpro (&read_key_sequence_cmd
);
11480 read_key_sequence_remapped
= Qnil
;
11481 staticpro (&read_key_sequence_remapped
);
11483 menu_bar_one_keymap_changed_items
= Qnil
;
11484 staticpro (&menu_bar_one_keymap_changed_items
);
11486 menu_bar_items_vector
= Qnil
;
11487 staticpro (&menu_bar_items_vector
);
11489 help_form_saved_window_configs
= Qnil
;
11490 staticpro (&help_form_saved_window_configs
);
11492 defsubr (&Scurrent_idle_time
);
11493 defsubr (&Sevent_symbol_parse_modifiers
);
11494 defsubr (&Sevent_convert_list
);
11495 defsubr (&Sread_key_sequence
);
11496 defsubr (&Sread_key_sequence_vector
);
11497 defsubr (&Srecursive_edit
);
11498 defsubr (&Strack_mouse
);
11499 defsubr (&Sinput_pending_p
);
11500 defsubr (&Scommand_execute
);
11501 defsubr (&Srecent_keys
);
11502 defsubr (&Sthis_command_keys
);
11503 defsubr (&Sthis_command_keys_vector
);
11504 defsubr (&Sthis_single_command_keys
);
11505 defsubr (&Sthis_single_command_raw_keys
);
11506 defsubr (&Sreset_this_command_lengths
);
11507 defsubr (&Sclear_this_command_keys
);
11508 defsubr (&Ssuspend_emacs
);
11509 defsubr (&Sabort_recursive_edit
);
11510 defsubr (&Sexit_recursive_edit
);
11511 defsubr (&Srecursion_depth
);
11512 defsubr (&Stop_level
);
11513 defsubr (&Sdiscard_input
);
11514 defsubr (&Sopen_dribble_file
);
11515 defsubr (&Sset_input_interrupt_mode
);
11516 defsubr (&Sset_output_flow_control
);
11517 defsubr (&Sset_input_meta_mode
);
11518 defsubr (&Sset_quit_char
);
11519 defsubr (&Sset_input_mode
);
11520 defsubr (&Scurrent_input_mode
);
11521 defsubr (&Sposn_at_point
);
11522 defsubr (&Sposn_at_x_y
);
11524 DEFVAR_LISP ("last-command-event", last_command_event
,
11525 doc
: /* Last input event that was part of a command. */);
11527 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11528 doc
: /* Last input event in a command, except for mouse menu events.
11529 Mouse menus give back keys that don't look like mouse events;
11530 this variable holds the actual mouse event that led to the menu,
11531 so that you can determine whether the command was run by mouse or not. */);
11533 DEFVAR_LISP ("last-input-event", last_input_event
,
11534 doc
: /* Last input event. */);
11536 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11537 doc
: /* List of events to be read as the command input.
11538 These events are processed first, before actual keyboard input.
11539 Events read from this list are not normally added to `this-command-keys',
11540 as they will already have been added once as they were read for the first time.
11541 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11542 Vunread_command_events
= Qnil
;
11544 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11545 doc
: /* List of events to be processed as input by input methods.
11546 These events are processed before `unread-command-events'
11547 and actual keyboard input, but are not given to `input-method-function'. */);
11548 Vunread_post_input_method_events
= Qnil
;
11550 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11551 doc
: /* List of events to be processed as input by input methods.
11552 These events are processed after `unread-command-events', but
11553 before actual keyboard input.
11554 If there's an active input method, the events are given to
11555 `input-method-function'. */);
11556 Vunread_input_method_events
= Qnil
;
11558 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11559 doc
: /* Meta-prefix character code.
11560 Meta-foo as command input turns into this character followed by foo. */);
11561 XSETINT (meta_prefix_char
, 033);
11563 DEFVAR_KBOARD ("last-command", Vlast_command
,
11564 doc
: /* The last command executed.
11565 Normally a symbol with a function definition, but can be whatever was found
11566 in the keymap, or whatever the variable `this-command' was set to by that
11569 The value `mode-exit' is special; it means that the previous command
11570 read an event that told it to exit, and it did so and unread that event.
11571 In other words, the present command is the event that made the previous
11574 The value `kill-region' is special; it means that the previous command
11575 was a kill command.
11577 `last-command' has a separate binding for each terminal device.
11578 See Info node `(elisp)Multiple Terminals'. */);
11580 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11581 doc
: /* Same as `last-command', but never altered by Lisp code.
11582 Taken from the previous value of `real-this-command'. */);
11584 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11585 doc
: /* Last command that may be repeated.
11586 The last command executed that was not bound to an input event.
11587 This is the command `repeat' will try to repeat.
11588 Taken from a previous value of `real-this-command'. */);
11590 DEFVAR_LISP ("this-command", Vthis_command
,
11591 doc
: /* The command now being executed.
11592 The command can set this variable; whatever is put here
11593 will be in `last-command' during the following command. */);
11594 Vthis_command
= Qnil
;
11596 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11597 doc
: /* This is like `this-command', except that commands should never modify it. */);
11598 Vreal_this_command
= Qnil
;
11600 DEFVAR_LISP ("this-command-keys-shift-translated",
11601 Vthis_command_keys_shift_translated
,
11602 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11603 Shift-translation occurs when there is no binding for the key sequence
11604 as entered, but a binding was found by changing an upper-case letter
11605 to lower-case, or a shifted function key to an unshifted one. */);
11606 Vthis_command_keys_shift_translated
= Qnil
;
11608 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11609 doc
: /* The command bound to the current key sequence before remapping.
11610 It equals `this-command' if the original command was not remapped through
11611 any of the active keymaps. Otherwise, the value of `this-command' is the
11612 result of looking up the original command in the active keymaps. */);
11613 Vthis_original_command
= Qnil
;
11615 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11616 doc
: /* Number of input events between auto-saves.
11617 Zero means disable autosaving due to number of characters typed. */);
11618 auto_save_interval
= 300;
11620 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11621 doc
: /* Number of seconds idle time before auto-save.
11622 Zero or nil means disable auto-saving due to idleness.
11623 After auto-saving due to this many seconds of idle time,
11624 Emacs also does a garbage collection if that seems to be warranted. */);
11625 XSETFASTINT (Vauto_save_timeout
, 30);
11627 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11628 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11629 The value may be integer or floating point.
11630 If the value is zero, don't echo at all. */);
11631 Vecho_keystrokes
= make_number (1);
11633 DEFVAR_INT ("polling-period", polling_period
,
11634 doc
: /* Interval between polling for input during Lisp execution.
11635 The reason for polling is to make C-g work to stop a running program.
11636 Polling is needed only when using X windows and SIGIO does not work.
11637 Polling is automatically disabled in all other cases. */);
11638 polling_period
= 2;
11640 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11641 doc
: /* Maximum time between mouse clicks to make a double-click.
11642 Measured in milliseconds. The value nil means disable double-click
11643 recognition; t means double-clicks have no time limit and are detected
11644 by position only. */);
11645 Vdouble_click_time
= make_number (500);
11647 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11648 doc
: /* Maximum mouse movement between clicks to make a double-click.
11649 On window-system frames, value is the number of pixels the mouse may have
11650 moved horizontally or vertically between two clicks to make a double-click.
11651 On non window-system frames, value is interpreted in units of 1/8 characters
11654 This variable is also the threshold for motion of the mouse
11655 to count as a drag. */);
11656 double_click_fuzz
= 3;
11658 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11659 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11660 inhibit_local_menu_bar_menus
= 0;
11662 DEFVAR_INT ("num-input-keys", num_input_keys
,
11663 doc
: /* Number of complete key sequences read as input so far.
11664 This includes key sequences read from keyboard macros.
11665 The number is effectively the number of interactive command invocations. */);
11666 num_input_keys
= 0;
11668 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11669 doc
: /* Number of input events read from the keyboard so far.
11670 This does not include events generated by keyboard macros. */);
11671 num_nonmacro_input_events
= 0;
11673 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11674 doc
: /* The frame in which the most recently read event occurred.
11675 If the last event came from a keyboard macro, this is set to `macro'. */);
11676 Vlast_event_frame
= Qnil
;
11678 /* This variable is set up in sysdep.c. */
11679 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11680 doc
: /* The ERASE character as set by the user with stty. */);
11682 DEFVAR_LISP ("help-char", Vhelp_char
,
11683 doc
: /* Character to recognize as meaning Help.
11684 When it is read, do `(eval help-form)', and display result if it's a string.
11685 If the value of `help-form' is nil, this char can be read normally. */);
11686 XSETINT (Vhelp_char
, Ctl ('H'));
11688 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11689 doc
: /* List of input events to recognize as meaning Help.
11690 These work just like the value of `help-char' (see that). */);
11691 Vhelp_event_list
= Qnil
;
11693 DEFVAR_LISP ("help-form", Vhelp_form
,
11694 doc
: /* Form to execute when character `help-char' is read.
11695 If the form returns a string, that string is displayed.
11696 If `help-form' is nil, the help char is not recognized. */);
11699 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11700 doc
: /* Command to run when `help-char' character follows a prefix key.
11701 This command is used only when there is no actual binding
11702 for that character after that prefix key. */);
11703 Vprefix_help_command
= Qnil
;
11705 DEFVAR_LISP ("top-level", Vtop_level
,
11706 doc
: /* Form to evaluate when Emacs starts up.
11707 Useful to set before you dump a modified Emacs. */);
11710 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11711 doc
: /* Translate table for local keyboard input, or nil.
11712 If non-nil, the value should be a char-table. Each character read
11713 from the keyboard is looked up in this char-table. If the value found
11714 there is non-nil, then it is used instead of the actual input character.
11716 The value can also be a string or vector, but this is considered obsolete.
11717 If it is a string or vector of length N, character codes N and up are left
11718 untranslated. In a vector, an element which is nil means "no translation".
11720 This is applied to the characters supplied to input methods, not their
11721 output. See also `translation-table-for-input'.
11723 This variable has a separate binding for each terminal.
11724 See Info node `(elisp)Multiple Terminals'. */);
11726 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11727 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11728 \(Even if the operating system has support for stopping a process.\) */);
11729 cannot_suspend
= 0;
11731 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11732 doc
: /* Non-nil means prompt with menus when appropriate.
11733 This is done when reading from a keymap that has a prompt string,
11734 for elements that have prompt strings.
11735 The menu is displayed on the screen
11736 if X menus were enabled at configuration
11737 time and the previous event was a mouse click prefix key.
11738 Otherwise, menu prompting uses the echo area. */);
11739 menu_prompting
= 1;
11741 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11742 doc
: /* Character to see next line of menu prompt.
11743 Type this character while in a menu prompt to rotate around the lines of it. */);
11744 XSETINT (menu_prompt_more_char
, ' ');
11746 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11747 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11748 Emacs applies the modifiers of the character stored here to each keyboard
11749 character it reads. For example, after evaluating the expression
11750 (setq extra-keyboard-modifiers ?\\C-x)
11751 all input characters will have the control modifier applied to them.
11753 Note that the character ?\\C-@, equivalent to the integer zero, does
11754 not count as a control character; rather, it counts as a character
11755 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11756 cancels any modification. */);
11757 extra_keyboard_modifiers
= 0;
11759 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11760 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11761 The command loop sets this to nil before each command,
11762 and tests the value when the command returns.
11763 Buffer modification stores t in this variable. */);
11764 Vdeactivate_mark
= Qnil
;
11765 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11767 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11768 doc
: /* Normal hook run before each command is executed.
11769 If an unhandled error happens in running this hook,
11770 the function in which the error occurred is unconditionally removed, since
11771 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11772 Vpre_command_hook
= Qnil
;
11774 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11775 doc
: /* Normal hook run after each command is executed.
11776 If an unhandled error happens in running this hook,
11777 the function in which the error occurred is unconditionally removed, since
11778 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11779 Vpost_command_hook
= Qnil
;
11782 DEFVAR_LISP ("echo-area-clear-hook", ...,
11783 doc
: /* Normal hook run when clearing the echo area. */);
11785 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11786 Fset (Qecho_area_clear_hook
, Qnil
);
11788 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11789 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11790 Vlucid_menu_bar_dirty_flag
= Qnil
;
11792 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11793 doc
: /* List of menu bar items to move to the end of the menu bar.
11794 The elements of the list are event types that may have menu bar bindings. */);
11795 Vmenu_bar_final_items
= Qnil
;
11797 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11798 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11799 This is used internally by graphical displays that do not render
11800 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11801 Vtool_bar_separator_image_expression
= Qnil
;
11803 DEFVAR_KBOARD ("overriding-terminal-local-map",
11804 Voverriding_terminal_local_map
,
11805 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11806 If this variable is non-nil, it is used as a keymap instead of the
11807 buffer's local map, and the minor mode keymaps and text property keymaps.
11808 It also replaces `overriding-local-map'.
11810 This variable is intended to let commands such as `universal-argument'
11811 set up a different keymap for reading the next command.
11813 `overriding-terminal-local-map' has a separate binding for each
11815 See Info node `(elisp)Multiple Terminals'. */);
11817 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11818 doc
: /* Keymap that overrides all other local keymaps.
11819 If this variable is non-nil, it is used as a keymap--replacing the
11820 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11821 Voverriding_local_map
= Qnil
;
11823 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11824 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11825 Otherwise, the menu bar continues to reflect the buffer's local map
11826 and the minor mode maps regardless of `overriding-local-map'. */);
11827 Voverriding_local_map_menu_flag
= Qnil
;
11829 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11830 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11831 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11833 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11834 doc
: /* Non-nil means generate motion events for mouse motion. */);
11836 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11837 doc
: /* Alist of system-specific X windows key symbols.
11838 Each element should have the form (N . SYMBOL) where N is the
11839 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11840 and SYMBOL is its name.
11842 `system-key-alist' has a separate binding for each terminal device.
11843 See Info node `(elisp)Multiple Terminals'. */);
11845 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11846 doc
: /* Keymap that translates key sequences to key sequences during input.
11847 This is used mainly for mapping key sequences into some preferred
11848 key events (symbols).
11850 The `read-key-sequence' function replaces any subsequence bound by
11851 `local-function-key-map' with its binding. More precisely, when the
11852 active keymaps have no binding for the current key sequence but
11853 `local-function-key-map' binds a suffix of the sequence to a vector or
11854 string, `read-key-sequence' replaces the matching suffix with its
11855 binding, and continues with the new sequence.
11857 If the binding is a function, it is called with one argument (the prompt)
11858 and its return value (a key sequence) is used.
11860 The events that come from bindings in `local-function-key-map' are not
11861 themselves looked up in `local-function-key-map'.
11863 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11864 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11865 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11866 typing `ESC O P x' would return [f1 x].
11868 `local-function-key-map' has a separate binding for each terminal
11869 device. See Info node `(elisp)Multiple Terminals'. If you need to
11870 define a binding on all terminals, change `function-key-map'
11871 instead. Initially, `local-function-key-map' is an empty keymap that
11872 has `function-key-map' as its parent on all terminal devices. */);
11874 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11875 doc
: /* Keymap that decodes input escape sequences.
11876 This is used mainly for mapping ASCII function key sequences into
11877 real Emacs function key events (symbols).
11879 The `read-key-sequence' function replaces any subsequence bound by
11880 `input-decode-map' with its binding. Contrary to `function-key-map',
11881 this map applies its rebinding regardless of the presence of an ordinary
11882 binding. So it is more like `key-translation-map' except that it applies
11883 before `function-key-map' rather than after.
11885 If the binding is a function, it is called with one argument (the prompt)
11886 and its return value (a key sequence) is used.
11888 The events that come from bindings in `input-decode-map' are not
11889 themselves looked up in `input-decode-map'.
11891 This variable is keyboard-local. */);
11893 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11894 doc
: /* The parent keymap of all `local-function-key-map' instances.
11895 Function key definitions that apply to all terminal devices should go
11896 here. If a mapping is defined in both the current
11897 `local-function-key-map' binding and this variable, then the local
11898 definition will take precedence. */);
11899 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11901 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11902 doc
: /* Keymap of key translations that can override keymaps.
11903 This keymap works like `function-key-map', but comes after that,
11904 and its non-prefix bindings override ordinary bindings.
11905 Another difference is that it is global rather than keyboard-local. */);
11906 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11908 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11909 doc
: /* List of deferred actions to be performed at a later time.
11910 The precise format isn't relevant here; we just check whether it is nil. */);
11911 Vdeferred_action_list
= Qnil
;
11913 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11914 doc
: /* Function to call to handle deferred actions, after each command.
11915 This function is called with no arguments after each command
11916 whenever `deferred-action-list' is non-nil. */);
11917 Vdeferred_action_function
= Qnil
;
11919 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11920 doc
: /* List of warnings to be displayed after this command.
11921 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11922 as per the args of `display-warning' (which see).
11923 If this variable is non-nil, `delayed-warnings-hook' will be run
11924 immediately after running `post-command-hook'. */);
11925 Vdelayed_warnings_list
= Qnil
;
11927 DEFVAR_LISP ("timer-list", Vtimer_list
,
11928 doc
: /* List of active absolute time timers in order of increasing time. */);
11929 Vtimer_list
= Qnil
;
11931 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11932 doc
: /* List of active idle-time timers in order of increasing time. */);
11933 Vtimer_idle_list
= Qnil
;
11935 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11936 doc
: /* If non-nil, the function that implements the current input method.
11937 It's called with one argument, a printing character that was just read.
11938 \(That means a character with code 040...0176.)
11939 Typically this function uses `read-event' to read additional events.
11940 When it does so, it should first bind `input-method-function' to nil
11941 so it will not be called recursively.
11943 The function should return a list of zero or more events
11944 to be used as input. If it wants to put back some events
11945 to be reconsidered, separately, by the input method,
11946 it can add them to the beginning of `unread-command-events'.
11948 The input method function can find in `input-method-previous-message'
11949 the previous echo area message.
11951 The input method function should refer to the variables
11952 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11953 for guidance on what to do. */);
11954 Vinput_method_function
= Qnil
;
11956 DEFVAR_LISP ("input-method-previous-message",
11957 Vinput_method_previous_message
,
11958 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11959 This variable exists because `read-event' clears the echo area
11960 before running the input method. It is nil if there was no message. */);
11961 Vinput_method_previous_message
= Qnil
;
11963 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11964 doc
: /* If non-nil, the function that implements the display of help.
11965 It's called with one argument, the help string to display. */);
11966 Vshow_help_function
= Qnil
;
11968 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11969 doc
: /* If non-nil, suppress point adjustment after executing a command.
11971 After a command is executed, if point is moved into a region that has
11972 special properties (e.g. composition, display), we adjust point to
11973 the boundary of the region. But, when a command sets this variable to
11974 non-nil, we suppress the point adjustment.
11976 This variable is set to nil before reading a command, and is checked
11977 just after executing the command. */);
11978 Vdisable_point_adjustment
= Qnil
;
11980 DEFVAR_LISP ("global-disable-point-adjustment",
11981 Vglobal_disable_point_adjustment
,
11982 doc
: /* If non-nil, always suppress point adjustment.
11984 The default value is nil, in which case, point adjustment are
11985 suppressed only after special commands that set
11986 `disable-point-adjustment' (which see) to non-nil. */);
11987 Vglobal_disable_point_adjustment
= Qnil
;
11989 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11990 doc
: /* How long to display an echo-area message when the minibuffer is active.
11991 If the value is not a number, such messages don't time out. */);
11992 Vminibuffer_message_timeout
= make_number (2);
11994 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11995 doc
: /* If non-nil, any keyboard input throws to this symbol.
11996 The value of that variable is passed to `quit-flag' and later causes a
11997 peculiar kind of quitting. */);
11998 Vthrow_on_input
= Qnil
;
12000 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12001 doc
: /* If non-nil, function to output error messages.
12002 The arguments are the error data, a list of the form
12003 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12004 such as just as `condition-case' would bind its variable to,
12005 the context (a string which normally goes at the start of the message),
12006 and the Lisp function within which the error was signaled. */);
12007 Vcommand_error_function
= Qnil
;
12009 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12010 Venable_disabled_menus_and_buttons
,
12011 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12013 Help functions bind this to allow help on disabled menu items
12014 and tool-bar buttons. */);
12015 Venable_disabled_menus_and_buttons
= Qnil
;
12017 DEFVAR_LISP ("select-active-regions",
12018 Vselect_active_regions
,
12019 doc
: /* If non-nil, an active region automatically sets the primary selection.
12020 If the value is `only', only temporarily active regions (usually made
12021 by mouse-dragging or shift-selection) set the window selection.
12023 This takes effect only when Transient Mark mode is enabled. */);
12024 Vselect_active_regions
= Qt
;
12026 DEFVAR_LISP ("saved-region-selection",
12027 Vsaved_region_selection
,
12028 doc
: /* Contents of active region prior to buffer modification.
12029 If `select-active-regions' is non-nil, Emacs sets this to the
12030 text in the region before modifying the buffer. The next
12031 `deactivate-mark' call uses this to set the window selection. */);
12032 Vsaved_region_selection
= Qnil
;
12034 DEFVAR_LISP ("selection-inhibit-update-commands",
12035 Vselection_inhibit_update_commands
,
12036 doc
: /* List of commands which should not update the selection.
12037 Normally, if `select-active-regions' is non-nil and the mark remains
12038 active after a command (i.e. the mark was not deactivated), the Emacs
12039 command loop sets the selection to the text in the region. However,
12040 if the command is in this list, the selection is not updated. */);
12041 Vselection_inhibit_update_commands
12042 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12044 DEFVAR_LISP ("debug-on-event",
12046 doc
: /* Enter debugger on this event. When Emacs
12047 receives the special event specified by this variable, it will try to
12048 break into the debugger as soon as possible instead of processing the
12049 event normally through `special-event-map'.
12051 Currently, the only supported values for this
12052 variable are `sigusr1' and `sigusr2'. */);
12053 Vdebug_on_event
= intern_c_string ("sigusr2");
12055 /* Create the initial keyboard. */
12056 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12057 init_kboard (initial_kboard
);
12058 /* Vwindow_system is left at t for now. */
12059 initial_kboard
->next_kboard
= all_kboards
;
12060 all_kboards
= initial_kboard
;
12064 keys_of_keyboard (void)
12066 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12067 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12068 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12069 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12070 initial_define_key (meta_map
, 'x', "execute-extended-command");
12072 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12073 "handle-delete-frame");
12074 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12075 "ns-put-working-text");
12076 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12077 "ns-unput-working-text");
12078 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12079 current-prefix-arg, as is done in `handle-switch-frame'.
12080 But `handle-switch-frame is not run from the special-map.
12081 Commands from that map are run in a special way that automatically
12082 preserves the prefix-arg. Restoring the prefix arg here is not just
12083 redundant but harmful:
12085 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12086 - after the first prompt, the exit-minibuffer-hook is run which may
12087 iconify a frame and thus push a `iconify-frame' event.
12088 - after running exit-minibuffer-hook, current-prefix-arg is
12089 restored to the non-nil value it had before the prompt.
12090 - we enter the second prompt.
12091 current-prefix-arg is non-nil, prefix-arg is nil.
12092 - before running the first real event, we run the special iconify-frame
12093 event, but we pass the `special' arg to execute-command so
12094 current-prefix-arg and prefix-arg are left untouched.
12095 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12096 - the next key event will have a spuriously non-nil current-prefix-arg. */
12097 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12099 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12101 /* Handling it at such a low-level causes read_key_sequence to get
12102 * confused because it doesn't realize that the current_buffer was
12103 * changed by read_char.
12105 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12106 * "handle-select-window"); */
12107 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12108 "handle-save-session");
12111 /* Define a special event which is raised for dbus callback
12113 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12114 "dbus-handle-event");
12117 #ifdef HAVE_INOTIFY
12118 /* Define a special event which is raised for inotify callback
12120 initial_define_lispy_key (Vspecial_event_map
, "file-inotify",
12121 "inotify-handle-event");
12122 #endif /* HAVE_INOTIFY */
12124 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12126 #if defined (WINDOWSNT)
12127 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12132 /* Mark the pointers in the kboard objects.
12133 Called by Fgarbage_collect. */
12135 mark_kboards (void)
12139 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12141 if (kb
->kbd_macro_buffer
)
12142 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12144 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12145 mark_object (KVAR (kb
, Vlast_command
));
12146 mark_object (KVAR (kb
, Vreal_last_command
));
12147 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12148 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12149 mark_object (KVAR (kb
, Vprefix_arg
));
12150 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12151 mark_object (KVAR (kb
, kbd_queue
));
12152 mark_object (KVAR (kb
, defining_kbd_macro
));
12153 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12154 mark_object (KVAR (kb
, Vsystem_key_alist
));
12155 mark_object (KVAR (kb
, system_key_syms
));
12156 mark_object (KVAR (kb
, Vwindow_system
));
12157 mark_object (KVAR (kb
, Vinput_decode_map
));
12158 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12159 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12160 mark_object (KVAR (kb
, echo_string
));
12163 struct input_event
*event
;
12164 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12166 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12167 event
= kbd_buffer
;
12168 /* These two special event types has no Lisp_Objects to mark. */
12169 if (event
->kind
!= SELECTION_REQUEST_EVENT
12170 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12172 mark_object (event
->x
);
12173 mark_object (event
->y
);
12174 mark_object (event
->frame_or_window
);
12175 mark_object (event
->arg
);