1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #define BLOCKINPUT_INLINE EXTERN_INLINE
24 #define KEYBOARD_INLINE EXTERN_INLINE
32 #include "termhooks.h"
37 #include "character.h"
40 #include "dispextern.h"
42 #include "intervals.h"
44 #include "blockinput.h"
58 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #if defined USABLE_FIONREAD && defined USG5_4
62 # include <sys/filio.h>
65 #include "syssignal.h"
67 #include <sys/types.h>
71 #ifdef HAVE_WINDOW_SYSTEM
73 #endif /* HAVE_WINDOW_SYSTEM */
75 /* Variables for blockinput.h: */
77 /* Positive if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* True means an input interrupt or alarm signal has arrived.
81 The QUIT macro checks this. */
82 volatile bool pending_signals
;
84 #define KBD_BUFFER_SIZE 4096
86 KBOARD
*initial_kboard
;
87 KBOARD
*current_kboard
;
90 /* True in the single-kboard state, false in the any-kboard state. */
91 static bool single_kboard
;
93 /* Non-nil disable property on a command means
94 do not execute it; call disabled-command-function's value instead. */
95 Lisp_Object Qdisabled
;
96 static Lisp_Object Qdisabled_command_function
;
98 #define NUM_RECENT_KEYS (300)
100 /* Index for storing next element into recent_keys. */
101 static int recent_keys_index
;
103 /* Total number of elements stored into recent_keys. */
104 static int total_keys
;
106 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
107 static Lisp_Object recent_keys
;
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 ptrdiff_t this_command_key_count
;
117 /* True after calling Freset_this_command_lengths.
118 Usually it is false. */
119 static bool this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static ptrdiff_t before_command_key_count
;
137 static ptrdiff_t before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static sys_jmp_buf getcjmp
;
143 /* True while doing kbd input. */
144 bool waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* True means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 EMACS_INT command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static ptrdiff_t last_non_minibuf_size
;
203 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
204 uintmax_t num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 /* The timestamp of the last input event we received from the X server.
225 X Windows wants this for selection ownership. */
226 Time last_event_timestamp
;
228 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
229 static Lisp_Object Qhandle_select_window
;
230 Lisp_Object QPRIMARY
;
232 static Lisp_Object Qself_insert_command
;
233 static Lisp_Object Qforward_char
;
234 static Lisp_Object Qbackward_char
;
235 Lisp_Object Qundefined
;
236 static Lisp_Object Qtimer_event_handler
;
238 /* read_key_sequence stores here the command definition of the
239 key sequence that it reads. */
240 static Lisp_Object read_key_sequence_cmd
;
241 static Lisp_Object read_key_sequence_remapped
;
243 static Lisp_Object Qinput_method_function
;
245 static Lisp_Object Qdeactivate_mark
;
247 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
249 static Lisp_Object Qecho_area_clear_hook
;
251 /* Hooks to run before and after each command. */
252 static Lisp_Object Qpre_command_hook
;
253 static Lisp_Object Qpost_command_hook
;
255 static Lisp_Object Qdeferred_action_function
;
257 static Lisp_Object Qdelayed_warnings_hook
;
259 static Lisp_Object Qinput_method_exit_on_first_char
;
260 static Lisp_Object Qinput_method_use_echo_area
;
262 static Lisp_Object Qhelp_form_show
;
264 /* File in which we write all commands we read. */
265 static FILE *dribble
;
267 /* Nonzero if input is available. */
270 /* Circular buffer for pre-read keyboard input. */
272 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
274 /* Pointer to next available character in kbd_buffer.
275 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
276 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
277 next available char is in kbd_buffer[0]. */
278 static struct input_event
*kbd_fetch_ptr
;
280 /* Pointer to next place to store character in kbd_buffer. This
281 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
282 character should go in kbd_buffer[0]. */
283 static struct input_event
* volatile kbd_store_ptr
;
285 /* The above pair of variables forms a "queue empty" flag. When we
286 enqueue a non-hook event, we increment kbd_store_ptr. When we
287 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
288 there is input available if the two pointers are not equal.
290 Why not just have a flag set and cleared by the enqueuing and
291 dequeuing functions? Such a flag could be screwed up by interrupts
292 at inopportune times. */
294 /* Symbols to head events. */
295 static Lisp_Object Qmouse_movement
;
296 static Lisp_Object Qscroll_bar_movement
;
297 Lisp_Object Qswitch_frame
;
298 static Lisp_Object Qdelete_frame
;
299 static Lisp_Object Qiconify_frame
;
300 static Lisp_Object Qmake_frame_visible
;
301 static Lisp_Object Qselect_window
;
302 Lisp_Object Qhelp_echo
;
304 static Lisp_Object Qmouse_fixup_help_message
;
306 /* Symbols to denote kinds of events. */
307 static Lisp_Object Qfunction_key
;
308 Lisp_Object Qmouse_click
;
310 Lisp_Object Qlanguage_change
;
312 static Lisp_Object Qdrag_n_drop
;
313 static Lisp_Object Qsave_session
;
315 static Lisp_Object Qdbus_event
;
317 #ifdef USE_FILE_NOTIFY
318 static Lisp_Object Qfile_notify
;
319 #endif /* USE_FILE_NOTIFY */
320 static Lisp_Object Qconfig_changed_event
;
322 /* Lisp_Object Qmouse_movement; - also an event header */
324 /* Properties of event headers. */
325 Lisp_Object Qevent_kind
;
326 static Lisp_Object Qevent_symbol_elements
;
328 /* Menu and tool bar item parts. */
329 static Lisp_Object Qmenu_enable
;
330 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
331 Lisp_Object QCfilter
;
333 /* Non-nil disable property on a command means
334 do not execute it; call disabled-command-function's value instead. */
335 Lisp_Object QCtoggle
, QCradio
;
336 static Lisp_Object QCbutton
, QClabel
;
338 static Lisp_Object QCvert_only
;
340 /* An event header symbol HEAD may have a property named
341 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
342 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
343 mask of modifiers applied to it. If present, this is used to help
344 speed up parse_modifiers. */
345 Lisp_Object Qevent_symbol_element_mask
;
347 /* An unmodified event header BASE may have a property named
348 Qmodifier_cache, which is an alist mapping modifier masks onto
349 modified versions of BASE. If present, this helps speed up
351 static Lisp_Object Qmodifier_cache
;
353 /* Symbols to use for parts of windows. */
354 Lisp_Object Qmode_line
;
355 Lisp_Object Qvertical_line
;
356 static Lisp_Object Qvertical_scroll_bar
;
357 Lisp_Object Qmenu_bar
;
359 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
360 static Lisp_Object
command_loop (void);
361 static Lisp_Object Qcommand_execute
;
362 EMACS_TIME
timer_check (void);
364 static void echo_now (void);
365 static ptrdiff_t echo_length (void);
367 static Lisp_Object Qpolling_period
;
369 /* Incremented whenever a timer is run. */
372 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
374 EMACS_TIME
*input_available_clear_time
;
376 /* True means use SIGIO interrupts; false means use CBREAK mode.
377 Default is true if INTERRUPT_INPUT is defined. */
378 bool interrupt_input
;
380 /* Nonzero while interrupts are temporarily deferred during redisplay. */
381 bool interrupts_deferred
;
383 /* If we support a window system, turn on the code to poll periodically
384 to detect C-g. It isn't actually used when doing interrupt input. */
385 #ifdef HAVE_WINDOW_SYSTEM
386 #define POLL_FOR_INPUT
389 /* The time when Emacs started being idle. */
391 static EMACS_TIME timer_idleness_start_time
;
393 /* After Emacs stops being idle, this saves the last value
394 of timer_idleness_start_time from when it was idle. */
396 static EMACS_TIME timer_last_idleness_start_time
;
399 /* Global variable declarations. */
401 /* Flags for readable_events. */
402 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
403 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
404 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
406 /* Function for init_keyboard to call with no args (if nonzero). */
407 static void (*keyboard_init_hook
) (void);
409 static bool get_input_pending (int);
410 static bool readable_events (int);
411 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
412 Lisp_Object
, bool *);
413 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
414 static Lisp_Object
make_lispy_event (struct input_event
*);
415 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
416 enum scroll_bar_part
,
417 Lisp_Object
, Lisp_Object
,
419 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
420 Lisp_Object
, const char *const *,
421 Lisp_Object
*, ptrdiff_t);
422 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
423 static bool help_char_p (Lisp_Object
);
424 static void save_getcjmp (sys_jmp_buf
);
425 static void restore_getcjmp (sys_jmp_buf
);
426 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
427 static void clear_event (struct input_event
*);
428 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
430 static void deliver_input_available_signal (int signo
);
432 static void handle_interrupt (bool);
433 static _Noreturn
void quit_throw_to_read_char (bool);
434 static void process_special_events (void);
435 static void timer_start_idle (void);
436 static void timer_stop_idle (void);
437 static void timer_resume_idle (void);
438 static void deliver_user_signal (int);
439 static char *find_user_signal_name (int);
440 static void store_user_signal_events (void);
442 /* These setters are used only in this file, so they can be private. */
444 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
446 kb
->INTERNAL_FIELD (echo_string
) = val
;
449 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
451 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
454 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
456 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
459 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
461 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
464 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
466 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
469 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
471 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
474 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
476 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
479 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
481 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
484 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
486 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
490 /* Add C to the echo string, without echoing it immediately. C can be
491 a character, which is pretty-printed, or a symbol, whose name is
495 echo_add_key (Lisp_Object c
)
497 int size
= KEY_DESCRIPTION_SIZE
+ 100;
498 char *buffer
= alloca (size
);
500 Lisp_Object echo_string
;
502 echo_string
= KVAR (current_kboard
, echo_string
);
504 /* If someone has passed us a composite event, use its head symbol. */
508 ptr
= push_key_description (XINT (c
), ptr
);
509 else if (SYMBOLP (c
))
511 Lisp_Object name
= SYMBOL_NAME (c
);
512 int nbytes
= SBYTES (name
);
514 if (size
- (ptr
- buffer
) < nbytes
)
516 int offset
= ptr
- buffer
;
517 size
= max (2 * size
, size
+ nbytes
);
518 buffer
= alloca (size
);
519 ptr
= buffer
+ offset
;
522 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
523 STRING_MULTIBYTE (name
), 1);
526 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
529 const char *text
= " (Type ? for further options)";
530 int len
= strlen (text
);
532 if (size
- (ptr
- buffer
) < len
)
534 int offset
= ptr
- buffer
;
536 buffer
= alloca (size
);
537 ptr
= buffer
+ offset
;
540 memcpy (ptr
, text
, len
);
544 /* Replace a dash from echo_dash with a space, otherwise add a space
545 at the end as a separator between keys. */
546 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
548 Lisp_Object last_char
, prev_char
, idx
;
550 idx
= make_number (SCHARS (echo_string
) - 2);
551 prev_char
= Faref (echo_string
, idx
);
553 idx
= make_number (SCHARS (echo_string
) - 1);
554 last_char
= Faref (echo_string
, idx
);
556 /* We test PREV_CHAR to make sure this isn't the echoing of a
558 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
559 Faset (echo_string
, idx
, make_number (' '));
561 echo_string
= concat2 (echo_string
, build_string (" "));
563 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
564 echo_string
= concat2 (echo_string
, build_string (" "));
568 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
571 /* Add C to the echo string, if echoing is going on. C can be a
572 character or a symbol. */
575 echo_char (Lisp_Object c
)
577 if (current_kboard
->immediate_echo
)
584 /* Temporarily add a dash to the end of the echo string if it's not
585 empty, so that it serves as a mini-prompt for the very next
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 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
669 message3_nolog (KVAR (current_kboard
, echo_string
));
672 /* Record in what buffer we echoed, and from which kboard. */
673 echo_message_buffer
= echo_area_buffer
[0];
674 echo_kboard
= current_kboard
;
676 if (waiting_for_input
&& !NILP (Vquit_flag
))
677 quit_throw_to_read_char (0);
680 /* Turn off echoing, for the start of a new command. */
683 cancel_echoing (void)
685 current_kboard
->immediate_echo
= 0;
686 current_kboard
->echo_after_prompt
= -1;
687 kset_echo_string (current_kboard
, Qnil
);
688 ok_to_echo_at_next_pause
= NULL
;
690 echo_message_buffer
= Qnil
;
693 /* Return the length of the current echo string. */
698 return (STRINGP (KVAR (current_kboard
, echo_string
))
699 ? SCHARS (KVAR (current_kboard
, echo_string
))
703 /* Truncate the current echo message to its first LEN chars.
704 This and echo_char get used by read_key_sequence when the user
705 switches frames while entering a key sequence. */
708 echo_truncate (ptrdiff_t nchars
)
710 if (STRINGP (KVAR (current_kboard
, echo_string
)))
711 kset_echo_string (current_kboard
,
712 Fsubstring (KVAR (current_kboard
, echo_string
),
713 make_number (0), make_number (nchars
)));
714 truncate_echo_area (nchars
);
718 /* Functions for manipulating this_command_keys. */
720 add_command_key (Lisp_Object key
)
722 #if 0 /* Not needed after we made Freset_this_command_lengths
723 do the job immediately. */
724 /* If reset-this-command-length was called recently, obey it now.
725 See the doc string of that function for an explanation of why. */
726 if (before_command_restore_flag
)
728 this_command_key_count
= before_command_key_count_1
;
729 if (this_command_key_count
< this_single_command_key_start
)
730 this_single_command_key_start
= this_command_key_count
;
731 echo_truncate (before_command_echo_length_1
);
732 before_command_restore_flag
= 0;
736 if (this_command_key_count
>= ASIZE (this_command_keys
))
737 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
739 ASET (this_command_keys
, this_command_key_count
, key
);
740 ++this_command_key_count
;
745 recursive_edit_1 (void)
747 ptrdiff_t count
= SPECPDL_INDEX ();
750 if (command_loop_level
> 0)
752 specbind (Qstandard_output
, Qt
);
753 specbind (Qstandard_input
, Qt
);
756 #ifdef HAVE_WINDOW_SYSTEM
757 /* The command loop has started an hourglass timer, so we have to
758 cancel it here, otherwise it will fire because the recursive edit
759 can take some time. Do not check for display_hourglass_p here,
760 because it could already be nil. */
764 /* This function may have been called from a debugger called from
765 within redisplay, for instance by Edebugging a function called
766 from fontification-functions. We want to allow redisplay in
767 the debugging session.
769 The recursive edit is left with a `(throw exit ...)'. The `exit'
770 tag is not caught anywhere in redisplay, i.e. when we leave the
771 recursive edit, the original redisplay leading to the recursive
772 edit will be unwound. The outcome should therefore be safe. */
773 specbind (Qinhibit_redisplay
, Qnil
);
776 val
= command_loop ();
778 Fsignal (Qquit
, Qnil
);
779 /* Handle throw from read_minibuf when using minibuffer
780 while it's active but we're in another window. */
782 xsignal1 (Qerror
, val
);
784 return unbind_to (count
, Qnil
);
787 /* When an auto-save happens, record the "time", and don't do again soon. */
790 record_auto_save (void)
792 last_auto_save
= num_nonmacro_input_events
;
795 /* Make an auto save happen as soon as possible at command level. */
799 force_auto_save_soon (void)
801 last_auto_save
= - auto_save_interval
- 1;
803 record_asynch_buffer_change ();
807 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
808 doc
: /* Invoke the editor command loop recursively.
809 To get out of the recursive edit, a command can do `(throw 'exit nil)';
810 that tells this function to return.
811 Alternatively, `(throw 'exit t)' makes this function signal an error.
812 This function is called by the editor initialization to begin editing. */)
815 ptrdiff_t count
= SPECPDL_INDEX ();
818 /* If we enter while input is blocked, don't lock up here.
819 This may happen through the debugger during redisplay. */
820 if (input_blocked_p ())
823 command_loop_level
++;
824 update_mode_lines
= 1;
826 if (command_loop_level
827 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
828 buffer
= Fcurrent_buffer ();
832 /* If we leave recursive_edit_1 below with a `throw' for instance,
833 like it is done in the splash screen display, we have to
834 make sure that we restore single_kboard as command_loop_1
835 would have done if it were left normally. */
836 if (command_loop_level
> 0)
837 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
838 record_unwind_protect (recursive_edit_unwind
, buffer
);
841 return unbind_to (count
, Qnil
);
845 recursive_edit_unwind (Lisp_Object buffer
)
847 if (BUFFERP (buffer
))
848 Fset_buffer (buffer
);
850 command_loop_level
--;
851 update_mode_lines
= 1;
856 #if 0 /* These two functions are now replaced with
857 temporarily_switch_to_single_kboard. */
861 #if 0 /* Theory: if there's anything in Vunread_command_events,
862 it will right away be read by read_key_sequence,
863 and then if we do switch KBOARDS, it will go into the side
864 queue then. So we don't need to do anything special here -- rms. */
865 if (CONSP (Vunread_command_events
))
867 current_kboard
->kbd_queue
868 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
869 current_kboard
->kbd_queue_has_data
= 1;
871 Vunread_command_events
= Qnil
;
876 /* Switch to the single-kboard state, making current_kboard
877 the only KBOARD from which further input is accepted. */
880 single_kboard_state ()
886 /* If we're in single_kboard state for kboard KBOARD,
890 not_single_kboard_state (KBOARD
*kboard
)
892 if (kboard
== current_kboard
)
896 /* Maintain a stack of kboards, so other parts of Emacs
897 can switch temporarily to the kboard of a given frame
898 and then revert to the previous status. */
903 struct kboard_stack
*next
;
906 static struct kboard_stack
*kboard_stack
;
909 push_kboard (struct kboard
*k
)
911 struct kboard_stack
*p
= xmalloc (sizeof *p
);
913 p
->next
= kboard_stack
;
914 p
->kboard
= current_kboard
;
924 struct kboard_stack
*p
= kboard_stack
;
926 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
928 if (t
->kboard
== p
->kboard
)
930 current_kboard
= p
->kboard
;
937 /* The terminal we remembered has been deleted. */
938 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
941 kboard_stack
= p
->next
;
945 /* Switch to single_kboard mode, making current_kboard the only KBOARD
946 from which further input is accepted. If F is non-nil, set its
947 KBOARD as the current keyboard.
949 This function uses record_unwind_protect to return to the previous
952 If Emacs is already in single_kboard mode, and F's keyboard is
953 locked, then this function will throw an error. */
956 temporarily_switch_to_single_kboard (struct frame
*f
)
958 bool was_locked
= single_kboard
;
961 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
962 /* We can not switch keyboards while in single_kboard mode.
963 In rare cases, Lisp code may call `recursive-edit' (or
964 `read-minibuffer' or `y-or-n-p') after it switched to a
965 locked frame. For example, this is likely to happen
966 when server.el connects to a new terminal while Emacs is in
967 single_kboard mode. It is best to throw an error instead
968 of presenting the user with a frozen screen. */
969 error ("Terminal %d is locked, cannot read from it",
970 FRAME_TERMINAL (f
)->id
);
972 /* This call is unnecessary, but helps
973 `restore_kboard_configuration' discover if somebody changed
974 `current_kboard' behind our back. */
975 push_kboard (current_kboard
);
978 current_kboard
= FRAME_KBOARD (f
);
980 record_unwind_protect (restore_kboard_configuration
,
981 (was_locked
? Qt
: Qnil
));
984 #if 0 /* This function is not needed anymore. */
986 record_single_kboard_state ()
989 push_kboard (current_kboard
);
990 record_unwind_protect (restore_kboard_configuration
,
991 (single_kboard
? Qt
: Qnil
));
996 restore_kboard_configuration (Lisp_Object was_locked
)
998 if (NILP (was_locked
))
1002 struct kboard
*prev
= current_kboard
;
1005 /* The pop should not change the kboard. */
1006 if (single_kboard
&& current_kboard
!= prev
)
1013 /* Handle errors that are not handled at inner levels
1014 by printing an error message and returning to the editor command loop. */
1017 cmd_error (Lisp_Object data
)
1019 Lisp_Object old_level
, old_length
;
1020 char macroerror
[sizeof "After..kbd macro iterations: "
1021 + INT_STRLEN_BOUND (EMACS_INT
)];
1023 #ifdef HAVE_WINDOW_SYSTEM
1024 if (display_hourglass_p
)
1025 cancel_hourglass ();
1028 if (!NILP (executing_kbd_macro
))
1030 if (executing_kbd_macro_iterations
== 1)
1031 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1033 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1034 executing_kbd_macro_iterations
);
1039 Vstandard_output
= Qt
;
1040 Vstandard_input
= Qt
;
1041 Vexecuting_kbd_macro
= Qnil
;
1042 executing_kbd_macro
= Qnil
;
1043 kset_prefix_arg (current_kboard
, Qnil
);
1044 kset_last_prefix_arg (current_kboard
, Qnil
);
1047 /* Avoid unquittable loop if data contains a circular list. */
1048 old_level
= Vprint_level
;
1049 old_length
= Vprint_length
;
1050 XSETFASTINT (Vprint_level
, 10);
1051 XSETFASTINT (Vprint_length
, 10);
1052 cmd_error_internal (data
, macroerror
);
1053 Vprint_level
= old_level
;
1054 Vprint_length
= old_length
;
1057 Vinhibit_quit
= Qnil
;
1059 return make_number (0);
1062 /* Take actions on handling an error. DATA is the data that describes
1065 CONTEXT is a C-string containing ASCII characters only which
1066 describes the context in which the error happened. If we need to
1067 generalize CONTEXT to allow multibyte characters, make it a Lisp
1071 cmd_error_internal (Lisp_Object data
, const char *context
)
1073 struct frame
*sf
= SELECTED_FRAME ();
1075 /* The immediate context is not interesting for Quits,
1076 since they are asynchronous. */
1077 if (EQ (XCAR (data
), Qquit
))
1078 Vsignaling_function
= Qnil
;
1083 /* Use user's specified output function if any. */
1084 if (!NILP (Vcommand_error_function
))
1085 call3 (Vcommand_error_function
, data
,
1086 context
? build_string (context
) : empty_unibyte_string
,
1087 Vsignaling_function
);
1088 /* If the window system or terminal frame hasn't been initialized
1089 yet, or we're not interactive, write the message to stderr and exit. */
1090 else if (!sf
->glyphs_initialized_p
1091 /* The initial frame is a special non-displaying frame. It
1092 will be current in daemon mode when there are no frames
1093 to display, and in non-daemon mode before the real frame
1094 has finished initializing. If an error is thrown in the
1095 latter case while creating the frame, then the frame
1096 will never be displayed, so the safest thing to do is
1097 write to stderr and quit. In daemon mode, there are
1098 many other potential errors that do not prevent frames
1099 from being created, so continuing as normal is better in
1101 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1104 print_error_message (data
, Qexternal_debugging_output
,
1105 context
, Vsignaling_function
);
1106 Fterpri (Qexternal_debugging_output
);
1107 Fkill_emacs (make_number (-1));
1111 clear_message (1, 0);
1113 message_log_maybe_newline ();
1116 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1119 Vsignaling_function
= Qnil
;
1122 static Lisp_Object
command_loop_2 (Lisp_Object
);
1123 static Lisp_Object
top_level_1 (Lisp_Object
);
1125 /* Entry to editor-command-loop.
1126 This level has the catches for exiting/returning to editor command loop.
1127 It returns nil to exit recursive edit, t to abort it. */
1132 if (command_loop_level
> 0 || minibuf_level
> 0)
1135 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1136 executing_kbd_macro
= Qnil
;
1142 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1143 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1144 executing_kbd_macro
= Qnil
;
1146 /* End of file in -batch run causes exit here. */
1152 /* Here we catch errors in execution of commands within the
1153 editing loop, and reenter the editing loop.
1154 When there is an error, cmd_error runs and returns a non-nil
1155 value to us. A value of nil means that command_loop_1 itself
1156 returned due to end of file (or end of kbd macro). */
1159 command_loop_2 (Lisp_Object ignore
)
1161 register Lisp_Object val
;
1164 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1165 while (!NILP (val
));
1173 return Feval (Vtop_level
, Qnil
);
1177 top_level_1 (Lisp_Object ignore
)
1179 /* On entry to the outer level, run the startup file. */
1180 if (!NILP (Vtop_level
))
1181 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1182 else if (!NILP (Vpurify_flag
))
1183 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1185 message1 ("Bare Emacs (standard Lisp code not loaded)");
1189 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1190 doc
: /* Exit all recursive editing levels.
1191 This also exits all active minibuffers. */)
1194 #ifdef HAVE_WINDOW_SYSTEM
1195 if (display_hourglass_p
)
1196 cancel_hourglass ();
1199 /* Unblock input if we enter with input blocked. This may happen if
1200 redisplay traps e.g. during tool-bar update with input blocked. */
1201 totally_unblock_input ();
1203 Fthrow (Qtop_level
, Qnil
);
1206 static _Noreturn
void
1207 user_error (const char *msg
)
1209 xsignal1 (Quser_error
, build_string (msg
));
1213 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1214 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1217 if (command_loop_level
> 0 || minibuf_level
> 0)
1218 Fthrow (Qexit
, Qnil
);
1220 user_error ("No recursive edit is in progress");
1224 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1225 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1228 if (command_loop_level
> 0 || minibuf_level
> 0)
1231 user_error ("No recursive edit is in progress");
1234 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1235 of this function. */
1238 tracking_off (Lisp_Object old_value
)
1240 do_mouse_tracking
= old_value
;
1241 if (NILP (old_value
))
1243 /* Redisplay may have been preempted because there was input
1244 available, and it assumes it will be called again after the
1245 input has been processed. If the only input available was
1246 the sort that we have just disabled, then we need to call
1248 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1250 redisplay_preserve_echo_area (6);
1251 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1257 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1258 doc
: /* Evaluate BODY with mouse movement events enabled.
1259 Within a `track-mouse' form, mouse motion generates input events that
1260 you can read with `read-event'.
1261 Normally, mouse motion is ignored.
1262 usage: (track-mouse BODY...) */)
1265 ptrdiff_t count
= SPECPDL_INDEX ();
1268 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1270 do_mouse_tracking
= Qt
;
1272 val
= Fprogn (args
);
1273 return unbind_to (count
, val
);
1276 /* If mouse has moved on some frame, return one of those frames.
1280 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1281 after resizing the tool-bar window. */
1283 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1286 bool ignore_mouse_drag_p
;
1289 some_mouse_moved (void)
1291 Lisp_Object tail
, frame
;
1293 if (ignore_mouse_drag_p
)
1295 /* ignore_mouse_drag_p = 0; */
1299 FOR_EACH_FRAME (tail
, frame
)
1301 if (XFRAME (frame
)->mouse_moved
)
1302 return XFRAME (frame
);
1309 /* This is the actual command reading loop,
1310 sans error-handling encapsulation. */
1312 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1314 void safe_run_hooks (Lisp_Object
);
1315 static void adjust_point_for_property (ptrdiff_t, bool);
1317 /* Cancel hourglass from protect_unwind.
1319 #ifdef HAVE_WINDOW_SYSTEM
1321 cancel_hourglass_unwind (Lisp_Object arg
)
1323 cancel_hourglass ();
1328 /* The last boundary auto-added to buffer-undo-list. */
1329 Lisp_Object last_undo_boundary
;
1331 /* FIXME: This is wrong rather than test window-system, we should call
1332 a new set-selection, which will then dispatch to x-set-selection, or
1333 tty-set-selection, or w32-set-selection, ... */
1336 command_loop_1 (void)
1339 Lisp_Object keybuf
[30];
1341 EMACS_INT prev_modiff
= 0;
1342 struct buffer
*prev_buffer
= NULL
;
1343 bool already_adjusted
= 0;
1345 kset_prefix_arg (current_kboard
, Qnil
);
1346 kset_last_prefix_arg (current_kboard
, Qnil
);
1347 Vdeactivate_mark
= Qnil
;
1348 waiting_for_input
= 0;
1351 this_command_key_count
= 0;
1352 this_command_key_count_reset
= 0;
1353 this_single_command_key_start
= 0;
1355 if (NILP (Vmemory_full
))
1357 /* Make sure this hook runs after commands that get errors and
1358 throw to top level. */
1359 /* Note that the value cell will never directly contain nil
1360 if the symbol is a local variable. */
1361 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1362 safe_run_hooks (Qpost_command_hook
);
1364 /* If displaying a message, resize the echo area window to fit
1365 that message's size exactly. */
1366 if (!NILP (echo_area_buffer
[0]))
1367 resize_echo_area_exactly ();
1369 /* If there are warnings waiting, process them. */
1370 if (!NILP (Vdelayed_warnings_list
))
1371 safe_run_hooks (Qdelayed_warnings_hook
);
1373 if (!NILP (Vdeferred_action_list
))
1374 safe_run_hooks (Qdeferred_action_function
);
1377 /* Do this after running Vpost_command_hook, for consistency. */
1378 kset_last_command (current_kboard
, Vthis_command
);
1379 kset_real_last_command (current_kboard
, Vreal_this_command
);
1380 if (!CONSP (last_command_event
))
1381 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1385 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1388 /* Make sure the current window's buffer is selected. */
1389 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1391 /* Display any malloc warning that just came out. Use while because
1392 displaying one warning can cause another. */
1394 while (pending_malloc_warning
)
1395 display_malloc_warning ();
1397 Vdeactivate_mark
= Qnil
;
1399 /* Don't ignore mouse movements for more than a single command
1400 loop. (This flag is set in xdisp.c whenever the tool bar is
1401 resized, because the resize moves text up or down, and would
1402 generate false mouse drag events if we don't ignore them.) */
1403 ignore_mouse_drag_p
= 0;
1405 /* If minibuffer on and echo area in use,
1406 wait a short time and redraw minibuffer. */
1409 && !NILP (echo_area_buffer
[0])
1410 && EQ (minibuf_window
, echo_area_window
)
1411 && NUMBERP (Vminibuffer_message_timeout
))
1413 /* Bind inhibit-quit to t so that C-g gets read in
1414 rather than quitting back to the minibuffer. */
1415 ptrdiff_t count
= SPECPDL_INDEX ();
1416 specbind (Qinhibit_quit
, Qt
);
1418 sit_for (Vminibuffer_message_timeout
, 0, 2);
1420 /* Clear the echo area. */
1422 safe_run_hooks (Qecho_area_clear_hook
);
1424 unbind_to (count
, Qnil
);
1426 /* If a C-g came in before, treat it as input now. */
1427 if (!NILP (Vquit_flag
))
1430 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1434 /* If it has changed current-menubar from previous value,
1435 really recompute the menubar from the value. */
1436 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1437 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1438 call0 (Qrecompute_lucid_menubar
);
1440 before_command_key_count
= this_command_key_count
;
1441 before_command_echo_length
= echo_length ();
1443 Vthis_command
= Qnil
;
1444 Vreal_this_command
= Qnil
;
1445 Vthis_original_command
= Qnil
;
1446 Vthis_command_keys_shift_translated
= Qnil
;
1448 /* Read next key sequence; i gets its length. */
1449 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1452 /* A filter may have run while we were reading the input. */
1453 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1455 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1459 /* Now we have read a key sequence of length I,
1460 or else I is 0 and we found end of file. */
1462 if (i
== 0) /* End of file -- happens only in */
1463 return Qnil
; /* a kbd macro, at the end. */
1464 /* -1 means read_key_sequence got a menu that was rejected.
1465 Just loop around and read another command. */
1469 this_command_key_count
= 0;
1470 this_command_key_count_reset
= 0;
1471 this_single_command_key_start
= 0;
1475 last_command_event
= keybuf
[i
- 1];
1477 /* If the previous command tried to force a specific window-start,
1478 forget about that, in case this command moves point far away
1479 from that position. But also throw away beg_unchanged and
1480 end_unchanged information in that case, so that redisplay will
1481 update the whole window properly. */
1482 if (XWINDOW (selected_window
)->force_start
)
1485 XWINDOW (selected_window
)->force_start
= 0;
1486 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1487 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1490 cmd
= read_key_sequence_cmd
;
1491 if (!NILP (Vexecuting_kbd_macro
))
1493 if (!NILP (Vquit_flag
))
1495 Vexecuting_kbd_macro
= Qt
;
1496 QUIT
; /* Make some noise. */
1497 /* Will return since macro now empty. */
1501 /* Do redisplay processing after this command except in special
1502 cases identified below. */
1503 prev_buffer
= current_buffer
;
1504 prev_modiff
= MODIFF
;
1505 last_point_position
= PT
;
1507 /* By default, we adjust point to a boundary of a region that
1508 has such a property that should be treated intangible
1509 (e.g. composition, display). But, some commands will set
1510 this variable differently. */
1511 Vdisable_point_adjustment
= Qnil
;
1513 /* Process filters and timers may have messed with deactivate-mark.
1514 reset it before we execute the command. */
1515 Vdeactivate_mark
= Qnil
;
1517 /* Remap command through active keymaps. */
1518 Vthis_original_command
= cmd
;
1519 if (!NILP (read_key_sequence_remapped
))
1520 cmd
= read_key_sequence_remapped
;
1522 /* Execute the command. */
1524 Vthis_command
= cmd
;
1525 Vreal_this_command
= cmd
;
1526 safe_run_hooks (Qpre_command_hook
);
1528 already_adjusted
= 0;
1530 if (NILP (Vthis_command
))
1532 /* nil means key is undefined. */
1533 Lisp_Object keys
= Fvector (i
, keybuf
);
1534 keys
= Fkey_description (keys
, Qnil
);
1536 message_with_string ("%s is undefined", keys
, 0);
1537 kset_defining_kbd_macro (current_kboard
, Qnil
);
1538 update_mode_lines
= 1;
1539 /* If this is a down-mouse event, don't reset prefix-arg;
1540 pass it to the command run by the up event. */
1541 if (EVENT_HAS_PARAMETERS (last_command_event
))
1543 Lisp_Object breakdown
1544 = parse_modifiers (EVENT_HEAD (last_command_event
));
1545 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1546 if (!(modifiers
& down_modifier
))
1547 kset_prefix_arg (current_kboard
, Qnil
);
1550 kset_prefix_arg (current_kboard
, Qnil
);
1554 /* Here for a command that isn't executed directly. */
1556 #ifdef HAVE_WINDOW_SYSTEM
1557 ptrdiff_t scount
= SPECPDL_INDEX ();
1559 if (display_hourglass_p
1560 && NILP (Vexecuting_kbd_macro
))
1562 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1567 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1569 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1572 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1573 ? Qnil
: BVAR (current_buffer
, undo_list
));
1575 call1 (Qcommand_execute
, Vthis_command
);
1577 #ifdef HAVE_WINDOW_SYSTEM
1578 /* Do not check display_hourglass_p here, because
1579 `command-execute' could change it, but we should cancel
1580 hourglass cursor anyway.
1581 But don't cancel the hourglass within a macro
1582 just because a command in the macro finishes. */
1583 if (NILP (Vexecuting_kbd_macro
))
1584 unbind_to (scount
, Qnil
);
1587 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1589 safe_run_hooks (Qpost_command_hook
);
1591 /* If displaying a message, resize the echo area window to fit
1592 that message's size exactly. */
1593 if (!NILP (echo_area_buffer
[0]))
1594 resize_echo_area_exactly ();
1596 /* If there are warnings waiting, process them. */
1597 if (!NILP (Vdelayed_warnings_list
))
1598 safe_run_hooks (Qdelayed_warnings_hook
);
1600 safe_run_hooks (Qdeferred_action_function
);
1602 /* If there is a prefix argument,
1603 1) We don't want Vlast_command to be ``universal-argument''
1604 (that would be dumb), so don't set Vlast_command,
1605 2) we want to leave echoing on so that the prefix will be
1606 echoed as part of this key sequence, so don't call
1608 3) we want to leave this_command_key_count non-zero, so that
1609 read_char will realize that it is re-reading a character, and
1610 not echo it a second time.
1612 If the command didn't actually create a prefix arg,
1613 but is merely a frame event that is transparent to prefix args,
1614 then the above doesn't apply. */
1615 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1616 || CONSP (last_command_event
))
1618 kset_last_command (current_kboard
, Vthis_command
);
1619 kset_real_last_command (current_kboard
, Vreal_this_command
);
1620 if (!CONSP (last_command_event
))
1621 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1623 this_command_key_count
= 0;
1624 this_command_key_count_reset
= 0;
1625 this_single_command_key_start
= 0;
1628 if (!NILP (BVAR (current_buffer
, mark_active
))
1629 && !NILP (Vrun_hooks
))
1631 /* In Emacs 22, setting transient-mark-mode to `only' was a
1632 way of turning it on for just one command. This usage is
1633 obsolete, but support it anyway. */
1634 if (EQ (Vtransient_mark_mode
, Qidentity
))
1635 Vtransient_mark_mode
= Qnil
;
1636 else if (EQ (Vtransient_mark_mode
, Qonly
))
1637 Vtransient_mark_mode
= Qidentity
;
1639 if (!NILP (Vdeactivate_mark
))
1640 /* If `select-active-regions' is non-nil, this call to
1641 `deactivate-mark' also sets the PRIMARY selection. */
1642 call0 (Qdeactivate_mark
);
1645 /* Even if not deactivating the mark, set PRIMARY if
1646 `select-active-regions' is non-nil. */
1647 if (!NILP (Fwindow_system (Qnil
))
1648 /* Even if mark_active is non-nil, the actual buffer
1649 marker may not have been set yet (Bug#7044). */
1650 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1651 && (EQ (Vselect_active_regions
, Qonly
)
1652 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1653 : (!NILP (Vselect_active_regions
)
1654 && !NILP (Vtransient_mark_mode
)))
1655 && NILP (Fmemq (Vthis_command
,
1656 Vselection_inhibit_update_commands
)))
1659 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1662 call2 (Qx_set_selection
, QPRIMARY
,
1663 make_buffer_string (beg
, end
, 0));
1665 call2 (Qx_set_selection
, QPRIMARY
,
1666 make_buffer_string (end
, beg
, 0));
1667 /* Don't set empty selections. */
1670 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1672 Lisp_Object hook
= intern ("activate-mark-hook");
1673 Frun_hooks (1, &hook
);
1677 Vsaved_region_selection
= Qnil
;
1682 if (current_buffer
== prev_buffer
1683 && last_point_position
!= PT
1684 && NILP (Vdisable_point_adjustment
)
1685 && NILP (Vglobal_disable_point_adjustment
))
1687 if (last_point_position
> BEGV
1688 && last_point_position
< ZV
1689 && (composition_adjust_point (last_point_position
,
1690 last_point_position
)
1691 != last_point_position
))
1692 /* The last point was temporarily set within a grapheme
1693 cluster to prevent automatic composition. To recover
1694 the automatic composition, we must update the
1696 windows_or_buffers_changed
++;
1697 if (!already_adjusted
)
1698 adjust_point_for_property (last_point_position
,
1699 MODIFF
!= prev_modiff
);
1702 /* Install chars successfully executed in kbd macro. */
1704 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1705 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1706 finalize_kbd_macro_chars ();
1710 /* Adjust point to a boundary of a region that has such a property
1711 that should be treated intangible. For the moment, we check
1712 `composition', `display' and `invisible' properties.
1713 LAST_PT is the last position of point. */
1716 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1719 Lisp_Object val
, overlay
, tmp
;
1720 /* When called after buffer modification, we should temporarily
1721 suppress the point adjustment for automatic composition so that a
1722 user can keep inserting another character at point or keep
1723 deleting characters around point. */
1724 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1725 ptrdiff_t orig_pt
= PT
;
1727 /* FIXME: cycling is probably not necessary because these properties
1728 can't be usefully combined anyway. */
1729 while (check_composition
|| check_display
|| check_invisible
)
1731 /* FIXME: check `intangible'. */
1732 if (check_composition
1733 && PT
> BEGV
&& PT
< ZV
1734 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1737 check_display
= check_invisible
= 1;
1739 check_composition
= 0;
1741 && PT
> BEGV
&& PT
< ZV
1742 && !NILP (val
= get_char_property_and_overlay
1743 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1744 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1745 && (!OVERLAYP (overlay
)
1746 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1747 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1748 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1749 && (beg
< PT
/* && end > PT <- It's always the case. */
1750 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1753 SET_PT (PT
< last_pt
1754 ? (STRINGP (val
) && SCHARS (val
) == 0
1755 ? max (beg
- 1, BEGV
)
1758 check_composition
= check_invisible
= 1;
1761 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1767 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1770 /* FIXME: We should stop if we find a spot between
1771 two runs of `invisible' where inserted text would
1772 be visible. This is important when we have two
1773 invisible boundaries that enclose an area: if the
1774 area is empty, we need this test in order to make
1775 it possible to place point in the middle rather
1776 than skip both boundaries. However, this code
1777 also stops anywhere in a non-sticky text-property,
1778 which breaks (e.g.) Org mode. */
1779 && (val
= get_pos_property (make_number (end
),
1781 TEXT_PROP_MEANS_INVISIBLE (val
))
1783 && !NILP (val
= get_char_property_and_overlay
1784 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1785 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1787 ellipsis
= ellipsis
|| inv
> 1
1788 || (OVERLAYP (overlay
)
1789 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1790 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1791 tmp
= Fnext_single_char_property_change
1792 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1793 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1797 && (val
= get_pos_property (make_number (beg
),
1799 TEXT_PROP_MEANS_INVISIBLE (val
))
1801 && !NILP (val
= get_char_property_and_overlay
1802 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1803 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1805 ellipsis
= ellipsis
|| inv
> 1
1806 || (OVERLAYP (overlay
)
1807 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1808 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1809 tmp
= Fprevious_single_char_property_change
1810 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1811 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1814 /* Move away from the inside area. */
1815 if (beg
< PT
&& end
> PT
)
1817 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1818 /* We haven't moved yet (so we don't need to fear
1819 infinite-looping) and we were outside the range
1820 before (so either end of the range still corresponds
1821 to a move in the right direction): pretend we moved
1822 less than we actually did, so that we still have
1823 more freedom below in choosing which end of the range
1825 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1826 /* We either have moved already or the last point
1827 was already in the range: we don't get to choose
1828 which end of the range we have to go to. */
1829 : (PT
< last_pt
? beg
: end
));
1830 check_composition
= check_display
= 1;
1832 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1833 the point to something other than its argument, due to
1834 point-motion hooks, intangibility, etc. */
1835 eassert (PT
== beg
|| PT
== end
);
1838 /* Pretend the area doesn't exist if the buffer is not
1840 if (!modified
&& !ellipsis
&& beg
< end
)
1842 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1843 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1844 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1845 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1846 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1847 /* We've already moved as far as we can. Trying to go
1848 to the other end would mean moving backwards and thus
1849 could lead to an infinite loop. */
1851 else if (val
= get_pos_property (make_number (PT
),
1853 TEXT_PROP_MEANS_INVISIBLE (val
)
1854 && (val
= get_pos_property
1855 (make_number (PT
== beg
? end
: beg
),
1857 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1858 (check_composition
= check_display
= 1,
1859 SET_PT (PT
== beg
? end
: beg
));
1862 check_invisible
= 0;
1866 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1869 safe_run_hooks_1 (void)
1871 eassert (CONSP (Vinhibit_quit
));
1872 return call0 (XCDR (Vinhibit_quit
));
1875 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1879 safe_run_hooks_error (Lisp_Object error_data
)
1882 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1883 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1884 Lisp_Object args
[4];
1885 args
[0] = build_string ("Error in %s (%S): %S");
1888 args
[3] = error_data
;
1894 Lisp_Object newval
= Qnil
;
1895 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1896 if (EQ (fun
, XCAR (val
)))
1899 newval
= Fcons (XCAR (val
), newval
);
1901 return Fset (hook
, Fnreverse (newval
));
1902 /* Not found in the local part of the hook. Let's look at the global
1905 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1906 : Fdefault_value (hook
));
1907 CONSP (val
); val
= XCDR (val
))
1908 if (EQ (fun
, XCAR (val
)))
1911 newval
= Fcons (XCAR (val
), newval
);
1913 return Fset_default (hook
, Fnreverse (newval
));
1919 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1921 eassert (nargs
== 1);
1922 if (CONSP (Vinhibit_quit
))
1923 XSETCDR (Vinhibit_quit
, args
[0]);
1925 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1927 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1931 /* If we get an error while running the hook, cause the hook variable
1932 to be nil. Also inhibit quits, so that C-g won't cause the hook
1933 to mysteriously evaporate. */
1936 safe_run_hooks (Lisp_Object hook
)
1938 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1939 to its body or to its handlers other than via globals such as
1940 dynamically-bound variables ;-) */
1941 ptrdiff_t count
= SPECPDL_INDEX ();
1942 specbind (Qinhibit_quit
, hook
);
1944 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1946 unbind_to (count
, Qnil
);
1950 /* Nonzero means polling for input is temporarily suppressed. */
1952 int poll_suppress_count
;
1955 #ifdef POLL_FOR_INPUT
1957 /* Asynchronous timer for polling. */
1959 static struct atimer
*poll_timer
;
1961 /* Poll for input, so that we catch a C-g if it comes in. This
1962 function is called from x_make_frame_visible, see comment
1966 poll_for_input_1 (void)
1968 if (! input_blocked_p ()
1969 && !waiting_for_input
)
1973 /* Timer callback function for poll_timer. TIMER is equal to
1977 poll_for_input (struct atimer
*timer
)
1979 if (poll_suppress_count
== 0)
1980 pending_signals
= 1;
1983 #endif /* POLL_FOR_INPUT */
1985 /* Begin signals to poll for input, if they are appropriate.
1986 This function is called unconditionally from various places. */
1989 start_polling (void)
1991 #ifdef POLL_FOR_INPUT
1992 /* XXX This condition was (read_socket_hook && !interrupt_input),
1993 but read_socket_hook is not global anymore. Let's pretend that
1995 if (!interrupt_input
)
1997 /* Turn alarm handling on unconditionally. It might have
1998 been turned off in process.c. */
1999 turn_on_atimers (1);
2001 /* If poll timer doesn't exist, are we need one with
2002 a different interval, start a new one. */
2003 if (poll_timer
== NULL
2004 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2006 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2007 EMACS_TIME interval
= make_emacs_time (period
, 0);
2010 cancel_atimer (poll_timer
);
2012 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2013 poll_for_input
, NULL
);
2016 /* Let the timer's callback function poll for input
2017 if this becomes zero. */
2018 --poll_suppress_count
;
2023 /* True if we are using polling to handle input asynchronously. */
2026 input_polling_used (void)
2028 #ifdef POLL_FOR_INPUT
2029 /* XXX This condition was (read_socket_hook && !interrupt_input),
2030 but read_socket_hook is not global anymore. Let's pretend that
2032 return !interrupt_input
;
2038 /* Turn off polling. */
2043 #ifdef POLL_FOR_INPUT
2044 /* XXX This condition was (read_socket_hook && !interrupt_input),
2045 but read_socket_hook is not global anymore. Let's pretend that
2047 if (!interrupt_input
)
2048 ++poll_suppress_count
;
2052 /* Set the value of poll_suppress_count to COUNT
2053 and start or stop polling accordingly. */
2056 set_poll_suppress_count (int count
)
2058 #ifdef POLL_FOR_INPUT
2059 if (count
== 0 && poll_suppress_count
!= 0)
2061 poll_suppress_count
= 1;
2064 else if (count
!= 0 && poll_suppress_count
== 0)
2068 poll_suppress_count
= count
;
2072 /* Bind polling_period to a value at least N.
2073 But don't decrease it. */
2076 bind_polling_period (int n
)
2078 #ifdef POLL_FOR_INPUT
2079 EMACS_INT
new = polling_period
;
2084 stop_other_atimers (poll_timer
);
2086 specbind (Qpolling_period
, make_number (new));
2087 /* Start a new alarm with the new period. */
2092 /* Apply the control modifier to CHARACTER. */
2095 make_ctrl_char (int c
)
2097 /* Save the upper bits here. */
2098 int upper
= c
& ~0177;
2100 if (! ASCII_BYTE_P (c
))
2101 return c
|= ctrl_modifier
;
2105 /* Everything in the columns containing the upper-case letters
2106 denotes a control character. */
2107 if (c
>= 0100 && c
< 0140)
2111 /* Set the shift modifier for a control char
2112 made from a shifted letter. But only for letters! */
2113 if (oc
>= 'A' && oc
<= 'Z')
2114 c
|= shift_modifier
;
2117 /* The lower-case letters denote control characters too. */
2118 else if (c
>= 'a' && c
<= 'z')
2121 /* Include the bits for control and shift
2122 only if the basic ASCII code can't indicate them. */
2126 /* Replace the high bits. */
2127 c
|= (upper
& ~ctrl_modifier
);
2132 /* Display the help-echo property of the character after the mouse pointer.
2133 Either show it in the echo area, or call show-help-function to display
2134 it by other means (maybe in a tooltip).
2136 If HELP is nil, that means clear the previous help echo.
2138 If HELP is a string, display that string. If HELP is a function,
2139 call it with OBJECT and POS as arguments; the function should
2140 return a help string or nil for none. For all other types of HELP,
2141 evaluate it to obtain a string.
2143 WINDOW is the window in which the help was generated, if any.
2144 It is nil if not in a window.
2146 If OBJECT is a buffer, POS is the position in the buffer where the
2147 `help-echo' text property was found.
2149 If OBJECT is an overlay, that overlay has a `help-echo' property,
2150 and POS is the position in the overlay's buffer under the mouse.
2152 If OBJECT is a string (an overlay string or a string displayed with
2153 the `display' property). POS is the position in that string under
2156 Note: this function may only be called with HELP nil or a string
2157 from X code running asynchronously. */
2160 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2163 if (!NILP (help
) && !STRINGP (help
))
2165 if (FUNCTIONP (help
))
2166 help
= safe_call (4, help
, window
, object
, pos
);
2168 help
= safe_eval (help
);
2170 if (!STRINGP (help
))
2174 if (!noninteractive
&& STRINGP (help
))
2176 /* The mouse-fixup-help-message Lisp function can call
2177 mouse_position_hook, which resets the mouse_moved flags.
2178 This causes trouble if we are trying to read a mouse motion
2179 event (i.e., if we are inside a `track-mouse' form), so we
2180 restore the mouse_moved flag. */
2181 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2182 help
= call1 (Qmouse_fixup_help_message
, help
);
2187 if (STRINGP (help
) || NILP (help
))
2189 if (!NILP (Vshow_help_function
))
2190 call1 (Vshow_help_function
, help
);
2191 help_echo_showing_p
= STRINGP (help
);
2197 /* Input of single characters from keyboard */
2199 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2200 EMACS_TIME
*end_time
);
2201 static void record_char (Lisp_Object c
);
2203 static Lisp_Object help_form_saved_window_configs
;
2205 read_char_help_form_unwind (Lisp_Object arg
)
2207 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2208 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2209 if (!NILP (window_config
))
2210 Fset_window_configuration (window_config
);
2214 #define STOP_POLLING \
2215 do { if (! polling_stopped_here) stop_polling (); \
2216 polling_stopped_here = 1; } while (0)
2218 #define RESUME_POLLING \
2219 do { if (polling_stopped_here) start_polling (); \
2220 polling_stopped_here = 0; } while (0)
2223 read_event_from_main_queue (EMACS_TIME
*end_time
,
2224 sys_jmp_buf local_getcjmp
,
2225 bool *used_mouse_menu
)
2227 Lisp_Object c
= Qnil
;
2228 sys_jmp_buf save_jump
;
2229 KBOARD
*kb
IF_LINT (= NULL
);
2233 /* Read from the main queue, and if that gives us something we can't use yet,
2234 we put it on the appropriate side queue and try again. */
2236 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2239 /* Actually read a character, waiting if necessary. */
2240 save_getcjmp (save_jump
);
2241 restore_getcjmp (local_getcjmp
);
2243 timer_start_idle ();
2244 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2245 restore_getcjmp (save_jump
);
2247 if (! NILP (c
) && (kb
!= current_kboard
))
2249 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2252 while (CONSP (XCDR (last
)))
2254 if (!NILP (XCDR (last
)))
2258 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2260 XSETCDR (last
, Fcons (c
, Qnil
));
2261 kb
->kbd_queue_has_data
= 1;
2265 current_kboard
= kb
;
2266 /* This is going to exit from read_char
2267 so we had better get rid of this frame's stuff. */
2268 return make_number (-2);
2271 /* Terminate Emacs in batch mode if at eof. */
2272 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2273 Fkill_emacs (make_number (1));
2277 /* Add in any extra modifiers, where appropriate. */
2278 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2279 || ((extra_keyboard_modifiers
& 0177) < ' '
2280 && (extra_keyboard_modifiers
& 0177) != 0))
2281 XSETINT (c
, make_ctrl_char (XINT (c
)));
2283 /* Transfer any other modifier bits directly from
2284 extra_keyboard_modifiers to c. Ignore the actual character code
2285 in the low 16 bits of extra_keyboard_modifiers. */
2286 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2289 /* FIXME: Decode tty keyboard input here. */
2295 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2298 read_decoded_event_from_main_queue (EMACS_TIME
*end_time
,
2299 sys_jmp_buf local_getcjmp
,
2300 Lisp_Object prev_event
,
2301 bool *used_mouse_menu
)
2303 #define MAX_ENCODED_BYTES 16
2304 Lisp_Object events
[MAX_ENCODED_BYTES
];
2309 = read_event_from_main_queue (end_time
, local_getcjmp
,
2312 /* w32_console already returns decoded events. It either reads
2313 Unicode characters from the Windows keyboard input, or
2314 converts characters encoded in the current codepage into
2315 Unicode. See w32inevt.c:key_event, near its end. */
2318 struct frame
*frame
= XFRAME (selected_frame
);
2319 struct terminal
*terminal
= frame
->terminal
;
2320 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2321 /* Don't apply decoding if we're just reading a raw event
2322 (e.g. reading bytes sent by the xterm to specify the position
2323 of a mouse click). */
2324 && (!EQ (prev_event
, Qt
))
2325 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2326 & CODING_REQUIRE_DECODING_MASK
)))
2327 return nextevt
; /* No decoding needed. */
2330 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2331 eassert (n
< MAX_ENCODED_BYTES
);
2332 events
[n
++] = nextevt
;
2333 if (NATNUMP (nextevt
)
2334 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2335 { /* An encoded byte sequence, let's try to decode it. */
2336 struct coding_system
*coding
2337 = TERMINAL_KEYBOARD_CODING (terminal
);
2338 unsigned char *src
= alloca (n
);
2340 for (i
= 0; i
< n
; i
++)
2341 src
[i
] = XINT (events
[i
]);
2343 for (i
= 0; i
< n
; i
++)
2345 coding
->destination
= alloca (n
* 4);
2346 coding
->dst_bytes
= n
* 4;
2347 decode_coding_c_string (coding
, src
, n
, Qnil
);
2348 eassert (coding
->produced_char
<= n
);
2349 if (coding
->produced_char
== 0)
2350 { /* The encoded sequence is incomplete. */
2351 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2352 continue; /* Read on! */
2356 const unsigned char *p
= coding
->destination
;
2357 eassert (coding
->carryover_bytes
== 0);
2359 while (n
< coding
->produced_char
)
2360 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2363 /* Now `events' should hold decoded events.
2364 Normally, n should be equal to 1, but better not rely on it.
2365 We can only return one event here, so return the first we
2366 had and keep the others (if any) for later. */
2368 Vunread_command_events
2369 = Fcons (events
[--n
], Vunread_command_events
);
2376 /* Read a character from the keyboard; call the redisplay if needed. */
2377 /* commandflag 0 means do not autosave, but do redisplay.
2378 -1 means do not redisplay, but do autosave.
2381 /* The arguments MAP is for menu prompting. MAP is a keymap.
2383 PREV_EVENT is the previous input event, or nil if we are reading
2384 the first event of a key sequence (or not reading a key sequence).
2385 If PREV_EVENT is t, that is a "magic" value that says
2386 not to run input methods, but in other respects to act as if
2387 not reading a key sequence.
2389 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2390 if we used a mouse menu to read the input, or false otherwise. If
2391 USED_MOUSE_MENU is null, don't dereference it.
2393 Value is -2 when we find input on another keyboard. A second call
2394 to read_char will read it.
2396 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2397 specifying the maximum time to wait until. If no input arrives by
2398 that time, stop waiting and return nil.
2400 Value is t if we showed a menu and the user rejected it. */
2403 read_char (int commandflag
, Lisp_Object map
,
2404 Lisp_Object prev_event
,
2405 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2409 sys_jmp_buf local_getcjmp
;
2410 sys_jmp_buf save_jump
;
2411 Lisp_Object tem
, save
;
2412 volatile Lisp_Object previous_echo_area_message
;
2413 volatile Lisp_Object also_record
;
2414 volatile bool reread
;
2415 struct gcpro gcpro1
, gcpro2
;
2416 bool volatile polling_stopped_here
= 0;
2417 struct kboard
*orig_kboard
= current_kboard
;
2421 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2422 before_command_key_count
= this_command_key_count
;
2423 before_command_echo_length
= echo_length ();
2426 previous_echo_area_message
= Qnil
;
2428 GCPRO2 (c
, previous_echo_area_message
);
2433 if (CONSP (Vunread_post_input_method_events
))
2435 c
= XCAR (Vunread_post_input_method_events
);
2436 Vunread_post_input_method_events
2437 = XCDR (Vunread_post_input_method_events
);
2439 /* Undo what read_char_x_menu_prompt did when it unread
2440 additional keys returned by Fx_popup_menu. */
2442 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2450 if (CONSP (Vunread_command_events
))
2452 bool was_disabled
= 0;
2454 c
= XCAR (Vunread_command_events
);
2455 Vunread_command_events
= XCDR (Vunread_command_events
);
2459 /* Undo what sit-for did when it unread additional keys
2460 inside universal-argument. */
2463 && EQ (XCAR (c
), Qt
))
2469 /* Undo what read_char_x_menu_prompt did when it unread
2470 additional keys returned by Fx_popup_menu. */
2472 && EQ (XCDR (c
), Qdisabled
)
2473 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2479 /* If the queued event is something that used the mouse,
2480 set used_mouse_menu accordingly. */
2482 /* Also check was_disabled so last-nonmenu-event won't return
2483 a bad value when submenus are involved. (Bug#447) */
2484 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2485 *used_mouse_menu
= 1;
2487 goto reread_for_input_method
;
2490 if (CONSP (Vunread_input_method_events
))
2492 c
= XCAR (Vunread_input_method_events
);
2493 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2495 /* Undo what read_char_x_menu_prompt did when it unread
2496 additional keys returned by Fx_popup_menu. */
2498 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2502 goto reread_for_input_method
;
2505 this_command_key_count_reset
= 0;
2507 if (!NILP (Vexecuting_kbd_macro
))
2509 /* We set this to Qmacro; since that's not a frame, nobody will
2510 try to switch frames on us, and the selected window will
2513 Since this event came from a macro, it would be misleading to
2514 leave internal_last_event_frame set to wherever the last
2515 real event came from. Normally, a switch-frame event selects
2516 internal_last_event_frame after each command is read, but
2517 events read from a macro should never cause a new frame to be
2519 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2521 /* Exit the macro if we are at the end.
2522 Also, some things replace the macro with t
2523 to force an early exit. */
2524 if (EQ (Vexecuting_kbd_macro
, Qt
)
2525 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2531 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2532 if (STRINGP (Vexecuting_kbd_macro
)
2533 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2534 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2536 executing_kbd_macro_index
++;
2541 if (!NILP (unread_switch_frame
))
2543 c
= unread_switch_frame
;
2544 unread_switch_frame
= Qnil
;
2546 /* This event should make it into this_command_keys, and get echoed
2547 again, so we do not set `reread'. */
2551 /* If redisplay was requested. */
2552 if (commandflag
>= 0)
2554 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2556 /* If there is pending input, process any events which are not
2557 user-visible, such as X selection_request events. */
2559 || detect_input_pending_run_timers (0))
2560 swallow_events (0); /* May clear input_pending. */
2562 /* Redisplay if no pending input. */
2563 while (!input_pending
)
2565 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2566 redisplay_preserve_echo_area (5);
2571 /* Normal case: no input arrived during redisplay. */
2574 /* Input arrived and pre-empted redisplay.
2575 Process any events which are not user-visible. */
2577 /* If that cleared input_pending, try again to redisplay. */
2580 /* Prevent the redisplay we just did
2581 from messing up echoing of the input after the prompt. */
2582 if (commandflag
== 0 && echo_current
)
2583 echo_message_buffer
= echo_area_buffer
[0];
2587 /* Message turns off echoing unless more keystrokes turn it on again.
2589 The code in 20.x for the condition was
2591 1. echo_area_glyphs && *echo_area_glyphs
2592 2. && echo_area_glyphs != current_kboard->echobuf
2593 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2595 (1) means there's a current message displayed
2597 (2) means it's not the message from echoing from the current
2600 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2601 is set to a non-null value. This is done in read_char and it is
2602 set to echo_area_glyphs after a call to echo_char. That means
2603 ok_to_echo_at_next_pause is either null or
2604 current_kboard->echobuf with the appropriate current_kboard at
2607 So, condition (3) means in clear text ok_to_echo_at_next_pause
2608 must be either null, or the current message isn't from echoing at
2609 all, or it's from echoing from a different kboard than the
2612 if (/* There currently is something in the echo area. */
2613 !NILP (echo_area_buffer
[0])
2614 && (/* And it's either not from echoing. */
2615 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2616 /* Or it's an echo from a different kboard. */
2617 || echo_kboard
!= current_kboard
2618 /* Or we explicitly allow overwriting whatever there is. */
2619 || ok_to_echo_at_next_pause
== NULL
))
2624 /* Try reading a character via menu prompting in the minibuf.
2625 Try this before the sit-for, because the sit-for
2626 would do the wrong thing if we are supposed to do
2627 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2628 after a mouse event so don't try a minibuf menu. */
2630 if (KEYMAPP (map
) && INTERACTIVE
2631 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2632 /* Don't bring up a menu if we already have another event. */
2633 && NILP (Vunread_command_events
)
2634 && !detect_input_pending_run_timers (0))
2636 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2638 if (INTEGERP (c
) && XINT (c
) == -2)
2639 return c
; /* wrong_kboard_jmpbuf */
2645 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2646 We will do that below, temporarily for short sections of code,
2647 when appropriate. local_getcjmp must be in effect
2648 around any call to sit_for or kbd_buffer_get_event;
2649 it *must not* be in effect when we call redisplay. */
2651 jmpcount
= SPECPDL_INDEX ();
2652 if (sys_setjmp (local_getcjmp
))
2654 /* Handle quits while reading the keyboard. */
2655 /* We must have saved the outer value of getcjmp here,
2656 so restore it now. */
2657 restore_getcjmp (save_jump
);
2658 unbind_to (jmpcount
, Qnil
);
2659 XSETINT (c
, quit_char
);
2660 internal_last_event_frame
= selected_frame
;
2661 Vlast_event_frame
= internal_last_event_frame
;
2662 /* If we report the quit char as an event,
2663 don't do so more than once. */
2664 if (!NILP (Vinhibit_quit
))
2668 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2669 if (kb
!= current_kboard
)
2671 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2672 /* We shouldn't get here if we were in single-kboard mode! */
2677 while (CONSP (XCDR (last
)))
2679 if (!NILP (XCDR (last
)))
2683 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2685 XSETCDR (last
, Fcons (c
, Qnil
));
2686 kb
->kbd_queue_has_data
= 1;
2687 current_kboard
= kb
;
2688 /* This is going to exit from read_char
2689 so we had better get rid of this frame's stuff. */
2691 return make_number (-2); /* wrong_kboard_jmpbuf */
2697 /* Start idle timers if no time limit is supplied. We don't do it
2698 if a time limit is supplied to avoid an infinite recursion in the
2699 situation where an idle timer calls `sit-for'. */
2702 timer_start_idle ();
2704 /* If in middle of key sequence and minibuffer not active,
2705 start echoing if enough time elapses. */
2707 if (minibuf_level
== 0
2709 && !current_kboard
->immediate_echo
2710 && this_command_key_count
> 0
2712 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2713 && NILP (Fzerop (Vecho_keystrokes
))
2714 && (/* No message. */
2715 NILP (echo_area_buffer
[0])
2716 /* Or empty message. */
2717 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2718 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2719 /* Or already echoing from same kboard. */
2720 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2721 /* Or not echoing before and echoing allowed. */
2722 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2724 /* After a mouse event, start echoing right away.
2725 This is because we are probably about to display a menu,
2726 and we don't want to delay before doing so. */
2727 if (EVENT_HAS_PARAMETERS (prev_event
))
2733 save_getcjmp (save_jump
);
2734 restore_getcjmp (local_getcjmp
);
2735 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2736 restore_getcjmp (save_jump
);
2738 && ! CONSP (Vunread_command_events
))
2743 /* Maybe auto save due to number of keystrokes. */
2745 if (commandflag
!= 0
2746 && auto_save_interval
> 0
2747 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2748 && !detect_input_pending_run_timers (0))
2750 Fdo_auto_save (Qnil
, Qnil
);
2751 /* Hooks can actually change some buffers in auto save. */
2755 /* Try reading using an X menu.
2756 This is never confused with reading using the minibuf
2757 because the recursive call of read_char in read_char_minibuf_menu_prompt
2758 does not pass on any keymaps. */
2760 if (KEYMAPP (map
) && INTERACTIVE
2761 && !NILP (prev_event
)
2762 && EVENT_HAS_PARAMETERS (prev_event
)
2763 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2764 && !EQ (XCAR (prev_event
), Qtool_bar
)
2765 /* Don't bring up a menu if we already have another event. */
2766 && NILP (Vunread_command_events
))
2768 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2770 /* Now that we have read an event, Emacs is not idle. */
2777 /* Maybe autosave and/or garbage collect due to idleness. */
2779 if (INTERACTIVE
&& NILP (c
))
2782 ptrdiff_t buffer_size
;
2784 /* Slow down auto saves logarithmically in size of current buffer,
2785 and garbage collect while we're at it. */
2786 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2787 last_non_minibuf_size
= Z
- BEG
;
2788 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2790 while (buffer_size
> 64)
2791 delay_level
++, buffer_size
-= buffer_size
>> 2;
2792 if (delay_level
< 4) delay_level
= 4;
2793 /* delay_level is 4 for files under around 50k, 7 at 100k,
2794 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2796 /* Auto save if enough time goes by without input. */
2797 if (commandflag
!= 0
2798 && num_nonmacro_input_events
> last_auto_save
2799 && INTEGERP (Vauto_save_timeout
)
2800 && XINT (Vauto_save_timeout
) > 0)
2803 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2805 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2806 timeout
= delay_level
* timeout
/ 4;
2807 save_getcjmp (save_jump
);
2808 restore_getcjmp (local_getcjmp
);
2809 tem0
= sit_for (make_number (timeout
), 1, 1);
2810 restore_getcjmp (save_jump
);
2813 && ! CONSP (Vunread_command_events
))
2815 Fdo_auto_save (Qnil
, Qnil
);
2820 /* If there is still no input available, ask for GC. */
2821 if (!detect_input_pending_run_timers (0))
2825 /* Notify the caller if an autosave hook, or a timer, sentinel or
2826 filter in the sit_for calls above have changed the current
2827 kboard. This could happen if they use the minibuffer or start a
2828 recursive edit, like the fancy splash screen in server.el's
2829 filter. If this longjmp wasn't here, read_key_sequence would
2830 interpret the next key sequence using the wrong translation
2831 tables and function keymaps. */
2832 if (NILP (c
) && current_kboard
!= orig_kboard
)
2835 return make_number (-2); /* wrong_kboard_jmpbuf */
2838 /* If this has become non-nil here, it has been set by a timer
2839 or sentinel or filter. */
2840 if (CONSP (Vunread_command_events
))
2842 c
= XCAR (Vunread_command_events
);
2843 Vunread_command_events
= XCDR (Vunread_command_events
);
2846 /* Read something from current KBOARD's side queue, if possible. */
2850 if (current_kboard
->kbd_queue_has_data
)
2852 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2854 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2855 kset_kbd_queue (current_kboard
,
2856 XCDR (KVAR (current_kboard
, kbd_queue
)));
2857 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2858 current_kboard
->kbd_queue_has_data
= 0;
2859 input_pending
= readable_events (0);
2860 if (EVENT_HAS_PARAMETERS (c
)
2861 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2862 internal_last_event_frame
= XCAR (XCDR (c
));
2863 Vlast_event_frame
= internal_last_event_frame
;
2867 /* If current_kboard's side queue is empty check the other kboards.
2868 If one of them has data that we have not yet seen here,
2869 switch to it and process the data waiting for it.
2871 Note: if the events queued up for another kboard
2872 have already been seen here, and therefore are not a complete command,
2873 the kbd_queue_has_data field is 0, so we skip that kboard here.
2874 That's to avoid an infinite loop switching between kboards here. */
2875 if (NILP (c
) && !single_kboard
)
2878 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2879 if (kb
->kbd_queue_has_data
)
2881 current_kboard
= kb
;
2882 /* This is going to exit from read_char
2883 so we had better get rid of this frame's stuff. */
2885 return make_number (-2); /* wrong_kboard_jmpbuf */
2895 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2896 prev_event
, used_mouse_menu
);
2897 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2899 if (EQ (c
, make_number (-2)))
2901 /* This is going to exit from read_char
2902 so we had better get rid of this frame's stuff. */
2916 if (commandflag
>= 0
2917 && !input_pending
&& !detect_input_pending_run_timers (0))
2923 /* Buffer switch events are only for internal wakeups
2924 so don't show them to the user.
2925 Also, don't record a key if we already did. */
2929 /* Process special events within read_char
2930 and loop around to read another event. */
2933 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2938 struct buffer
*prev_buffer
= current_buffer
;
2939 last_input_event
= c
;
2940 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2942 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2943 /* We stopped being idle for this event; undo that. This
2944 prevents automatic window selection (under
2945 mouse_autoselect_window from acting as a real input event, for
2946 example banishing the mouse under mouse-avoidance-mode. */
2947 timer_resume_idle ();
2949 if (current_buffer
!= prev_buffer
)
2951 /* The command may have changed the keymaps. Pretend there
2952 is input in another keyboard and return. This will
2953 recalculate keymaps. */
2954 c
= make_number (-2);
2961 /* Handle things that only apply to characters. */
2964 /* If kbd_buffer_get_event gave us an EOF, return that. */
2968 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2969 && UNSIGNED_CMP (XFASTINT (c
), <,
2970 SCHARS (KVAR (current_kboard
,
2971 Vkeyboard_translate_table
))))
2972 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2973 && UNSIGNED_CMP (XFASTINT (c
), <,
2974 ASIZE (KVAR (current_kboard
,
2975 Vkeyboard_translate_table
))))
2976 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2980 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2981 /* nil in keyboard-translate-table means no translation. */
2987 /* If this event is a mouse click in the menu bar,
2988 return just menu-bar for now. Modify the mouse click event
2989 so we won't do this twice, then queue it up. */
2990 if (EVENT_HAS_PARAMETERS (c
)
2992 && CONSP (EVENT_START (c
))
2993 && CONSP (XCDR (EVENT_START (c
))))
2997 posn
= POSN_POSN (EVENT_START (c
));
2998 /* Handle menu-bar events:
2999 insert the dummy prefix event `menu-bar'. */
3000 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3002 /* Change menu-bar to (menu-bar) as the event "position". */
3003 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3006 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3011 /* Store these characters into recent_keys, the dribble file if any,
3012 and the keyboard macro being defined, if any. */
3014 if (! NILP (also_record
))
3015 record_char (also_record
);
3017 /* Wipe the echo area.
3018 But first, if we are about to use an input method,
3019 save the echo area contents for it to refer to. */
3021 && ! NILP (Vinput_method_function
)
3022 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3024 previous_echo_area_message
= Fcurrent_message ();
3025 Vinput_method_previous_message
= previous_echo_area_message
;
3028 /* Now wipe the echo area, except for help events which do their
3029 own stuff with the echo area. */
3031 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3032 && !(EQ (Qswitch_frame
, XCAR (c
)))
3033 /* Don't wipe echo area for select window events: These might
3034 get delayed via `mouse-autoselect-window' (Bug#11304). */
3035 && !(EQ (Qselect_window
, XCAR (c
)))))
3037 if (!NILP (echo_area_buffer
[0]))
3039 safe_run_hooks (Qecho_area_clear_hook
);
3040 clear_message (1, 0);
3044 reread_for_input_method
:
3046 /* Pass this to the input method, if appropriate. */
3048 && ! NILP (Vinput_method_function
)
3049 /* Don't run the input method within a key sequence,
3050 after the first event of the key sequence. */
3051 && NILP (prev_event
)
3052 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3055 ptrdiff_t key_count
;
3056 bool key_count_reset
;
3057 struct gcpro gcpro1
;
3058 ptrdiff_t count
= SPECPDL_INDEX ();
3060 /* Save the echo status. */
3061 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3062 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3063 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3064 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3067 if (before_command_restore_flag
)
3069 this_command_key_count
= before_command_key_count_1
;
3070 if (this_command_key_count
< this_single_command_key_start
)
3071 this_single_command_key_start
= this_command_key_count
;
3072 echo_truncate (before_command_echo_length_1
);
3073 before_command_restore_flag
= 0;
3077 /* Save the this_command_keys status. */
3078 key_count
= this_command_key_count
;
3079 key_count_reset
= this_command_key_count_reset
;
3082 keys
= Fcopy_sequence (this_command_keys
);
3087 /* Clear out this_command_keys. */
3088 this_command_key_count
= 0;
3089 this_command_key_count_reset
= 0;
3091 /* Now wipe the echo area. */
3092 if (!NILP (echo_area_buffer
[0]))
3093 safe_run_hooks (Qecho_area_clear_hook
);
3094 clear_message (1, 0);
3097 /* If we are not reading a key sequence,
3098 never use the echo area. */
3101 specbind (Qinput_method_use_echo_area
, Qt
);
3104 /* Call the input method. */
3105 tem
= call1 (Vinput_method_function
, c
);
3107 tem
= unbind_to (count
, tem
);
3109 /* Restore the saved echoing state
3110 and this_command_keys state. */
3111 this_command_key_count
= key_count
;
3112 this_command_key_count_reset
= key_count_reset
;
3114 this_command_keys
= keys
;
3117 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3118 kset_echo_string (current_kboard
, saved_echo_string
);
3119 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3120 if (saved_immediate_echo
)
3125 /* The input method can return no events. */
3128 /* Bring back the previous message, if any. */
3129 if (! NILP (previous_echo_area_message
))
3130 message_with_string ("%s", previous_echo_area_message
, 0);
3133 /* It returned one event or more. */
3135 Vunread_post_input_method_events
3136 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3141 /* Display help if not echoing. */
3142 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3144 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3145 Lisp_Object help
, object
, position
, window
, htem
;
3147 htem
= Fcdr (XCDR (c
));
3150 window
= Fcar (htem
);
3152 object
= Fcar (htem
);
3154 position
= Fcar (htem
);
3156 show_help_echo (help
, window
, object
, position
);
3158 /* We stopped being idle for this event; undo that. */
3160 timer_resume_idle ();
3164 if ((! reread
|| this_command_key_count
== 0
3165 || this_command_key_count_reset
)
3169 /* Don't echo mouse motion events. */
3170 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3171 && NILP (Fzerop (Vecho_keystrokes
))
3172 && ! (EVENT_HAS_PARAMETERS (c
)
3173 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3176 if (! NILP (also_record
))
3177 echo_char (also_record
);
3178 /* Once we reread a character, echoing can happen
3179 the next time we pause to read a new one. */
3180 ok_to_echo_at_next_pause
= current_kboard
;
3183 /* Record this character as part of the current key. */
3184 add_command_key (c
);
3185 if (! NILP (also_record
))
3186 add_command_key (also_record
);
3189 last_input_event
= c
;
3192 /* Process the help character specially if enabled. */
3193 if (!NILP (Vhelp_form
) && help_char_p (c
))
3195 ptrdiff_t count
= SPECPDL_INDEX ();
3197 help_form_saved_window_configs
3198 = Fcons (Fcurrent_window_configuration (Qnil
),
3199 help_form_saved_window_configs
);
3200 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3201 call0 (Qhelp_form_show
);
3206 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3207 if (EVENT_HAS_PARAMETERS (c
)
3208 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3209 XSETCAR (help_form_saved_window_configs
, Qnil
);
3211 while (BUFFERP (c
));
3212 /* Remove the help from the frame. */
3213 unbind_to (count
, Qnil
);
3216 if (EQ (c
, make_number (040)))
3220 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3221 while (BUFFERP (c
));
3230 /* Record a key that came from a mouse menu.
3231 Record it for echoing, for this-command-keys, and so on. */
3234 record_menu_key (Lisp_Object c
)
3236 /* Wipe the echo area. */
3237 clear_message (1, 0);
3242 before_command_key_count
= this_command_key_count
;
3243 before_command_echo_length
= echo_length ();
3246 /* Don't echo mouse motion events. */
3247 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3248 && NILP (Fzerop (Vecho_keystrokes
)))
3252 /* Once we reread a character, echoing can happen
3253 the next time we pause to read a new one. */
3254 ok_to_echo_at_next_pause
= 0;
3257 /* Record this character as part of the current key. */
3258 add_command_key (c
);
3260 /* Re-reading in the middle of a command */
3261 last_input_event
= c
;
3265 /* Return true if should recognize C as "the help character". */
3268 help_char_p (Lisp_Object c
)
3272 if (EQ (c
, Vhelp_char
))
3274 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3275 if (EQ (c
, XCAR (tail
)))
3280 /* Record the input event C in various ways. */
3283 record_char (Lisp_Object c
)
3287 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3289 /* To avoid filling recent_keys with help-echo and mouse-movement
3290 events, we filter out repeated help-echo events, only store the
3291 first and last in a series of mouse-movement events, and don't
3292 store repeated help-echo events which are only separated by
3293 mouse-movement events. */
3295 Lisp_Object ev1
, ev2
, ev3
;
3298 if ((ix1
= recent_keys_index
- 1) < 0)
3299 ix1
= NUM_RECENT_KEYS
- 1;
3300 ev1
= AREF (recent_keys
, ix1
);
3302 if ((ix2
= ix1
- 1) < 0)
3303 ix2
= NUM_RECENT_KEYS
- 1;
3304 ev2
= AREF (recent_keys
, ix2
);
3306 if ((ix3
= ix2
- 1) < 0)
3307 ix3
= NUM_RECENT_KEYS
- 1;
3308 ev3
= AREF (recent_keys
, ix3
);
3310 if (EQ (XCAR (c
), Qhelp_echo
))
3312 /* Don't record `help-echo' in recent_keys unless it shows some help
3313 message, and a different help than the previously recorded
3315 Lisp_Object help
, last_help
;
3317 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3318 if (!STRINGP (help
))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3321 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3323 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3325 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3327 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3328 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3329 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3330 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3333 else if (EQ (XCAR (c
), Qmouse_movement
))
3335 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3336 So additional mouse movement events replace the last element. */
3337 Lisp_Object last_window
, window
;
3339 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3340 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3341 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3342 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3343 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3345 ASET (recent_keys
, ix1
, c
);
3351 store_kbd_macro_char (c
);
3355 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3356 ASET (recent_keys
, recent_keys_index
, c
);
3357 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3358 recent_keys_index
= 0;
3360 else if (recorded
< 0)
3362 /* We need to remove one or two events from recent_keys.
3363 To do this, we simply put nil at those events and move the
3364 recent_keys_index backwards over those events. Usually,
3365 users will never see those nil events, as they will be
3366 overwritten by the command keys entered to see recent_keys
3369 while (recorded
++ < 0 && total_keys
> 0)
3371 if (total_keys
< NUM_RECENT_KEYS
)
3373 if (--recent_keys_index
< 0)
3374 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3375 ASET (recent_keys
, recent_keys_index
, Qnil
);
3379 num_nonmacro_input_events
++;
3381 /* Write c to the dribble file. If c is a lispy event, write
3382 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3383 If you, dear reader, have a better idea, you've got the source. :-) */
3389 if (XUINT (c
) < 0x100)
3390 putc (XUINT (c
), dribble
);
3392 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3396 Lisp_Object dribblee
;
3398 /* If it's a structured event, take the event header. */
3399 dribblee
= EVENT_HEAD (c
);
3401 if (SYMBOLP (dribblee
))
3403 putc ('<', dribble
);
3404 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3405 SBYTES (SYMBOL_NAME (dribblee
)),
3407 putc ('>', dribble
);
3416 /* Copy out or in the info on where C-g should throw to.
3417 This is used when running Lisp code from within get_char,
3418 in case get_char is called recursively.
3419 See read_process_output. */
3422 save_getcjmp (sys_jmp_buf temp
)
3424 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3428 restore_getcjmp (sys_jmp_buf temp
)
3430 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3433 /* Low level keyboard/mouse input.
3434 kbd_buffer_store_event places events in kbd_buffer, and
3435 kbd_buffer_get_event retrieves them. */
3437 /* Return true if there are any events in the queue that read-char
3438 would return. If this returns false, a read-char would block. */
3440 readable_events (int flags
)
3442 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3445 /* If the buffer contains only FOCUS_IN_EVENT events, and
3446 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3447 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3449 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3450 #ifdef USE_TOOLKIT_SCROLL_BARS
3451 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3455 struct input_event
*event
;
3457 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3464 #ifdef USE_TOOLKIT_SCROLL_BARS
3465 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3467 event
->kind
== FOCUS_IN_EVENT
)
3468 #ifdef USE_TOOLKIT_SCROLL_BARS
3469 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3470 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3471 && event
->part
== scroll_bar_handle
3472 && event
->modifiers
== 0)
3477 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3480 while (event
!= kbd_store_ptr
);
3486 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3487 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3491 if (current_kboard
->kbd_queue_has_data
)
3497 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3498 if (kb
->kbd_queue_has_data
)
3504 /* Set this for debugging, to have a way to get out */
3505 int stop_character EXTERNALLY_VISIBLE
;
3508 event_to_kboard (struct input_event
*event
)
3510 /* Not applicable for these special events. */
3511 if (event
->kind
== SELECTION_REQUEST_EVENT
3512 || event
->kind
== SELECTION_CLEAR_EVENT
)
3516 Lisp_Object obj
= event
->frame_or_window
;
3517 /* There are some events that set this field to nil or string. */
3519 obj
= WINDOW_FRAME (XWINDOW (obj
));
3520 /* Also ignore dead frames here. */
3521 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3522 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3527 /* Return the number of slots occupied in kbd_buffer. */
3530 kbd_buffer_nr_stored (void)
3532 return kbd_fetch_ptr
== kbd_store_ptr
3534 : (kbd_fetch_ptr
< kbd_store_ptr
3535 ? kbd_store_ptr
- kbd_fetch_ptr
3536 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3537 + (kbd_store_ptr
- kbd_buffer
)));
3539 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3542 kbd_buffer_store_event (register struct input_event
*event
)
3544 kbd_buffer_store_event_hold (event
, 0);
3547 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3549 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3550 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3551 Else, if EVENT is a quit event, store the quit event
3552 in HOLD_QUIT, and return (thus ignoring further events).
3554 This is used to postpone the processing of the quit event until all
3555 subsequent input events have been parsed (and discarded). */
3558 kbd_buffer_store_event_hold (register struct input_event
*event
,
3559 struct input_event
*hold_quit
)
3561 if (event
->kind
== NO_EVENT
)
3564 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3567 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3569 register int c
= event
->code
& 0377;
3571 if (event
->modifiers
& ctrl_modifier
)
3572 c
= make_ctrl_char (c
);
3574 c
|= (event
->modifiers
3575 & (meta_modifier
| alt_modifier
3576 | hyper_modifier
| super_modifier
));
3580 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3581 struct input_event
*sp
;
3583 if (single_kboard
&& kb
!= current_kboard
)
3586 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3587 Fcons (make_number (c
), Qnil
)));
3588 kb
->kbd_queue_has_data
= 1;
3589 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3591 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3594 if (event_to_kboard (sp
) == kb
)
3596 sp
->kind
= NO_EVENT
;
3597 sp
->frame_or_window
= Qnil
;
3606 *hold_quit
= *event
;
3610 /* If this results in a quit_char being returned to Emacs as
3611 input, set Vlast_event_frame properly. If this doesn't
3612 get returned to Emacs as an event, the next event read
3613 will set Vlast_event_frame again, so this is safe to do. */
3617 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3619 focus
= event
->frame_or_window
;
3620 internal_last_event_frame
= focus
;
3621 Vlast_event_frame
= focus
;
3624 last_event_timestamp
= event
->timestamp
;
3626 handle_interrupt (0);
3630 if (c
&& c
== stop_character
)
3636 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3637 Just ignore the second one. */
3638 else if (event
->kind
== BUFFER_SWITCH_EVENT
3639 && kbd_fetch_ptr
!= kbd_store_ptr
3640 && ((kbd_store_ptr
== kbd_buffer
3641 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3642 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3645 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3646 kbd_store_ptr
= kbd_buffer
;
3648 /* Don't let the very last slot in the buffer become full,
3649 since that would make the two pointers equal,
3650 and that is indistinguishable from an empty buffer.
3651 Discard the event if it would fill the last slot. */
3652 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3654 *kbd_store_ptr
= *event
;
3657 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3659 /* Don't read keyboard input until we have processed kbd_buffer.
3660 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3661 hold_keyboard_input ();
3662 if (!noninteractive
)
3666 #endif /* subprocesses */
3669 /* If we're inside while-no-input, and this event qualifies
3670 as input, set quit-flag to cause an interrupt. */
3671 if (!NILP (Vthrow_on_input
)
3672 && event
->kind
!= FOCUS_IN_EVENT
3673 && event
->kind
!= HELP_EVENT
3674 && event
->kind
!= DEICONIFY_EVENT
)
3676 Vquit_flag
= Vthrow_on_input
;
3677 /* If we're inside a function that wants immediate quits,
3679 if (immediate_quit
&& NILP (Vinhibit_quit
))
3688 /* Put an input event back in the head of the event queue. */
3691 kbd_buffer_unget_event (register struct input_event
*event
)
3693 if (kbd_fetch_ptr
== kbd_buffer
)
3694 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3696 /* Don't let the very last slot in the buffer become full, */
3697 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3700 *kbd_fetch_ptr
= *event
;
3705 /* Generate a HELP_EVENT input_event and store it in the keyboard
3708 HELP is the help form.
3710 FRAME and WINDOW are the frame and window where the help is
3711 generated. OBJECT is the Lisp object where the help was found (a
3712 buffer, a string, an overlay, or nil if neither from a string nor
3713 from a buffer). POS is the position within OBJECT where the help
3717 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3718 Lisp_Object object
, ptrdiff_t pos
)
3720 struct input_event event
;
3724 event
.kind
= HELP_EVENT
;
3725 event
.frame_or_window
= frame
;
3727 event
.x
= WINDOWP (window
) ? window
: frame
;
3730 kbd_buffer_store_event (&event
);
3734 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3737 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3739 struct input_event event
;
3741 event
.kind
= HELP_EVENT
;
3742 event
.frame_or_window
= frame
;
3747 kbd_buffer_store_event (&event
);
3751 /* Discard any mouse events in the event buffer by setting them to
3754 discard_mouse_events (void)
3756 struct input_event
*sp
;
3757 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3759 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3762 if (sp
->kind
== MOUSE_CLICK_EVENT
3763 || sp
->kind
== WHEEL_EVENT
3764 || sp
->kind
== HORIZ_WHEEL_EVENT
3766 || sp
->kind
== GPM_CLICK_EVENT
3768 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3770 sp
->kind
= NO_EVENT
;
3776 /* Return true if there are any real events waiting in the event
3777 buffer, not counting `NO_EVENT's.
3779 Discard NO_EVENT events at the front of the input queue, possibly
3780 leaving the input queue empty if there are no real input events. */
3783 kbd_buffer_events_waiting (void)
3785 struct input_event
*sp
;
3787 for (sp
= kbd_fetch_ptr
;
3788 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3791 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3796 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3800 /* Clear input event EVENT. */
3803 clear_event (struct input_event
*event
)
3805 event
->kind
= NO_EVENT
;
3809 /* Read one event from the event buffer, waiting if necessary.
3810 The value is a Lisp object representing the event.
3811 The value is nil for an event that should be ignored,
3812 or that was handled here.
3813 We always read and discard one event. */
3816 kbd_buffer_get_event (KBOARD
**kbp
,
3817 bool *used_mouse_menu
,
3818 EMACS_TIME
*end_time
)
3823 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3825 /* Start reading input again because we have processed enough to
3826 be able to accept new events again. */
3827 unhold_keyboard_input ();
3830 #endif /* subprocesses */
3832 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3834 /* In case we are running as a daemon, only do this before
3835 detaching from the terminal. */
3836 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3840 *kbp
= current_kboard
;
3843 #endif /* ! HAVE_DBUS */
3845 /* Wait until there is input available. */
3848 /* Break loop if there's an unread command event. Needed in
3849 moused window autoselection which uses a timer to insert such
3851 if (CONSP (Vunread_command_events
))
3854 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3856 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3859 /* If the quit flag is set, then read_char will return
3860 quit_char, so that counts as "available input." */
3861 if (!NILP (Vquit_flag
))
3862 quit_throw_to_read_char (0);
3864 /* One way or another, wait until input is available; then, if
3865 interrupt handlers have not read it, read it now. */
3870 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3872 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3876 EMACS_TIME now
= current_emacs_time ();
3877 if (EMACS_TIME_LE (*end_time
, now
))
3878 return Qnil
; /* Finished waiting. */
3881 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3882 wait_reading_process_output (min (EMACS_SECS (duration
),
3884 EMACS_NSECS (duration
),
3885 -1, 1, Qnil
, NULL
, 0);
3889 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3891 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3895 if (CONSP (Vunread_command_events
))
3898 first
= XCAR (Vunread_command_events
);
3899 Vunread_command_events
= XCDR (Vunread_command_events
);
3900 *kbp
= current_kboard
;
3904 /* At this point, we know that there is a readable event available
3905 somewhere. If the event queue is empty, then there must be a
3906 mouse movement enabled and available. */
3907 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3909 struct input_event
*event
;
3911 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3915 last_event_timestamp
= event
->timestamp
;
3917 *kbp
= event_to_kboard (event
);
3919 *kbp
= current_kboard
; /* Better than returning null ptr? */
3923 /* These two kinds of events get special handling
3924 and don't actually appear to the command loop.
3925 We return nil for them. */
3926 if (event
->kind
== SELECTION_REQUEST_EVENT
3927 || event
->kind
== SELECTION_CLEAR_EVENT
)
3930 struct input_event copy
;
3932 /* Remove it from the buffer before processing it,
3933 since otherwise swallow_events will see it
3934 and process it again. */
3936 kbd_fetch_ptr
= event
+ 1;
3937 input_pending
= readable_events (0);
3938 x_handle_selection_event (©
);
3940 /* We're getting selection request events, but we don't have
3946 #if defined (HAVE_NS)
3947 else if (event
->kind
== NS_TEXT_EVENT
)
3949 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3950 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3952 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3953 kbd_fetch_ptr
= event
+ 1;
3954 if (used_mouse_menu
)
3955 *used_mouse_menu
= 1;
3959 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3960 || defined (HAVE_NS)
3961 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3963 /* Make an event (delete-frame (FRAME)). */
3964 obj
= Fcons (event
->frame_or_window
, Qnil
);
3965 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3966 kbd_fetch_ptr
= event
+ 1;
3969 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3970 || defined (HAVE_NS)
3971 else if (event
->kind
== ICONIFY_EVENT
)
3973 /* Make an event (iconify-frame (FRAME)). */
3974 obj
= Fcons (event
->frame_or_window
, Qnil
);
3975 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3976 kbd_fetch_ptr
= event
+ 1;
3978 else if (event
->kind
== DEICONIFY_EVENT
)
3980 /* Make an event (make-frame-visible (FRAME)). */
3981 obj
= Fcons (event
->frame_or_window
, Qnil
);
3982 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3983 kbd_fetch_ptr
= event
+ 1;
3986 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3988 /* The value doesn't matter here; only the type is tested. */
3989 XSETBUFFER (obj
, current_buffer
);
3990 kbd_fetch_ptr
= event
+ 1;
3992 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3993 || defined (HAVE_NS) || defined (USE_GTK)
3994 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3996 kbd_fetch_ptr
= event
+ 1;
3997 input_pending
= readable_events (0);
3998 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3999 x_activate_menubar (XFRAME (event
->frame_or_window
));
4003 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4005 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
4006 obj
= Fcons (Qlanguage_change
,
4007 list3 (event
->frame_or_window
,
4008 make_number (event
->code
),
4009 make_number (event
->modifiers
)));
4010 kbd_fetch_ptr
= event
+ 1;
4013 #ifdef USE_FILE_NOTIFY
4014 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4016 #ifdef HAVE_W32NOTIFY
4017 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4018 obj
= Fcons (Qfile_notify
,
4019 list2 (list3 (make_number (event
->code
),
4022 event
->frame_or_window
));
4024 obj
= make_lispy_event (event
);
4026 kbd_fetch_ptr
= event
+ 1;
4028 #endif /* USE_FILE_NOTIFY */
4029 else if (event
->kind
== SAVE_SESSION_EVENT
)
4031 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
4032 kbd_fetch_ptr
= event
+ 1;
4034 /* Just discard these, by returning nil.
4035 With MULTI_KBOARD, these events are used as placeholders
4036 when we need to randomly delete events from the queue.
4037 (They shouldn't otherwise be found in the buffer,
4038 but on some machines it appears they do show up
4039 even without MULTI_KBOARD.) */
4040 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4041 mouse events during a popup-menu call. */
4042 else if (event
->kind
== NO_EVENT
)
4043 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== HELP_EVENT
)
4046 Lisp_Object object
, position
, help
, frame
, window
;
4048 frame
= event
->frame_or_window
;
4049 object
= event
->arg
;
4050 position
= make_number (event
->code
);
4053 clear_event (event
);
4055 kbd_fetch_ptr
= event
+ 1;
4056 if (!WINDOWP (window
))
4058 obj
= Fcons (Qhelp_echo
,
4059 list5 (frame
, help
, window
, object
, position
));
4061 else if (event
->kind
== FOCUS_IN_EVENT
)
4063 /* Notification of a FocusIn event. The frame receiving the
4064 focus is in event->frame_or_window. Generate a
4065 switch-frame event if necessary. */
4066 Lisp_Object frame
, focus
;
4068 frame
= event
->frame_or_window
;
4069 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4073 if (!EQ (frame
, internal_last_event_frame
)
4074 && !EQ (frame
, selected_frame
))
4075 obj
= make_lispy_switch_frame (frame
);
4076 internal_last_event_frame
= frame
;
4077 kbd_fetch_ptr
= event
+ 1;
4080 else if (event
->kind
== DBUS_EVENT
)
4082 obj
= make_lispy_event (event
);
4083 kbd_fetch_ptr
= event
+ 1;
4086 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4088 obj
= make_lispy_event (event
);
4089 kbd_fetch_ptr
= event
+ 1;
4093 /* If this event is on a different frame, return a switch-frame this
4094 time, and leave the event in the queue for next time. */
4098 frame
= event
->frame_or_window
;
4100 frame
= XCAR (frame
);
4101 else if (WINDOWP (frame
))
4102 frame
= WINDOW_FRAME (XWINDOW (frame
));
4104 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4108 if (! EQ (frame
, internal_last_event_frame
)
4109 && !EQ (frame
, selected_frame
))
4110 obj
= make_lispy_switch_frame (frame
);
4111 internal_last_event_frame
= frame
;
4113 /* If we didn't decide to make a switch-frame event, go ahead
4114 and build a real event from the queue entry. */
4118 obj
= make_lispy_event (event
);
4120 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4121 || defined (HAVE_NS) || defined (USE_GTK)
4122 /* If this was a menu selection, then set the flag to inhibit
4123 writing to last_nonmenu_event. Don't do this if the event
4124 we're returning is (menu-bar), though; that indicates the
4125 beginning of the menu sequence, and we might as well leave
4126 that as the `event with parameters' for this selection. */
4128 && !EQ (event
->frame_or_window
, event
->arg
)
4129 && (event
->kind
== MENU_BAR_EVENT
4130 || event
->kind
== TOOL_BAR_EVENT
))
4131 *used_mouse_menu
= 1;
4134 /* Certain system events are non-key events. */
4136 && event
->kind
== NS_NONKEY_EVENT
)
4137 *used_mouse_menu
= 1;
4140 /* Wipe out this event, to catch bugs. */
4141 clear_event (event
);
4142 kbd_fetch_ptr
= event
+ 1;
4146 /* Try generating a mouse motion event. */
4147 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4149 FRAME_PTR f
= some_mouse_moved ();
4150 Lisp_Object bar_window
;
4151 enum scroll_bar_part part
;
4155 *kbp
= current_kboard
;
4156 /* Note that this uses F to determine which terminal to look at.
4157 If there is no valid info, it does not store anything
4158 so x remains nil. */
4161 /* XXX Can f or mouse_position_hook be NULL here? */
4162 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4163 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4168 /* Decide if we should generate a switch-frame event. Don't
4169 generate switch-frame events for motion outside of all Emacs
4175 frame
= FRAME_FOCUS_FRAME (f
);
4177 XSETFRAME (frame
, f
);
4179 if (! EQ (frame
, internal_last_event_frame
)
4180 && !EQ (frame
, selected_frame
))
4181 obj
= make_lispy_switch_frame (frame
);
4182 internal_last_event_frame
= frame
;
4185 /* If we didn't decide to make a switch-frame event, go ahead and
4186 return a mouse-motion event. */
4187 if (!NILP (x
) && NILP (obj
))
4188 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4191 /* We were promised by the above while loop that there was
4192 something for us to read! */
4195 input_pending
= readable_events (0);
4197 Vlast_event_frame
= internal_last_event_frame
;
4202 /* Process any non-user-visible events (currently X selection events),
4203 without reading any user-visible events. */
4206 process_special_events (void)
4208 struct input_event
*event
;
4210 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4212 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4215 if (event
== kbd_store_ptr
)
4219 /* If we find a stored X selection request, handle it now. */
4220 if (event
->kind
== SELECTION_REQUEST_EVENT
4221 || event
->kind
== SELECTION_CLEAR_EVENT
)
4225 /* Remove the event from the fifo buffer before processing;
4226 otherwise swallow_events called recursively could see it
4227 and process it again. To do this, we move the events
4228 between kbd_fetch_ptr and EVENT one slot to the right,
4231 struct input_event copy
= *event
;
4232 struct input_event
*beg
4233 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4234 ? kbd_buffer
: kbd_fetch_ptr
;
4237 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4238 else if (event
< beg
)
4240 if (event
> kbd_buffer
)
4241 memmove (kbd_buffer
+ 1, kbd_buffer
,
4242 (event
- kbd_buffer
) * sizeof (struct input_event
));
4243 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4244 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4245 memmove (beg
+ 1, beg
,
4246 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4247 * sizeof (struct input_event
));
4250 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4251 kbd_fetch_ptr
= kbd_buffer
+ 1;
4255 /* X wants last_event_timestamp for selection ownership. */
4256 last_event_timestamp
= copy
.timestamp
;
4257 input_pending
= readable_events (0);
4258 x_handle_selection_event (©
);
4260 /* We're getting selection request events, but we don't have
4268 /* Process any events that are not user-visible, run timer events that
4269 are ripe, and return, without reading any user-visible events. */
4272 swallow_events (bool do_display
)
4274 unsigned old_timers_run
;
4276 process_special_events ();
4278 old_timers_run
= timers_run
;
4279 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4281 if (timers_run
!= old_timers_run
&& do_display
)
4282 redisplay_preserve_echo_area (7);
4285 /* Record the start of when Emacs is idle,
4286 for the sake of running idle-time timers. */
4289 timer_start_idle (void)
4291 /* If we are already in the idle state, do nothing. */
4292 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4295 timer_idleness_start_time
= current_emacs_time ();
4296 timer_last_idleness_start_time
= timer_idleness_start_time
;
4298 /* Mark all idle-time timers as once again candidates for running. */
4299 call0 (intern ("internal-timer-start-idle"));
4302 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4305 timer_stop_idle (void)
4307 timer_idleness_start_time
= invalid_emacs_time ();
4310 /* Resume idle timer from last idle start time. */
4313 timer_resume_idle (void)
4315 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4318 timer_idleness_start_time
= timer_last_idleness_start_time
;
4321 /* This is only for debugging. */
4322 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4324 /* List of elisp functions to call, delayed because they were generated in
4325 a context where Elisp could not be safely run (e.g. redisplay, signal,
4326 ...). Each element has the form (FUN . ARGS). */
4327 Lisp_Object pending_funcalls
;
4329 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4331 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4333 Lisp_Object
*vector
;
4335 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4337 vector
= XVECTOR (timer
)->contents
;
4338 if (! NILP (vector
[0]))
4341 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4346 /* Check whether a timer has fired. To prevent larger problems we simply
4347 disregard elements that are not proper timers. Do not make a circular
4348 timer list for the time being.
4350 Returns the time to wait until the next timer fires. If a
4351 timer is triggering now, return zero.
4352 If no timer is active, return -1.
4354 If a timer is ripe, we run it, with quitting turned off.
4355 In that case we return 0 to indicate that a new timer_check_2 call
4359 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4361 EMACS_TIME nexttime
;
4363 EMACS_TIME idleness_now
;
4364 Lisp_Object chosen_timer
;
4365 struct gcpro gcpro1
;
4367 nexttime
= invalid_emacs_time ();
4369 chosen_timer
= Qnil
;
4370 GCPRO1 (chosen_timer
);
4372 /* First run the code that was delayed. */
4373 while (CONSP (pending_funcalls
))
4375 Lisp_Object funcall
= XCAR (pending_funcalls
);
4376 pending_funcalls
= XCDR (pending_funcalls
);
4377 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4380 if (CONSP (timers
) || CONSP (idle_timers
))
4382 now
= current_emacs_time ();
4383 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4384 ? sub_emacs_time (now
, timer_idleness_start_time
)
4385 : make_emacs_time (0, 0));
4388 while (CONSP (timers
) || CONSP (idle_timers
))
4390 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4391 EMACS_TIME timer_time
, idle_timer_time
;
4392 EMACS_TIME difference
;
4393 EMACS_TIME timer_difference
= invalid_emacs_time ();
4394 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4395 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4397 /* Set TIMER and TIMER_DIFFERENCE
4398 based on the next ordinary timer.
4399 TIMER_DIFFERENCE is the distance in time from NOW to when
4400 this timer becomes ripe (negative if it's already ripe).
4401 Skip past invalid timers and timers already handled. */
4404 timer
= XCAR (timers
);
4405 if (! decode_timer (timer
, &timer_time
))
4407 timers
= XCDR (timers
);
4411 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4412 timer_difference
= (timer_ripe
4413 ? sub_emacs_time (now
, timer_time
)
4414 : sub_emacs_time (timer_time
, now
));
4417 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4418 based on the next idle timer. */
4419 if (CONSP (idle_timers
))
4421 idle_timer
= XCAR (idle_timers
);
4422 if (! decode_timer (idle_timer
, &idle_timer_time
))
4424 idle_timers
= XCDR (idle_timers
);
4428 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4429 idle_timer_difference
4431 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4432 : sub_emacs_time (idle_timer_time
, idleness_now
));
4435 /* Decide which timer is the next timer,
4436 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4437 Also step down the list where we found that timer. */
4439 if (EMACS_TIME_VALID_P (timer_difference
)
4440 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4441 || idle_timer_ripe
< timer_ripe
4442 || (idle_timer_ripe
== timer_ripe
4444 ? EMACS_TIME_LT (idle_timer_difference
,
4446 : EMACS_TIME_LT (timer_difference
,
4447 idle_timer_difference
)))))
4449 chosen_timer
= timer
;
4450 timers
= XCDR (timers
);
4451 difference
= timer_difference
;
4456 chosen_timer
= idle_timer
;
4457 idle_timers
= XCDR (idle_timers
);
4458 difference
= idle_timer_difference
;
4459 ripe
= idle_timer_ripe
;
4462 /* If timer is ripe, run it if it hasn't been run. */
4465 if (NILP (AREF (chosen_timer
, 0)))
4467 ptrdiff_t count
= SPECPDL_INDEX ();
4468 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4470 /* Mark the timer as triggered to prevent problems if the lisp
4471 code fails to reschedule it right. */
4472 ASET (chosen_timer
, 0, Qt
);
4474 specbind (Qinhibit_quit
, Qt
);
4476 call1 (Qtimer_event_handler
, chosen_timer
);
4477 Vdeactivate_mark
= old_deactivate_mark
;
4479 unbind_to (count
, Qnil
);
4481 /* Since we have handled the event,
4482 we don't need to tell the caller to wake up and do it. */
4483 /* But the caller must still wait for the next timer, so
4484 return 0 to indicate that. */
4487 nexttime
= make_emacs_time (0, 0);
4491 /* When we encounter a timer that is still waiting,
4492 return the amount of time to wait before it is ripe. */
4499 /* No timers are pending in the future. */
4500 /* Return 0 if we generated an event, and -1 if not. */
4506 /* Check whether a timer has fired. To prevent larger problems we simply
4507 disregard elements that are not proper timers. Do not make a circular
4508 timer list for the time being.
4510 Returns the time to wait until the next timer fires.
4511 If no timer is active, return an invalid value.
4513 As long as any timer is ripe, we run it. */
4518 EMACS_TIME nexttime
;
4519 Lisp_Object timers
, idle_timers
;
4520 struct gcpro gcpro1
, gcpro2
;
4522 Lisp_Object tem
= Vinhibit_quit
;
4525 /* We use copies of the timers' lists to allow a timer to add itself
4526 again, without locking up Emacs if the newly added timer is
4527 already ripe when added. */
4529 /* Always consider the ordinary timers. */
4530 timers
= Fcopy_sequence (Vtimer_list
);
4531 /* Consider the idle timers only if Emacs is idle. */
4532 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4533 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4537 Vinhibit_quit
= tem
;
4539 GCPRO2 (timers
, idle_timers
);
4543 nexttime
= timer_check_2 (timers
, idle_timers
);
4545 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4551 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4552 doc
: /* Return the current length of Emacs idleness, or nil.
4553 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4554 in the same style as (current-time).
4556 The value when Emacs is not idle is nil.
4558 PSEC is a multiple of the system clock resolution. */)
4561 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4562 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4563 timer_idleness_start_time
));
4568 /* Caches for modify_event_symbol. */
4569 static Lisp_Object accent_key_syms
;
4570 static Lisp_Object func_key_syms
;
4571 static Lisp_Object mouse_syms
;
4572 static Lisp_Object wheel_syms
;
4573 static Lisp_Object drag_n_drop_syms
;
4575 /* This is a list of keysym codes for special "accent" characters.
4576 It parallels lispy_accent_keys. */
4578 static const int lispy_accent_codes
[] =
4580 #ifdef XK_dead_circumflex
4585 #ifdef XK_dead_grave
4590 #ifdef XK_dead_tilde
4595 #ifdef XK_dead_diaeresis
4600 #ifdef XK_dead_macron
4605 #ifdef XK_dead_degree
4610 #ifdef XK_dead_acute
4615 #ifdef XK_dead_cedilla
4620 #ifdef XK_dead_breve
4625 #ifdef XK_dead_ogonek
4630 #ifdef XK_dead_caron
4635 #ifdef XK_dead_doubleacute
4636 XK_dead_doubleacute
,
4640 #ifdef XK_dead_abovedot
4645 #ifdef XK_dead_abovering
4655 #ifdef XK_dead_belowdot
4660 #ifdef XK_dead_voiced_sound
4661 XK_dead_voiced_sound
,
4665 #ifdef XK_dead_semivoiced_sound
4666 XK_dead_semivoiced_sound
,
4682 /* This is a list of Lisp names for special "accent" characters.
4683 It parallels lispy_accent_codes. */
4685 static const char *const lispy_accent_keys
[] =
4703 "dead-voiced-sound",
4704 "dead-semivoiced-sound",
4710 #define FUNCTION_KEY_OFFSET 0x0
4712 const char *const lispy_function_keys
[] =
4716 0, /* VK_LBUTTON 0x01 */
4717 0, /* VK_RBUTTON 0x02 */
4718 "cancel", /* VK_CANCEL 0x03 */
4719 0, /* VK_MBUTTON 0x04 */
4721 0, 0, 0, /* 0x05 .. 0x07 */
4723 "backspace", /* VK_BACK 0x08 */
4724 "tab", /* VK_TAB 0x09 */
4726 0, 0, /* 0x0A .. 0x0B */
4728 "clear", /* VK_CLEAR 0x0C */
4729 "return", /* VK_RETURN 0x0D */
4731 0, 0, /* 0x0E .. 0x0F */
4733 0, /* VK_SHIFT 0x10 */
4734 0, /* VK_CONTROL 0x11 */
4735 0, /* VK_MENU 0x12 */
4736 "pause", /* VK_PAUSE 0x13 */
4737 "capslock", /* VK_CAPITAL 0x14 */
4738 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4740 "junja", /* VK_JUNJA 0x17 */
4741 "final", /* VK_FINAL 0x18 */
4742 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4744 "escape", /* VK_ESCAPE 0x1B */
4745 "convert", /* VK_CONVERT 0x1C */
4746 "non-convert", /* VK_NONCONVERT 0x1D */
4747 "accept", /* VK_ACCEPT 0x1E */
4748 "mode-change", /* VK_MODECHANGE 0x1F */
4749 0, /* VK_SPACE 0x20 */
4750 "prior", /* VK_PRIOR 0x21 */
4751 "next", /* VK_NEXT 0x22 */
4752 "end", /* VK_END 0x23 */
4753 "home", /* VK_HOME 0x24 */
4754 "left", /* VK_LEFT 0x25 */
4755 "up", /* VK_UP 0x26 */
4756 "right", /* VK_RIGHT 0x27 */
4757 "down", /* VK_DOWN 0x28 */
4758 "select", /* VK_SELECT 0x29 */
4759 "print", /* VK_PRINT 0x2A */
4760 "execute", /* VK_EXECUTE 0x2B */
4761 "snapshot", /* VK_SNAPSHOT 0x2C */
4762 "insert", /* VK_INSERT 0x2D */
4763 "delete", /* VK_DELETE 0x2E */
4764 "help", /* VK_HELP 0x2F */
4766 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4768 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4770 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4772 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4774 0, 0, 0, 0, 0, 0, 0, 0, 0,
4775 0, 0, 0, 0, 0, 0, 0, 0, 0,
4776 0, 0, 0, 0, 0, 0, 0, 0,
4778 "lwindow", /* VK_LWIN 0x5B */
4779 "rwindow", /* VK_RWIN 0x5C */
4780 "apps", /* VK_APPS 0x5D */
4783 "kp-0", /* VK_NUMPAD0 0x60 */
4784 "kp-1", /* VK_NUMPAD1 0x61 */
4785 "kp-2", /* VK_NUMPAD2 0x62 */
4786 "kp-3", /* VK_NUMPAD3 0x63 */
4787 "kp-4", /* VK_NUMPAD4 0x64 */
4788 "kp-5", /* VK_NUMPAD5 0x65 */
4789 "kp-6", /* VK_NUMPAD6 0x66 */
4790 "kp-7", /* VK_NUMPAD7 0x67 */
4791 "kp-8", /* VK_NUMPAD8 0x68 */
4792 "kp-9", /* VK_NUMPAD9 0x69 */
4793 "kp-multiply", /* VK_MULTIPLY 0x6A */
4794 "kp-add", /* VK_ADD 0x6B */
4795 "kp-separator", /* VK_SEPARATOR 0x6C */
4796 "kp-subtract", /* VK_SUBTRACT 0x6D */
4797 "kp-decimal", /* VK_DECIMAL 0x6E */
4798 "kp-divide", /* VK_DIVIDE 0x6F */
4799 "f1", /* VK_F1 0x70 */
4800 "f2", /* VK_F2 0x71 */
4801 "f3", /* VK_F3 0x72 */
4802 "f4", /* VK_F4 0x73 */
4803 "f5", /* VK_F5 0x74 */
4804 "f6", /* VK_F6 0x75 */
4805 "f7", /* VK_F7 0x76 */
4806 "f8", /* VK_F8 0x77 */
4807 "f9", /* VK_F9 0x78 */
4808 "f10", /* VK_F10 0x79 */
4809 "f11", /* VK_F11 0x7A */
4810 "f12", /* VK_F12 0x7B */
4811 "f13", /* VK_F13 0x7C */
4812 "f14", /* VK_F14 0x7D */
4813 "f15", /* VK_F15 0x7E */
4814 "f16", /* VK_F16 0x7F */
4815 "f17", /* VK_F17 0x80 */
4816 "f18", /* VK_F18 0x81 */
4817 "f19", /* VK_F19 0x82 */
4818 "f20", /* VK_F20 0x83 */
4819 "f21", /* VK_F21 0x84 */
4820 "f22", /* VK_F22 0x85 */
4821 "f23", /* VK_F23 0x86 */
4822 "f24", /* VK_F24 0x87 */
4824 0, 0, 0, 0, /* 0x88 .. 0x8B */
4825 0, 0, 0, 0, /* 0x8C .. 0x8F */
4827 "kp-numlock", /* VK_NUMLOCK 0x90 */
4828 "scroll", /* VK_SCROLL 0x91 */
4829 /* Not sure where the following block comes from.
4830 Windows headers have NEC and Fujitsu specific keys in
4831 this block, but nothing generic. */
4832 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4833 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4834 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4835 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4836 "kp-end", /* VK_NUMPAD_END 0x96 */
4837 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4838 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4839 "kp-up", /* VK_NUMPAD_UP 0x99 */
4840 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4841 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4842 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4843 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4845 0, 0, /* 0x9E .. 0x9F */
4848 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4849 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4850 * No other API or message will distinguish left and right keys this way.
4855 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4856 to enable them selectively, and gives access to a few more functions.
4857 See lispy_multimedia_keys below. */
4858 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4859 0, 0, 0, /* 0xAD .. 0xAF Volume */
4860 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4861 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4863 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4864 0, 0, 0, 0, 0, 0, 0, 0, 0,
4866 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4867 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4868 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4871 "ax", /* VK_OEM_AX 0xE1 */
4872 0, /* VK_OEM_102 0xE2 */
4873 "ico-help", /* VK_ICO_HELP 0xE3 */
4874 "ico-00", /* VK_ICO_00 0xE4 */
4875 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4876 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4877 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4879 "reset", /* VK_OEM_RESET 0xE9 */
4880 "jump", /* VK_OEM_JUMP 0xEA */
4881 "oem-pa1", /* VK_OEM_PA1 0xEB */
4882 "oem-pa2", /* VK_OEM_PA2 0xEC */
4883 "oem-pa3", /* VK_OEM_PA3 0xED */
4884 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4885 "cusel", /* VK_OEM_CUSEL 0xEF */
4886 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4887 "finish", /* VK_OEM_FINISH 0xF1 */
4888 "copy", /* VK_OEM_COPY 0xF2 */
4889 "auto", /* VK_OEM_AUTO 0xF3 */
4890 "enlw", /* VK_OEM_ENLW 0xF4 */
4891 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4892 "attn", /* VK_ATTN 0xF6 */
4893 "crsel", /* VK_CRSEL 0xF7 */
4894 "exsel", /* VK_EXSEL 0xF8 */
4895 "ereof", /* VK_EREOF 0xF9 */
4896 "play", /* VK_PLAY 0xFA */
4897 "zoom", /* VK_ZOOM 0xFB */
4898 "noname", /* VK_NONAME 0xFC */
4899 "pa1", /* VK_PA1 0xFD */
4900 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4904 /* Some of these duplicate the "Media keys" on newer keyboards,
4905 but they are delivered to the application in a different way. */
4906 static const char *const lispy_multimedia_keys
[] =
4914 "browser-favorites",
4951 "toggle-dictate-command",
4957 "media-fast-forward",
4960 "media-channel-down"
4963 #else /* not HAVE_NTGUI */
4965 /* This should be dealt with in XTread_socket now, and that doesn't
4966 depend on the client system having the Kana syms defined. See also
4967 the XK_kana_A case below. */
4970 static const char *const lispy_kana_keys
[] =
4972 /* X Keysym value */
4973 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4974 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4975 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4976 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4977 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4978 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4979 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4980 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4981 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4982 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4983 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4984 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4985 "kana-i", "kana-u", "kana-e", "kana-o",
4986 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4987 "prolongedsound", "kana-A", "kana-I", "kana-U",
4988 "kana-E", "kana-O", "kana-KA", "kana-KI",
4989 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4990 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4991 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4992 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4993 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4994 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4995 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4996 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4997 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4998 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4999 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5000 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5002 #endif /* XK_kana_A */
5005 #define FUNCTION_KEY_OFFSET 0xff00
5007 /* You'll notice that this table is arranged to be conveniently
5008 indexed by X Windows keysym values. */
5009 static const char *const lispy_function_keys
[] =
5011 /* X Keysym value */
5013 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5014 "backspace", "tab", "linefeed", "clear",
5016 0, 0, 0, "pause", /* 0xff10...1f */
5017 0, 0, 0, 0, 0, 0, 0, "escape",
5019 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5020 "romaji", "hiragana", "katakana", "hiragana-katakana",
5021 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5022 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5023 "eisu-toggle", /* 0xff30...3f */
5024 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5025 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5027 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5028 "down", "prior", "next", "end",
5029 "begin", 0, 0, 0, 0, 0, 0, 0,
5030 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5041 "break", /* 0xff6b */
5044 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5045 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5046 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5047 0, 0, 0, 0, 0, 0, 0, 0,
5048 "kp-tab", /* 0xff89 */
5050 "kp-enter", /* 0xff8d */
5052 "kp-f1", /* 0xff91 */
5056 "kp-home", /* 0xff95 */
5061 "kp-prior", /* kp-page-up */
5062 "kp-next", /* kp-page-down */
5068 0, 0, 0, 0, 0, 0, 0, 0, 0,
5069 "kp-multiply", /* 0xffaa */
5074 "kp-divide", /* 0xffaf */
5075 "kp-0", /* 0xffb0 */
5076 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5079 "kp-equal", /* 0xffbd */
5080 "f1", /* 0xffbe */ /* IsFunctionKey */
5082 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5083 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5084 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5085 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5086 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5087 0, 0, 0, 0, 0, 0, 0, 0,
5088 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5089 0, 0, 0, 0, 0, 0, 0, "delete"
5092 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5093 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5095 static const char *const iso_lispy_function_keys
[] =
5097 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5098 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5099 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5100 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5101 "iso-lefttab", /* 0xfe20 */
5102 "iso-move-line-up", "iso-move-line-down",
5103 "iso-partial-line-up", "iso-partial-line-down",
5104 "iso-partial-space-left", "iso-partial-space-right",
5105 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5106 "iso-release-margin-left", "iso-release-margin-right",
5107 "iso-release-both-margins",
5108 "iso-fast-cursor-left", "iso-fast-cursor-right",
5109 "iso-fast-cursor-up", "iso-fast-cursor-down",
5110 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5111 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5114 #endif /* not HAVE_NTGUI */
5116 static Lisp_Object Vlispy_mouse_stem
;
5118 static const char *const lispy_wheel_names
[] =
5120 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5123 /* drag-n-drop events are generated when a set of selected files are
5124 dragged from another application and dropped onto an Emacs window. */
5125 static const char *const lispy_drag_n_drop_names
[] =
5130 /* Scroll bar parts. */
5131 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5132 Lisp_Object Qup
, Qdown
, Qbottom
;
5133 static Lisp_Object Qend_scroll
;
5135 static Lisp_Object Qratio
;
5137 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5138 static Lisp_Object
*const scroll_bar_parts
[] = {
5139 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5140 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5143 /* A vector, indexed by button number, giving the down-going location
5144 of currently depressed buttons, both scroll bar and non-scroll bar.
5146 The elements have the form
5147 (BUTTON-NUMBER MODIFIER-MASK . REST)
5148 where REST is the cdr of a position as it would be reported in the event.
5150 The make_lispy_event function stores positions here to tell the
5151 difference between click and drag events, and to store the starting
5152 location to be included in drag events. */
5154 static Lisp_Object button_down_location
;
5156 /* Information about the most recent up-going button event: Which
5157 button, what location, and what time. */
5159 static int last_mouse_button
;
5160 static int last_mouse_x
;
5161 static int last_mouse_y
;
5162 static Time button_down_time
;
5164 /* The number of clicks in this multiple-click. */
5166 static int double_click_count
;
5168 /* X and Y are frame-relative coordinates for a click or wheel event.
5169 Return a Lisp-style event list. */
5172 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5175 enum window_part part
;
5176 Lisp_Object posn
= Qnil
;
5177 Lisp_Object extra_info
= Qnil
;
5178 /* Coordinate pixel positions to return. */
5179 int xret
= 0, yret
= 0;
5180 /* The window under frame pixel coordinates (x,y) */
5181 Lisp_Object window
= f
5182 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5185 if (WINDOWP (window
))
5187 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5188 struct window
*w
= XWINDOW (window
);
5189 Lisp_Object string_info
= Qnil
;
5190 ptrdiff_t textpos
= -1;
5191 int col
= -1, row
= -1;
5192 int dx
= -1, dy
= -1;
5193 int width
= -1, height
= -1;
5194 Lisp_Object object
= Qnil
;
5196 /* Pixel coordinates relative to the window corner. */
5197 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5198 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5200 /* For text area clicks, return X, Y relative to the corner of
5201 this text area. Note that dX, dY etc are set below, by
5202 buffer_posn_from_coords. */
5203 if (part
== ON_TEXT
)
5205 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5206 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5208 /* For mode line and header line clicks, return X, Y relative to
5209 the left window edge. Use mode_line_string to look for a
5210 string on the click position. */
5211 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5216 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5217 /* Note that mode_line_string takes COL, ROW as pixels and
5218 converts them to characters. */
5221 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5222 &object
, &dx
, &dy
, &width
, &height
);
5223 if (STRINGP (string
))
5224 string_info
= Fcons (string
, make_number (charpos
));
5225 textpos
= (w
== XWINDOW (selected_window
)
5226 && current_buffer
== XBUFFER (w
->contents
))
5227 ? PT
: marker_position (w
->pointm
);
5232 /* For fringes and margins, Y is relative to the area's (and the
5233 window's) top edge, while X is meaningless. */
5234 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5239 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5242 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5243 &object
, &dx
, &dy
, &width
, &height
);
5244 if (STRINGP (string
))
5245 string_info
= Fcons (string
, make_number (charpos
));
5246 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5248 else if (part
== ON_LEFT_FRINGE
)
5250 posn
= Qleft_fringe
;
5253 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5254 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5255 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5257 else if (part
== ON_RIGHT_FRINGE
)
5259 posn
= Qright_fringe
;
5262 - window_box_width (w
, LEFT_MARGIN_AREA
)
5263 - window_box_width (w
, TEXT_AREA
)
5264 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5265 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5267 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5269 else if (part
== ON_VERTICAL_BORDER
)
5271 posn
= Qvertical_line
;
5276 /* Nothing special for part == ON_SCROLL_BAR. */
5278 /* For clicks in the text area, fringes, or margins, call
5279 buffer_posn_from_coords to extract TEXTPOS, the buffer
5280 position nearest to the click. */
5283 Lisp_Object string2
, object2
= Qnil
;
5284 struct display_pos p
;
5286 int width2
, height2
;
5287 /* The pixel X coordinate passed to buffer_posn_from_coords
5288 is the X coordinate relative to the text area for
5289 text-area and right-margin clicks, zero otherwise. */
5291 = (part
== ON_TEXT
) ? xret
5292 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5293 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5297 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5298 &object2
, &dx2
, &dy2
,
5300 textpos
= CHARPOS (p
.pos
);
5301 if (col
< 0) col
= x2
;
5302 if (row
< 0) row
= y2
;
5303 if (dx
< 0) dx
= dx2
;
5304 if (dy
< 0) dy
= dy2
;
5305 if (width
< 0) width
= width2
;
5306 if (height
< 0) height
= height2
;
5310 posn
= make_number (textpos
);
5311 if (STRINGP (string2
))
5312 string_info
= Fcons (string2
,
5313 make_number (CHARPOS (p
.string_pos
)));
5319 #ifdef HAVE_WINDOW_SYSTEM
5320 if (IMAGEP (object
))
5322 Lisp_Object image_map
, hotspot
;
5323 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5325 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5327 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5328 posn
= XCAR (hotspot
);
5335 Fcons (make_number (dx
), make_number (dy
)),
5336 Fcons (make_number (width
), make_number (height
)));
5339 extra_info
= Fcons (string_info
,
5340 Fcons (make_number (textpos
),
5341 Fcons (Fcons (make_number (col
),
5346 XSETFRAME (window
, f
);
5350 return Fcons (window
,
5352 Fcons (Fcons (make_number (xret
),
5353 make_number (yret
)),
5354 Fcons (make_number (t
),
5358 /* Given a struct input_event, build the lisp event which represents
5359 it. If EVENT is 0, build a mouse movement event from the mouse
5360 movement buffer, which should have a movement event in it.
5362 Note that events must be passed to this function in the order they
5363 are received; this function stores the location of button presses
5364 in order to build drag events when the button is released. */
5367 make_lispy_event (struct input_event
*event
)
5371 switch (event
->kind
)
5373 /* A simple keystroke. */
5374 case ASCII_KEYSTROKE_EVENT
:
5375 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5377 Lisp_Object lispy_c
;
5378 EMACS_INT c
= event
->code
;
5379 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5382 eassert (c
== event
->code
);
5383 /* Turn ASCII characters into control characters
5385 if (event
->modifiers
& ctrl_modifier
)
5387 c
= make_ctrl_char (c
);
5388 event
->modifiers
&= ~ctrl_modifier
;
5392 /* Add in the other modifier bits. The shift key was taken care
5393 of by the X code. */
5394 c
|= (event
->modifiers
5395 & (meta_modifier
| alt_modifier
5396 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5397 /* Distinguish Shift-SPC from SPC. */
5398 if ((event
->code
) == 040
5399 && event
->modifiers
& shift_modifier
)
5400 c
|= shift_modifier
;
5401 button_down_time
= 0;
5402 XSETFASTINT (lispy_c
, c
);
5407 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5408 except that they are non-key events (last-nonmenu-event is nil). */
5409 case NS_NONKEY_EVENT
:
5412 /* A function key. The symbol may need to have modifier prefixes
5414 case NON_ASCII_KEYSTROKE_EVENT
:
5415 button_down_time
= 0;
5417 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5418 if (event
->code
== lispy_accent_codes
[i
])
5419 return modify_event_symbol (i
,
5421 Qfunction_key
, Qnil
,
5422 lispy_accent_keys
, &accent_key_syms
,
5423 (sizeof (lispy_accent_keys
)
5424 / sizeof (lispy_accent_keys
[0])));
5428 if (event
->code
>= 0x400 && event
->code
< 0x500)
5429 return modify_event_symbol (event
->code
- 0x400,
5430 event
->modifiers
& ~shift_modifier
,
5431 Qfunction_key
, Qnil
,
5432 lispy_kana_keys
, &func_key_syms
,
5433 (sizeof (lispy_kana_keys
)
5434 / sizeof (lispy_kana_keys
[0])));
5435 #endif /* XK_kana_A */
5438 #ifdef ISO_FUNCTION_KEY_OFFSET
5439 if (event
->code
< FUNCTION_KEY_OFFSET
5440 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5441 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5443 Qfunction_key
, Qnil
,
5444 iso_lispy_function_keys
, &func_key_syms
,
5445 (sizeof (iso_lispy_function_keys
)
5446 / sizeof (iso_lispy_function_keys
[0])));
5449 /* Handle system-specific or unknown keysyms. */
5450 if (event
->code
& (1 << 28)
5451 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5452 || (event
->code
- FUNCTION_KEY_OFFSET
5453 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5454 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5456 /* We need to use an alist rather than a vector as the cache
5457 since we can't make a vector long enough. */
5458 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5459 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5460 return modify_event_symbol (event
->code
,
5463 KVAR (current_kboard
, Vsystem_key_alist
),
5464 0, &KVAR (current_kboard
, system_key_syms
),
5468 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5470 Qfunction_key
, Qnil
,
5471 lispy_function_keys
, &func_key_syms
,
5472 (sizeof (lispy_function_keys
)
5473 / sizeof (lispy_function_keys
[0])));
5476 case MULTIMEDIA_KEY_EVENT
:
5477 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5478 / sizeof (lispy_multimedia_keys
[0]))
5479 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5481 return modify_event_symbol (event
->code
, event
->modifiers
,
5482 Qfunction_key
, Qnil
,
5483 lispy_multimedia_keys
, &func_key_syms
,
5484 (sizeof (lispy_multimedia_keys
)
5485 / sizeof (lispy_multimedia_keys
[0])));
5490 /* A mouse click. Figure out where it is, decide whether it's
5491 a press, click or drag, and build the appropriate structure. */
5492 case MOUSE_CLICK_EVENT
:
5493 #ifndef USE_TOOLKIT_SCROLL_BARS
5494 case SCROLL_BAR_CLICK_EVENT
:
5497 int button
= event
->code
;
5499 Lisp_Object position
;
5500 Lisp_Object
*start_pos_ptr
;
5501 Lisp_Object start_pos
;
5505 /* Build the position as appropriate for this mouse click. */
5506 if (event
->kind
== MOUSE_CLICK_EVENT
)
5508 struct frame
*f
= XFRAME (event
->frame_or_window
);
5509 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5513 /* Ignore mouse events that were made on frame that
5514 have been deleted. */
5515 if (! FRAME_LIVE_P (f
))
5518 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5519 /* EVENT->x and EVENT->y are frame-relative pixel
5520 coordinates at this place. Under old redisplay, COLUMN
5521 and ROW are set to frame relative glyph coordinates
5522 which are then used to determine whether this click is
5523 in a menu (non-toolkit version). */
5524 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5525 &column
, &row
, NULL
, 1);
5527 /* In the non-toolkit version, clicks on the menu bar
5528 are ordinary button events in the event buffer.
5529 Distinguish them, and invoke the menu.
5531 (In the toolkit version, the toolkit handles the menu bar
5532 and Emacs doesn't know about it until after the user
5533 makes a selection.) */
5534 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5535 && (event
->modifiers
& down_modifier
))
5537 Lisp_Object items
, item
;
5539 /* Find the menu bar item under `column'. */
5541 items
= FRAME_MENU_BAR_ITEMS (f
);
5542 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5544 Lisp_Object pos
, string
;
5545 string
= AREF (items
, i
+ 1);
5546 pos
= AREF (items
, i
+ 3);
5549 if (column
>= XINT (pos
)
5550 && column
< XINT (pos
) + SCHARS (string
))
5552 item
= AREF (items
, i
);
5557 /* ELisp manual 2.4b says (x y) are window relative but
5558 code says they are frame-relative. */
5560 = Fcons (event
->frame_or_window
,
5562 Fcons (Fcons (event
->x
, event
->y
),
5563 Fcons (make_number (event
->timestamp
),
5566 return Fcons (item
, Fcons (position
, Qnil
));
5568 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5570 position
= make_lispy_position (f
, event
->x
, event
->y
,
5573 #ifndef USE_TOOLKIT_SCROLL_BARS
5576 /* It's a scrollbar click. */
5578 Lisp_Object portion_whole
;
5581 window
= event
->frame_or_window
;
5582 portion_whole
= Fcons (event
->x
, event
->y
);
5583 part
= *scroll_bar_parts
[(int) event
->part
];
5587 Fcons (Qvertical_scroll_bar
,
5588 Fcons (portion_whole
,
5589 Fcons (make_number (event
->timestamp
),
5590 Fcons (part
, Qnil
)))));
5592 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5594 if (button
>= ASIZE (button_down_location
))
5596 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5597 button_down_location
= larger_vector (button_down_location
,
5599 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5602 start_pos_ptr
= aref_addr (button_down_location
, button
);
5603 start_pos
= *start_pos_ptr
;
5604 *start_pos_ptr
= Qnil
;
5607 /* On window-system frames, use the value of
5608 double-click-fuzz as is. On other frames, interpret it
5609 as a multiple of 1/8 characters. */
5613 if (WINDOWP (event
->frame_or_window
))
5614 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5615 else if (FRAMEP (event
->frame_or_window
))
5616 f
= XFRAME (event
->frame_or_window
);
5620 if (FRAME_WINDOW_P (f
))
5621 fuzz
= double_click_fuzz
;
5623 fuzz
= double_click_fuzz
/ 8;
5625 is_double
= (button
== last_mouse_button
5626 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5627 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5628 && button_down_time
!= 0
5629 && (EQ (Vdouble_click_time
, Qt
)
5630 || (NATNUMP (Vdouble_click_time
)
5631 && (event
->timestamp
- button_down_time
5632 < XFASTINT (Vdouble_click_time
)))));
5635 last_mouse_button
= button
;
5636 last_mouse_x
= XINT (event
->x
);
5637 last_mouse_y
= XINT (event
->y
);
5639 /* If this is a button press, squirrel away the location, so
5640 we can decide later whether it was a click or a drag. */
5641 if (event
->modifiers
& down_modifier
)
5645 double_click_count
++;
5646 event
->modifiers
|= ((double_click_count
> 2)
5651 double_click_count
= 1;
5652 button_down_time
= event
->timestamp
;
5653 *start_pos_ptr
= Fcopy_alist (position
);
5654 ignore_mouse_drag_p
= 0;
5657 /* Now we're releasing a button - check the co-ordinates to
5658 see if this was a click or a drag. */
5659 else if (event
->modifiers
& up_modifier
)
5661 /* If we did not see a down before this up, ignore the up.
5662 Probably this happened because the down event chose a
5663 menu item. It would be an annoyance to treat the
5664 release of the button that chose the menu item as a
5667 if (!CONSP (start_pos
))
5670 event
->modifiers
&= ~up_modifier
;
5673 Lisp_Object new_down
, down
;
5674 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5676 /* The third element of every position
5677 should be the (x,y) pair. */
5678 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5679 new_down
= Fcar (Fcdr (Fcdr (position
)));
5682 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5684 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5685 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5688 if (ignore_mouse_drag_p
)
5690 event
->modifiers
|= click_modifier
;
5691 ignore_mouse_drag_p
= 0;
5693 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5694 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5695 /* Maybe the mouse has moved a lot, caused scrolling, and
5696 eventually ended up at the same screen position (but
5697 not buffer position) in which case it is a drag, not
5699 /* FIXME: OTOH if the buffer position has changed
5700 because of a timer or process filter rather than
5701 because of mouse movement, it should be considered as
5702 a click. But mouse-drag-region completely ignores
5703 this case and it hasn't caused any real problem, so
5704 it's probably OK to ignore it as well. */
5705 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5706 /* Mouse hasn't moved (much). */
5707 event
->modifiers
|= click_modifier
;
5710 button_down_time
= 0;
5711 event
->modifiers
|= drag_modifier
;
5714 /* Don't check is_double; treat this as multiple
5715 if the down-event was multiple. */
5716 if (double_click_count
> 1)
5717 event
->modifiers
|= ((double_click_count
> 2)
5723 /* Every mouse event should either have the down_modifier or
5724 the up_modifier set. */
5728 /* Get the symbol we should use for the mouse click. */
5731 head
= modify_event_symbol (button
,
5733 Qmouse_click
, Vlispy_mouse_stem
,
5736 ASIZE (mouse_syms
));
5737 if (event
->modifiers
& drag_modifier
)
5742 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5745 Fcons (make_number (double_click_count
),
5755 case HORIZ_WHEEL_EVENT
:
5757 Lisp_Object position
;
5760 /* Build the position as appropriate for this mouse click. */
5761 struct frame
*f
= XFRAME (event
->frame_or_window
);
5763 /* Ignore wheel events that were made on frame that have been
5765 if (! FRAME_LIVE_P (f
))
5768 position
= make_lispy_position (f
, event
->x
, event
->y
,
5771 /* Set double or triple modifiers to indicate the wheel speed. */
5773 /* On window-system frames, use the value of
5774 double-click-fuzz as is. On other frames, interpret it
5775 as a multiple of 1/8 characters. */
5781 if (WINDOWP (event
->frame_or_window
))
5782 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5783 else if (FRAMEP (event
->frame_or_window
))
5784 fr
= XFRAME (event
->frame_or_window
);
5788 fuzz
= FRAME_WINDOW_P (fr
)
5789 ? double_click_fuzz
: double_click_fuzz
/ 8;
5791 if (event
->modifiers
& up_modifier
)
5793 /* Emit a wheel-up event. */
5794 event
->modifiers
&= ~up_modifier
;
5797 else if (event
->modifiers
& down_modifier
)
5799 /* Emit a wheel-down event. */
5800 event
->modifiers
&= ~down_modifier
;
5804 /* Every wheel event should either have the down_modifier or
5805 the up_modifier set. */
5808 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5811 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5812 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5813 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5814 && button_down_time
!= 0
5815 && (EQ (Vdouble_click_time
, Qt
)
5816 || (NATNUMP (Vdouble_click_time
)
5817 && (event
->timestamp
- button_down_time
5818 < XFASTINT (Vdouble_click_time
)))));
5821 double_click_count
++;
5822 event
->modifiers
|= ((double_click_count
> 2)
5828 double_click_count
= 1;
5829 event
->modifiers
|= click_modifier
;
5832 button_down_time
= event
->timestamp
;
5833 /* Use a negative value to distinguish wheel from mouse button. */
5834 last_mouse_button
= - (1 + symbol_num
);
5835 last_mouse_x
= XINT (event
->x
);
5836 last_mouse_y
= XINT (event
->y
);
5838 /* Get the symbol we should use for the wheel event. */
5839 head
= modify_event_symbol (symbol_num
,
5845 ASIZE (wheel_syms
));
5848 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5851 Fcons (make_number (double_click_count
),
5860 #ifdef USE_TOOLKIT_SCROLL_BARS
5862 /* We don't have down and up events if using toolkit scroll bars,
5863 so make this always a click event. Store in the `part' of
5864 the Lisp event a symbol which maps to the following actions:
5866 `above_handle' page up
5867 `below_handle' page down
5871 `bottom' bottom of buffer
5872 `handle' thumb has been dragged.
5873 `end-scroll' end of interaction with scroll bar
5875 The incoming input_event contains in its `part' member an
5876 index of type `enum scroll_bar_part' which we can use as an
5877 index in scroll_bar_parts to get the appropriate symbol. */
5879 case SCROLL_BAR_CLICK_EVENT
:
5881 Lisp_Object position
, head
, window
, portion_whole
, part
;
5883 window
= event
->frame_or_window
;
5884 portion_whole
= Fcons (event
->x
, event
->y
);
5885 part
= *scroll_bar_parts
[(int) event
->part
];
5889 Fcons (Qvertical_scroll_bar
,
5890 Fcons (portion_whole
,
5891 Fcons (make_number (event
->timestamp
),
5892 Fcons (part
, Qnil
)))));
5894 /* Always treat scroll bar events as clicks. */
5895 event
->modifiers
|= click_modifier
;
5896 event
->modifiers
&= ~up_modifier
;
5898 if (event
->code
>= ASIZE (mouse_syms
))
5899 mouse_syms
= larger_vector (mouse_syms
,
5900 event
->code
- ASIZE (mouse_syms
) + 1,
5903 /* Get the symbol we should use for the mouse click. */
5904 head
= modify_event_symbol (event
->code
,
5909 ASIZE (mouse_syms
));
5910 return Fcons (head
, Fcons (position
, Qnil
));
5913 #endif /* USE_TOOLKIT_SCROLL_BARS */
5915 case DRAG_N_DROP_EVENT
:
5918 Lisp_Object head
, position
;
5921 f
= XFRAME (event
->frame_or_window
);
5924 /* Ignore mouse events that were made on frames that
5925 have been deleted. */
5926 if (! FRAME_LIVE_P (f
))
5929 position
= make_lispy_position (f
, event
->x
, event
->y
,
5932 head
= modify_event_symbol (0, event
->modifiers
,
5934 lispy_drag_n_drop_names
,
5935 &drag_n_drop_syms
, 1);
5942 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5943 || defined (HAVE_NS) || defined (USE_GTK)
5944 case MENU_BAR_EVENT
:
5945 if (EQ (event
->arg
, event
->frame_or_window
))
5946 /* This is the prefix key. We translate this to
5947 `(menu_bar)' because the code in keyboard.c for menu
5948 events, which we use, relies on this. */
5949 return Fcons (Qmenu_bar
, Qnil
);
5953 case SELECT_WINDOW_EVENT
:
5954 /* Make an event (select-window (WINDOW)). */
5955 return Fcons (Qselect_window
,
5956 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5959 case TOOL_BAR_EVENT
:
5960 if (EQ (event
->arg
, event
->frame_or_window
))
5961 /* This is the prefix key. We translate this to
5962 `(tool_bar)' because the code in keyboard.c for tool bar
5963 events, which we use, relies on this. */
5964 return Fcons (Qtool_bar
, Qnil
);
5965 else if (SYMBOLP (event
->arg
))
5966 return apply_modifiers (event
->modifiers
, event
->arg
);
5969 case USER_SIGNAL_EVENT
:
5970 /* A user signal. */
5972 char *name
= find_user_signal_name (event
->code
);
5975 return intern (name
);
5978 case SAVE_SESSION_EVENT
:
5979 return Qsave_session
;
5984 return Fcons (Qdbus_event
, event
->arg
);
5986 #endif /* HAVE_DBUS */
5988 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5989 case FILE_NOTIFY_EVENT
:
5991 return Fcons (Qfile_notify
, event
->arg
);
5993 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5995 case CONFIG_CHANGED_EVENT
:
5996 return Fcons (Qconfig_changed_event
,
5998 Fcons (event
->frame_or_window
, Qnil
)));
6000 case GPM_CLICK_EVENT
:
6002 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6003 Lisp_Object head
, position
;
6004 Lisp_Object
*start_pos_ptr
;
6005 Lisp_Object start_pos
;
6006 int button
= event
->code
;
6008 if (button
>= ASIZE (button_down_location
))
6010 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
6011 button_down_location
= larger_vector (button_down_location
,
6013 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
6016 start_pos_ptr
= aref_addr (button_down_location
, button
);
6017 start_pos
= *start_pos_ptr
;
6019 position
= make_lispy_position (f
, event
->x
, event
->y
,
6022 if (event
->modifiers
& down_modifier
)
6023 *start_pos_ptr
= Fcopy_alist (position
);
6024 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6026 if (!CONSP (start_pos
))
6028 event
->modifiers
&= ~up_modifier
;
6031 head
= modify_event_symbol (button
,
6033 Qmouse_click
, Vlispy_mouse_stem
,
6036 ASIZE (mouse_syms
));
6038 if (event
->modifiers
& drag_modifier
)
6043 else if (event
->modifiers
& double_modifier
)
6046 Fcons (make_number (2),
6048 else if (event
->modifiers
& triple_modifier
)
6051 Fcons (make_number (3),
6058 #endif /* HAVE_GPM */
6060 /* The 'kind' field of the event is something we don't recognize. */
6067 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6068 Lisp_Object x
, Lisp_Object y
, Time t
)
6070 /* Is it a scroll bar movement? */
6071 if (frame
&& ! NILP (bar_window
))
6073 Lisp_Object part_sym
;
6075 part_sym
= *scroll_bar_parts
[(int) part
];
6076 return Fcons (Qscroll_bar_movement
,
6077 Fcons (list5 (bar_window
,
6078 Qvertical_scroll_bar
,
6084 /* Or is it an ordinary mouse movement? */
6087 Lisp_Object position
;
6088 position
= make_lispy_position (frame
, x
, y
, t
);
6089 return list2 (Qmouse_movement
, position
);
6093 /* Construct a switch frame event. */
6095 make_lispy_switch_frame (Lisp_Object frame
)
6097 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6100 /* Manipulating modifiers. */
6102 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6104 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6105 SYMBOL's name of the end of the modifiers; the string from this
6106 position is the unmodified symbol name.
6108 This doesn't use any caches. */
6111 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6117 CHECK_SYMBOL (symbol
);
6120 name
= SYMBOL_NAME (symbol
);
6122 for (i
= 0; i
< SBYTES (name
) - 1; )
6124 ptrdiff_t this_mod_end
= 0;
6127 /* See if the name continues with a modifier word.
6128 Check that the word appears, but don't check what follows it.
6129 Set this_mod and this_mod_end to record what we find. */
6131 switch (SREF (name
, i
))
6133 #define SINGLE_LETTER_MOD(BIT) \
6134 (this_mod_end = i + 1, this_mod = BIT)
6137 SINGLE_LETTER_MOD (alt_modifier
);
6141 SINGLE_LETTER_MOD (ctrl_modifier
);
6145 SINGLE_LETTER_MOD (hyper_modifier
);
6149 SINGLE_LETTER_MOD (meta_modifier
);
6153 SINGLE_LETTER_MOD (shift_modifier
);
6157 SINGLE_LETTER_MOD (super_modifier
);
6160 #undef SINGLE_LETTER_MOD
6162 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6163 if (i + LEN + 1 <= SBYTES (name) \
6164 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6166 this_mod_end = i + LEN; \
6171 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6172 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6173 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6177 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6179 #undef MULTI_LETTER_MOD
6183 /* If we found no modifier, stop looking for them. */
6184 if (this_mod_end
== 0)
6187 /* Check there is a dash after the modifier, so that it
6188 really is a modifier. */
6189 if (this_mod_end
>= SBYTES (name
)
6190 || SREF (name
, this_mod_end
) != '-')
6193 /* This modifier is real; look for another. */
6194 modifiers
|= this_mod
;
6195 i
= this_mod_end
+ 1;
6198 /* Should we include the `click' modifier? */
6199 if (! (modifiers
& (down_modifier
| drag_modifier
6200 | double_modifier
| triple_modifier
))
6201 && i
+ 7 == SBYTES (name
)
6202 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6203 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6204 modifiers
|= click_modifier
;
6206 if (! (modifiers
& (double_modifier
| triple_modifier
))
6207 && i
+ 6 < SBYTES (name
)
6208 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6209 modifiers
|= click_modifier
;
6217 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6218 prepended to the string BASE[0..BASE_LEN-1].
6219 This doesn't use any caches. */
6221 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6223 /* Since BASE could contain nulls, we can't use intern here; we have
6224 to use Fintern, which expects a genuine Lisp_String, and keeps a
6226 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6232 /* Only the event queue may use the `up' modifier; it should always
6233 be turned into a click or drag event before presented to lisp code. */
6234 if (modifiers
& up_modifier
)
6237 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6238 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6239 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6240 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6241 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6242 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6243 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6244 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6245 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6246 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6247 /* The click modifier is denoted by the absence of other modifiers. */
6251 mod_len
= p
- new_mods
;
6255 Lisp_Object new_name
;
6257 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6258 mod_len
+ base_len_byte
);
6259 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6260 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6262 return Fintern (new_name
, Qnil
);
6267 static const char *const modifier_names
[] =
6269 "up", "down", "drag", "click", "double", "triple", 0, 0,
6270 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6271 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6273 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6275 static Lisp_Object modifier_symbols
;
6277 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6279 lispy_modifier_list (int modifiers
)
6281 Lisp_Object modifier_list
;
6284 modifier_list
= Qnil
;
6285 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6286 if (modifiers
& (1<<i
))
6287 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6290 return modifier_list
;
6294 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6295 where UNMODIFIED is the unmodified form of SYMBOL,
6296 MASK is the set of modifiers present in SYMBOL's name.
6297 This is similar to parse_modifiers_uncached, but uses the cache in
6298 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6299 Qevent_symbol_elements property. */
6301 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6304 parse_modifiers (Lisp_Object symbol
)
6306 Lisp_Object elements
;
6308 if (INTEGERP (symbol
))
6309 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6310 else if (!SYMBOLP (symbol
))
6313 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6314 if (CONSP (elements
))
6319 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6320 Lisp_Object unmodified
;
6323 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6324 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6327 if (modifiers
& ~INTMASK
)
6329 XSETFASTINT (mask
, modifiers
);
6330 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6332 /* Cache the parsing results on SYMBOL. */
6333 Fput (symbol
, Qevent_symbol_element_mask
,
6335 Fput (symbol
, Qevent_symbol_elements
,
6336 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6338 /* Since we know that SYMBOL is modifiers applied to unmodified,
6339 it would be nice to put that in unmodified's cache.
6340 But we can't, since we're not sure that parse_modifiers is
6347 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6348 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6349 doc
: /* Parse the event symbol. For internal use. */)
6350 (Lisp_Object symbol
)
6352 /* Fill the cache if needed. */
6353 parse_modifiers (symbol
);
6354 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6355 and use the Lispier representation stored on Qevent_symbol_elements
6357 return Fget (symbol
, Qevent_symbol_elements
);
6360 /* Apply the modifiers MODIFIERS to the symbol BASE.
6361 BASE must be unmodified.
6363 This is like apply_modifiers_uncached, but uses BASE's
6364 Qmodifier_cache property, if present. It also builds
6365 Qevent_symbol_elements properties, since it has that info anyway.
6367 apply_modifiers copies the value of BASE's Qevent_kind property to
6368 the modified symbol. */
6370 apply_modifiers (int modifiers
, Lisp_Object base
)
6372 Lisp_Object cache
, idx
, entry
, new_symbol
;
6374 /* Mask out upper bits. We don't know where this value's been. */
6375 modifiers
&= INTMASK
;
6377 if (INTEGERP (base
))
6378 return make_number (XINT (base
) | modifiers
);
6380 /* The click modifier never figures into cache indices. */
6381 cache
= Fget (base
, Qmodifier_cache
);
6382 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6383 entry
= assq_no_quit (idx
, cache
);
6386 new_symbol
= XCDR (entry
);
6389 /* We have to create the symbol ourselves. */
6390 new_symbol
= apply_modifiers_uncached (modifiers
,
6391 SSDATA (SYMBOL_NAME (base
)),
6392 SCHARS (SYMBOL_NAME (base
)),
6393 SBYTES (SYMBOL_NAME (base
)));
6395 /* Add the new symbol to the base's cache. */
6396 entry
= Fcons (idx
, new_symbol
);
6397 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6399 /* We have the parsing info now for free, so we could add it to
6401 XSETFASTINT (idx, modifiers);
6402 Fput (new_symbol, Qevent_symbol_element_mask,
6403 Fcons (base, Fcons (idx, Qnil)));
6404 Fput (new_symbol, Qevent_symbol_elements,
6405 Fcons (base, lispy_modifier_list (modifiers)));
6406 Sadly, this is only correct if `base' is indeed a base event,
6407 which is not necessarily the case. -stef */
6410 /* Make sure this symbol is of the same kind as BASE.
6412 You'd think we could just set this once and for all when we
6413 intern the symbol above, but reorder_modifiers may call us when
6414 BASE's property isn't set right; we can't assume that just
6415 because it has a Qmodifier_cache property it must have its
6416 Qevent_kind set right as well. */
6417 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6421 kind
= Fget (base
, Qevent_kind
);
6423 Fput (new_symbol
, Qevent_kind
, kind
);
6430 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6431 return a symbol with the modifiers placed in the canonical order.
6432 Canonical order is alphabetical, except for down and drag, which
6433 always come last. The 'click' modifier is never written out.
6435 Fdefine_key calls this to make sure that (for example) C-M-foo
6436 and M-C-foo end up being equivalent in the keymap. */
6439 reorder_modifiers (Lisp_Object symbol
)
6441 /* It's hopefully okay to write the code this way, since everything
6442 will soon be in caches, and no consing will be done at all. */
6445 parsed
= parse_modifiers (symbol
);
6446 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6451 /* For handling events, we often want to produce a symbol whose name
6452 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6453 to some base, like the name of a function key or mouse button.
6454 modify_event_symbol produces symbols of this sort.
6456 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6457 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6460 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6461 into symbol names, or a string specifying a name stem used to
6462 construct a symbol name or the form `STEM-N', where N is the decimal
6463 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6464 non-nil; otherwise NAME_TABLE is used.
6466 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6467 persist between calls to modify_event_symbol that it can use to
6468 store a cache of the symbols it's generated for this NAME_TABLE
6469 before. The object stored there may be a vector or an alist.
6471 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6473 MODIFIERS is a set of modifier bits (as given in struct input_events)
6474 whose prefixes should be applied to the symbol name.
6476 SYMBOL_KIND is the value to be placed in the event_kind property of
6477 the returned symbol.
6479 The symbols we create are supposed to have an
6480 `event-symbol-elements' property, which lists the modifiers present
6481 in the symbol's name. */
6484 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6485 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6486 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6489 Lisp_Object symbol_int
;
6491 /* Get rid of the "vendor-specific" bit here. */
6492 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6494 /* Is this a request for a valid symbol? */
6495 if (symbol_num
< 0 || symbol_num
>= table_size
)
6498 if (CONSP (*symbol_table
))
6499 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6501 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6502 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6503 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6504 we've never used that symbol before. */
6507 if (! VECTORP (*symbol_table
)
6508 || ASIZE (*symbol_table
) != table_size
)
6512 XSETFASTINT (size
, table_size
);
6513 *symbol_table
= Fmake_vector (size
, Qnil
);
6516 value
= AREF (*symbol_table
, symbol_num
);
6519 /* Have we already used this symbol before? */
6522 /* No; let's create it. */
6523 if (CONSP (name_alist_or_stem
))
6524 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6525 else if (STRINGP (name_alist_or_stem
))
6528 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6529 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6531 buf
= SAFE_ALLOCA (len
);
6532 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6533 XINT (symbol_int
) + 1);
6534 value
= intern (buf
);
6537 else if (name_table
!= 0 && name_table
[symbol_num
])
6538 value
= intern (name_table
[symbol_num
]);
6540 #ifdef HAVE_WINDOW_SYSTEM
6543 char *name
= x_get_keysym_name (symbol_num
);
6545 value
= intern (name
);
6551 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6552 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6553 value
= intern (buf
);
6556 if (CONSP (*symbol_table
))
6557 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6559 ASET (*symbol_table
, symbol_num
, value
);
6561 /* Fill in the cache entries for this symbol; this also
6562 builds the Qevent_symbol_elements property, which the user
6564 apply_modifiers (modifiers
& click_modifier
, value
);
6565 Fput (value
, Qevent_kind
, symbol_kind
);
6568 /* Apply modifiers to that symbol. */
6569 return apply_modifiers (modifiers
, value
);
6572 /* Convert a list that represents an event type,
6573 such as (ctrl meta backspace), into the usual representation of that
6574 event type as a number or a symbol. */
6576 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6577 doc
: /* Convert the event description list EVENT-DESC to an event type.
6578 EVENT-DESC should contain one base event type (a character or symbol)
6579 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6580 drag, down, double or triple). The base must be last.
6581 The return value is an event type (a character or symbol) which
6582 has the same base event type and all the specified modifiers. */)
6583 (Lisp_Object event_desc
)
6591 while (CONSP (rest
))
6599 /* Given a symbol, see if it is a modifier name. */
6600 if (SYMBOLP (elt
) && CONSP (rest
))
6601 this = parse_solitary_modifier (elt
);
6605 else if (!NILP (base
))
6606 error ("Two bases given in one event");
6612 /* Let the symbol A refer to the character A. */
6613 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6614 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6616 if (INTEGERP (base
))
6618 /* Turn (shift a) into A. */
6619 if ((modifiers
& shift_modifier
) != 0
6620 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6622 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6623 modifiers
&= ~shift_modifier
;
6626 /* Turn (control a) into C-a. */
6627 if (modifiers
& ctrl_modifier
)
6628 return make_number ((modifiers
& ~ctrl_modifier
)
6629 | make_ctrl_char (XINT (base
)));
6631 return make_number (modifiers
| XINT (base
));
6633 else if (SYMBOLP (base
))
6634 return apply_modifiers (modifiers
, base
);
6636 error ("Invalid base event");
6639 /* Try to recognize SYMBOL as a modifier name.
6640 Return the modifier flag bit, or 0 if not recognized. */
6643 parse_solitary_modifier (Lisp_Object symbol
)
6645 Lisp_Object name
= SYMBOL_NAME (symbol
);
6647 switch (SREF (name
, 0))
6649 #define SINGLE_LETTER_MOD(BIT) \
6650 if (SBYTES (name) == 1) \
6653 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6654 if (LEN == SBYTES (name) \
6655 && ! memcmp (SDATA (name), NAME, LEN)) \
6659 SINGLE_LETTER_MOD (alt_modifier
);
6663 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6667 SINGLE_LETTER_MOD (ctrl_modifier
);
6671 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6672 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6676 SINGLE_LETTER_MOD (hyper_modifier
);
6680 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6684 SINGLE_LETTER_MOD (meta_modifier
);
6688 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6692 SINGLE_LETTER_MOD (shift_modifier
);
6696 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6697 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6698 SINGLE_LETTER_MOD (super_modifier
);
6702 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6703 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6704 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6708 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6711 #undef SINGLE_LETTER_MOD
6712 #undef MULTI_LETTER_MOD
6718 /* Return true if EVENT is a list whose elements are all integers or symbols.
6719 Such a list is not valid as an event,
6720 but it can be a Lucid-style event type list. */
6723 lucid_event_type_list_p (Lisp_Object object
)
6727 if (! CONSP (object
))
6730 if (EQ (XCAR (object
), Qhelp_echo
)
6731 || EQ (XCAR (object
), Qvertical_line
)
6732 || EQ (XCAR (object
), Qmode_line
)
6733 || EQ (XCAR (object
), Qheader_line
))
6736 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6740 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6747 /* Return true if terminal input chars are available.
6748 Also, store the return value into INPUT_PENDING.
6750 Serves the purpose of ioctl (0, FIONREAD, ...)
6751 but works even if FIONREAD does not exist.
6752 (In fact, this may actually read some input.)
6754 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6755 timer events that are ripe.
6756 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6757 events (FOCUS_IN_EVENT).
6758 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6759 movements and toolkit scroll bar thumb drags. */
6762 get_input_pending (int flags
)
6764 /* First of all, have we already counted some input? */
6765 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6767 /* If input is being read as it arrives, and we have none, there is none. */
6768 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6770 /* Try to read some input and see how much we get. */
6772 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6775 return input_pending
;
6778 /* Put a BUFFER_SWITCH_EVENT in the buffer
6779 so that read_key_sequence will notice the new current buffer. */
6782 record_asynch_buffer_change (void)
6784 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6785 The purpose of the event is to make read_key_sequence look up the
6786 keymaps again. If we aren't in read_key_sequence, we don't need one,
6787 and the event could cause trouble by messing up (input-pending-p).
6788 Note: Fwaiting_for_user_input_p always returns nil when async
6789 subprocesses aren't supported. */
6790 if (!NILP (Fwaiting_for_user_input_p ()))
6792 struct input_event event
;
6795 event
.kind
= BUFFER_SWITCH_EVENT
;
6796 event
.frame_or_window
= Qnil
;
6799 /* Make sure no interrupt happens while storing the event. */
6801 if (interrupt_input
)
6802 kbd_buffer_store_event (&event
);
6807 kbd_buffer_store_event (&event
);
6813 /* Read any terminal input already buffered up by the system
6814 into the kbd_buffer, but do not wait.
6816 Return the number of keyboard chars read, or -1 meaning
6817 this is a bad time to try to read input. */
6826 /* Store pending user signal events, if any. */
6827 store_user_signal_events ();
6829 /* Loop through the available terminals, and call their input hooks. */
6833 struct terminal
*next
= t
->next_terminal
;
6835 if (t
->read_socket_hook
)
6838 struct input_event hold_quit
;
6840 if (input_blocked_p ())
6842 pending_signals
= 1;
6846 EVENT_INIT (hold_quit
);
6847 hold_quit
.kind
= NO_EVENT
;
6849 /* No need for FIONREAD or fcntl; just say don't wait. */
6850 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6853 if (nr
== -1) /* Not OK to read input now. */
6857 else if (nr
== -2) /* Non-transient error. */
6859 /* The terminal device terminated; it should be closed. */
6861 /* Kill Emacs if this was our last terminal. */
6862 if (!terminal_list
->next_terminal
)
6863 /* Formerly simply reported no input, but that
6864 sometimes led to a failure of Emacs to terminate.
6865 SIGHUP seems appropriate if we can't reach the
6867 /* ??? Is it really right to send the signal just to
6868 this process rather than to the whole process
6869 group? Perhaps on systems with FIONREAD Emacs is
6870 alone in its group. */
6871 terminate_due_to_signal (SIGHUP
, 10);
6873 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6876 XSETTERMINAL (tmp
, t
);
6877 Fdelete_terminal (tmp
, Qnoelisp
);
6881 if (hold_quit
.kind
!= NO_EVENT
)
6882 kbd_buffer_store_event (&hold_quit
);
6891 frame_make_pointer_visible ();
6896 /* This is the tty way of reading available input.
6898 Note that each terminal device has its own `struct terminal' object,
6899 and so this function is called once for each individual termcap
6900 terminal. The first parameter indicates which terminal to read from. */
6903 tty_read_avail_input (struct terminal
*terminal
,
6904 struct input_event
*hold_quit
)
6906 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6907 the kbd_buffer can really hold. That may prevent loss
6908 of characters on some systems when input is stuffed at us. */
6909 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6911 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6914 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6916 if (kbd_on_hold_p () || buffer_free
<= 0)
6918 #endif /* subprocesses */
6920 if (!terminal
->name
) /* Don't read from a dead terminal. */
6923 if (terminal
->type
!= output_termcap
6924 && terminal
->type
!= output_msdos_raw
)
6927 /* XXX I think the following code should be moved to separate hook
6928 functions in system-dependent files. */
6930 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6931 code sets read_socket_hook to w32_console_read_socket instead! */
6933 #else /* not WINDOWSNT */
6934 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6938 return 0; /* The terminal is suspended. */
6941 n_to_read
= dos_keysns ();
6945 cbuf
[0] = dos_keyread ();
6948 #else /* not MSDOS */
6953 struct input_event gpm_hold_quit
;
6954 int gpm
, fd
= gpm_fd
;
6956 EVENT_INIT (gpm_hold_quit
);
6957 gpm_hold_quit
.kind
= NO_EVENT
;
6959 /* gpm==1 if event received.
6960 gpm==0 if the GPM daemon has closed the connection, in which case
6961 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6962 we save it in `fd' so close_gpm can remove it from the
6964 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6965 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6966 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6969 /* Presumably the GPM daemon has closed the connection. */
6971 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6972 kbd_buffer_store_event (&gpm_hold_quit
);
6976 #endif /* HAVE_GPM */
6978 /* Determine how many characters we should *try* to read. */
6979 #ifdef USABLE_FIONREAD
6980 /* Find out how much input is available. */
6981 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6983 if (! noninteractive
)
6984 return -2; /* Close this terminal. */
6990 if (n_to_read
> sizeof cbuf
)
6991 n_to_read
= sizeof cbuf
;
6992 #elif defined USG || defined CYGWIN
6993 /* Read some input if available, but don't wait. */
6994 n_to_read
= sizeof cbuf
;
6995 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6997 # error "Cannot read without possibly delaying"
7001 /* Don't read more than we can store. */
7002 if (n_to_read
> buffer_free
)
7003 n_to_read
= buffer_free
;
7004 #endif /* subprocesses */
7006 /* Now read; for one reason or another, this will not block.
7007 NREAD is set to the number of chars read. */
7010 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7011 /* POSIX infers that processes which are not in the session leader's
7012 process group won't get SIGHUP's at logout time. BSDI adheres to
7013 this part standard and returns -1 from read (0) with errno==EIO
7014 when the control tty is taken away.
7015 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7016 if (nread
== -1 && errno
== EIO
)
7017 return -2; /* Close this terminal. */
7018 #if defined (AIX) && defined (_BSD)
7019 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7020 This looks incorrect, but it isn't, because _BSD causes
7021 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7022 and that causes a value other than 0 when there is no input. */
7024 return -2; /* Close this terminal. */
7028 /* We used to retry the read if it was interrupted.
7029 But this does the wrong thing when O_NONBLOCK causes
7030 an EAGAIN error. Does anybody know of a situation
7031 where a retry is actually needed? */
7033 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7043 #ifndef USABLE_FIONREAD
7044 #if defined (USG) || defined (CYGWIN)
7045 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7046 #endif /* USG or CYGWIN */
7047 #endif /* no FIONREAD */
7052 #endif /* not MSDOS */
7053 #endif /* not WINDOWSNT */
7055 for (i
= 0; i
< nread
; i
++)
7057 struct input_event buf
;
7059 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7061 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7062 buf
.modifiers
= meta_modifier
;
7063 if (tty
->meta_key
!= 2)
7067 /* Set the frame corresponding to the active tty. Note that the
7068 value of selected_frame is not reliable here, redisplay tends
7069 to temporarily change it. */
7070 buf
.frame_or_window
= tty
->top_frame
;
7073 kbd_buffer_store_event (&buf
);
7074 /* Don't look at input that follows a C-g too closely.
7075 This reduces lossage due to autorepeat on C-g. */
7076 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7077 && buf
.code
== quit_char
)
7085 handle_async_input (void)
7090 int nread
= gobble_input ();
7091 /* -1 means it's not ok to read the input now.
7092 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7093 0 means there was no keyboard input available. */
7101 process_pending_signals (void)
7103 pending_signals
= 0;
7104 handle_async_input ();
7105 do_pending_atimers ();
7108 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7109 and also (if the level is now 0) reinvoke any pending signal. */
7112 unblock_input_to (int level
)
7114 interrupt_input_blocked
= level
;
7117 if (pending_signals
)
7118 process_pending_signals ();
7124 /* End critical section.
7126 If doing signal-driven input, and a signal came in when input was
7127 blocked, reinvoke the signal handler now to deal with it. */
7130 unblock_input (void)
7132 unblock_input_to (interrupt_input_blocked
- 1);
7135 /* Undo any number of BLOCK_INPUT calls,
7136 and also reinvoke any pending signal. */
7139 totally_unblock_input (void)
7141 unblock_input_to (0);
7147 handle_input_available_signal (int sig
)
7149 pending_signals
= 1;
7151 if (input_available_clear_time
)
7152 *input_available_clear_time
= make_emacs_time (0, 0);
7156 deliver_input_available_signal (int sig
)
7158 deliver_process_signal (sig
, handle_input_available_signal
);
7160 #endif /* USABLE_SIGIO */
7163 /* User signal events. */
7165 struct user_signal_info
7167 /* Signal number. */
7170 /* Name of the signal. */
7173 /* Number of pending signals. */
7176 struct user_signal_info
*next
;
7179 /* List of user signals. */
7180 static struct user_signal_info
*user_signals
= NULL
;
7183 add_user_signal (int sig
, const char *name
)
7185 struct sigaction action
;
7186 struct user_signal_info
*p
;
7188 for (p
= user_signals
; p
; p
= p
->next
)
7190 /* Already added. */
7193 p
= xmalloc (sizeof *p
);
7195 p
->name
= xstrdup (name
);
7197 p
->next
= user_signals
;
7200 emacs_sigaction_init (&action
, deliver_user_signal
);
7201 sigaction (sig
, &action
, 0);
7205 handle_user_signal (int sig
)
7207 struct user_signal_info
*p
;
7208 const char *special_event_name
= NULL
;
7210 if (SYMBOLP (Vdebug_on_event
))
7211 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7213 for (p
= user_signals
; p
; p
= p
->next
)
7216 if (special_event_name
7217 && strcmp (special_event_name
, p
->name
) == 0)
7219 /* Enter the debugger in many ways. */
7220 debug_on_next_call
= 1;
7223 Vinhibit_quit
= Qnil
;
7225 /* Eat the event. */
7231 if (interrupt_input
)
7232 handle_input_available_signal (sig
);
7236 /* Tell wait_reading_process_output that it needs to wake
7237 up and look around. */
7238 if (input_available_clear_time
)
7239 *input_available_clear_time
= make_emacs_time (0, 0);
7246 deliver_user_signal (int sig
)
7248 deliver_process_signal (sig
, handle_user_signal
);
7252 find_user_signal_name (int sig
)
7254 struct user_signal_info
*p
;
7256 for (p
= user_signals
; p
; p
= p
->next
)
7264 store_user_signal_events (void)
7266 struct user_signal_info
*p
;
7267 struct input_event buf
;
7268 bool buf_initialized
= 0;
7270 for (p
= user_signals
; p
; p
= p
->next
)
7271 if (p
->npending
> 0)
7273 if (! buf_initialized
)
7275 memset (&buf
, 0, sizeof buf
);
7276 buf
.kind
= USER_SIGNAL_EVENT
;
7277 buf
.frame_or_window
= selected_frame
;
7278 buf_initialized
= 1;
7284 kbd_buffer_store_event (&buf
);
7287 while (p
->npending
> 0);
7292 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7293 static Lisp_Object menu_bar_one_keymap_changed_items
;
7295 /* These variables hold the vector under construction within
7296 menu_bar_items and its subroutines, and the current index
7297 for storing into that vector. */
7298 static Lisp_Object menu_bar_items_vector
;
7299 static int menu_bar_items_index
;
7302 static const char* separator_names
[] = {
7307 "single-dashed-line",
7308 "double-dashed-line",
7310 "shadow-etched-out",
7311 "shadow-etched-in-dash",
7312 "shadow-etched-out-dash",
7313 "shadow-double-etched-in",
7314 "shadow-double-etched-out",
7315 "shadow-double-etched-in-dash",
7316 "shadow-double-etched-out-dash",
7320 /* Return true if LABEL specifies a separator. */
7323 menu_separator_name_p (const char *label
)
7327 else if (strlen (label
) > 3
7328 && memcmp (label
, "--", 2) == 0
7333 for (i
= 0; separator_names
[i
]; ++i
)
7334 if (strcmp (label
, separator_names
[i
]) == 0)
7339 /* It's a separator if it contains only dashes. */
7340 while (*label
== '-')
7342 return (*label
== 0);
7349 /* Return a vector of menu items for a menu bar, appropriate
7350 to the current buffer. Each item has three elements in the vector:
7353 OLD is an old vector we can optionally reuse, or nil. */
7356 menu_bar_items (Lisp_Object old
)
7358 /* The number of keymaps we're scanning right now, and the number of
7359 keymaps we have allocated space for. */
7362 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7363 in the current keymaps, or nil where it is not a prefix. */
7366 Lisp_Object def
, tail
;
7371 /* In order to build the menus, we need to call the keymap
7372 accessors. They all call QUIT. But this function is called
7373 during redisplay, during which a quit is fatal. So inhibit
7374 quitting while building the menus.
7375 We do this instead of specbind because (1) errors will clear it anyway
7376 and (2) this avoids risk of specpdl overflow. */
7377 oquit
= Vinhibit_quit
;
7381 menu_bar_items_vector
= old
;
7383 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7384 menu_bar_items_index
= 0;
7386 /* Build our list of keymaps.
7387 If we recognize a function key and replace its escape sequence in
7388 keybuf with its symbol, or if the sequence starts with a mouse
7389 click and we need to switch buffers, we jump back here to rebuild
7390 the initial keymaps from the current buffer. */
7394 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7395 if (!NILP (Voverriding_local_map_menu_flag
)
7396 && !NILP (Voverriding_local_map
))
7398 /* Yes, use them (if non-nil) as well as the global map. */
7399 maps
= alloca (3 * sizeof (maps
[0]));
7401 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7402 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7403 if (!NILP (Voverriding_local_map
))
7404 maps
[nmaps
++] = Voverriding_local_map
;
7408 /* No, so use major and minor mode keymaps and keymap property.
7409 Note that menu-bar bindings in the local-map and keymap
7410 properties may not work reliable, as they are only
7411 recognized when the menu-bar (or mode-line) is updated,
7412 which does not normally happen after every command. */
7415 nminor
= current_minor_maps (NULL
, &tmaps
);
7416 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7418 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7419 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7420 maps
[nmaps
++] = tem
;
7421 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7422 maps
[nmaps
++] = tem
;
7423 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7425 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7427 maps
[nmaps
++] = current_global_map
;
7430 /* Look up in each map the dummy prefix key `menu-bar'. */
7432 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7433 if (!NILP (maps
[mapno
]))
7435 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7439 menu_bar_one_keymap_changed_items
= Qnil
;
7440 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7444 /* Move to the end those items that should be at the end. */
7446 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7449 int end
= menu_bar_items_index
;
7451 for (i
= 0; i
< end
; i
+= 4)
7452 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7454 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7455 /* Move the item at index I to the end,
7456 shifting all the others forward. */
7457 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7458 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7459 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7460 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7462 memmove (aref_addr (menu_bar_items_vector
, i
),
7463 aref_addr (menu_bar_items_vector
, i
+ 4),
7464 (end
- i
- 4) * word_size
);
7465 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7466 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7467 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7468 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7473 /* Add nil, nil, nil, nil at the end. */
7475 int i
= menu_bar_items_index
;
7476 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7477 menu_bar_items_vector
=
7478 larger_vector (menu_bar_items_vector
, 4, -1);
7479 /* Add this item. */
7480 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7481 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7482 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7483 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7484 menu_bar_items_index
= i
;
7487 Vinhibit_quit
= oquit
;
7488 return menu_bar_items_vector
;
7491 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7492 If there's already an item for KEY, add this DEF to it. */
7494 Lisp_Object item_properties
;
7497 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7499 struct gcpro gcpro1
;
7504 if (EQ (item
, Qundefined
))
7506 /* If a map has an explicit `undefined' as definition,
7507 discard any previously made menu bar item. */
7509 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7510 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7512 if (menu_bar_items_index
> i
+ 4)
7513 memmove (aref_addr (menu_bar_items_vector
, i
),
7514 aref_addr (menu_bar_items_vector
, i
+ 4),
7515 (menu_bar_items_index
- i
- 4) * word_size
);
7516 menu_bar_items_index
-= 4;
7520 /* If this keymap has already contributed to this KEY,
7521 don't contribute to it a second time. */
7522 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7523 if (!NILP (tem
) || NILP (item
))
7526 menu_bar_one_keymap_changed_items
7527 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7529 /* We add to menu_bar_one_keymap_changed_items before doing the
7530 parse_menu_item, so that if it turns out it wasn't a menu item,
7531 it still correctly hides any further menu item. */
7533 parsed
= parse_menu_item (item
, 1);
7538 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7540 /* Find any existing item for this KEY. */
7541 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7542 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7545 /* If we did not find this KEY, add it at the end. */
7546 if (i
== menu_bar_items_index
)
7548 /* If vector is too small, get a bigger one. */
7549 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7550 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7551 /* Add this item. */
7552 ASET (menu_bar_items_vector
, i
, key
); i
++;
7553 ASET (menu_bar_items_vector
, i
,
7554 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7555 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7556 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7557 menu_bar_items_index
= i
;
7559 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7563 old
= AREF (menu_bar_items_vector
, i
+ 2);
7564 /* If the new and the old items are not both keymaps,
7565 the lookup will only find `item'. */
7566 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7567 ASET (menu_bar_items_vector
, i
+ 2, item
);
7571 /* This is used as the handler when calling menu_item_eval_property. */
7573 menu_item_eval_property_1 (Lisp_Object arg
)
7575 /* If we got a quit from within the menu computation,
7576 quit all the way out of it. This takes care of C-] in the debugger. */
7577 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7578 Fsignal (Qquit
, Qnil
);
7584 eval_dyn (Lisp_Object form
)
7586 return Feval (form
, Qnil
);
7589 /* Evaluate an expression and return the result (or nil if something
7590 went wrong). Used to evaluate dynamic parts of menu items. */
7592 menu_item_eval_property (Lisp_Object sexpr
)
7594 ptrdiff_t count
= SPECPDL_INDEX ();
7596 specbind (Qinhibit_redisplay
, Qt
);
7597 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7598 menu_item_eval_property_1
);
7599 return unbind_to (count
, val
);
7602 /* This function parses a menu item and leaves the result in the
7603 vector item_properties.
7604 ITEM is a key binding, a possible menu item.
7605 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7607 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7608 parse_menu_item returns true if the item is a menu item and false
7612 parse_menu_item (Lisp_Object item
, int inmenubar
)
7614 Lisp_Object def
, tem
, item_string
, start
;
7616 Lisp_Object keyhint
;
7625 /* Create item_properties vector if necessary. */
7626 if (NILP (item_properties
))
7628 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7630 /* Initialize optional entries. */
7631 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7632 ASET (item_properties
, i
, Qnil
);
7633 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7635 /* Save the item here to protect it from GC. */
7636 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7638 item_string
= XCAR (item
);
7642 if (STRINGP (item_string
))
7644 /* Old format menu item. */
7645 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7647 /* Maybe help string. */
7648 if (CONSP (item
) && STRINGP (XCAR (item
)))
7650 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7655 /* Maybe an obsolete key binding cache. */
7656 if (CONSP (item
) && CONSP (XCAR (item
))
7657 && (NILP (XCAR (XCAR (item
)))
7658 || VECTORP (XCAR (XCAR (item
)))))
7661 /* This is the real definition--the function to run. */
7662 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7664 /* Get enable property, if any. */
7667 tem
= Fget (item
, Qmenu_enable
);
7668 if (!NILP (Venable_disabled_menus_and_buttons
))
7669 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7670 else if (!NILP (tem
))
7671 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7674 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7676 /* New format menu item. */
7677 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7678 start
= XCDR (item
);
7681 /* We have a real binding. */
7682 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7684 item
= XCDR (start
);
7685 /* Is there an obsolete cache list with key equivalences. */
7686 if (CONSP (item
) && CONSP (XCAR (item
)))
7689 /* Parse properties. */
7690 while (CONSP (item
) && CONSP (XCDR (item
)))
7695 if (EQ (tem
, QCenable
))
7697 if (!NILP (Venable_disabled_menus_and_buttons
))
7698 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7700 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7702 else if (EQ (tem
, QCvisible
))
7704 /* If got a visible property and that evaluates to nil
7705 then ignore this item. */
7706 tem
= menu_item_eval_property (XCAR (item
));
7710 else if (EQ (tem
, QChelp
))
7711 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7712 else if (EQ (tem
, QCfilter
))
7714 else if (EQ (tem
, QCkey_sequence
))
7717 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7718 /* Be GC protected. Set keyhint to item instead of tem. */
7721 else if (EQ (tem
, QCkeys
))
7724 if (CONSP (tem
) || STRINGP (tem
))
7725 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7727 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7732 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7734 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7736 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7742 else if (inmenubar
|| !NILP (start
))
7746 return 0; /* not a menu item */
7748 /* If item string is not a string, evaluate it to get string.
7749 If we don't get a string, skip this item. */
7750 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7751 if (!(STRINGP (item_string
)))
7753 item_string
= menu_item_eval_property (item_string
);
7754 if (!STRINGP (item_string
))
7756 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7759 /* If got a filter apply it on definition. */
7760 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7763 def
= menu_item_eval_property (list2 (XCAR (filter
),
7764 list2 (Qquote
, def
)));
7766 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7769 /* Enable or disable selection of item. */
7770 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7773 tem
= menu_item_eval_property (tem
);
7774 if (inmenubar
&& NILP (tem
))
7775 return 0; /* Ignore disabled items in menu bar. */
7776 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7779 /* If we got no definition, this item is just unselectable text which
7780 is OK in a submenu but not in the menubar. */
7782 return (!inmenubar
);
7784 /* See if this is a separate pane or a submenu. */
7785 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7786 tem
= get_keymap (def
, 0, 1);
7787 /* For a subkeymap, just record its details and exit. */
7790 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7791 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7795 /* At the top level in the menu bar, do likewise for commands also.
7796 The menu bar does not display equivalent key bindings anyway.
7797 ITEM_PROPERTY_DEF is already set up properly. */
7801 { /* This is a command. See if there is an equivalent key binding. */
7802 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7804 /* The previous code preferred :key-sequence to :keys, so we
7805 preserve this behavior. */
7806 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7807 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7810 Lisp_Object prefix
= keyeq
;
7811 Lisp_Object keys
= Qnil
;
7815 def
= XCAR (prefix
);
7816 prefix
= XCDR (prefix
);
7819 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7821 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7823 keys
= XCAR (keyhint
);
7824 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7826 /* We have a suggested key. Is it bound to the command? */
7829 /* If the command is an alias for another
7830 (such as lmenu.el set it up), check if the
7831 original command matches the cached command. */
7833 && EQ (tem
, XSYMBOL (def
)->function
))))
7838 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7842 tem
= Fkey_description (keys
, Qnil
);
7845 if (STRINGP (XCAR (prefix
)))
7846 tem
= concat2 (XCAR (prefix
), tem
);
7847 if (STRINGP (XCDR (prefix
)))
7848 tem
= concat2 (tem
, XCDR (prefix
));
7850 keyeq
= concat2 (build_string (" "), tem
);
7851 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7857 /* If we have an equivalent key binding, use that. */
7858 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7861 /* Include this when menu help is implemented.
7862 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7863 if (!(NILP (tem) || STRINGP (tem)))
7865 tem = menu_item_eval_property (tem);
7868 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7872 /* Handle radio buttons or toggle boxes. */
7873 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7875 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7876 menu_item_eval_property (tem
));
7883 /***********************************************************************
7885 ***********************************************************************/
7887 /* A vector holding tool bar items while they are parsed in function
7888 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7891 static Lisp_Object tool_bar_items_vector
;
7893 /* A vector holding the result of parse_tool_bar_item. Layout is like
7894 the one for a single item in tool_bar_items_vector. */
7896 static Lisp_Object tool_bar_item_properties
;
7898 /* Next free index in tool_bar_items_vector. */
7900 static int ntool_bar_items
;
7902 /* The symbols `:image' and `:rtl'. */
7904 static Lisp_Object QCimage
;
7905 static Lisp_Object QCrtl
;
7907 /* Function prototypes. */
7909 static void init_tool_bar_items (Lisp_Object
);
7910 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7911 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7912 static void append_tool_bar_item (void);
7915 /* Return a vector of tool bar items for keymaps currently in effect.
7916 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7917 tool bar items found. */
7920 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7929 /* In order to build the menus, we need to call the keymap
7930 accessors. They all call QUIT. But this function is called
7931 during redisplay, during which a quit is fatal. So inhibit
7932 quitting while building the menus. We do this instead of
7933 specbind because (1) errors will clear it anyway and (2) this
7934 avoids risk of specpdl overflow. */
7935 oquit
= Vinhibit_quit
;
7938 /* Initialize tool_bar_items_vector and protect it from GC. */
7939 init_tool_bar_items (reuse
);
7941 /* Build list of keymaps in maps. Set nmaps to the number of maps
7944 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7945 if (!NILP (Voverriding_local_map_menu_flag
)
7946 && !NILP (Voverriding_local_map
))
7948 /* Yes, use them (if non-nil) as well as the global map. */
7949 maps
= alloca (3 * sizeof *maps
);
7951 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7952 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7953 if (!NILP (Voverriding_local_map
))
7954 maps
[nmaps
++] = Voverriding_local_map
;
7958 /* No, so use major and minor mode keymaps and keymap property.
7959 Note that tool-bar bindings in the local-map and keymap
7960 properties may not work reliable, as they are only
7961 recognized when the tool-bar (or mode-line) is updated,
7962 which does not normally happen after every command. */
7965 nminor
= current_minor_maps (NULL
, &tmaps
);
7966 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7968 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7969 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7970 maps
[nmaps
++] = tem
;
7971 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7972 maps
[nmaps
++] = tem
;
7973 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7975 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7978 /* Add global keymap at the end. */
7979 maps
[nmaps
++] = current_global_map
;
7981 /* Process maps in reverse order and look up in each map the prefix
7983 for (i
= nmaps
- 1; i
>= 0; --i
)
7984 if (!NILP (maps
[i
]))
7988 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7990 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7993 Vinhibit_quit
= oquit
;
7994 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7995 return tool_bar_items_vector
;
7999 /* Process the definition of KEY which is DEF. */
8002 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8005 struct gcpro gcpro1
, gcpro2
;
8007 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8011 if (EQ (def
, Qundefined
))
8013 /* If a map has an explicit `undefined' as definition,
8014 discard any previously made item. */
8015 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8017 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8019 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8021 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8022 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8023 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8025 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8030 else if (parse_tool_bar_item (key
, def
))
8031 /* Append a new tool bar item to tool_bar_items_vector. Accept
8032 more than one definition for the same key. */
8033 append_tool_bar_item ();
8038 /* Access slot with index IDX of vector tool_bar_item_properties. */
8039 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8041 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8043 ASET (tool_bar_item_properties
, idx
, val
);
8047 /* Parse a tool bar item specification ITEM for key KEY and return the
8048 result in tool_bar_item_properties. Value is false if ITEM is
8051 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8053 CAPTION is the caption of the item, If it's not a string, it is
8054 evaluated to get a string.
8056 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8057 as binding are currently ignored.
8059 The following properties are recognized:
8063 FORM is evaluated and specifies whether the tool bar item is
8064 enabled or disabled.
8068 FORM is evaluated and specifies whether the tool bar item is visible.
8070 - `:filter FUNCTION'
8072 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8073 result is stored as the new binding.
8075 - `:button (TYPE SELECTED)'
8077 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8078 and specifies whether the button is selected (pressed) or not.
8082 IMAGES is either a single image specification or a vector of four
8083 image specifications. See enum tool_bar_item_images.
8085 - `:help HELP-STRING'.
8087 Gives a help string to display for the tool bar item.
8089 - `:label LABEL-STRING'.
8091 A text label to show with the tool bar button if labels are enabled. */
8094 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8096 Lisp_Object filter
= Qnil
;
8097 Lisp_Object caption
;
8099 bool have_label
= 0;
8101 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8102 Rule out items that aren't lists, don't start with
8103 `menu-item' or whose rest following `tool-bar-item' is not a
8108 /* As an exception, allow old-style menu separators. */
8109 if (STRINGP (XCAR (item
)))
8110 item
= Fcons (XCAR (item
), Qnil
);
8111 else if (!EQ (XCAR (item
), Qmenu_item
)
8112 || (item
= XCDR (item
), !CONSP (item
)))
8115 /* Create tool_bar_item_properties vector if necessary. Reset it to
8117 if (VECTORP (tool_bar_item_properties
))
8119 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8123 tool_bar_item_properties
8124 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8127 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8128 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8130 /* Get the caption of the item. If the caption is not a string,
8131 evaluate it to get a string. If we don't get a string, skip this
8133 caption
= XCAR (item
);
8134 if (!STRINGP (caption
))
8136 caption
= menu_item_eval_property (caption
);
8137 if (!STRINGP (caption
))
8140 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8142 /* If the rest following the caption is not a list, the menu item is
8143 either a separator, or invalid. */
8147 if (menu_separator_name_p (SSDATA (caption
)))
8149 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8150 #if !defined (USE_GTK) && !defined (HAVE_NS)
8151 /* If we use build_desired_tool_bar_string to render the
8152 tool bar, the separator is rendered as an image. */
8153 PROP (TOOL_BAR_ITEM_IMAGES
)
8154 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8155 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8156 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8157 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8164 /* Store the binding. */
8165 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8168 /* Ignore cached key binding, if any. */
8169 if (CONSP (item
) && CONSP (XCAR (item
)))
8172 /* Process the rest of the properties. */
8173 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8175 Lisp_Object ikey
, value
;
8178 value
= XCAR (XCDR (item
));
8180 if (EQ (ikey
, QCenable
))
8182 /* `:enable FORM'. */
8183 if (!NILP (Venable_disabled_menus_and_buttons
))
8184 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8186 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8188 else if (EQ (ikey
, QCvisible
))
8190 /* `:visible FORM'. If got a visible property and that
8191 evaluates to nil then ignore this item. */
8192 if (NILP (menu_item_eval_property (value
)))
8195 else if (EQ (ikey
, QChelp
))
8196 /* `:help HELP-STRING'. */
8197 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8198 else if (EQ (ikey
, QCvert_only
))
8199 /* `:vert-only t/nil'. */
8200 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8201 else if (EQ (ikey
, QClabel
))
8203 const char *bad_label
= "!!?GARBLED ITEM?!!";
8204 /* `:label LABEL-STRING'. */
8205 set_prop (TOOL_BAR_ITEM_LABEL
,
8206 STRINGP (value
) ? value
: build_string (bad_label
));
8209 else if (EQ (ikey
, QCfilter
))
8210 /* ':filter FORM'. */
8212 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8214 /* `:button (TYPE . SELECTED)'. */
8215 Lisp_Object type
, selected
;
8217 type
= XCAR (value
);
8218 selected
= XCDR (value
);
8219 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8221 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8222 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8225 else if (EQ (ikey
, QCimage
)
8227 || (VECTORP (value
) && ASIZE (value
) == 4)))
8228 /* Value is either a single image specification or a vector
8229 of 4 such specifications for the different button states. */
8230 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8231 else if (EQ (ikey
, QCrtl
))
8233 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8239 /* Try to make one from caption and key. */
8240 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8241 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8242 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8243 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8245 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8246 char *buf
= xmalloc (max_lbl
+ 1);
8247 Lisp_Object new_lbl
;
8248 ptrdiff_t caption_len
= strlen (capt
);
8250 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8253 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8255 buf
[caption_len
] = '\0';
8259 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8263 strcpy (buf
, label
);
8265 for (j
= 0; buf
[j
] != '\0'; ++j
)
8273 new_lbl
= Fupcase_initials (build_string (label
));
8274 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8275 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8277 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8281 /* If got a filter apply it on binding. */
8283 set_prop (TOOL_BAR_ITEM_BINDING
,
8284 (menu_item_eval_property
8287 PROP (TOOL_BAR_ITEM_BINDING
))))));
8289 /* See if the binding is a keymap. Give up if it is. */
8290 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8293 /* Enable or disable selection of item. */
8294 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8295 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8296 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8298 /* Handle radio buttons or toggle boxes. */
8299 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8300 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8301 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8309 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8310 that can be reused. */
8313 init_tool_bar_items (Lisp_Object reuse
)
8315 if (VECTORP (reuse
))
8316 tool_bar_items_vector
= reuse
;
8318 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8319 ntool_bar_items
= 0;
8323 /* Append parsed tool bar item properties from
8324 tool_bar_item_properties */
8327 append_tool_bar_item (void)
8331 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8333 /* Enlarge tool_bar_items_vector if necessary. */
8335 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8337 /* Append entries from tool_bar_item_properties to the end of
8338 tool_bar_items_vector. */
8339 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8340 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8341 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8348 /* Read a character using menus based on the keymap MAP.
8349 Return nil if there are no menus in the maps.
8350 Return t if we displayed a menu but the user rejected it.
8352 PREV_EVENT is the previous input event, or nil if we are reading
8353 the first event of a key sequence.
8355 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8356 if we used a mouse menu to read the input, or false otherwise. If
8357 USED_MOUSE_MENU is null, don't dereference it.
8359 The prompting is done based on the prompt-string of the map
8360 and the strings associated with various map elements.
8362 This can be done with X menus or with menus put in the minibuf.
8363 These are done in different ways, depending on how the input will be read.
8364 Menus using X are done after auto-saving in read-char, getting the input
8365 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8366 and do auto-saving in the inner call of read_char. */
8369 read_char_x_menu_prompt (Lisp_Object map
,
8370 Lisp_Object prev_event
, bool *used_mouse_menu
)
8372 if (used_mouse_menu
)
8373 *used_mouse_menu
= 0;
8375 /* Use local over global Menu maps. */
8377 if (! menu_prompting
)
8381 /* If we got to this point via a mouse click,
8382 use a real menu for mouse selection. */
8383 if (EVENT_HAS_PARAMETERS (prev_event
)
8384 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8385 && !EQ (XCAR (prev_event
), Qtool_bar
))
8387 /* Display the menu and get the selection. */
8390 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8395 record_menu_key (XCAR (value
));
8397 /* If we got multiple events, unread all but
8399 There is no way to prevent those unread events
8400 from showing up later in last_nonmenu_event.
8401 So turn symbol and integer events into lists,
8402 to indicate that they came from a mouse menu,
8403 so that when present in last_nonmenu_event
8404 they won't confuse things. */
8405 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8407 record_menu_key (XCAR (tem
));
8408 if (SYMBOLP (XCAR (tem
))
8409 || INTEGERP (XCAR (tem
)))
8410 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8413 /* If we got more than one event, put all but the first
8414 onto this list to be read later.
8415 Return just the first event now. */
8416 Vunread_command_events
8417 = nconc2 (XCDR (value
), Vunread_command_events
);
8418 value
= XCAR (value
);
8420 else if (NILP (value
))
8422 if (used_mouse_menu
)
8423 *used_mouse_menu
= 1;
8426 #endif /* HAVE_MENUS */
8431 read_char_minibuf_menu_prompt (int commandflag
,
8434 register Lisp_Object name
;
8436 /* FIXME: Use the minibuffer's frame width. */
8437 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8439 bool nobindings
= 1;
8440 Lisp_Object rest
, vector
;
8441 Lisp_Object prompt_strings
= Qnil
;
8445 if (! menu_prompting
)
8448 map
= get_keymap (map
, 0, 1);
8449 name
= Fkeymap_prompt (map
);
8451 /* If we don't have any menus, just read a character normally. */
8452 if (!STRINGP (name
))
8455 #define PUSH_C_STR(str, listvar) \
8456 listvar = Fcons (make_unibyte_string (str, strlen (str)), listvar)
8458 /* Prompt string always starts with map's prompt, and a space. */
8459 prompt_strings
= Fcons (name
, prompt_strings
);
8460 PUSH_C_STR (": ", prompt_strings
);
8461 nlength
= SCHARS (name
) + 2;
8465 /* Present the documented bindings, a line at a time. */
8469 Lisp_Object menu_strings
= prompt_strings
;
8470 ptrdiff_t i
= nlength
;
8472 Lisp_Object orig_defn_macro
;
8474 /* Loop over elements of map. */
8479 /* FIXME: Use map_keymap to handle new keymap formats. */
8481 /* At end of map, wrap around if just starting,
8482 or end this line if already have something on it. */
8485 if (notfirst
|| nobindings
)
8491 /* Look at the next element of the map. */
8493 elt
= AREF (vector
, idx
);
8495 elt
= Fcar_safe (rest
);
8497 if (idx
< 0 && VECTORP (elt
))
8499 /* If we found a dense table in the keymap,
8500 advanced past it, but start scanning its contents. */
8501 rest
= Fcdr_safe (rest
);
8507 /* An ordinary element. */
8508 Lisp_Object event
, tem
;
8512 event
= Fcar_safe (elt
); /* alist */
8513 elt
= Fcdr_safe (elt
);
8517 XSETINT (event
, idx
); /* vector */
8520 /* Ignore the element if it has no prompt string. */
8521 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8523 /* True if the char to type matches the string. */
8525 Lisp_Object upcased_event
, downcased_event
;
8526 Lisp_Object desc
= Qnil
;
8528 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8530 upcased_event
= Fupcase (event
);
8531 downcased_event
= Fdowncase (event
);
8532 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8533 || XINT (downcased_event
) == SREF (s
, 0));
8535 desc
= Fsingle_key_description (event
, Qnil
);
8537 #if 0 /* It is redundant to list the equivalent key bindings because
8538 the prefix is what the user has already typed. */
8540 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8542 /* Insert equivalent keybinding. */
8543 s
= concat2 (s
, tem
);
8546 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8547 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8549 /* Insert button prefix. */
8550 Lisp_Object selected
8551 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8552 if (EQ (tem
, QCradio
))
8553 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8555 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8556 s
= concat2 (tem
, s
);
8560 /* If we have room for the prompt string, add it to this line.
8561 If this is the first on the line, always add it. */
8562 if ((SCHARS (s
) + i
+ 2
8563 + (char_matches
? 0 : SCHARS (desc
) + 3))
8567 ptrdiff_t thiswidth
;
8569 /* Punctuate between strings. */
8572 PUSH_C_STR (", ", menu_strings
);
8578 /* If the char to type doesn't match the string's
8579 first char, explicitly show what char to type. */
8582 /* Add as much of string as fits. */
8583 thiswidth
= min (SCHARS (desc
), width
- i
);
8585 = Fcons (Fsubstring (desc
, make_number (0),
8586 make_number (thiswidth
)),
8589 PUSH_C_STR (" = ", menu_strings
);
8593 /* Add as much of string as fits. */
8594 thiswidth
= min (SCHARS (s
), width
- i
);
8596 = Fcons (Fsubstring (s
, make_number (0),
8597 make_number (thiswidth
)),
8603 /* If this element does not fit, end the line now,
8604 and save the element for the next line. */
8605 PUSH_C_STR ("...", menu_strings
);
8610 /* Move past this element. */
8611 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8612 /* Handle reaching end of dense table. */
8617 rest
= Fcdr_safe (rest
);
8621 /* Prompt with that and read response. */
8622 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8624 /* Make believe it's not a keyboard macro in case the help char
8625 is pressed. Help characters are not recorded because menu prompting
8626 is not used on replay. */
8627 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8628 kset_defining_kbd_macro (current_kboard
, Qnil
);
8630 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8631 while (BUFFERP (obj
));
8632 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8634 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8637 if (! EQ (obj
, menu_prompt_more_char
)
8638 && (!INTEGERP (menu_prompt_more_char
)
8639 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8641 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8642 store_kbd_macro_char (obj
);
8645 /* Help char - go round again. */
8649 /* Reading key sequences. */
8652 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8654 return access_keymap (get_keymap (keymap
, 0, 1),
8659 active_maps (Lisp_Object first_event
)
8661 Lisp_Object position
8662 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8663 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8666 /* Structure used to keep track of partial application of key remapping
8667 such as Vfunction_key_map and Vkey_translation_map. */
8668 typedef struct keyremap
8670 /* This is the map originally specified for this use. */
8672 /* This is a submap reached by looking up, in PARENT,
8673 the events from START to END. */
8675 /* Positions [START, END) in the key sequence buffer
8676 are the key that we have scanned so far.
8677 Those events are the ones that we will replace
8678 if PARENT maps them into a key sequence. */
8682 /* Lookup KEY in MAP.
8683 MAP is a keymap mapping keys to key vectors or functions.
8684 If the mapping is a function and DO_FUNCALL is true,
8685 the function is called with PROMPT as parameter and its return
8686 value is used as the return value of this function (after checking
8687 that it is indeed a vector). */
8690 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8695 next
= access_keymap (map
, key
, 1, 0, 1);
8697 /* Handle a symbol whose function definition is a keymap
8699 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8700 && (ARRAYP (XSYMBOL (next
)->function
)
8701 || KEYMAPP (XSYMBOL (next
)->function
)))
8702 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8704 /* If the keymap gives a function, not an
8705 array, then call the function with one arg and use
8706 its value instead. */
8707 if (do_funcall
&& FUNCTIONP (next
))
8712 next
= call1 (next
, prompt
);
8713 /* If the function returned something invalid,
8714 barf--don't ignore it.
8715 (To ignore it safely, we would need to gcpro a bunch of
8716 other variables.) */
8717 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8718 error ("Function %s returns invalid key sequence",
8719 SSDATA (SYMBOL_NAME (tem
)));
8724 /* Do one step of the key remapping used for function-key-map and
8725 key-translation-map:
8726 KEYBUF is the buffer holding the input events.
8727 BUFSIZE is its maximum size.
8728 FKEY is a pointer to the keyremap structure to use.
8729 INPUT is the index of the last element in KEYBUF.
8730 DOIT if true says that the remapping can actually take place.
8731 DIFF is used to return the number of keys added/removed by the remapping.
8732 PARENT is the root of the keymap.
8733 PROMPT is the prompt to use if the remapping happens through a function.
8734 Return true if the remapping actually took place. */
8737 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8738 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8740 Lisp_Object next
, key
;
8742 key
= keybuf
[fkey
->end
++];
8744 if (KEYMAPP (fkey
->parent
))
8745 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8749 /* If keybuf[fkey->start..fkey->end] is bound in the
8750 map and we're in a position to do the key remapping, replace it with
8751 the binding and restart with fkey->start at the end. */
8752 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8754 int len
= XFASTINT (Flength (next
));
8757 *diff
= len
- (fkey
->end
- fkey
->start
);
8759 if (bufsize
- input
<= *diff
)
8760 error ("Key sequence too long");
8762 /* Shift the keys that follow fkey->end. */
8764 for (i
= fkey
->end
; i
< input
; i
++)
8765 keybuf
[i
+ *diff
] = keybuf
[i
];
8767 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8768 keybuf
[i
+ *diff
] = keybuf
[i
];
8769 /* Overwrite the old keys with the new ones. */
8770 for (i
= 0; i
< len
; i
++)
8771 keybuf
[fkey
->start
+ i
]
8772 = Faref (next
, make_number (i
));
8774 fkey
->start
= fkey
->end
+= *diff
;
8775 fkey
->map
= fkey
->parent
;
8780 fkey
->map
= get_keymap (next
, 0, 1);
8782 /* If we no longer have a bound suffix, try a new position for
8784 if (!CONSP (fkey
->map
))
8786 fkey
->end
= ++fkey
->start
;
8787 fkey
->map
= fkey
->parent
;
8793 test_undefined (Lisp_Object binding
)
8795 return (NILP (binding
)
8796 || EQ (binding
, Qundefined
)
8797 || (SYMBOLP (binding
)
8798 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8801 /* Read a sequence of keys that ends with a non prefix character,
8802 storing it in KEYBUF, a buffer of size BUFSIZE.
8804 Return the length of the key sequence stored.
8805 Return -1 if the user rejected a command menu.
8807 Echo starting immediately unless `prompt' is 0.
8809 Where a key sequence ends depends on the currently active keymaps.
8810 These include any minor mode keymaps active in the current buffer,
8811 the current buffer's local map, and the global map.
8813 If a key sequence has no other bindings, we check Vfunction_key_map
8814 to see if some trailing subsequence might be the beginning of a
8815 function key's sequence. If so, we try to read the whole function
8816 key, and substitute its symbolic name into the key sequence.
8818 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8819 `double-' events into similar click events, if that would make them
8820 bound. We try to turn `triple-' events first into `double-' events,
8823 If we get a mouse click in a mode line, vertical divider, or other
8824 non-text area, we treat the click as if it were prefixed by the
8825 symbol denoting that area - `mode-line', `vertical-line', or
8828 If the sequence starts with a mouse click, we read the key sequence
8829 with respect to the buffer clicked on, not the current buffer.
8831 If the user switches frames in the midst of a key sequence, we put
8832 off the switch-frame event until later; the next call to
8833 read_char will return it.
8835 If FIX_CURRENT_BUFFER, we restore current_buffer
8836 from the selected window's buffer. */
8839 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8840 bool dont_downcase_last
, bool can_return_switch_frame
,
8841 bool fix_current_buffer
)
8843 ptrdiff_t count
= SPECPDL_INDEX ();
8845 /* How many keys there are in the current key sequence. */
8848 /* The length of the echo buffer when we started reading, and
8849 the length of this_command_keys when we started reading. */
8850 ptrdiff_t echo_start
IF_LINT (= 0);
8851 ptrdiff_t keys_start
;
8853 Lisp_Object current_binding
= Qnil
;
8854 Lisp_Object first_event
= Qnil
;
8856 /* Index of the first key that has no binding.
8857 It is useless to try fkey.start larger than that. */
8860 /* If t < mock_input, then KEYBUF[t] should be read as the next
8863 We use this to recover after recognizing a function key. Once we
8864 realize that a suffix of the current key sequence is actually a
8865 function key's escape sequence, we replace the suffix with the
8866 function key's binding from Vfunction_key_map. Now keybuf
8867 contains a new and different key sequence, so the echo area,
8868 this_command_keys, and the submaps and defs arrays are wrong. In
8869 this situation, we set mock_input to t, set t to 0, and jump to
8870 restart_sequence; the loop will read keys from keybuf up until
8871 mock_input, thus rebuilding the state; and then it will resume
8872 reading characters from the keyboard. */
8875 /* If the sequence is unbound in submaps[], then
8876 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8877 and fkey.map is its binding.
8879 These might be > t, indicating that all function key scanning
8880 should hold off until t reaches them. We do this when we've just
8881 recognized a function key, to avoid searching for the function
8882 key's again in Vfunction_key_map. */
8885 /* Likewise, for key_translation_map and input-decode-map. */
8886 keyremap keytran
, indec
;
8888 /* True if we are trying to map a key by changing an upper-case
8889 letter to lower case, or a shifted function key to an unshifted
8891 bool shift_translated
= 0;
8893 /* If we receive a `switch-frame' or `select-window' event in the middle of
8894 a key sequence, we put it off for later.
8895 While we're reading, we keep the event here. */
8896 Lisp_Object delayed_switch_frame
;
8898 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8899 int original_uppercase_position
= -1;
8901 /* Gets around Microsoft compiler limitations. */
8904 struct buffer
*starting_buffer
;
8906 /* List of events for which a fake prefix key has been generated. */
8907 Lisp_Object fake_prefixed_keys
= Qnil
;
8909 struct gcpro gcpro1
;
8911 GCPRO1 (fake_prefixed_keys
);
8912 raw_keybuf_count
= 0;
8914 last_nonmenu_event
= Qnil
;
8916 delayed_switch_frame
= Qnil
;
8922 /* Install the string STR as the beginning of the string of
8923 echoing, so that it serves as a prompt for the next
8925 kset_echo_string (current_kboard
, prompt
);
8926 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8929 else if (cursor_in_echo_area
8930 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8931 && NILP (Fzerop (Vecho_keystrokes
)))
8932 /* This doesn't put in a dash if the echo buffer is empty, so
8933 you don't always see a dash hanging out in the minibuffer. */
8937 /* Record the initial state of the echo area and this_command_keys;
8938 we will need to restore them if we replay a key sequence. */
8940 echo_start
= echo_length ();
8941 keys_start
= this_command_key_count
;
8942 this_single_command_key_start
= keys_start
;
8944 /* We jump here when we need to reinitialize fkey and keytran; this
8945 happens if we switch keyboards between rescans. */
8946 replay_entire_sequence
:
8948 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8949 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8950 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8951 indec
.start
= indec
.end
= 0;
8952 fkey
.start
= fkey
.end
= 0;
8953 keytran
.start
= keytran
.end
= 0;
8955 /* We jump here when the key sequence has been thoroughly changed, and
8956 we need to rescan it starting from the beginning. When we jump here,
8957 keybuf[0..mock_input] holds the sequence we should reread. */
8960 starting_buffer
= current_buffer
;
8961 first_unbound
= bufsize
+ 1;
8963 /* Build our list of keymaps.
8964 If we recognize a function key and replace its escape sequence in
8965 keybuf with its symbol, or if the sequence starts with a mouse
8966 click and we need to switch buffers, we jump back here to rebuild
8967 the initial keymaps from the current buffer. */
8968 current_binding
= active_maps (first_event
);
8970 /* Start from the beginning in keybuf. */
8973 /* These are no-ops the first time through, but if we restart, they
8974 revert the echo area and this_command_keys to their original state. */
8975 this_command_key_count
= keys_start
;
8976 if (INTERACTIVE
&& t
< mock_input
)
8977 echo_truncate (echo_start
);
8979 /* If the best binding for the current key sequence is a keymap, or
8980 we may be looking at a function key's escape sequence, keep on
8982 while (!NILP (current_binding
)
8983 /* Keep reading as long as there's a prefix binding. */
8984 ? KEYMAPP (current_binding
)
8985 /* Don't return in the middle of a possible function key sequence,
8986 if the only bindings we found were via case conversion.
8987 Thus, if ESC O a has a function-key-map translation
8988 and ESC o has a binding, don't return after ESC O,
8989 so that we can translate ESC O plus the next character. */
8990 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8993 bool used_mouse_menu
= 0;
8995 /* Where the last real key started. If we need to throw away a
8996 key that has expanded into more than one element of keybuf
8997 (say, a mouse click on the mode line which is being treated
8998 as [mode-line (mouse-...)], then we backtrack to this point
9000 int last_real_key_start
;
9002 /* These variables are analogous to echo_start and keys_start;
9003 while those allow us to restart the entire key sequence,
9004 echo_local_start and keys_local_start allow us to throw away
9006 ptrdiff_t echo_local_start
IF_LINT (= 0);
9007 int keys_local_start
;
9008 Lisp_Object new_binding
;
9010 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9011 eassert (indec
.start
<= indec
.end
);
9012 eassert (fkey
.start
<= fkey
.end
);
9013 eassert (keytran
.start
<= keytran
.end
);
9014 /* key-translation-map is applied *after* function-key-map
9015 which is itself applied *after* input-decode-map. */
9016 eassert (fkey
.end
<= indec
.start
);
9017 eassert (keytran
.end
<= fkey
.start
);
9019 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9020 first_unbound
< keytran
.start
)
9021 { /* The prefix upto first_unbound has no binding and has
9022 no translation left to do either, so we know it's unbound.
9023 If we don't stop now, we risk staying here indefinitely
9024 (if the user keeps entering fkey or keytran prefixes
9025 like C-c ESC ESC ESC ESC ...) */
9027 for (i
= first_unbound
+ 1; i
< t
; i
++)
9028 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9029 mock_input
= t
- first_unbound
- 1;
9030 indec
.end
= indec
.start
-= first_unbound
+ 1;
9031 indec
.map
= indec
.parent
;
9032 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9033 fkey
.map
= fkey
.parent
;
9034 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9035 keytran
.map
= keytran
.parent
;
9036 goto replay_sequence
;
9040 error ("Key sequence too long");
9043 echo_local_start
= echo_length ();
9044 keys_local_start
= this_command_key_count
;
9047 /* These are no-ops, unless we throw away a keystroke below and
9048 jumped back up to replay_key; in that case, these restore the
9049 variables to their original state, allowing us to replay the
9051 if (INTERACTIVE
&& t
< mock_input
)
9052 echo_truncate (echo_local_start
);
9053 this_command_key_count
= keys_local_start
;
9055 /* By default, assume each event is "real". */
9056 last_real_key_start
= t
;
9058 /* Does mock_input indicate that we are re-reading a key sequence? */
9062 add_command_key (key
);
9063 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9064 && NILP (Fzerop (Vecho_keystrokes
))
9065 && current_kboard
->immediate_echo
)
9072 /* If not, we should actually read a character. */
9076 KBOARD
*interrupted_kboard
= current_kboard
;
9077 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9078 key
= read_char (NILP (prompt
),
9079 current_binding
, last_nonmenu_event
,
9080 &used_mouse_menu
, NULL
);
9081 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9082 /* When switching to a new tty (with a new keyboard),
9083 read_char returns the new buffer, rather than -2
9084 (Bug#5095). This is because `terminal-init-xterm'
9085 calls read-char, which eats the wrong_kboard_jmpbuf
9086 return. Any better way to fix this? -- cyd */
9087 || (interrupted_kboard
!= current_kboard
))
9092 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9093 if (k
== interrupted_kboard
)
9098 /* Don't touch interrupted_kboard when it's been
9100 delayed_switch_frame
= Qnil
;
9101 goto replay_entire_sequence
;
9104 if (!NILP (delayed_switch_frame
))
9107 (interrupted_kboard
,
9108 Fcons (delayed_switch_frame
,
9109 KVAR (interrupted_kboard
, kbd_queue
)));
9110 delayed_switch_frame
= Qnil
;
9115 (interrupted_kboard
,
9116 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9118 /* If the side queue is non-empty, ensure it begins with a
9119 switch-frame, so we'll replay it in the right context. */
9120 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9121 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9122 !(EVENT_HAS_PARAMETERS (key
)
9123 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9127 XSETFRAME (frame
, interrupted_frame
);
9129 (interrupted_kboard
,
9130 Fcons (make_lispy_switch_frame (frame
),
9131 KVAR (interrupted_kboard
, kbd_queue
)));
9134 goto replay_entire_sequence
;
9138 /* read_char returns t when it shows a menu and the user rejects it.
9142 unbind_to (count
, Qnil
);
9147 /* read_char returns -1 at the end of a macro.
9148 Emacs 18 handles this by returning immediately with a
9149 zero, so that's what we'll do. */
9150 if (INTEGERP (key
) && XINT (key
) == -1)
9153 /* The Microsoft C compiler can't handle the goto that
9159 /* If the current buffer has been changed from under us, the
9160 keymap may have changed, so replay the sequence. */
9163 timer_resume_idle ();
9166 /* Reset the current buffer from the selected window
9167 in case something changed the former and not the latter.
9168 This is to be more consistent with the behavior
9169 of the command_loop_1. */
9170 if (fix_current_buffer
)
9172 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9174 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9176 Fset_buffer (XWINDOW (selected_window
)->contents
);
9179 goto replay_sequence
;
9182 /* If we have a quit that was typed in another frame, and
9183 quit_throw_to_read_char switched buffers,
9184 replay to get the right keymap. */
9186 && XINT (key
) == quit_char
9187 && current_buffer
!= starting_buffer
)
9190 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9195 goto replay_sequence
;
9200 if (EVENT_HAS_PARAMETERS (key
)
9201 /* Either a `switch-frame' or a `select-window' event. */
9202 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9204 /* If we're at the beginning of a key sequence, and the caller
9205 says it's okay, go ahead and return this event. If we're
9206 in the midst of a key sequence, delay it until the end. */
9207 if (t
> 0 || !can_return_switch_frame
)
9209 delayed_switch_frame
= key
;
9214 if (NILP (first_event
))
9217 /* Even if first_event does not specify a particular
9218 window/position, it's important to recompute the maps here
9219 since a long time might have passed since we entered
9220 read_key_sequence, and a timer (or process-filter or
9221 special-event-map, ...) might have switched the current buffer
9222 or the selected window from under us in the mean time. */
9223 if (fix_current_buffer
9224 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9226 Fset_buffer (XWINDOW (selected_window
)->contents
);
9227 current_binding
= active_maps (first_event
);
9231 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9235 /* Clicks in non-text areas get prefixed by the symbol
9236 in their CHAR-ADDRESS field. For example, a click on
9237 the mode line is prefixed by the symbol `mode-line'.
9239 Furthermore, key sequences beginning with mouse clicks
9240 are read using the keymaps of the buffer clicked on, not
9241 the current buffer. So we may have to switch the buffer
9244 When we turn one event into two events, we must make sure
9245 that neither of the two looks like the original--so that,
9246 if we replay the events, they won't be expanded again.
9247 If not for this, such reexpansion could happen either here
9248 or when user programs play with this-command-keys. */
9249 if (EVENT_HAS_PARAMETERS (key
))
9251 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9252 if (EQ (kind
, Qmouse_click
))
9254 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9255 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9258 || (!NILP (fake_prefixed_keys
)
9259 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9261 /* We're looking a second time at an event for which
9262 we generated a fake prefix key. Set
9263 last_real_key_start appropriately. */
9265 last_real_key_start
= t
- 1;
9268 if (last_real_key_start
== 0)
9270 /* Key sequences beginning with mouse clicks are
9271 read using the keymaps in the buffer clicked on,
9272 not the current buffer. If we're at the
9273 beginning of a key sequence, switch buffers. */
9274 if (WINDOWP (window
)
9275 && BUFFERP (XWINDOW (window
)->contents
)
9276 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9278 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9283 /* Arrange to go back to the original buffer once we're
9284 done reading the key sequence. Note that we can't
9285 use save_excursion_{save,restore} here, because they
9286 save point as well as the current buffer; we don't
9287 want to save point, because redisplay may change it,
9288 to accommodate a Fset_window_start or something. We
9289 don't want to do this at the top of the function,
9290 because we may get input from a subprocess which
9291 wants to change the selected window and stuff (say,
9293 record_unwind_current_buffer ();
9295 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9297 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9298 goto replay_sequence
;
9302 /* Expand mode-line and scroll-bar events into two events:
9303 use posn as a fake prefix key. */
9305 && (NILP (fake_prefixed_keys
)
9306 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9308 if (bufsize
- t
<= 1)
9309 error ("Key sequence too long");
9312 keybuf
[t
+ 1] = key
;
9315 /* Record that a fake prefix key has been generated
9316 for KEY. Don't modify the event; this would
9317 prevent proper action when the event is pushed
9318 back into unread-command-events. */
9319 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9323 else if (CONSP (XCDR (key
))
9324 && CONSP (EVENT_START (key
))
9325 && CONSP (XCDR (EVENT_START (key
))))
9329 posn
= POSN_POSN (EVENT_START (key
));
9330 /* Handle menu-bar events:
9331 insert the dummy prefix event `menu-bar'. */
9332 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9334 if (bufsize
- t
<= 1)
9335 error ("Key sequence too long");
9337 keybuf
[t
+ 1] = key
;
9339 /* Zap the position in key, so we know that we've
9340 expanded it, and don't try to do so again. */
9341 POSN_SET_POSN (EVENT_START (key
),
9342 Fcons (posn
, Qnil
));
9345 goto replay_sequence
;
9347 else if (CONSP (posn
))
9349 /* We're looking at the second event of a
9350 sequence which we expanded before. Set
9351 last_real_key_start appropriately. */
9352 if (last_real_key_start
== t
&& t
> 0)
9353 last_real_key_start
= t
- 1;
9358 /* We have finally decided that KEY is something we might want
9360 new_binding
= follow_key (current_binding
, key
);
9362 /* If KEY wasn't bound, we'll try some fallbacks. */
9363 if (!NILP (new_binding
))
9364 /* This is needed for the following scenario:
9365 event 0: a down-event that gets dropped by calling replay_key.
9366 event 1: some normal prefix like C-h.
9367 After event 0, first_unbound is 0, after event 1 indec.start,
9368 fkey.start, and keytran.start are all 1, so when we see that
9369 C-h is bound, we need to update first_unbound. */
9370 first_unbound
= max (t
+ 1, first_unbound
);
9375 /* Remember the position to put an upper bound on indec.start. */
9376 first_unbound
= min (t
, first_unbound
);
9378 head
= EVENT_HEAD (key
);
9379 if (help_char_p (head
) && t
> 0)
9381 read_key_sequence_cmd
= Vprefix_help_command
;
9383 last_nonmenu_event
= key
;
9384 /* The Microsoft C compiler can't handle the goto that
9392 Lisp_Object breakdown
;
9395 breakdown
= parse_modifiers (head
);
9396 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9397 /* Attempt to reduce an unbound mouse event to a simpler
9398 event that is bound:
9399 Drags reduce to clicks.
9400 Double-clicks reduce to clicks.
9401 Triple-clicks reduce to double-clicks, then to clicks.
9402 Down-clicks are eliminated.
9403 Double-downs reduce to downs, then are eliminated.
9404 Triple-downs reduce to double-downs, then to downs,
9405 then are eliminated. */
9406 if (modifiers
& (down_modifier
| drag_modifier
9407 | double_modifier
| triple_modifier
))
9409 while (modifiers
& (down_modifier
| drag_modifier
9410 | double_modifier
| triple_modifier
))
9412 Lisp_Object new_head
, new_click
;
9413 if (modifiers
& triple_modifier
)
9414 modifiers
^= (double_modifier
| triple_modifier
);
9415 else if (modifiers
& double_modifier
)
9416 modifiers
&= ~double_modifier
;
9417 else if (modifiers
& drag_modifier
)
9418 modifiers
&= ~drag_modifier
;
9421 /* Dispose of this `down' event by simply jumping
9422 back to replay_key, to get another event.
9424 Note that if this event came from mock input,
9425 then just jumping back to replay_key will just
9426 hand it to us again. So we have to wipe out any
9429 We could delete keybuf[t] and shift everything
9430 after that to the left by one spot, but we'd also
9431 have to fix up any variable that points into
9432 keybuf, and shifting isn't really necessary
9435 Adding prefixes for non-textual mouse clicks
9436 creates two characters of mock input, and both
9437 must be thrown away. If we're only looking at
9438 the prefix now, we can just jump back to
9439 replay_key. On the other hand, if we've already
9440 processed the prefix, and now the actual click
9441 itself is giving us trouble, then we've lost the
9442 state of the keymaps we want to backtrack to, and
9443 we need to replay the whole sequence to rebuild
9446 Beyond that, only function key expansion could
9447 create more than two keys, but that should never
9448 generate mouse events, so it's okay to zero
9449 mock_input in that case too.
9451 FIXME: The above paragraph seems just plain
9452 wrong, if you consider things like
9453 xterm-mouse-mode. -stef
9455 Isn't this just the most wonderful code ever? */
9457 /* If mock_input > t + 1, the above simplification
9458 will actually end up dropping keys on the floor.
9459 This is probably OK for now, but even
9460 if mock_input <= t + 1, we need to adjust indec,
9462 Typical case [header-line down-mouse-N]:
9463 mock_input = 2, t = 1, fkey.end = 1,
9464 last_real_key_start = 0. */
9465 if (indec
.end
> last_real_key_start
)
9467 indec
.end
= indec
.start
9468 = min (last_real_key_start
, indec
.start
);
9469 indec
.map
= indec
.parent
;
9470 if (fkey
.end
> last_real_key_start
)
9472 fkey
.end
= fkey
.start
9473 = min (last_real_key_start
, fkey
.start
);
9474 fkey
.map
= fkey
.parent
;
9475 if (keytran
.end
> last_real_key_start
)
9477 keytran
.end
= keytran
.start
9478 = min (last_real_key_start
, keytran
.start
);
9479 keytran
.map
= keytran
.parent
;
9483 if (t
== last_real_key_start
)
9490 mock_input
= last_real_key_start
;
9491 goto replay_sequence
;
9496 = apply_modifiers (modifiers
, XCAR (breakdown
));
9498 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9500 /* Look for a binding for this new key. */
9501 new_binding
= follow_key (current_binding
, new_click
);
9503 /* If that click is bound, go for it. */
9504 if (!NILP (new_binding
))
9506 current_binding
= new_binding
;
9510 /* Otherwise, we'll leave key set to the drag event. */
9515 current_binding
= new_binding
;
9518 /* Normally, last_nonmenu_event gets the previous key we read.
9519 But when a mouse popup menu is being used,
9520 we don't update last_nonmenu_event; it continues to hold the mouse
9521 event that preceded the first level of menu. */
9522 if (!used_mouse_menu
)
9523 last_nonmenu_event
= key
;
9525 /* Record what part of this_command_keys is the current key sequence. */
9526 this_single_command_key_start
= this_command_key_count
- t
;
9528 /* Look for this sequence in input-decode-map.
9529 Scan from indec.end until we find a bound suffix. */
9530 while (indec
.end
< t
)
9532 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9536 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9537 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9542 mock_input
= diff
+ max (t
, mock_input
);
9543 goto replay_sequence
;
9547 if (!KEYMAPP (current_binding
)
9548 && !test_undefined (current_binding
)
9549 && indec
.start
>= t
)
9550 /* There is a binding and it's not a prefix.
9551 (and it doesn't have any input-decode-map translation pending).
9552 There is thus no function-key in this sequence.
9553 Moving fkey.start is important in this case to allow keytran.start
9554 to go over the sequence before we return (since we keep the
9555 invariant that keytran.end <= fkey.start). */
9558 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9561 /* If the sequence is unbound, see if we can hang a function key
9562 off the end of it. */
9563 /* Continue scan from fkey.end until we find a bound suffix. */
9564 while (fkey
.end
< indec
.start
)
9566 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9570 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9571 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9572 max (t
, mock_input
),
9573 /* If there's a binding (i.e.
9574 first_binding >= nmaps) we don't want
9575 to apply this function-key-mapping. */
9577 && (test_undefined (current_binding
)),
9582 mock_input
= diff
+ max (t
, mock_input
);
9583 /* Adjust the input-decode-map counters. */
9585 indec
.start
+= diff
;
9587 goto replay_sequence
;
9591 /* Look for this sequence in key-translation-map.
9592 Scan from keytran.end until we find a bound suffix. */
9593 while (keytran
.end
< fkey
.start
)
9595 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9599 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9600 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9605 mock_input
= diff
+ max (t
, mock_input
);
9606 /* Adjust the function-key-map and input-decode-map counters. */
9608 indec
.start
+= diff
;
9612 goto replay_sequence
;
9616 /* If KEY is not defined in any of the keymaps,
9617 and cannot be part of a function key or translation,
9618 and is an upper case letter
9619 use the corresponding lower-case letter instead. */
9620 if (NILP (current_binding
)
9621 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9623 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9624 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9625 || (XINT (key
) & shift_modifier
)))
9627 Lisp_Object new_key
;
9629 original_uppercase
= key
;
9630 original_uppercase_position
= t
- 1;
9632 if (XINT (key
) & shift_modifier
)
9633 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9635 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9636 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9638 /* We have to do this unconditionally, regardless of whether
9639 the lower-case char is defined in the keymaps, because they
9640 might get translated through function-key-map. */
9641 keybuf
[t
- 1] = new_key
;
9642 mock_input
= max (t
, mock_input
);
9643 shift_translated
= 1;
9645 goto replay_sequence
;
9647 /* If KEY is not defined in any of the keymaps,
9648 and cannot be part of a function key or translation,
9649 and is a shifted function key,
9650 use the corresponding unshifted function key instead. */
9651 if (NILP (current_binding
)
9652 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9654 Lisp_Object breakdown
= parse_modifiers (key
);
9656 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9658 if (modifiers
& shift_modifier
9659 /* Treat uppercase keys as shifted. */
9661 && (KEY_TO_CHAR (key
)
9662 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9663 && uppercasep (KEY_TO_CHAR (key
))))
9666 = (modifiers
& shift_modifier
9667 ? apply_modifiers (modifiers
& ~shift_modifier
,
9669 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9671 original_uppercase
= key
;
9672 original_uppercase_position
= t
- 1;
9674 /* We have to do this unconditionally, regardless of whether
9675 the lower-case char is defined in the keymaps, because they
9676 might get translated through function-key-map. */
9677 keybuf
[t
- 1] = new_key
;
9678 mock_input
= max (t
, mock_input
);
9679 /* Reset fkey (and consequently keytran) to apply
9680 function-key-map on the result, so that S-backspace is
9681 correctly mapped to DEL (via backspace). OTOH,
9682 input-decode-map doesn't need to go through it again. */
9683 fkey
.start
= fkey
.end
= 0;
9684 keytran
.start
= keytran
.end
= 0;
9685 shift_translated
= 1;
9687 goto replay_sequence
;
9692 read_key_sequence_cmd
= current_binding
;
9693 read_key_sequence_remapped
9694 /* Remap command through active keymaps.
9695 Do the remapping here, before the unbind_to so it uses the keymaps
9696 of the appropriate buffer. */
9697 = SYMBOLP (read_key_sequence_cmd
)
9698 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9701 unread_switch_frame
= delayed_switch_frame
;
9702 unbind_to (count
, Qnil
);
9704 /* Don't downcase the last character if the caller says don't.
9705 Don't downcase it if the result is undefined, either. */
9706 if ((dont_downcase_last
|| NILP (current_binding
))
9708 && t
- 1 == original_uppercase_position
)
9710 keybuf
[t
- 1] = original_uppercase
;
9711 shift_translated
= 0;
9714 if (shift_translated
)
9715 Vthis_command_keys_shift_translated
= Qt
;
9717 /* Occasionally we fabricate events, perhaps by expanding something
9718 according to function-key-map, or by adding a prefix symbol to a
9719 mouse click in the scroll bar or modeline. In this cases, return
9720 the entire generated key sequence, even if we hit an unbound
9721 prefix or a definition before the end. This means that you will
9722 be able to push back the event properly, and also means that
9723 read-key-sequence will always return a logical unit.
9726 for (; t
< mock_input
; t
++)
9728 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9729 && NILP (Fzerop (Vecho_keystrokes
)))
9730 echo_char (keybuf
[t
]);
9731 add_command_key (keybuf
[t
]);
9738 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9739 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9740 The sequence is sufficient to specify a non-prefix command in the
9741 current local and global maps.
9743 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9744 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9745 as a continuation of the previous key.
9747 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9748 convert the last event to lower case. (Normally any upper case event
9749 is converted to lower case if the original event is undefined and the lower
9750 case equivalent is defined.) A non-nil value is appropriate for reading
9751 a key sequence to be defined.
9753 A C-g typed while in this function is treated like any other character,
9754 and `quit-flag' is not set.
9756 If the key sequence starts with a mouse click, then the sequence is read
9757 using the keymaps of the buffer of the window clicked in, not the buffer
9758 of the selected window as normal.
9760 `read-key-sequence' drops unbound button-down events, since you normally
9761 only care about the click or drag events which follow them. If a drag
9762 or multi-click event is unbound, but the corresponding click event would
9763 be bound, `read-key-sequence' turns the event into a click event at the
9764 drag's starting position. This means that you don't have to distinguish
9765 between click and drag, double, or triple events unless you want to.
9767 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9768 lines separating windows, and scroll bars with imaginary keys
9769 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9771 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9772 function will process a switch-frame event if the user switches frames
9773 before typing anything. If the user switches frames in the middle of a
9774 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9775 is nil, then the event will be put off until after the current key sequence.
9777 `read-key-sequence' checks `function-key-map' for function key
9778 sequences, where they wouldn't conflict with ordinary bindings. See
9779 `function-key-map' for more details.
9781 The optional fifth argument CMD-LOOP, if non-nil, means
9782 that this key sequence is being read by something that will
9783 read commands one after another. It should be nil if the caller
9784 will read just one key sequence. */)
9785 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9787 Lisp_Object keybuf
[30];
9789 struct gcpro gcpro1
;
9790 ptrdiff_t count
= SPECPDL_INDEX ();
9793 CHECK_STRING (prompt
);
9796 specbind (Qinput_method_exit_on_first_char
,
9797 (NILP (cmd_loop
) ? Qt
: Qnil
));
9798 specbind (Qinput_method_use_echo_area
,
9799 (NILP (cmd_loop
) ? Qt
: Qnil
));
9801 memset (keybuf
, 0, sizeof keybuf
);
9803 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9805 if (NILP (continue_echo
))
9807 this_command_key_count
= 0;
9808 this_command_key_count_reset
= 0;
9809 this_single_command_key_start
= 0;
9812 #ifdef HAVE_WINDOW_SYSTEM
9813 if (display_hourglass_p
)
9814 cancel_hourglass ();
9817 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9818 prompt
, ! NILP (dont_downcase_last
),
9819 ! NILP (can_return_switch_frame
), 0);
9821 #if 0 /* The following is fine for code reading a key sequence and
9822 then proceeding with a lengthy computation, but it's not good
9823 for code reading keys in a loop, like an input method. */
9824 #ifdef HAVE_WINDOW_SYSTEM
9825 if (display_hourglass_p
)
9836 return unbind_to (count
, make_event_array (i
, keybuf
));
9839 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9840 Sread_key_sequence_vector
, 1, 5, 0,
9841 doc
: /* Like `read-key-sequence' but always return a vector. */)
9842 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9844 Lisp_Object keybuf
[30];
9846 struct gcpro gcpro1
;
9847 ptrdiff_t count
= SPECPDL_INDEX ();
9850 CHECK_STRING (prompt
);
9853 specbind (Qinput_method_exit_on_first_char
,
9854 (NILP (cmd_loop
) ? Qt
: Qnil
));
9855 specbind (Qinput_method_use_echo_area
,
9856 (NILP (cmd_loop
) ? Qt
: Qnil
));
9858 memset (keybuf
, 0, sizeof keybuf
);
9860 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9862 if (NILP (continue_echo
))
9864 this_command_key_count
= 0;
9865 this_command_key_count_reset
= 0;
9866 this_single_command_key_start
= 0;
9869 #ifdef HAVE_WINDOW_SYSTEM
9870 if (display_hourglass_p
)
9871 cancel_hourglass ();
9874 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9875 prompt
, ! NILP (dont_downcase_last
),
9876 ! NILP (can_return_switch_frame
), 0);
9878 #ifdef HAVE_WINDOW_SYSTEM
9879 if (display_hourglass_p
)
9889 return unbind_to (count
, Fvector (i
, keybuf
));
9892 /* Return true if input events are pending. */
9895 detect_input_pending (void)
9897 return input_pending
|| get_input_pending (0);
9900 /* Return true if input events other than mouse movements are
9904 detect_input_pending_ignore_squeezables (void)
9906 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9909 /* Return true if input events are pending, and run any pending timers. */
9912 detect_input_pending_run_timers (bool do_display
)
9914 unsigned old_timers_run
= timers_run
;
9917 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9919 if (old_timers_run
!= timers_run
&& do_display
)
9921 redisplay_preserve_echo_area (8);
9922 /* The following fixes a bug when using lazy-lock with
9923 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9924 from an idle timer function. The symptom of the bug is that
9925 the cursor sometimes doesn't become visible until the next X
9926 event is processed. --gerd. */
9928 Lisp_Object tail
, frame
;
9929 FOR_EACH_FRAME (tail
, frame
)
9930 if (FRAME_RIF (XFRAME (frame
)))
9931 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9935 return input_pending
;
9938 /* This is called in some cases before a possible quit.
9939 It cases the next call to detect_input_pending to recompute input_pending.
9940 So calling this function unnecessarily can't do any harm. */
9943 clear_input_pending (void)
9948 /* Return true if there are pending requeued events.
9949 This isn't used yet. The hope is to make wait_reading_process_output
9950 call it, and return if it runs Lisp code that unreads something.
9951 The problem is, kbd_buffer_get_event needs to be fixed to know what
9952 to do in that case. It isn't trivial. */
9955 requeued_events_pending_p (void)
9957 return (!NILP (Vunread_command_events
));
9961 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9962 doc
: /* Return t if command input is currently available with no wait.
9963 Actually, the value is nil only if we can be sure that no input is available;
9964 if there is a doubt, the value is t. */)
9967 if (!NILP (Vunread_command_events
)
9968 || !NILP (Vunread_post_input_method_events
)
9969 || !NILP (Vunread_input_method_events
))
9972 /* Process non-user-visible events (Bug#10195). */
9973 process_special_events ();
9975 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9976 | READABLE_EVENTS_FILTER_EVENTS
)
9980 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9981 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9984 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9987 if (total_keys
< NUM_RECENT_KEYS
)
9988 return Fvector (total_keys
, keys
);
9991 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9992 vcopy (val
, 0, keys
+ recent_keys_index
,
9993 NUM_RECENT_KEYS
- recent_keys_index
);
9994 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9995 keys
, recent_keys_index
);
10000 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10001 doc
: /* Return the key sequence that invoked this command.
10002 However, if the command has called `read-key-sequence', it returns
10003 the last key sequence that has been read.
10004 The value is a string or a vector.
10006 See also `this-command-keys-vector'. */)
10009 return make_event_array (this_command_key_count
,
10010 XVECTOR (this_command_keys
)->contents
);
10013 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10014 doc
: /* Return the key sequence that invoked this command, as a vector.
10015 However, if the command has called `read-key-sequence', it returns
10016 the last key sequence that has been read.
10018 See also `this-command-keys'. */)
10021 return Fvector (this_command_key_count
,
10022 XVECTOR (this_command_keys
)->contents
);
10025 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10026 Sthis_single_command_keys
, 0, 0, 0,
10027 doc
: /* Return the key sequence that invoked this command.
10028 More generally, it returns the last key sequence read, either by
10029 the command loop or by `read-key-sequence'.
10030 Unlike `this-command-keys', this function's value
10031 does not include prefix arguments.
10032 The value is always a vector. */)
10035 return Fvector (this_command_key_count
10036 - this_single_command_key_start
,
10037 (XVECTOR (this_command_keys
)->contents
10038 + this_single_command_key_start
));
10041 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10042 Sthis_single_command_raw_keys
, 0, 0, 0,
10043 doc
: /* Return the raw events that were read for this command.
10044 More generally, it returns the last key sequence read, either by
10045 the command loop or by `read-key-sequence'.
10046 Unlike `this-single-command-keys', this function's value
10047 shows the events before all translations (except for input methods).
10048 The value is always a vector. */)
10051 return Fvector (raw_keybuf_count
,
10052 (XVECTOR (raw_keybuf
)->contents
));
10055 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10056 Sreset_this_command_lengths
, 0, 0, 0,
10057 doc
: /* Make the unread events replace the last command and echo.
10058 Used in `universal-argument-other-key'.
10060 `universal-argument-other-key' rereads the event just typed.
10061 It then gets translated through `function-key-map'.
10062 The translated event has to replace the real events,
10063 both in the value of (this-command-keys) and in echoing.
10064 To achieve this, `universal-argument-other-key' calls
10065 `reset-this-command-lengths', which discards the record of reading
10066 these events the first time. */)
10069 this_command_key_count
= before_command_key_count
;
10070 if (this_command_key_count
< this_single_command_key_start
)
10071 this_single_command_key_start
= this_command_key_count
;
10073 echo_truncate (before_command_echo_length
);
10075 /* Cause whatever we put into unread-command-events
10076 to echo as if it were being freshly read from the keyboard. */
10077 this_command_key_count_reset
= 1;
10082 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10083 Sclear_this_command_keys
, 0, 1, 0,
10084 doc
: /* Clear out the vector that `this-command-keys' returns.
10085 Also clear the record of the last 100 events, unless optional arg
10086 KEEP-RECORD is non-nil. */)
10087 (Lisp_Object keep_record
)
10091 this_command_key_count
= 0;
10092 this_command_key_count_reset
= 0;
10094 if (NILP (keep_record
))
10096 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10097 ASET (recent_keys
, i
, Qnil
);
10099 recent_keys_index
= 0;
10104 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10105 doc
: /* Return the current depth in recursive edits. */)
10109 /* Wrap around reliably on integer overflow. */
10110 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10111 XSETINT (temp
, sum
);
10115 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10116 "FOpen dribble file: ",
10117 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10118 If FILE is nil, close any open dribble file.
10119 The file will be closed when Emacs exits. */)
10131 file
= Fexpand_file_name (file
, Qnil
);
10132 dribble
= fopen (SSDATA (file
), "w");
10134 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10139 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10140 doc
: /* Discard the contents of the terminal input buffer.
10141 Also end any kbd macro being defined. */)
10144 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10146 /* Discard the last command from the macro. */
10147 Fcancel_kbd_macro_events ();
10151 update_mode_lines
++;
10153 Vunread_command_events
= Qnil
;
10155 discard_tty_input ();
10157 kbd_fetch_ptr
= kbd_store_ptr
;
10163 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10164 doc
: /* Stop Emacs and return to superior process. You can resume later.
10165 If `cannot-suspend' is non-nil, or if the system doesn't support job
10166 control, run a subshell instead.
10168 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10169 to be read as terminal input by Emacs's parent, after suspension.
10171 Before suspending, run the normal hook `suspend-hook'.
10172 After resumption run the normal hook `suspend-resume-hook'.
10174 Some operating systems cannot stop the Emacs process and resume it later.
10175 On such systems, Emacs starts a subshell instead of suspending. */)
10176 (Lisp_Object stuffstring
)
10178 ptrdiff_t count
= SPECPDL_INDEX ();
10179 int old_height
, old_width
;
10181 struct gcpro gcpro1
;
10184 if (tty_list
&& tty_list
->next
)
10185 error ("There are other tty frames open; close them before suspending Emacs");
10187 if (!NILP (stuffstring
))
10188 CHECK_STRING (stuffstring
);
10190 /* Run the functions in suspend-hook. */
10191 hook
= intern ("suspend-hook");
10192 Frun_hooks (1, &hook
);
10194 GCPRO1 (stuffstring
);
10195 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10196 reset_all_sys_modes ();
10197 /* sys_suspend can get an error if it tries to fork a subshell
10198 and the system resources aren't available for that. */
10199 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10201 stuff_buffered_input (stuffstring
);
10202 if (cannot_suspend
)
10206 unbind_to (count
, Qnil
);
10208 /* Check if terminal/window size has changed.
10209 Note that this is not useful when we are running directly
10210 with a window system; but suspend should be disabled in that case. */
10211 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10212 if (width
!= old_width
|| height
!= old_height
)
10213 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10215 /* Run suspend-resume-hook. */
10216 hook
= intern ("suspend-resume-hook");
10217 Frun_hooks (1, &hook
);
10223 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10224 Then in any case stuff anything Emacs has read ahead and not used. */
10227 stuff_buffered_input (Lisp_Object stuffstring
)
10229 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10230 register unsigned char *p
;
10232 if (STRINGP (stuffstring
))
10234 register ptrdiff_t count
;
10236 p
= SDATA (stuffstring
);
10237 count
= SBYTES (stuffstring
);
10238 while (count
-- > 0)
10243 /* Anything we have read ahead, put back for the shell to read. */
10244 /* ?? What should this do when we have multiple keyboards??
10245 Should we ignore anything that was typed in at the "wrong" kboard?
10247 rms: we should stuff everything back into the kboard
10249 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10252 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10253 kbd_fetch_ptr
= kbd_buffer
;
10254 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10255 stuff_char (kbd_fetch_ptr
->code
);
10257 clear_event (kbd_fetch_ptr
);
10261 #endif /* SIGTSTP */
10265 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10267 input_available_clear_time
= time_to_clear
;
10269 /* Tell handle_interrupt to throw back to read_char, */
10270 waiting_for_input
= 1;
10272 /* If handle_interrupt was called before and buffered a C-g,
10273 make it run again now, to avoid timing error. */
10274 if (!NILP (Vquit_flag
))
10275 quit_throw_to_read_char (0);
10279 clear_waiting_for_input (void)
10281 /* Tell handle_interrupt not to throw back to read_char, */
10282 waiting_for_input
= 0;
10283 input_available_clear_time
= 0;
10286 /* The SIGINT handler.
10288 If we have a frame on the controlling tty, we assume that the
10289 SIGINT was generated by C-g, so we call handle_interrupt.
10290 Otherwise, tell QUIT to kill Emacs. */
10293 handle_interrupt_signal (int sig
)
10295 /* See if we have an active terminal on our controlling tty. */
10296 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10299 /* If there are no frames there, let's pretend that we are a
10300 well-behaving UN*X program and quit. We must not call Lisp
10301 in a signal handler, so tell QUIT to exit when it is
10303 Vquit_flag
= Qkill_emacs
;
10307 /* Otherwise, the SIGINT was probably generated by C-g. */
10309 /* Set internal_last_event_frame to the top frame of the
10310 controlling tty, if we have a frame there. We disable the
10311 interrupt key on secondary ttys, so the SIGINT must have come
10312 from the controlling tty. */
10313 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10315 handle_interrupt (1);
10320 deliver_interrupt_signal (int sig
)
10322 deliver_process_signal (sig
, handle_interrupt_signal
);
10326 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10327 of the number of times C-g has been requested. If C-g is pressed
10328 enough times, then quit anyway. See bug#6585. */
10329 static int volatile force_quit_count
;
10331 /* This routine is called at interrupt level in response to C-g.
10333 It is called from the SIGINT handler or kbd_buffer_store_event.
10335 If `waiting_for_input' is non zero, then unless `echoing' is
10336 nonzero, immediately throw back to read_char.
10338 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10339 eval to throw, when it gets a chance. If quit-flag is already
10340 non-nil, it stops the job right away. */
10343 handle_interrupt (bool in_signal_handler
)
10349 /* XXX This code needs to be revised for multi-tty support. */
10350 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10352 if (! in_signal_handler
)
10354 /* If SIGINT isn't blocked, don't let us be interrupted by
10355 a SIGINT. It might be harmful due to non-reentrancy
10356 in I/O functions. */
10358 sigemptyset (&blocked
);
10359 sigaddset (&blocked
, SIGINT
);
10360 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10364 reset_all_sys_modes ();
10368 * On systems which can suspend the current process and return to the original
10369 * shell, this command causes the user to end up back at the shell.
10370 * The "Auto-save" and "Abort" questions are not asked until
10371 * the user elects to return to emacs, at which point he can save the current
10372 * job and either dump core or continue.
10376 /* Perhaps should really fork an inferior shell?
10377 But that would not provide any way to get back
10378 to the original shell, ever. */
10379 printf ("No support for stopping a process on this operating system;\n");
10380 printf ("you can continue or abort.\n");
10381 #endif /* not SIGTSTP */
10383 /* We must remain inside the screen area when the internal terminal
10384 is used. Note that [Enter] is not echoed by dos. */
10385 cursor_to (SELECTED_FRAME (), 0, 0);
10387 /* It doesn't work to autosave while GC is in progress;
10388 the code used for auto-saving doesn't cope with the mark bit. */
10389 if (!gc_in_progress
)
10391 printf ("Auto-save? (y or n) ");
10393 if (((c
= getchar ()) & ~040) == 'Y')
10395 Fdo_auto_save (Qt
, Qnil
);
10397 printf ("\r\nAuto-save done");
10398 #else /* not MSDOS */
10399 printf ("Auto-save done\n");
10400 #endif /* not MSDOS */
10402 while (c
!= '\n') c
= getchar ();
10406 /* During GC, it must be safe to reenable quitting again. */
10407 Vinhibit_quit
= Qnil
;
10410 #endif /* not MSDOS */
10411 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10412 printf ("but will instead do a real quit after garbage collection ends\r\n");
10417 printf ("\r\nAbort? (y or n) ");
10418 #else /* not MSDOS */
10419 printf ("Abort (and dump core)? (y or n) ");
10420 #endif /* not MSDOS */
10422 if (((c
= getchar ()) & ~040) == 'Y')
10424 while (c
!= '\n') c
= getchar ();
10426 printf ("\r\nContinuing...\r\n");
10427 #else /* not MSDOS */
10428 printf ("Continuing...\n");
10429 #endif /* not MSDOS */
10431 init_all_sys_modes ();
10435 /* If executing a function that wants to be interrupted out of
10436 and the user has not deferred quitting by binding `inhibit-quit'
10437 then quit right away. */
10438 if (immediate_quit
&& NILP (Vinhibit_quit
))
10440 struct gl_state_s saved
;
10441 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10443 immediate_quit
= 0;
10444 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10446 GCPRO4 (saved
.object
, saved
.global_code
,
10447 saved
.current_syntax_table
, saved
.old_prop
);
10448 Fsignal (Qquit
, Qnil
);
10453 { /* Else request quit when it's safe. */
10454 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10455 force_quit_count
= count
;
10458 immediate_quit
= 1;
10459 Vinhibit_quit
= Qnil
;
10465 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10467 /* TODO: The longjmp in this call throws the NS event loop integration off,
10468 and it seems to do fine without this. Probably some attention
10469 needs to be paid to the setting of waiting_for_input in
10470 wait_reading_process_output() under HAVE_NS because of the call
10471 to ns_select there (needed because otherwise events aren't picked up
10472 outside of polling since we don't get SIGIO like X and we don't have a
10473 separate event loop thread like W32. */
10475 if (waiting_for_input
&& !echoing
)
10476 quit_throw_to_read_char (in_signal_handler
);
10480 /* Handle a C-g by making read_char return C-g. */
10483 quit_throw_to_read_char (bool from_signal
)
10485 /* When not called from a signal handler it is safe to call
10487 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10488 Fkill_emacs (Qnil
);
10490 /* Prevent another signal from doing this before we finish. */
10491 clear_waiting_for_input ();
10494 Vunread_command_events
= Qnil
;
10496 if (FRAMEP (internal_last_event_frame
)
10497 && !EQ (internal_last_event_frame
, selected_frame
))
10498 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10501 sys_longjmp (getcjmp
, 1);
10504 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10505 Sset_input_interrupt_mode
, 1, 1, 0,
10506 doc
: /* Set interrupt mode of reading keyboard input.
10507 If INTERRUPT is non-nil, Emacs will use input interrupts;
10508 otherwise Emacs uses CBREAK mode.
10510 See also `current-input-mode'. */)
10511 (Lisp_Object interrupt
)
10513 bool new_interrupt_input
;
10514 #ifdef USABLE_SIGIO
10515 #ifdef HAVE_X_WINDOWS
10516 if (x_display_list
!= NULL
)
10518 /* When using X, don't give the user a real choice,
10519 because we haven't implemented the mechanisms to support it. */
10520 new_interrupt_input
= 1;
10523 #endif /* HAVE_X_WINDOWS */
10524 new_interrupt_input
= !NILP (interrupt
);
10525 #else /* not USABLE_SIGIO */
10526 new_interrupt_input
= 0;
10527 #endif /* not USABLE_SIGIO */
10529 if (new_interrupt_input
!= interrupt_input
)
10531 #ifdef POLL_FOR_INPUT
10535 /* this causes startup screen to be restored and messes with the mouse */
10536 reset_all_sys_modes ();
10537 interrupt_input
= new_interrupt_input
;
10538 init_all_sys_modes ();
10540 interrupt_input
= new_interrupt_input
;
10543 #ifdef POLL_FOR_INPUT
10544 poll_suppress_count
= 1;
10551 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10552 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10553 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10554 C-q in key sequences.
10556 This setting only has an effect on tty terminals and only when
10557 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10559 See also `current-input-mode'. */)
10560 (Lisp_Object flow
, Lisp_Object terminal
)
10562 struct terminal
*t
= get_terminal (terminal
, 1);
10563 struct tty_display_info
*tty
;
10564 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10566 tty
= t
->display_info
.tty
;
10568 if (tty
->flow_control
!= !NILP (flow
))
10571 /* This causes startup screen to be restored and messes with the mouse. */
10572 reset_sys_modes (tty
);
10575 tty
->flow_control
= !NILP (flow
);
10578 init_sys_modes (tty
);
10584 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10585 doc
: /* Enable or disable 8-bit input on TERMINAL.
10586 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10587 bit as the Meta modifier.
10589 If META is nil, Emacs will ignore the top bit, on the assumption it is
10592 Otherwise, Emacs will accept and pass through 8-bit input without
10593 specially interpreting the top bit.
10595 This setting only has an effect on tty terminal devices.
10597 Optional parameter TERMINAL specifies the tty terminal device to use.
10598 It may be a terminal object, a frame, or nil for the terminal used by
10599 the currently selected frame.
10601 See also `current-input-mode'. */)
10602 (Lisp_Object meta
, Lisp_Object terminal
)
10604 struct terminal
*t
= get_terminal (terminal
, 1);
10605 struct tty_display_info
*tty
;
10608 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10610 tty
= t
->display_info
.tty
;
10614 else if (EQ (meta
, Qt
))
10619 if (tty
->meta_key
!= new_meta
)
10622 /* this causes startup screen to be restored and messes with the mouse */
10623 reset_sys_modes (tty
);
10626 tty
->meta_key
= new_meta
;
10629 init_sys_modes (tty
);
10635 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10636 doc
: /* Specify character used for quitting.
10637 QUIT must be an ASCII character.
10639 This function only has an effect on the controlling tty of the Emacs
10642 See also `current-input-mode'. */)
10645 struct terminal
*t
= get_named_tty ("/dev/tty");
10646 struct tty_display_info
*tty
;
10647 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10649 tty
= t
->display_info
.tty
;
10651 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10652 error ("QUIT must be an ASCII character");
10655 /* this causes startup screen to be restored and messes with the mouse */
10656 reset_sys_modes (tty
);
10659 /* Don't let this value be out of range. */
10660 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10663 init_sys_modes (tty
);
10669 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10670 doc
: /* Set mode of reading keyboard input.
10671 First arg INTERRUPT non-nil means use input interrupts;
10672 nil means use CBREAK mode.
10673 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10674 (no effect except in CBREAK mode).
10675 Third arg META t means accept 8-bit input (for a Meta key).
10676 META nil means ignore the top bit, on the assumption it is parity.
10677 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10678 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10679 See also `current-input-mode'. */)
10680 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10682 Fset_input_interrupt_mode (interrupt
);
10683 Fset_output_flow_control (flow
, Qnil
);
10684 Fset_input_meta_mode (meta
, Qnil
);
10686 Fset_quit_char (quit
);
10690 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10691 doc
: /* Return information about the way Emacs currently reads keyboard input.
10692 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10693 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10694 nil, Emacs is using CBREAK mode.
10695 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10696 terminal; this does not apply if Emacs uses interrupt-driven input.
10697 META is t if accepting 8-bit input with 8th bit as Meta flag.
10698 META nil means ignoring the top bit, on the assumption it is parity.
10699 META is neither t nor nil if accepting 8-bit input and using
10700 all 8 bits as the character code.
10701 QUIT is the character Emacs currently uses to quit.
10702 The elements of this list correspond to the arguments of
10703 `set-input-mode'. */)
10706 Lisp_Object val
[4];
10707 struct frame
*sf
= XFRAME (selected_frame
);
10709 val
[0] = interrupt_input
? Qt
: Qnil
;
10710 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10712 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10713 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10715 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10722 XSETFASTINT (val
[3], quit_char
);
10724 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10727 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10728 doc
: /* Return position information for pixel coordinates X and Y.
10729 By default, X and Y are relative to text area of the selected window.
10730 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10731 If optional fourth arg WHOLE is non-nil, X is relative to the left
10732 edge of the window.
10734 The return value is similar to a mouse click position:
10735 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10736 IMAGE (DX . DY) (WIDTH . HEIGHT))
10737 The `posn-' functions access elements of such lists. */)
10738 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10743 if (NILP (frame_or_window
))
10744 frame_or_window
= selected_window
;
10746 if (WINDOWP (frame_or_window
))
10748 struct window
*w
= decode_live_window (frame_or_window
);
10750 XSETINT (x
, (XINT (x
)
10751 + WINDOW_LEFT_EDGE_X (w
)
10753 ? window_box_left_offset (w
, TEXT_AREA
)
10755 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10756 frame_or_window
= w
->frame
;
10759 CHECK_LIVE_FRAME (frame_or_window
);
10761 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10764 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10765 doc
: /* Return position information for buffer POS in WINDOW.
10766 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10768 Return nil if position is not visible in window. Otherwise,
10769 the return value is similar to that returned by `event-start' for
10770 a mouse click at the upper left corner of the glyph corresponding
10771 to the given buffer position:
10772 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10773 IMAGE (DX . DY) (WIDTH . HEIGHT))
10774 The `posn-' functions access elements of such lists. */)
10775 (Lisp_Object pos
, Lisp_Object window
)
10780 window
= selected_window
;
10782 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10785 Lisp_Object x
= XCAR (tem
);
10786 Lisp_Object y
= XCAR (XCDR (tem
));
10788 /* Point invisible due to hscrolling? */
10791 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10799 * Set up a new kboard object with reasonable initial values.
10802 init_kboard (KBOARD
*kb
)
10804 kset_overriding_terminal_local_map (kb
, Qnil
);
10805 kset_last_command (kb
, Qnil
);
10806 kset_real_last_command (kb
, Qnil
);
10807 kset_keyboard_translate_table (kb
, Qnil
);
10808 kset_last_repeatable_command (kb
, Qnil
);
10809 kset_prefix_arg (kb
, Qnil
);
10810 kset_last_prefix_arg (kb
, Qnil
);
10811 kset_kbd_queue (kb
, Qnil
);
10812 kb
->kbd_queue_has_data
= 0;
10813 kb
->immediate_echo
= 0;
10814 kset_echo_string (kb
, Qnil
);
10815 kb
->echo_after_prompt
= -1;
10816 kb
->kbd_macro_buffer
= 0;
10817 kb
->kbd_macro_bufsize
= 0;
10818 kset_defining_kbd_macro (kb
, Qnil
);
10819 kset_last_kbd_macro (kb
, Qnil
);
10820 kb
->reference_count
= 0;
10821 kset_system_key_alist (kb
, Qnil
);
10822 kset_system_key_syms (kb
, Qnil
);
10823 kset_window_system (kb
, Qt
); /* Unset. */
10824 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10825 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10826 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10827 kset_default_minibuffer_frame (kb
, Qnil
);
10831 * Destroy the contents of a kboard object, but not the object itself.
10832 * We use this just before deleting it, or if we're going to initialize
10833 * it a second time.
10836 wipe_kboard (KBOARD
*kb
)
10838 xfree (kb
->kbd_macro_buffer
);
10841 /* Free KB and memory referenced from it. */
10844 delete_kboard (KBOARD
*kb
)
10848 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10851 *kbp
= kb
->next_kboard
;
10853 /* Prevent a dangling reference to KB. */
10854 if (kb
== current_kboard
10855 && FRAMEP (selected_frame
)
10856 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10858 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10860 if (current_kboard
== kb
)
10869 init_keyboard (void)
10871 /* This is correct before outermost invocation of the editor loop. */
10872 command_loop_level
= -1;
10873 immediate_quit
= 0;
10874 quit_char
= Ctl ('g');
10875 Vunread_command_events
= Qnil
;
10876 timer_idleness_start_time
= invalid_emacs_time ();
10878 recent_keys_index
= 0;
10879 kbd_fetch_ptr
= kbd_buffer
;
10880 kbd_store_ptr
= kbd_buffer
;
10881 do_mouse_tracking
= Qnil
;
10883 interrupt_input_blocked
= 0;
10884 pending_signals
= 0;
10886 /* This means that command_loop_1 won't try to select anything the first
10888 internal_last_event_frame
= Qnil
;
10889 Vlast_event_frame
= internal_last_event_frame
;
10891 current_kboard
= initial_kboard
;
10892 /* Re-initialize the keyboard again. */
10893 wipe_kboard (current_kboard
);
10894 init_kboard (current_kboard
);
10895 /* A value of nil for Vwindow_system normally means a tty, but we also use
10896 it for the initial terminal since there is no window system there. */
10897 kset_window_system (current_kboard
, Qnil
);
10899 if (!noninteractive
)
10901 /* Before multi-tty support, these handlers used to be installed
10902 only if the current session was a tty session. Now an Emacs
10903 session may have multiple display types, so we always handle
10904 SIGINT. There is special code in handle_interrupt_signal to exit
10905 Emacs on SIGINT when there are no termcap frames on the
10906 controlling terminal. */
10907 struct sigaction action
;
10908 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10909 sigaction (SIGINT
, &action
, 0);
10911 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10912 SIGQUIT and we can't tell which one it will give us. */
10913 sigaction (SIGQUIT
, &action
, 0);
10914 #endif /* not DOS_NT */
10916 #ifdef USABLE_SIGIO
10917 if (!noninteractive
)
10919 struct sigaction action
;
10920 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10921 sigaction (SIGIO
, &action
, 0);
10925 /* Use interrupt input by default, if it works and noninterrupt input
10926 has deficiencies. */
10928 #ifdef INTERRUPT_INPUT
10929 interrupt_input
= 1;
10931 interrupt_input
= 0;
10934 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10937 if (keyboard_init_hook
)
10938 (*keyboard_init_hook
) ();
10940 #ifdef POLL_FOR_INPUT
10942 poll_suppress_count
= 1;
10947 /* This type's only use is in syms_of_keyboard, to initialize the
10948 event header symbols and put properties on them. */
10949 struct event_head
{
10955 static const struct event_head head_table
[] = {
10956 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10957 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10958 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10959 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10960 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10961 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10962 /* `select-window' should be handled just like `switch-frame'
10963 in read_key_sequence. */
10964 {&Qselect_window
, "select-window", &Qswitch_frame
}
10968 syms_of_keyboard (void)
10970 pending_funcalls
= Qnil
;
10971 staticpro (&pending_funcalls
);
10973 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10974 staticpro (&Vlispy_mouse_stem
);
10977 DEFSYM (QCimage
, ":image");
10978 DEFSYM (Qhelp_echo
, "help-echo");
10979 DEFSYM (QCrtl
, ":rtl");
10981 staticpro (&item_properties
);
10982 item_properties
= Qnil
;
10984 staticpro (&tool_bar_item_properties
);
10985 tool_bar_item_properties
= Qnil
;
10986 staticpro (&tool_bar_items_vector
);
10987 tool_bar_items_vector
= Qnil
;
10989 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10990 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10991 DEFSYM (Qself_insert_command
, "self-insert-command");
10992 DEFSYM (Qforward_char
, "forward-char");
10993 DEFSYM (Qbackward_char
, "backward-char");
10994 DEFSYM (Qdisabled
, "disabled");
10995 DEFSYM (Qundefined
, "undefined");
10996 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10997 DEFSYM (Qpost_command_hook
, "post-command-hook");
10998 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10999 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11000 DEFSYM (Qfunction_key
, "function-key");
11001 DEFSYM (Qmouse_click
, "mouse-click");
11002 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11003 DEFSYM (Qsave_session
, "save-session");
11004 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11005 DEFSYM (Qmenu_enable
, "menu-enable");
11008 DEFSYM (Qlanguage_change
, "language-change");
11012 DEFSYM (Qdbus_event
, "dbus-event");
11015 #ifdef USE_FILE_NOTIFY
11016 DEFSYM (Qfile_notify
, "file-notify");
11017 #endif /* USE_FILE_NOTIFY */
11019 DEFSYM (QCenable
, ":enable");
11020 DEFSYM (QCvisible
, ":visible");
11021 DEFSYM (QChelp
, ":help");
11022 DEFSYM (QCfilter
, ":filter");
11023 DEFSYM (QCbutton
, ":button");
11024 DEFSYM (QCkeys
, ":keys");
11025 DEFSYM (QCkey_sequence
, ":key-sequence");
11026 DEFSYM (QCtoggle
, ":toggle");
11027 DEFSYM (QCradio
, ":radio");
11028 DEFSYM (QClabel
, ":label");
11029 DEFSYM (QCvert_only
, ":vert-only");
11031 DEFSYM (Qmode_line
, "mode-line");
11032 DEFSYM (Qvertical_line
, "vertical-line");
11033 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11034 DEFSYM (Qmenu_bar
, "menu-bar");
11036 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11038 DEFSYM (Qabove_handle
, "above-handle");
11039 DEFSYM (Qhandle
, "handle");
11040 DEFSYM (Qbelow_handle
, "below-handle");
11041 DEFSYM (Qup
, "up");
11042 DEFSYM (Qdown
, "down");
11043 DEFSYM (Qtop
, "top");
11044 DEFSYM (Qbottom
, "bottom");
11045 DEFSYM (Qend_scroll
, "end-scroll");
11046 DEFSYM (Qratio
, "ratio");
11048 DEFSYM (Qevent_kind
, "event-kind");
11049 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11050 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11051 DEFSYM (Qmodifier_cache
, "modifier-cache");
11053 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11054 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11056 DEFSYM (Qpolling_period
, "polling-period");
11058 DEFSYM (Qx_set_selection
, "x-set-selection");
11059 DEFSYM (QPRIMARY
, "PRIMARY");
11060 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11061 DEFSYM (Qhandle_select_window
, "handle-select-window");
11063 DEFSYM (Qinput_method_function
, "input-method-function");
11064 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11065 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11067 DEFSYM (Qhelp_form_show
, "help-form-show");
11069 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11070 Fset (Qinput_method_use_echo_area
, Qnil
);
11074 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11076 for (i
= 0; i
< len
; i
++)
11078 const struct event_head
*p
= &head_table
[i
];
11079 *p
->var
= intern_c_string (p
->name
);
11080 staticpro (p
->var
);
11081 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11082 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11086 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11087 staticpro (&button_down_location
);
11088 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11089 staticpro (&mouse_syms
);
11090 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11091 / sizeof (lispy_wheel_names
[0])),
11093 staticpro (&wheel_syms
);
11097 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11099 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11100 for (i
= 0; i
< len
; i
++)
11101 if (modifier_names
[i
])
11102 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11103 staticpro (&modifier_symbols
);
11106 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11107 staticpro (&recent_keys
);
11109 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11110 staticpro (&this_command_keys
);
11112 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11113 staticpro (&raw_keybuf
);
11115 DEFSYM (Qcommand_execute
, "command-execute");
11117 accent_key_syms
= Qnil
;
11118 staticpro (&accent_key_syms
);
11120 func_key_syms
= Qnil
;
11121 staticpro (&func_key_syms
);
11123 drag_n_drop_syms
= Qnil
;
11124 staticpro (&drag_n_drop_syms
);
11126 unread_switch_frame
= Qnil
;
11127 staticpro (&unread_switch_frame
);
11129 internal_last_event_frame
= Qnil
;
11130 staticpro (&internal_last_event_frame
);
11132 read_key_sequence_cmd
= Qnil
;
11133 staticpro (&read_key_sequence_cmd
);
11134 read_key_sequence_remapped
= Qnil
;
11135 staticpro (&read_key_sequence_remapped
);
11137 menu_bar_one_keymap_changed_items
= Qnil
;
11138 staticpro (&menu_bar_one_keymap_changed_items
);
11140 menu_bar_items_vector
= Qnil
;
11141 staticpro (&menu_bar_items_vector
);
11143 help_form_saved_window_configs
= Qnil
;
11144 staticpro (&help_form_saved_window_configs
);
11146 defsubr (&Scurrent_idle_time
);
11147 defsubr (&Sevent_symbol_parse_modifiers
);
11148 defsubr (&Sevent_convert_list
);
11149 defsubr (&Sread_key_sequence
);
11150 defsubr (&Sread_key_sequence_vector
);
11151 defsubr (&Srecursive_edit
);
11152 defsubr (&Strack_mouse
);
11153 defsubr (&Sinput_pending_p
);
11154 defsubr (&Srecent_keys
);
11155 defsubr (&Sthis_command_keys
);
11156 defsubr (&Sthis_command_keys_vector
);
11157 defsubr (&Sthis_single_command_keys
);
11158 defsubr (&Sthis_single_command_raw_keys
);
11159 defsubr (&Sreset_this_command_lengths
);
11160 defsubr (&Sclear_this_command_keys
);
11161 defsubr (&Ssuspend_emacs
);
11162 defsubr (&Sabort_recursive_edit
);
11163 defsubr (&Sexit_recursive_edit
);
11164 defsubr (&Srecursion_depth
);
11165 defsubr (&Stop_level
);
11166 defsubr (&Sdiscard_input
);
11167 defsubr (&Sopen_dribble_file
);
11168 defsubr (&Sset_input_interrupt_mode
);
11169 defsubr (&Sset_output_flow_control
);
11170 defsubr (&Sset_input_meta_mode
);
11171 defsubr (&Sset_quit_char
);
11172 defsubr (&Sset_input_mode
);
11173 defsubr (&Scurrent_input_mode
);
11174 defsubr (&Sposn_at_point
);
11175 defsubr (&Sposn_at_x_y
);
11177 DEFVAR_LISP ("last-command-event", last_command_event
,
11178 doc
: /* Last input event that was part of a command. */);
11180 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11181 doc
: /* Last input event in a command, except for mouse menu events.
11182 Mouse menus give back keys that don't look like mouse events;
11183 this variable holds the actual mouse event that led to the menu,
11184 so that you can determine whether the command was run by mouse or not. */);
11186 DEFVAR_LISP ("last-input-event", last_input_event
,
11187 doc
: /* Last input event. */);
11189 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11190 doc
: /* List of events to be read as the command input.
11191 These events are processed first, before actual keyboard input.
11192 Events read from this list are not normally added to `this-command-keys',
11193 as they will already have been added once as they were read for the first time.
11194 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11195 Vunread_command_events
= Qnil
;
11197 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11198 doc
: /* List of events to be processed as input by input methods.
11199 These events are processed before `unread-command-events'
11200 and actual keyboard input, but are not given to `input-method-function'. */);
11201 Vunread_post_input_method_events
= Qnil
;
11203 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11204 doc
: /* List of events to be processed as input by input methods.
11205 These events are processed after `unread-command-events', but
11206 before actual keyboard input.
11207 If there's an active input method, the events are given to
11208 `input-method-function'. */);
11209 Vunread_input_method_events
= Qnil
;
11211 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11212 doc
: /* Meta-prefix character code.
11213 Meta-foo as command input turns into this character followed by foo. */);
11214 XSETINT (meta_prefix_char
, 033);
11216 DEFVAR_KBOARD ("last-command", Vlast_command
,
11217 doc
: /* The last command executed.
11218 Normally a symbol with a function definition, but can be whatever was found
11219 in the keymap, or whatever the variable `this-command' was set to by that
11222 The value `mode-exit' is special; it means that the previous command
11223 read an event that told it to exit, and it did so and unread that event.
11224 In other words, the present command is the event that made the previous
11227 The value `kill-region' is special; it means that the previous command
11228 was a kill command.
11230 `last-command' has a separate binding for each terminal device.
11231 See Info node `(elisp)Multiple Terminals'. */);
11233 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11234 doc
: /* Same as `last-command', but never altered by Lisp code.
11235 Taken from the previous value of `real-this-command'. */);
11237 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11238 doc
: /* Last command that may be repeated.
11239 The last command executed that was not bound to an input event.
11240 This is the command `repeat' will try to repeat.
11241 Taken from a previous value of `real-this-command'. */);
11243 DEFVAR_LISP ("this-command", Vthis_command
,
11244 doc
: /* The command now being executed.
11245 The command can set this variable; whatever is put here
11246 will be in `last-command' during the following command. */);
11247 Vthis_command
= Qnil
;
11249 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11250 doc
: /* This is like `this-command', except that commands should never modify it. */);
11251 Vreal_this_command
= Qnil
;
11253 DEFVAR_LISP ("this-command-keys-shift-translated",
11254 Vthis_command_keys_shift_translated
,
11255 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11256 Shift-translation occurs when there is no binding for the key sequence
11257 as entered, but a binding was found by changing an upper-case letter
11258 to lower-case, or a shifted function key to an unshifted one. */);
11259 Vthis_command_keys_shift_translated
= Qnil
;
11261 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11262 doc
: /* The command bound to the current key sequence before remapping.
11263 It equals `this-command' if the original command was not remapped through
11264 any of the active keymaps. Otherwise, the value of `this-command' is the
11265 result of looking up the original command in the active keymaps. */);
11266 Vthis_original_command
= Qnil
;
11268 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11269 doc
: /* Number of input events between auto-saves.
11270 Zero means disable autosaving due to number of characters typed. */);
11271 auto_save_interval
= 300;
11273 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11274 doc
: /* Number of seconds idle time before auto-save.
11275 Zero or nil means disable auto-saving due to idleness.
11276 After auto-saving due to this many seconds of idle time,
11277 Emacs also does a garbage collection if that seems to be warranted. */);
11278 XSETFASTINT (Vauto_save_timeout
, 30);
11280 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11281 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11282 The value may be integer or floating point.
11283 If the value is zero, don't echo at all. */);
11284 Vecho_keystrokes
= make_number (1);
11286 DEFVAR_INT ("polling-period", polling_period
,
11287 doc
: /* Interval between polling for input during Lisp execution.
11288 The reason for polling is to make C-g work to stop a running program.
11289 Polling is needed only when using X windows and SIGIO does not work.
11290 Polling is automatically disabled in all other cases. */);
11291 polling_period
= 2;
11293 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11294 doc
: /* Maximum time between mouse clicks to make a double-click.
11295 Measured in milliseconds. The value nil means disable double-click
11296 recognition; t means double-clicks have no time limit and are detected
11297 by position only. */);
11298 Vdouble_click_time
= make_number (500);
11300 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11301 doc
: /* Maximum mouse movement between clicks to make a double-click.
11302 On window-system frames, value is the number of pixels the mouse may have
11303 moved horizontally or vertically between two clicks to make a double-click.
11304 On non window-system frames, value is interpreted in units of 1/8 characters
11307 This variable is also the threshold for motion of the mouse
11308 to count as a drag. */);
11309 double_click_fuzz
= 3;
11311 DEFVAR_INT ("num-input-keys", num_input_keys
,
11312 doc
: /* Number of complete key sequences read as input so far.
11313 This includes key sequences read from keyboard macros.
11314 The number is effectively the number of interactive command invocations. */);
11315 num_input_keys
= 0;
11317 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11318 doc
: /* Number of input events read from the keyboard so far.
11319 This does not include events generated by keyboard macros. */);
11320 num_nonmacro_input_events
= 0;
11322 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11323 doc
: /* The frame in which the most recently read event occurred.
11324 If the last event came from a keyboard macro, this is set to `macro'. */);
11325 Vlast_event_frame
= Qnil
;
11327 /* This variable is set up in sysdep.c. */
11328 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11329 doc
: /* The ERASE character as set by the user with stty. */);
11331 DEFVAR_LISP ("help-char", Vhelp_char
,
11332 doc
: /* Character to recognize as meaning Help.
11333 When it is read, do `(eval help-form)', and display result if it's a string.
11334 If the value of `help-form' is nil, this char can be read normally. */);
11335 XSETINT (Vhelp_char
, Ctl ('H'));
11337 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11338 doc
: /* List of input events to recognize as meaning Help.
11339 These work just like the value of `help-char' (see that). */);
11340 Vhelp_event_list
= Qnil
;
11342 DEFVAR_LISP ("help-form", Vhelp_form
,
11343 doc
: /* Form to execute when character `help-char' is read.
11344 If the form returns a string, that string is displayed.
11345 If `help-form' is nil, the help char is not recognized. */);
11348 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11349 doc
: /* Command to run when `help-char' character follows a prefix key.
11350 This command is used only when there is no actual binding
11351 for that character after that prefix key. */);
11352 Vprefix_help_command
= Qnil
;
11354 DEFVAR_LISP ("top-level", Vtop_level
,
11355 doc
: /* Form to evaluate when Emacs starts up.
11356 Useful to set before you dump a modified Emacs. */);
11359 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11360 doc
: /* Translate table for local keyboard input, or nil.
11361 If non-nil, the value should be a char-table. Each character read
11362 from the keyboard is looked up in this char-table. If the value found
11363 there is non-nil, then it is used instead of the actual input character.
11365 The value can also be a string or vector, but this is considered obsolete.
11366 If it is a string or vector of length N, character codes N and up are left
11367 untranslated. In a vector, an element which is nil means "no translation".
11369 This is applied to the characters supplied to input methods, not their
11370 output. See also `translation-table-for-input'.
11372 This variable has a separate binding for each terminal.
11373 See Info node `(elisp)Multiple Terminals'. */);
11375 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11376 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11377 \(Even if the operating system has support for stopping a process.\) */);
11378 cannot_suspend
= 0;
11380 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11381 doc
: /* Non-nil means prompt with menus when appropriate.
11382 This is done when reading from a keymap that has a prompt string,
11383 for elements that have prompt strings.
11384 The menu is displayed on the screen
11385 if X menus were enabled at configuration
11386 time and the previous event was a mouse click prefix key.
11387 Otherwise, menu prompting uses the echo area. */);
11388 menu_prompting
= 1;
11390 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11391 doc
: /* Character to see next line of menu prompt.
11392 Type this character while in a menu prompt to rotate around the lines of it. */);
11393 XSETINT (menu_prompt_more_char
, ' ');
11395 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11396 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11397 Emacs applies the modifiers of the character stored here to each keyboard
11398 character it reads. For example, after evaluating the expression
11399 (setq extra-keyboard-modifiers ?\\C-x)
11400 all input characters will have the control modifier applied to them.
11402 Note that the character ?\\C-@, equivalent to the integer zero, does
11403 not count as a control character; rather, it counts as a character
11404 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11405 cancels any modification. */);
11406 extra_keyboard_modifiers
= 0;
11408 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11409 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11410 The command loop sets this to nil before each command,
11411 and tests the value when the command returns.
11412 Buffer modification stores t in this variable. */);
11413 Vdeactivate_mark
= Qnil
;
11414 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11416 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11417 doc
: /* Normal hook run before each command is executed.
11418 If an unhandled error happens in running this hook,
11419 the function in which the error occurred is unconditionally removed, since
11420 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11421 Vpre_command_hook
= Qnil
;
11423 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11424 doc
: /* Normal hook run after each command is executed.
11425 If an unhandled error happens in running this hook,
11426 the function in which the error occurred is unconditionally removed, since
11427 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11428 Vpost_command_hook
= Qnil
;
11431 DEFVAR_LISP ("echo-area-clear-hook", ...,
11432 doc
: /* Normal hook run when clearing the echo area. */);
11434 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11435 Fset (Qecho_area_clear_hook
, Qnil
);
11437 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11438 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11439 Vlucid_menu_bar_dirty_flag
= Qnil
;
11441 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11442 doc
: /* List of menu bar items to move to the end of the menu bar.
11443 The elements of the list are event types that may have menu bar bindings. */);
11444 Vmenu_bar_final_items
= Qnil
;
11446 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11447 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11448 This is used internally by graphical displays that do not render
11449 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11450 Vtool_bar_separator_image_expression
= Qnil
;
11452 DEFVAR_KBOARD ("overriding-terminal-local-map",
11453 Voverriding_terminal_local_map
,
11454 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11456 This variable is intended to let commands such as `universal-argument'
11457 set up a different keymap for reading the next command.
11459 `overriding-terminal-local-map' has a separate binding for each
11461 See Info node `(elisp)Multiple Terminals'. */);
11463 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11464 doc
: /* Keymap that overrides almost all other local keymaps.
11465 If this variable is non-nil, it is used as a keymap--replacing the
11466 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11467 Voverriding_local_map
= Qnil
;
11469 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11470 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11471 Otherwise, the menu bar continues to reflect the buffer's local map
11472 and the minor mode maps regardless of `overriding-local-map'. */);
11473 Voverriding_local_map_menu_flag
= Qnil
;
11475 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11476 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11477 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11479 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11480 doc
: /* Non-nil means generate motion events for mouse motion. */);
11482 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11483 doc
: /* Alist of system-specific X windows key symbols.
11484 Each element should have the form (N . SYMBOL) where N is the
11485 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11486 and SYMBOL is its name.
11488 `system-key-alist' has a separate binding for each terminal device.
11489 See Info node `(elisp)Multiple Terminals'. */);
11491 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11492 doc
: /* Keymap that translates key sequences to key sequences during input.
11493 This is used mainly for mapping key sequences into some preferred
11494 key events (symbols).
11496 The `read-key-sequence' function replaces any subsequence bound by
11497 `local-function-key-map' with its binding. More precisely, when the
11498 active keymaps have no binding for the current key sequence but
11499 `local-function-key-map' binds a suffix of the sequence to a vector or
11500 string, `read-key-sequence' replaces the matching suffix with its
11501 binding, and continues with the new sequence.
11503 If the binding is a function, it is called with one argument (the prompt)
11504 and its return value (a key sequence) is used.
11506 The events that come from bindings in `local-function-key-map' are not
11507 themselves looked up in `local-function-key-map'.
11509 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11510 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11511 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11512 typing `ESC O P x' would return [f1 x].
11514 `local-function-key-map' has a separate binding for each terminal
11515 device. See Info node `(elisp)Multiple Terminals'. If you need to
11516 define a binding on all terminals, change `function-key-map'
11517 instead. Initially, `local-function-key-map' is an empty keymap that
11518 has `function-key-map' as its parent on all terminal devices. */);
11520 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11521 doc
: /* Keymap that decodes input escape sequences.
11522 This is used mainly for mapping ASCII function key sequences into
11523 real Emacs function key events (symbols).
11525 The `read-key-sequence' function replaces any subsequence bound by
11526 `input-decode-map' with its binding. Contrary to `function-key-map',
11527 this map applies its rebinding regardless of the presence of an ordinary
11528 binding. So it is more like `key-translation-map' except that it applies
11529 before `function-key-map' rather than after.
11531 If the binding is a function, it is called with one argument (the prompt)
11532 and its return value (a key sequence) is used.
11534 The events that come from bindings in `input-decode-map' are not
11535 themselves looked up in `input-decode-map'. */);
11537 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11538 doc
: /* The parent keymap of all `local-function-key-map' instances.
11539 Function key definitions that apply to all terminal devices should go
11540 here. If a mapping is defined in both the current
11541 `local-function-key-map' binding and this variable, then the local
11542 definition will take precedence. */);
11543 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11545 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11546 doc
: /* Keymap of key translations that can override keymaps.
11547 This keymap works like `input-decode-map', but comes after `function-key-map'.
11548 Another difference is that it is global rather than terminal-local. */);
11549 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11551 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11552 doc
: /* List of deferred actions to be performed at a later time.
11553 The precise format isn't relevant here; we just check whether it is nil. */);
11554 Vdeferred_action_list
= Qnil
;
11556 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11557 doc
: /* Function to call to handle deferred actions, after each command.
11558 This function is called with no arguments after each command
11559 whenever `deferred-action-list' is non-nil. */);
11560 Vdeferred_action_function
= Qnil
;
11562 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11563 doc
: /* List of warnings to be displayed after this command.
11564 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11565 as per the args of `display-warning' (which see).
11566 If this variable is non-nil, `delayed-warnings-hook' will be run
11567 immediately after running `post-command-hook'. */);
11568 Vdelayed_warnings_list
= Qnil
;
11570 DEFVAR_LISP ("timer-list", Vtimer_list
,
11571 doc
: /* List of active absolute time timers in order of increasing time. */);
11572 Vtimer_list
= Qnil
;
11574 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11575 doc
: /* List of active idle-time timers in order of increasing time. */);
11576 Vtimer_idle_list
= Qnil
;
11578 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11579 doc
: /* If non-nil, the function that implements the current input method.
11580 It's called with one argument, a printing character that was just read.
11581 \(That means a character with code 040...0176.)
11582 Typically this function uses `read-event' to read additional events.
11583 When it does so, it should first bind `input-method-function' to nil
11584 so it will not be called recursively.
11586 The function should return a list of zero or more events
11587 to be used as input. If it wants to put back some events
11588 to be reconsidered, separately, by the input method,
11589 it can add them to the beginning of `unread-command-events'.
11591 The input method function can find in `input-method-previous-message'
11592 the previous echo area message.
11594 The input method function should refer to the variables
11595 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11596 for guidance on what to do. */);
11597 Vinput_method_function
= Qnil
;
11599 DEFVAR_LISP ("input-method-previous-message",
11600 Vinput_method_previous_message
,
11601 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11602 This variable exists because `read-event' clears the echo area
11603 before running the input method. It is nil if there was no message. */);
11604 Vinput_method_previous_message
= Qnil
;
11606 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11607 doc
: /* If non-nil, the function that implements the display of help.
11608 It's called with one argument, the help string to display. */);
11609 Vshow_help_function
= Qnil
;
11611 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11612 doc
: /* If non-nil, suppress point adjustment after executing a command.
11614 After a command is executed, if point is moved into a region that has
11615 special properties (e.g. composition, display), we adjust point to
11616 the boundary of the region. But, when a command sets this variable to
11617 non-nil, we suppress the point adjustment.
11619 This variable is set to nil before reading a command, and is checked
11620 just after executing the command. */);
11621 Vdisable_point_adjustment
= Qnil
;
11623 DEFVAR_LISP ("global-disable-point-adjustment",
11624 Vglobal_disable_point_adjustment
,
11625 doc
: /* If non-nil, always suppress point adjustment.
11627 The default value is nil, in which case, point adjustment are
11628 suppressed only after special commands that set
11629 `disable-point-adjustment' (which see) to non-nil. */);
11630 Vglobal_disable_point_adjustment
= Qnil
;
11632 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11633 doc
: /* How long to display an echo-area message when the minibuffer is active.
11634 If the value is not a number, such messages don't time out. */);
11635 Vminibuffer_message_timeout
= make_number (2);
11637 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11638 doc
: /* If non-nil, any keyboard input throws to this symbol.
11639 The value of that variable is passed to `quit-flag' and later causes a
11640 peculiar kind of quitting. */);
11641 Vthrow_on_input
= Qnil
;
11643 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11644 doc
: /* If non-nil, function to output error messages.
11645 The arguments are the error data, a list of the form
11646 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11647 such as just as `condition-case' would bind its variable to,
11648 the context (a string which normally goes at the start of the message),
11649 and the Lisp function within which the error was signaled. */);
11650 Vcommand_error_function
= Qnil
;
11652 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11653 Venable_disabled_menus_and_buttons
,
11654 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11656 Help functions bind this to allow help on disabled menu items
11657 and tool-bar buttons. */);
11658 Venable_disabled_menus_and_buttons
= Qnil
;
11660 DEFVAR_LISP ("select-active-regions",
11661 Vselect_active_regions
,
11662 doc
: /* If non-nil, an active region automatically sets the primary selection.
11663 If the value is `only', only temporarily active regions (usually made
11664 by mouse-dragging or shift-selection) set the window selection.
11666 This takes effect only when Transient Mark mode is enabled. */);
11667 Vselect_active_regions
= Qt
;
11669 DEFVAR_LISP ("saved-region-selection",
11670 Vsaved_region_selection
,
11671 doc
: /* Contents of active region prior to buffer modification.
11672 If `select-active-regions' is non-nil, Emacs sets this to the
11673 text in the region before modifying the buffer. The next call to
11674 the function `deactivate-mark' uses this to set the window selection. */);
11675 Vsaved_region_selection
= Qnil
;
11677 DEFVAR_LISP ("selection-inhibit-update-commands",
11678 Vselection_inhibit_update_commands
,
11679 doc
: /* List of commands which should not update the selection.
11680 Normally, if `select-active-regions' is non-nil and the mark remains
11681 active after a command (i.e. the mark was not deactivated), the Emacs
11682 command loop sets the selection to the text in the region. However,
11683 if the command is in this list, the selection is not updated. */);
11684 Vselection_inhibit_update_commands
11685 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11687 DEFVAR_LISP ("debug-on-event",
11689 doc
: /* Enter debugger on this event. When Emacs
11690 receives the special event specified by this variable, it will try to
11691 break into the debugger as soon as possible instead of processing the
11692 event normally through `special-event-map'.
11694 Currently, the only supported values for this
11695 variable are `sigusr1' and `sigusr2'. */);
11696 Vdebug_on_event
= intern_c_string ("sigusr2");
11698 /* Create the initial keyboard. */
11699 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11700 init_kboard (initial_kboard
);
11701 /* Vwindow_system is left at t for now. */
11702 initial_kboard
->next_kboard
= all_kboards
;
11703 all_kboards
= initial_kboard
;
11707 keys_of_keyboard (void)
11709 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11710 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11711 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11712 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11713 initial_define_key (meta_map
, 'x', "execute-extended-command");
11715 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11716 "handle-delete-frame");
11717 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11718 "ns-put-working-text");
11719 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11720 "ns-unput-working-text");
11721 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11722 current-prefix-arg, as is done in `handle-switch-frame'.
11723 But `handle-switch-frame is not run from the special-map.
11724 Commands from that map are run in a special way that automatically
11725 preserves the prefix-arg. Restoring the prefix arg here is not just
11726 redundant but harmful:
11728 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11729 - after the first prompt, the exit-minibuffer-hook is run which may
11730 iconify a frame and thus push a `iconify-frame' event.
11731 - after running exit-minibuffer-hook, current-prefix-arg is
11732 restored to the non-nil value it had before the prompt.
11733 - we enter the second prompt.
11734 current-prefix-arg is non-nil, prefix-arg is nil.
11735 - before running the first real event, we run the special iconify-frame
11736 event, but we pass the `special' arg to execute-command so
11737 current-prefix-arg and prefix-arg are left untouched.
11738 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11739 - the next key event will have a spuriously non-nil current-prefix-arg. */
11740 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11742 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11744 /* Handling it at such a low-level causes read_key_sequence to get
11745 * confused because it doesn't realize that the current_buffer was
11746 * changed by read_char.
11748 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11749 * "handle-select-window"); */
11750 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11751 "handle-save-session");
11754 /* Define a special event which is raised for dbus callback
11756 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11757 "dbus-handle-event");
11760 #ifdef USE_FILE_NOTIFY
11761 /* Define a special event which is raised for notification callback
11763 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11764 "file-notify-handle-event");
11765 #endif /* USE_FILE_NOTIFY */
11767 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11769 #if defined (WINDOWSNT)
11770 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11775 /* Mark the pointers in the kboard objects.
11776 Called by Fgarbage_collect. */
11778 mark_kboards (void)
11782 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11784 if (kb
->kbd_macro_buffer
)
11785 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11787 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11788 mark_object (KVAR (kb
, Vlast_command
));
11789 mark_object (KVAR (kb
, Vreal_last_command
));
11790 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11791 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11792 mark_object (KVAR (kb
, Vprefix_arg
));
11793 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11794 mark_object (KVAR (kb
, kbd_queue
));
11795 mark_object (KVAR (kb
, defining_kbd_macro
));
11796 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11797 mark_object (KVAR (kb
, Vsystem_key_alist
));
11798 mark_object (KVAR (kb
, system_key_syms
));
11799 mark_object (KVAR (kb
, Vwindow_system
));
11800 mark_object (KVAR (kb
, Vinput_decode_map
));
11801 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11802 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11803 mark_object (KVAR (kb
, echo_string
));
11806 struct input_event
*event
;
11807 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11809 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11810 event
= kbd_buffer
;
11811 /* These two special event types has no Lisp_Objects to mark. */
11812 if (event
->kind
!= SELECTION_REQUEST_EVENT
11813 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11815 mark_object (event
->x
);
11816 mark_object (event
->y
);
11817 mark_object (event
->frame_or_window
);
11818 mark_object (event
->arg
);