1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #define BLOCKINPUT_INLINE EXTERN_INLINE
23 #define KEYBOARD_INLINE EXTERN_INLINE
31 #include "termhooks.h"
36 #include "character.h"
39 #include "dispextern.h"
41 #include "intervals.h"
43 #include "blockinput.h"
57 #include <sys/ioctl.h>
58 #endif /* not MSDOS */
60 #if defined USABLE_FIONREAD && defined USG5_4
61 # include <sys/filio.h>
64 #include "syssignal.h"
66 #include <sys/types.h>
70 #ifdef HAVE_WINDOW_SYSTEM
72 #endif /* HAVE_WINDOW_SYSTEM */
74 /* Variables for blockinput.h: */
76 /* Positive if interrupt input is blocked right now. */
77 volatile int interrupt_input_blocked
;
79 /* True means an input interrupt or alarm signal has arrived.
80 The QUIT macro checks this. */
81 volatile bool pending_signals
;
83 #define KBD_BUFFER_SIZE 4096
85 KBOARD
*initial_kboard
;
86 KBOARD
*current_kboard
;
89 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
90 static int single_kboard
;
92 /* Non-nil disable property on a command means
93 do not execute it; call disabled-command-function's value instead. */
94 Lisp_Object Qdisabled
;
95 static Lisp_Object Qdisabled_command_function
;
97 #define NUM_RECENT_KEYS (300)
99 /* Index for storing next element into recent_keys. */
100 static int recent_keys_index
;
102 /* Total number of elements stored into recent_keys. */
103 static int total_keys
;
105 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
106 static Lisp_Object recent_keys
;
108 /* Vector holding the key sequence that invoked the current command.
109 It is reused for each command, and it may be longer than the current
110 sequence; this_command_key_count indicates how many elements
111 actually mean something.
112 It's easier to staticpro a single Lisp_Object than an array. */
113 Lisp_Object this_command_keys
;
114 ptrdiff_t this_command_key_count
;
116 /* 1 after calling Freset_this_command_lengths.
118 static int this_command_key_count_reset
;
120 /* This vector is used as a buffer to record the events that were actually read
121 by read_key_sequence. */
122 static Lisp_Object raw_keybuf
;
123 static int raw_keybuf_count
;
125 #define GROW_RAW_KEYBUF \
126 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
127 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
129 /* Number of elements of this_command_keys
130 that precede this key sequence. */
131 static ptrdiff_t this_single_command_key_start
;
133 /* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135 static ptrdiff_t before_command_key_count
;
136 static ptrdiff_t before_command_echo_length
;
138 /* For longjmp to where kbd input is being done. */
140 static sys_jmp_buf getcjmp
;
142 /* True while doing kbd input. */
143 int waiting_for_input
;
145 /* True while displaying for echoing. Delays C-g throwing. */
149 /* Non-null means we can start echoing at the next input pause even
150 though there is something in the echo area. */
152 static struct kboard
*ok_to_echo_at_next_pause
;
154 /* The kboard last echoing, or null for none. Reset to 0 in
155 cancel_echoing. If non-null, and a current echo area message
156 exists, and echo_message_buffer is eq to the current message
157 buffer, we know that the message comes from echo_kboard. */
159 struct kboard
*echo_kboard
;
161 /* The buffer used for echoing. Set in echo_now, reset in
164 Lisp_Object echo_message_buffer
;
166 /* Nonzero means C-g should cause immediate error-signal. */
169 /* Character that causes a quit. Normally C-g.
171 If we are running on an ordinary terminal, this must be an ordinary
172 ASCII char, since we want to make it our interrupt character.
174 If we are not running on an ordinary terminal, it still needs to be
175 an ordinary ASCII char. This character needs to be recognized in
176 the input interrupt handler. At this point, the keystroke is
177 represented as a struct input_event, while the desired quit
178 character is specified as a lispy event. The mapping from struct
179 input_events to lispy events cannot run in an interrupt handler,
180 and the reverse mapping is difficult for anything but ASCII
183 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
187 /* Current depth in recursive edits. */
188 EMACS_INT command_loop_level
;
190 /* If not Qnil, this is a switch-frame event which we decided to put
191 off until the end of a key sequence. This should be read as the
192 next command input, after any unread_command_events.
194 read_key_sequence uses this to delay switch-frame events until the
195 end of the key sequence; Fread_char uses it to put off switch-frame
196 events until a non-ASCII event is acceptable as input. */
197 Lisp_Object unread_switch_frame
;
199 /* Last size recorded for a current buffer which is not a minibuffer. */
200 static ptrdiff_t last_non_minibuf_size
;
202 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
203 uintmax_t num_input_events
;
205 /* Value of num_nonmacro_input_events as of last auto save. */
207 static EMACS_INT last_auto_save
;
209 /* The value of point when the last command was started. */
210 static ptrdiff_t last_point_position
;
212 /* The buffer that was current when the last command was started. */
213 static Lisp_Object last_point_position_buffer
;
215 /* The window that was selected when the last command was started. */
216 static Lisp_Object last_point_position_window
;
218 /* The frame in which the last input event occurred, or Qmacro if the
219 last event came from a macro. We use this to determine when to
220 generate switch-frame events. This may be cleared by functions
221 like Fselect_frame, to make sure that a switch-frame event is
222 generated by the next character.
224 FIXME: This is modified by a signal handler so it should be volatile.
225 It's exported to Lisp, though, so it can't simply be marked
227 Lisp_Object internal_last_event_frame
;
229 /* The timestamp of the last input event we received from the X server.
230 X Windows wants this for selection ownership. */
231 Time last_event_timestamp
;
233 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
234 static Lisp_Object Qhandle_select_window
;
235 Lisp_Object QPRIMARY
;
237 static Lisp_Object Qself_insert_command
;
238 static Lisp_Object Qforward_char
;
239 static Lisp_Object Qbackward_char
;
240 Lisp_Object Qundefined
;
241 static Lisp_Object Qtimer_event_handler
;
243 /* read_key_sequence stores here the command definition of the
244 key sequence that it reads. */
245 static Lisp_Object read_key_sequence_cmd
;
246 static Lisp_Object read_key_sequence_remapped
;
248 static Lisp_Object Qinput_method_function
;
250 static Lisp_Object Qdeactivate_mark
;
252 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
254 static Lisp_Object Qecho_area_clear_hook
;
256 /* Hooks to run before and after each command. */
257 static Lisp_Object Qpre_command_hook
;
258 static Lisp_Object Qpost_command_hook
;
260 static Lisp_Object Qdeferred_action_function
;
262 static Lisp_Object Qdelayed_warnings_hook
;
264 static Lisp_Object Qinput_method_exit_on_first_char
;
265 static Lisp_Object Qinput_method_use_echo_area
;
267 static Lisp_Object Qhelp_form_show
;
269 /* File in which we write all commands we read. */
270 static FILE *dribble
;
272 /* Nonzero if input is available. */
275 /* Circular buffer for pre-read keyboard input. */
277 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
279 /* Pointer to next available character in kbd_buffer.
280 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
281 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
282 next available char is in kbd_buffer[0]. */
283 static struct input_event
*kbd_fetch_ptr
;
285 /* Pointer to next place to store character in kbd_buffer. This
286 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
287 character should go in kbd_buffer[0]. */
288 static struct input_event
* volatile kbd_store_ptr
;
290 /* The above pair of variables forms a "queue empty" flag. When we
291 enqueue a non-hook event, we increment kbd_store_ptr. When we
292 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
293 there is input available if the two pointers are not equal.
295 Why not just have a flag set and cleared by the enqueuing and
296 dequeuing functions? Such a flag could be screwed up by interrupts
297 at inopportune times. */
299 /* Symbols to head events. */
300 static Lisp_Object Qmouse_movement
;
301 static Lisp_Object Qscroll_bar_movement
;
302 Lisp_Object Qswitch_frame
;
303 static Lisp_Object Qdelete_frame
;
304 static Lisp_Object Qiconify_frame
;
305 static Lisp_Object Qmake_frame_visible
;
306 static Lisp_Object Qselect_window
;
307 Lisp_Object Qhelp_echo
;
309 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
310 static Lisp_Object Qmouse_fixup_help_message
;
313 /* Symbols to denote kinds of events. */
314 static Lisp_Object Qfunction_key
;
315 Lisp_Object Qmouse_click
;
317 Lisp_Object Qlanguage_change
;
319 Lisp_Object Qfile_notify
;
322 static Lisp_Object Qdrag_n_drop
;
323 static Lisp_Object Qsave_session
;
325 static Lisp_Object Qdbus_event
;
327 static Lisp_Object Qconfig_changed_event
;
329 /* Lisp_Object Qmouse_movement; - also an event header */
331 /* Properties of event headers. */
332 Lisp_Object Qevent_kind
;
333 static Lisp_Object Qevent_symbol_elements
;
335 /* Menu and tool bar item parts. */
336 static Lisp_Object Qmenu_enable
;
337 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
338 Lisp_Object QCfilter
;
340 /* Non-nil disable property on a command means
341 do not execute it; call disabled-command-function's value instead. */
342 Lisp_Object QCtoggle
, QCradio
;
343 static Lisp_Object QCbutton
, QClabel
;
345 static Lisp_Object QCvert_only
;
347 /* An event header symbol HEAD may have a property named
348 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
349 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
350 mask of modifiers applied to it. If present, this is used to help
351 speed up parse_modifiers. */
352 Lisp_Object Qevent_symbol_element_mask
;
354 /* An unmodified event header BASE may have a property named
355 Qmodifier_cache, which is an alist mapping modifier masks onto
356 modified versions of BASE. If present, this helps speed up
358 static Lisp_Object Qmodifier_cache
;
360 /* Symbols to use for parts of windows. */
361 Lisp_Object Qmode_line
;
362 Lisp_Object Qvertical_line
;
363 static Lisp_Object Qvertical_scroll_bar
;
364 Lisp_Object Qmenu_bar
;
366 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
367 static Lisp_Object
command_loop (void);
368 static Lisp_Object Qextended_command_history
;
369 EMACS_TIME
timer_check (void);
371 static void record_menu_key (Lisp_Object c
);
372 static void echo_now (void);
373 static ptrdiff_t echo_length (void);
375 static Lisp_Object Qpolling_period
;
377 /* Incremented whenever a timer is run. */
380 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
382 EMACS_TIME
*input_available_clear_time
;
384 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
385 Default is 1 if INTERRUPT_INPUT is defined. */
388 /* Nonzero while interrupts are temporarily deferred during redisplay. */
389 int interrupts_deferred
;
391 /* If we support a window system, turn on the code to poll periodically
392 to detect C-g. It isn't actually used when doing interrupt input. */
393 #ifdef HAVE_WINDOW_SYSTEM
394 #define POLL_FOR_INPUT
397 /* The time when Emacs started being idle. */
399 static EMACS_TIME timer_idleness_start_time
;
401 /* After Emacs stops being idle, this saves the last value
402 of timer_idleness_start_time from when it was idle. */
404 static EMACS_TIME timer_last_idleness_start_time
;
407 /* Global variable declarations. */
409 /* Flags for readable_events. */
410 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
411 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
412 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
414 /* Function for init_keyboard to call with no args (if nonzero). */
415 static void (*keyboard_init_hook
) (void);
417 static void get_input_pending (int *, int);
418 static int readable_events (int);
419 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
421 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
423 static Lisp_Object
make_lispy_event (struct input_event
*);
424 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
425 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
426 enum scroll_bar_part
,
427 Lisp_Object
, Lisp_Object
,
430 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
431 Lisp_Object
, const char *const *,
432 Lisp_Object
*, ptrdiff_t);
433 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
434 static int help_char_p (Lisp_Object
);
435 static void save_getcjmp (sys_jmp_buf
);
436 static void restore_getcjmp (sys_jmp_buf
);
437 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
438 static void clear_event (struct input_event
*);
439 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
441 static void deliver_input_available_signal (int signo
);
443 static void handle_interrupt (bool);
444 static _Noreturn
void quit_throw_to_read_char (int);
445 static void process_special_events (void);
446 static void timer_start_idle (void);
447 static void timer_stop_idle (void);
448 static void timer_resume_idle (void);
449 static void deliver_user_signal (int);
450 static char *find_user_signal_name (int);
451 static void store_user_signal_events (void);
453 /* These setters are used only in this file, so they can be private. */
455 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (echo_string
) = val
;
460 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
465 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
470 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
475 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
480 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
485 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
490 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
492 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
495 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
497 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
501 /* Add C to the echo string, if echoing is going on.
502 C can be a character, which is printed prettily ("M-C-x" and all that
503 jazz), or a symbol, whose name is printed. */
506 echo_char (Lisp_Object c
)
508 if (current_kboard
->immediate_echo
)
510 int size
= KEY_DESCRIPTION_SIZE
+ 100;
511 char *buffer
= alloca (size
);
513 Lisp_Object echo_string
;
515 echo_string
= KVAR (current_kboard
, echo_string
);
517 /* If someone has passed us a composite event, use its head symbol. */
522 ptr
= push_key_description (XINT (c
), ptr
, 1);
524 else if (SYMBOLP (c
))
526 Lisp_Object name
= SYMBOL_NAME (c
);
527 int nbytes
= SBYTES (name
);
529 if (size
- (ptr
- buffer
) < nbytes
)
531 int offset
= ptr
- buffer
;
532 size
= max (2 * size
, size
+ nbytes
);
533 buffer
= alloca (size
);
534 ptr
= buffer
+ offset
;
537 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
538 STRING_MULTIBYTE (name
), 1);
541 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
544 const char *text
= " (Type ? for further options)";
545 int len
= strlen (text
);
547 if (size
- (ptr
- buffer
) < len
)
549 int offset
= ptr
- buffer
;
551 buffer
= alloca (size
);
552 ptr
= buffer
+ offset
;
555 memcpy (ptr
, text
, len
);
559 /* Replace a dash from echo_dash with a space, otherwise
560 add a space at the end as a separator between keys. */
561 if (STRINGP (echo_string
)
562 && SCHARS (echo_string
) > 1)
564 Lisp_Object last_char
, prev_char
, idx
;
566 idx
= make_number (SCHARS (echo_string
) - 2);
567 prev_char
= Faref (echo_string
, idx
);
569 idx
= make_number (SCHARS (echo_string
) - 1);
570 last_char
= Faref (echo_string
, idx
);
572 /* We test PREV_CHAR to make sure this isn't the echoing
574 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
575 Faset (echo_string
, idx
, make_number (' '));
577 echo_string
= concat2 (echo_string
, build_string (" "));
579 else if (STRINGP (echo_string
))
580 echo_string
= concat2 (echo_string
, build_string (" "));
584 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
590 /* Temporarily add a dash to the end of the echo string if it's not
591 empty, so that it serves as a mini-prompt for the very next character. */
596 /* Do nothing if not echoing at all. */
597 if (NILP (KVAR (current_kboard
, echo_string
)))
600 if (this_command_key_count
== 0)
603 if (!current_kboard
->immediate_echo
604 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
607 /* Do nothing if we just printed a prompt. */
608 if (current_kboard
->echo_after_prompt
609 == SCHARS (KVAR (current_kboard
, echo_string
)))
612 /* Do nothing if we have already put a dash at the end. */
613 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
615 Lisp_Object last_char
, prev_char
, idx
;
617 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
618 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
620 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
621 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
623 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
627 /* Put a dash at the end of the buffer temporarily,
628 but make it go away when the next character is added. */
631 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
635 /* Display the current echo string, and begin echoing if not already
641 if (!current_kboard
->immediate_echo
)
644 current_kboard
->immediate_echo
= 1;
646 for (i
= 0; i
< this_command_key_count
; i
++)
650 /* Set before_command_echo_length to the value that would
651 have been saved before the start of this subcommand in
652 command_loop_1, if we had already been echoing then. */
653 if (i
== this_single_command_key_start
)
654 before_command_echo_length
= echo_length ();
656 c
= AREF (this_command_keys
, i
);
657 if (! (EVENT_HAS_PARAMETERS (c
)
658 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
662 /* Set before_command_echo_length to the value that would
663 have been saved before the start of this subcommand in
664 command_loop_1, if we had already been echoing then. */
665 if (this_command_key_count
== this_single_command_key_start
)
666 before_command_echo_length
= echo_length ();
668 /* Put a dash at the end to invite the user to type more. */
673 message3_nolog (KVAR (current_kboard
, echo_string
),
674 SBYTES (KVAR (current_kboard
, echo_string
)),
675 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
678 /* Record in what buffer we echoed, and from which kboard. */
679 echo_message_buffer
= echo_area_buffer
[0];
680 echo_kboard
= current_kboard
;
682 if (waiting_for_input
&& !NILP (Vquit_flag
))
683 quit_throw_to_read_char (0);
686 /* Turn off echoing, for the start of a new command. */
689 cancel_echoing (void)
691 current_kboard
->immediate_echo
= 0;
692 current_kboard
->echo_after_prompt
= -1;
693 kset_echo_string (current_kboard
, Qnil
);
694 ok_to_echo_at_next_pause
= NULL
;
696 echo_message_buffer
= Qnil
;
699 /* Return the length of the current echo string. */
704 return (STRINGP (KVAR (current_kboard
, echo_string
))
705 ? SCHARS (KVAR (current_kboard
, echo_string
))
709 /* Truncate the current echo message to its first LEN chars.
710 This and echo_char get used by read_key_sequence when the user
711 switches frames while entering a key sequence. */
714 echo_truncate (ptrdiff_t nchars
)
716 if (STRINGP (KVAR (current_kboard
, echo_string
)))
717 kset_echo_string (current_kboard
,
718 Fsubstring (KVAR (current_kboard
, echo_string
),
719 make_number (0), make_number (nchars
)));
720 truncate_echo_area (nchars
);
724 /* Functions for manipulating this_command_keys. */
726 add_command_key (Lisp_Object key
)
728 #if 0 /* Not needed after we made Freset_this_command_lengths
729 do the job immediately. */
730 /* If reset-this-command-length was called recently, obey it now.
731 See the doc string of that function for an explanation of why. */
732 if (before_command_restore_flag
)
734 this_command_key_count
= before_command_key_count_1
;
735 if (this_command_key_count
< this_single_command_key_start
)
736 this_single_command_key_start
= this_command_key_count
;
737 echo_truncate (before_command_echo_length_1
);
738 before_command_restore_flag
= 0;
742 if (this_command_key_count
>= ASIZE (this_command_keys
))
743 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
745 ASET (this_command_keys
, this_command_key_count
, key
);
746 ++this_command_key_count
;
751 recursive_edit_1 (void)
753 ptrdiff_t count
= SPECPDL_INDEX ();
756 if (command_loop_level
> 0)
758 specbind (Qstandard_output
, Qt
);
759 specbind (Qstandard_input
, Qt
);
762 #ifdef HAVE_WINDOW_SYSTEM
763 /* The command loop has started an hourglass timer, so we have to
764 cancel it here, otherwise it will fire because the recursive edit
765 can take some time. Do not check for display_hourglass_p here,
766 because it could already be nil. */
770 /* This function may have been called from a debugger called from
771 within redisplay, for instance by Edebugging a function called
772 from fontification-functions. We want to allow redisplay in
773 the debugging session.
775 The recursive edit is left with a `(throw exit ...)'. The `exit'
776 tag is not caught anywhere in redisplay, i.e. when we leave the
777 recursive edit, the original redisplay leading to the recursive
778 edit will be unwound. The outcome should therefore be safe. */
779 specbind (Qinhibit_redisplay
, Qnil
);
782 val
= command_loop ();
784 Fsignal (Qquit
, Qnil
);
785 /* Handle throw from read_minibuf when using minibuffer
786 while it's active but we're in another window. */
788 xsignal1 (Qerror
, val
);
790 return unbind_to (count
, Qnil
);
793 /* When an auto-save happens, record the "time", and don't do again soon. */
796 record_auto_save (void)
798 last_auto_save
= num_nonmacro_input_events
;
801 /* Make an auto save happen as soon as possible at command level. */
805 force_auto_save_soon (void)
807 last_auto_save
= - auto_save_interval
- 1;
809 record_asynch_buffer_change ();
813 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
814 doc
: /* Invoke the editor command loop recursively.
815 To get out of the recursive edit, a command can do `(throw 'exit nil)';
816 that tells this function to return.
817 Alternatively, `(throw 'exit t)' makes this function signal an error.
818 This function is called by the editor initialization to begin editing. */)
821 ptrdiff_t count
= SPECPDL_INDEX ();
824 /* If we enter while input is blocked, don't lock up here.
825 This may happen through the debugger during redisplay. */
826 if (input_blocked_p ())
829 command_loop_level
++;
830 update_mode_lines
= 1;
832 if (command_loop_level
833 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
834 buffer
= Fcurrent_buffer ();
838 /* If we leave recursive_edit_1 below with a `throw' for instance,
839 like it is done in the splash screen display, we have to
840 make sure that we restore single_kboard as command_loop_1
841 would have done if it were left normally. */
842 if (command_loop_level
> 0)
843 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
844 record_unwind_protect (recursive_edit_unwind
, buffer
);
847 return unbind_to (count
, Qnil
);
851 recursive_edit_unwind (Lisp_Object buffer
)
853 if (BUFFERP (buffer
))
854 Fset_buffer (buffer
);
856 command_loop_level
--;
857 update_mode_lines
= 1;
862 #if 0 /* These two functions are now replaced with
863 temporarily_switch_to_single_kboard. */
867 #if 0 /* Theory: if there's anything in Vunread_command_events,
868 it will right away be read by read_key_sequence,
869 and then if we do switch KBOARDS, it will go into the side
870 queue then. So we don't need to do anything special here -- rms. */
871 if (CONSP (Vunread_command_events
))
873 current_kboard
->kbd_queue
874 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
875 current_kboard
->kbd_queue_has_data
= 1;
877 Vunread_command_events
= Qnil
;
882 /* Switch to the single-kboard state, making current_kboard
883 the only KBOARD from which further input is accepted. */
886 single_kboard_state ()
892 /* If we're in single_kboard state for kboard KBOARD,
896 not_single_kboard_state (KBOARD
*kboard
)
898 if (kboard
== current_kboard
)
902 /* Maintain a stack of kboards, so other parts of Emacs
903 can switch temporarily to the kboard of a given frame
904 and then revert to the previous status. */
909 struct kboard_stack
*next
;
912 static struct kboard_stack
*kboard_stack
;
915 push_kboard (struct kboard
*k
)
917 struct kboard_stack
*p
= xmalloc (sizeof *p
);
919 p
->next
= kboard_stack
;
920 p
->kboard
= current_kboard
;
930 struct kboard_stack
*p
= kboard_stack
;
932 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
934 if (t
->kboard
== p
->kboard
)
936 current_kboard
= p
->kboard
;
943 /* The terminal we remembered has been deleted. */
944 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
947 kboard_stack
= p
->next
;
951 /* Switch to single_kboard mode, making current_kboard the only KBOARD
952 from which further input is accepted. If F is non-nil, set its
953 KBOARD as the current keyboard.
955 This function uses record_unwind_protect to return to the previous
958 If Emacs is already in single_kboard mode, and F's keyboard is
959 locked, then this function will throw an error. */
962 temporarily_switch_to_single_kboard (struct frame
*f
)
964 int was_locked
= single_kboard
;
967 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
968 /* We can not switch keyboards while in single_kboard mode.
969 In rare cases, Lisp code may call `recursive-edit' (or
970 `read-minibuffer' or `y-or-n-p') after it switched to a
971 locked frame. For example, this is likely to happen
972 when server.el connects to a new terminal while Emacs is in
973 single_kboard mode. It is best to throw an error instead
974 of presenting the user with a frozen screen. */
975 error ("Terminal %d is locked, cannot read from it",
976 FRAME_TERMINAL (f
)->id
);
978 /* This call is unnecessary, but helps
979 `restore_kboard_configuration' discover if somebody changed
980 `current_kboard' behind our back. */
981 push_kboard (current_kboard
);
984 current_kboard
= FRAME_KBOARD (f
);
986 record_unwind_protect (restore_kboard_configuration
,
987 (was_locked
? Qt
: Qnil
));
990 #if 0 /* This function is not needed anymore. */
992 record_single_kboard_state ()
995 push_kboard (current_kboard
);
996 record_unwind_protect (restore_kboard_configuration
,
997 (single_kboard
? Qt
: Qnil
));
1002 restore_kboard_configuration (Lisp_Object was_locked
)
1004 if (NILP (was_locked
))
1008 struct kboard
*prev
= current_kboard
;
1011 /* The pop should not change the kboard. */
1012 if (single_kboard
&& current_kboard
!= prev
)
1019 /* Handle errors that are not handled at inner levels
1020 by printing an error message and returning to the editor command loop. */
1023 cmd_error (Lisp_Object data
)
1025 Lisp_Object old_level
, old_length
;
1026 char macroerror
[sizeof "After..kbd macro iterations: "
1027 + INT_STRLEN_BOUND (EMACS_INT
)];
1029 #ifdef HAVE_WINDOW_SYSTEM
1030 if (display_hourglass_p
)
1031 cancel_hourglass ();
1034 if (!NILP (executing_kbd_macro
))
1036 if (executing_kbd_macro_iterations
== 1)
1037 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1039 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1040 executing_kbd_macro_iterations
);
1045 Vstandard_output
= Qt
;
1046 Vstandard_input
= Qt
;
1047 Vexecuting_kbd_macro
= Qnil
;
1048 executing_kbd_macro
= Qnil
;
1049 kset_prefix_arg (current_kboard
, Qnil
);
1050 kset_last_prefix_arg (current_kboard
, Qnil
);
1053 /* Avoid unquittable loop if data contains a circular list. */
1054 old_level
= Vprint_level
;
1055 old_length
= Vprint_length
;
1056 XSETFASTINT (Vprint_level
, 10);
1057 XSETFASTINT (Vprint_length
, 10);
1058 cmd_error_internal (data
, macroerror
);
1059 Vprint_level
= old_level
;
1060 Vprint_length
= old_length
;
1064 Vinhibit_quit
= Qnil
;
1065 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1066 if (command_loop_level
== 0 && minibuf_level
== 0)
1067 any_kboard_state ();
1070 return make_number (0);
1073 /* Take actions on handling an error. DATA is the data that describes
1076 CONTEXT is a C-string containing ASCII characters only which
1077 describes the context in which the error happened. If we need to
1078 generalize CONTEXT to allow multibyte characters, make it a Lisp
1082 cmd_error_internal (Lisp_Object data
, const char *context
)
1084 struct frame
*sf
= SELECTED_FRAME ();
1086 /* The immediate context is not interesting for Quits,
1087 since they are asynchronous. */
1088 if (EQ (XCAR (data
), Qquit
))
1089 Vsignaling_function
= Qnil
;
1094 /* Use user's specified output function if any. */
1095 if (!NILP (Vcommand_error_function
))
1096 call3 (Vcommand_error_function
, data
,
1097 context
? build_string (context
) : empty_unibyte_string
,
1098 Vsignaling_function
);
1099 /* If the window system or terminal frame hasn't been initialized
1100 yet, or we're not interactive, write the message to stderr and exit. */
1101 else if (!sf
->glyphs_initialized_p
1102 /* The initial frame is a special non-displaying frame. It
1103 will be current in daemon mode when there are no frames
1104 to display, and in non-daemon mode before the real frame
1105 has finished initializing. If an error is thrown in the
1106 latter case while creating the frame, then the frame
1107 will never be displayed, so the safest thing to do is
1108 write to stderr and quit. In daemon mode, there are
1109 many other potential errors that do not prevent frames
1110 from being created, so continuing as normal is better in
1112 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1115 print_error_message (data
, Qexternal_debugging_output
,
1116 context
, Vsignaling_function
);
1117 Fterpri (Qexternal_debugging_output
);
1118 Fkill_emacs (make_number (-1));
1122 clear_message (1, 0);
1124 message_log_maybe_newline ();
1127 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1130 Vsignaling_function
= Qnil
;
1133 Lisp_Object
command_loop_1 (void);
1134 static Lisp_Object
command_loop_2 (Lisp_Object
);
1135 static Lisp_Object
top_level_1 (Lisp_Object
);
1137 /* Entry to editor-command-loop.
1138 This level has the catches for exiting/returning to editor command loop.
1139 It returns nil to exit recursive edit, t to abort it. */
1144 if (command_loop_level
> 0 || minibuf_level
> 0)
1147 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1148 executing_kbd_macro
= Qnil
;
1154 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1155 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1156 /* Reset single_kboard in case top-level set it while
1157 evaluating an -f option, or we are stuck there for some
1159 any_kboard_state ();
1161 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1162 executing_kbd_macro
= Qnil
;
1164 /* End of file in -batch run causes exit here. */
1170 /* Here we catch errors in execution of commands within the
1171 editing loop, and reenter the editing loop.
1172 When there is an error, cmd_error runs and returns a non-nil
1173 value to us. A value of nil means that command_loop_1 itself
1174 returned due to end of file (or end of kbd macro). */
1177 command_loop_2 (Lisp_Object ignore
)
1179 register Lisp_Object val
;
1182 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1183 while (!NILP (val
));
1191 return Feval (Vtop_level
, Qnil
);
1195 top_level_1 (Lisp_Object ignore
)
1197 /* On entry to the outer level, run the startup file */
1198 if (!NILP (Vtop_level
))
1199 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1200 else if (!NILP (Vpurify_flag
))
1201 message ("Bare impure Emacs (standard Lisp code not loaded)");
1203 message ("Bare Emacs (standard Lisp code not loaded)");
1207 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1208 doc
: /* Exit all recursive editing levels.
1209 This also exits all active minibuffers. */)
1212 #ifdef HAVE_WINDOW_SYSTEM
1213 if (display_hourglass_p
)
1214 cancel_hourglass ();
1217 /* Unblock input if we enter with input blocked. This may happen if
1218 redisplay traps e.g. during tool-bar update with input blocked. */
1219 totally_unblock_input ();
1221 Fthrow (Qtop_level
, Qnil
);
1224 static _Noreturn
void
1225 user_error (const char *msg
)
1227 xsignal1 (Quser_error
, build_string (msg
));
1231 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1232 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1235 if (command_loop_level
> 0 || minibuf_level
> 0)
1236 Fthrow (Qexit
, Qnil
);
1238 user_error ("No recursive edit is in progress");
1242 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1243 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1246 if (command_loop_level
> 0 || minibuf_level
> 0)
1249 user_error ("No recursive edit is in progress");
1252 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1254 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1255 of this function. */
1258 tracking_off (Lisp_Object old_value
)
1260 do_mouse_tracking
= old_value
;
1261 if (NILP (old_value
))
1263 /* Redisplay may have been preempted because there was input
1264 available, and it assumes it will be called again after the
1265 input has been processed. If the only input available was
1266 the sort that we have just disabled, then we need to call
1268 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1270 redisplay_preserve_echo_area (6);
1271 get_input_pending (&input_pending
,
1272 READABLE_EVENTS_DO_TIMERS_NOW
);
1278 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1279 doc
: /* Evaluate BODY with mouse movement events enabled.
1280 Within a `track-mouse' form, mouse motion generates input events that
1281 you can read with `read-event'.
1282 Normally, mouse motion is ignored.
1283 usage: (track-mouse BODY...) */)
1286 ptrdiff_t count
= SPECPDL_INDEX ();
1289 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1291 do_mouse_tracking
= Qt
;
1293 val
= Fprogn (args
);
1294 return unbind_to (count
, val
);
1297 /* If mouse has moved on some frame, return one of those frames.
1301 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1302 after resizing the tool-bar window. */
1304 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1307 int ignore_mouse_drag_p
;
1310 some_mouse_moved (void)
1312 Lisp_Object tail
, frame
;
1314 if (ignore_mouse_drag_p
)
1316 /* ignore_mouse_drag_p = 0; */
1320 FOR_EACH_FRAME (tail
, frame
)
1322 if (XFRAME (frame
)->mouse_moved
)
1323 return XFRAME (frame
);
1329 #endif /* HAVE_MOUSE || HAVE_GPM */
1331 /* This is the actual command reading loop,
1332 sans error-handling encapsulation. */
1334 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1336 void safe_run_hooks (Lisp_Object
);
1337 static void adjust_point_for_property (ptrdiff_t, int);
1339 /* Cancel hourglass from protect_unwind.
1341 #ifdef HAVE_WINDOW_SYSTEM
1343 cancel_hourglass_unwind (Lisp_Object arg
)
1345 cancel_hourglass ();
1350 /* The last boundary auto-added to buffer-undo-list. */
1351 Lisp_Object last_undo_boundary
;
1353 /* FIXME: This is wrong rather than test window-system, we should call
1354 a new set-selection, which will then dispatch to x-set-selection, or
1355 tty-set-selection, or w32-set-selection, ... */
1358 command_loop_1 (void)
1361 Lisp_Object keybuf
[30];
1363 EMACS_INT prev_modiff
= 0;
1364 struct buffer
*prev_buffer
= NULL
;
1365 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1366 int was_locked
= single_kboard
;
1368 int already_adjusted
= 0;
1370 kset_prefix_arg (current_kboard
, Qnil
);
1371 kset_last_prefix_arg (current_kboard
, Qnil
);
1372 Vdeactivate_mark
= Qnil
;
1373 waiting_for_input
= 0;
1376 this_command_key_count
= 0;
1377 this_command_key_count_reset
= 0;
1378 this_single_command_key_start
= 0;
1380 if (NILP (Vmemory_full
))
1382 /* Make sure this hook runs after commands that get errors and
1383 throw to top level. */
1384 /* Note that the value cell will never directly contain nil
1385 if the symbol is a local variable. */
1386 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1387 safe_run_hooks (Qpost_command_hook
);
1389 /* If displaying a message, resize the echo area window to fit
1390 that message's size exactly. */
1391 if (!NILP (echo_area_buffer
[0]))
1392 resize_echo_area_exactly ();
1394 /* If there are warnings waiting, process them. */
1395 if (!NILP (Vdelayed_warnings_list
))
1396 safe_run_hooks (Qdelayed_warnings_hook
);
1398 if (!NILP (Vdeferred_action_list
))
1399 safe_run_hooks (Qdeferred_action_function
);
1402 /* Do this after running Vpost_command_hook, for consistency. */
1403 kset_last_command (current_kboard
, Vthis_command
);
1404 kset_real_last_command (current_kboard
, Vreal_this_command
);
1405 if (!CONSP (last_command_event
))
1406 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1410 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1413 /* Make sure the current window's buffer is selected. */
1414 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1416 /* Display any malloc warning that just came out. Use while because
1417 displaying one warning can cause another. */
1419 while (pending_malloc_warning
)
1420 display_malloc_warning ();
1422 Vdeactivate_mark
= Qnil
;
1424 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1426 /* Don't ignore mouse movements for more than a single command
1427 loop. (This flag is set in xdisp.c whenever the tool bar is
1428 resized, because the resize moves text up or down, and would
1429 generate false mouse drag events if we don't ignore them.) */
1430 ignore_mouse_drag_p
= 0;
1433 /* If minibuffer on and echo area in use,
1434 wait a short time and redraw minibuffer. */
1437 && !NILP (echo_area_buffer
[0])
1438 && EQ (minibuf_window
, echo_area_window
)
1439 && NUMBERP (Vminibuffer_message_timeout
))
1441 /* Bind inhibit-quit to t so that C-g gets read in
1442 rather than quitting back to the minibuffer. */
1443 ptrdiff_t count
= SPECPDL_INDEX ();
1444 specbind (Qinhibit_quit
, Qt
);
1446 sit_for (Vminibuffer_message_timeout
, 0, 2);
1448 /* Clear the echo area. */
1450 safe_run_hooks (Qecho_area_clear_hook
);
1452 unbind_to (count
, Qnil
);
1454 /* If a C-g came in before, treat it as input now. */
1455 if (!NILP (Vquit_flag
))
1458 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1462 /* If it has changed current-menubar from previous value,
1463 really recompute the menubar from the value. */
1464 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1465 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1466 call0 (Qrecompute_lucid_menubar
);
1468 before_command_key_count
= this_command_key_count
;
1469 before_command_echo_length
= echo_length ();
1471 Vthis_command
= Qnil
;
1472 Vreal_this_command
= Qnil
;
1473 Vthis_original_command
= Qnil
;
1474 Vthis_command_keys_shift_translated
= Qnil
;
1476 /* Read next key sequence; i gets its length. */
1477 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1480 /* A filter may have run while we were reading the input. */
1481 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1483 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1487 /* Now we have read a key sequence of length I,
1488 or else I is 0 and we found end of file. */
1490 if (i
== 0) /* End of file -- happens only in */
1491 return Qnil
; /* a kbd macro, at the end. */
1492 /* -1 means read_key_sequence got a menu that was rejected.
1493 Just loop around and read another command. */
1497 this_command_key_count
= 0;
1498 this_command_key_count_reset
= 0;
1499 this_single_command_key_start
= 0;
1503 last_command_event
= keybuf
[i
- 1];
1505 /* If the previous command tried to force a specific window-start,
1506 forget about that, in case this command moves point far away
1507 from that position. But also throw away beg_unchanged and
1508 end_unchanged information in that case, so that redisplay will
1509 update the whole window properly. */
1510 if (XWINDOW (selected_window
)->force_start
)
1513 XWINDOW (selected_window
)->force_start
= 0;
1514 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1515 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1518 cmd
= read_key_sequence_cmd
;
1519 if (!NILP (Vexecuting_kbd_macro
))
1521 if (!NILP (Vquit_flag
))
1523 Vexecuting_kbd_macro
= Qt
;
1524 QUIT
; /* Make some noise. */
1525 /* Will return since macro now empty. */
1529 /* Do redisplay processing after this command except in special
1530 cases identified below. */
1531 prev_buffer
= current_buffer
;
1532 prev_modiff
= MODIFF
;
1533 last_point_position
= PT
;
1534 last_point_position_window
= selected_window
;
1535 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1537 /* By default, we adjust point to a boundary of a region that
1538 has such a property that should be treated intangible
1539 (e.g. composition, display). But, some commands will set
1540 this variable differently. */
1541 Vdisable_point_adjustment
= Qnil
;
1543 /* Process filters and timers may have messed with deactivate-mark.
1544 reset it before we execute the command. */
1545 Vdeactivate_mark
= Qnil
;
1547 /* Remap command through active keymaps. */
1548 Vthis_original_command
= cmd
;
1549 if (!NILP (read_key_sequence_remapped
))
1550 cmd
= read_key_sequence_remapped
;
1552 /* Execute the command. */
1554 Vthis_command
= cmd
;
1555 Vreal_this_command
= cmd
;
1556 safe_run_hooks (Qpre_command_hook
);
1558 already_adjusted
= 0;
1560 if (NILP (Vthis_command
))
1562 /* nil means key is undefined. */
1563 Lisp_Object keys
= Fvector (i
, keybuf
);
1564 keys
= Fkey_description (keys
, Qnil
);
1566 message_with_string ("%s is undefined", keys
, 0);
1567 kset_defining_kbd_macro (current_kboard
, Qnil
);
1568 update_mode_lines
= 1;
1569 /* If this is a down-mouse event, don't reset prefix-arg;
1570 pass it to the command run by the up event. */
1571 if (EVENT_HAS_PARAMETERS (last_command_event
))
1573 Lisp_Object breakdown
1574 = parse_modifiers (EVENT_HEAD (last_command_event
));
1575 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1576 if (!(modifiers
& down_modifier
))
1577 kset_prefix_arg (current_kboard
, Qnil
);
1580 kset_prefix_arg (current_kboard
, Qnil
);
1584 /* Here for a command that isn't executed directly. */
1586 #ifdef HAVE_WINDOW_SYSTEM
1587 ptrdiff_t scount
= SPECPDL_INDEX ();
1589 if (display_hourglass_p
1590 && NILP (Vexecuting_kbd_macro
))
1592 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1597 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1599 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1602 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1603 ? Qnil
: BVAR (current_buffer
, undo_list
));
1605 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1607 #ifdef HAVE_WINDOW_SYSTEM
1608 /* Do not check display_hourglass_p here, because
1609 Fcommand_execute could change it, but we should cancel
1610 hourglass cursor anyway.
1611 But don't cancel the hourglass within a macro
1612 just because a command in the macro finishes. */
1613 if (NILP (Vexecuting_kbd_macro
))
1614 unbind_to (scount
, Qnil
);
1617 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1619 safe_run_hooks (Qpost_command_hook
);
1621 /* If displaying a message, resize the echo area window to fit
1622 that message's size exactly. */
1623 if (!NILP (echo_area_buffer
[0]))
1624 resize_echo_area_exactly ();
1626 /* If there are warnings waiting, process them. */
1627 if (!NILP (Vdelayed_warnings_list
))
1628 safe_run_hooks (Qdelayed_warnings_hook
);
1630 safe_run_hooks (Qdeferred_action_function
);
1632 /* If there is a prefix argument,
1633 1) We don't want Vlast_command to be ``universal-argument''
1634 (that would be dumb), so don't set Vlast_command,
1635 2) we want to leave echoing on so that the prefix will be
1636 echoed as part of this key sequence, so don't call
1638 3) we want to leave this_command_key_count non-zero, so that
1639 read_char will realize that it is re-reading a character, and
1640 not echo it a second time.
1642 If the command didn't actually create a prefix arg,
1643 but is merely a frame event that is transparent to prefix args,
1644 then the above doesn't apply. */
1645 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1646 || CONSP (last_command_event
))
1648 kset_last_command (current_kboard
, Vthis_command
);
1649 kset_real_last_command (current_kboard
, Vreal_this_command
);
1650 if (!CONSP (last_command_event
))
1651 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1653 this_command_key_count
= 0;
1654 this_command_key_count_reset
= 0;
1655 this_single_command_key_start
= 0;
1658 if (!NILP (BVAR (current_buffer
, mark_active
))
1659 && !NILP (Vrun_hooks
))
1661 /* In Emacs 22, setting transient-mark-mode to `only' was a
1662 way of turning it on for just one command. This usage is
1663 obsolete, but support it anyway. */
1664 if (EQ (Vtransient_mark_mode
, Qidentity
))
1665 Vtransient_mark_mode
= Qnil
;
1666 else if (EQ (Vtransient_mark_mode
, Qonly
))
1667 Vtransient_mark_mode
= Qidentity
;
1669 if (!NILP (Vdeactivate_mark
))
1670 /* If `select-active-regions' is non-nil, this call to
1671 `deactivate-mark' also sets the PRIMARY selection. */
1672 call0 (Qdeactivate_mark
);
1675 /* Even if not deactivating the mark, set PRIMARY if
1676 `select-active-regions' is non-nil. */
1677 if (!NILP (Fwindow_system (Qnil
))
1678 /* Even if mark_active is non-nil, the actual buffer
1679 marker may not have been set yet (Bug#7044). */
1680 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1681 && (EQ (Vselect_active_regions
, Qonly
)
1682 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1683 : (!NILP (Vselect_active_regions
)
1684 && !NILP (Vtransient_mark_mode
)))
1685 && NILP (Fmemq (Vthis_command
,
1686 Vselection_inhibit_update_commands
)))
1689 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1692 call2 (Qx_set_selection
, QPRIMARY
,
1693 make_buffer_string (beg
, end
, 0));
1695 call2 (Qx_set_selection
, QPRIMARY
,
1696 make_buffer_string (end
, beg
, 0));
1697 /* Don't set empty selections. */
1700 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1702 Lisp_Object hook
= intern ("activate-mark-hook");
1703 Frun_hooks (1, &hook
);
1707 Vsaved_region_selection
= Qnil
;
1712 if (current_buffer
== prev_buffer
1713 && last_point_position
!= PT
1714 && NILP (Vdisable_point_adjustment
)
1715 && NILP (Vglobal_disable_point_adjustment
))
1717 if (last_point_position
> BEGV
1718 && last_point_position
< ZV
1719 && (composition_adjust_point (last_point_position
,
1720 last_point_position
)
1721 != last_point_position
))
1722 /* The last point was temporarily set within a grapheme
1723 cluster to prevent automatic composition. To recover
1724 the automatic composition, we must update the
1726 windows_or_buffers_changed
++;
1727 if (!already_adjusted
)
1728 adjust_point_for_property (last_point_position
,
1729 MODIFF
!= prev_modiff
);
1732 /* Install chars successfully executed in kbd macro. */
1734 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1735 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1736 finalize_kbd_macro_chars ();
1737 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1739 any_kboard_state ();
1744 /* Adjust point to a boundary of a region that has such a property
1745 that should be treated intangible. For the moment, we check
1746 `composition', `display' and `invisible' properties.
1747 LAST_PT is the last position of point. */
1750 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1753 Lisp_Object val
, overlay
, tmp
;
1754 /* When called after buffer modification, we should temporarily
1755 suppress the point adjustment for automatic composition so that a
1756 user can keep inserting another character at point or keep
1757 deleting characters around point. */
1758 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1759 ptrdiff_t orig_pt
= PT
;
1761 /* FIXME: cycling is probably not necessary because these properties
1762 can't be usefully combined anyway. */
1763 while (check_composition
|| check_display
|| check_invisible
)
1765 /* FIXME: check `intangible'. */
1766 if (check_composition
1767 && PT
> BEGV
&& PT
< ZV
1768 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1771 check_display
= check_invisible
= 1;
1773 check_composition
= 0;
1775 && PT
> BEGV
&& PT
< ZV
1776 && !NILP (val
= get_char_property_and_overlay
1777 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1778 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1779 && (!OVERLAYP (overlay
)
1780 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1781 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1782 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1783 && (beg
< PT
/* && end > PT <- It's always the case. */
1784 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1787 SET_PT (PT
< last_pt
1788 ? (STRINGP (val
) && SCHARS (val
) == 0
1789 ? max (beg
- 1, BEGV
)
1792 check_composition
= check_invisible
= 1;
1795 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1797 int inv
, ellipsis
= 0;
1800 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1803 /* FIXME: We should stop if we find a spot between
1804 two runs of `invisible' where inserted text would
1805 be visible. This is important when we have two
1806 invisible boundaries that enclose an area: if the
1807 area is empty, we need this test in order to make
1808 it possible to place point in the middle rather
1809 than skip both boundaries. However, this code
1810 also stops anywhere in a non-sticky text-property,
1811 which breaks (e.g.) Org mode. */
1812 && (val
= get_pos_property (make_number (end
),
1814 TEXT_PROP_MEANS_INVISIBLE (val
))
1816 && !NILP (val
= get_char_property_and_overlay
1817 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1818 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1820 ellipsis
= ellipsis
|| inv
> 1
1821 || (OVERLAYP (overlay
)
1822 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1823 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1824 tmp
= Fnext_single_char_property_change
1825 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1826 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1830 && (val
= get_pos_property (make_number (beg
),
1832 TEXT_PROP_MEANS_INVISIBLE (val
))
1834 && !NILP (val
= get_char_property_and_overlay
1835 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1836 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1838 ellipsis
= ellipsis
|| inv
> 1
1839 || (OVERLAYP (overlay
)
1840 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1841 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1842 tmp
= Fprevious_single_char_property_change
1843 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1844 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1847 /* Move away from the inside area. */
1848 if (beg
< PT
&& end
> PT
)
1850 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1851 /* We haven't moved yet (so we don't need to fear
1852 infinite-looping) and we were outside the range
1853 before (so either end of the range still corresponds
1854 to a move in the right direction): pretend we moved
1855 less than we actually did, so that we still have
1856 more freedom below in choosing which end of the range
1858 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1859 /* We either have moved already or the last point
1860 was already in the range: we don't get to choose
1861 which end of the range we have to go to. */
1862 : (PT
< last_pt
? beg
: end
));
1863 check_composition
= check_display
= 1;
1865 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1866 the point to something other than its argument, due to
1867 point-motion hooks, intangibility, etc. */
1868 eassert (PT
== beg
|| PT
== end
);
1871 /* Pretend the area doesn't exist if the buffer is not
1873 if (!modified
&& !ellipsis
&& beg
< end
)
1875 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1876 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1877 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1878 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1879 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1880 /* We've already moved as far as we can. Trying to go
1881 to the other end would mean moving backwards and thus
1882 could lead to an infinite loop. */
1884 else if (val
= get_pos_property (make_number (PT
),
1886 TEXT_PROP_MEANS_INVISIBLE (val
)
1887 && (val
= get_pos_property
1888 (make_number (PT
== beg
? end
: beg
),
1890 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1891 (check_composition
= check_display
= 1,
1892 SET_PT (PT
== beg
? end
: beg
));
1895 check_invisible
= 0;
1899 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1902 safe_run_hooks_1 (void)
1904 eassert (CONSP (Vinhibit_quit
));
1905 return call0 (XCDR (Vinhibit_quit
));
1908 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1912 safe_run_hooks_error (Lisp_Object error_data
)
1915 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1916 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1917 Lisp_Object args
[4];
1918 args
[0] = build_string ("Error in %s (%s): %S");
1921 args
[3] = error_data
;
1927 Lisp_Object newval
= Qnil
;
1928 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1929 if (EQ (fun
, XCAR (val
)))
1932 newval
= Fcons (XCAR (val
), newval
);
1934 return Fset (hook
, Fnreverse (newval
));
1935 /* Not found in the local part of the hook. Let's look at the global
1938 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1939 : Fdefault_value (hook
));
1940 CONSP (val
); val
= XCDR (val
))
1941 if (EQ (fun
, XCAR (val
)))
1944 newval
= Fcons (XCAR (val
), newval
);
1946 return Fset_default (hook
, Fnreverse (newval
));
1952 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1954 eassert (nargs
== 1);
1955 if (CONSP (Vinhibit_quit
))
1956 XSETCDR (Vinhibit_quit
, args
[0]);
1958 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1960 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1964 /* If we get an error while running the hook, cause the hook variable
1965 to be nil. Also inhibit quits, so that C-g won't cause the hook
1966 to mysteriously evaporate. */
1969 safe_run_hooks (Lisp_Object hook
)
1971 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1972 to its body or to its handlers other than via globals such as
1973 dynamically-bound variables ;-) */
1974 ptrdiff_t count
= SPECPDL_INDEX ();
1975 specbind (Qinhibit_quit
, hook
);
1977 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1979 unbind_to (count
, Qnil
);
1983 /* Nonzero means polling for input is temporarily suppressed. */
1985 int poll_suppress_count
;
1987 /* Asynchronous timer for polling. */
1989 static struct atimer
*poll_timer
;
1992 #ifdef POLL_FOR_INPUT
1994 /* Poll for input, so that we catch a C-g if it comes in. This
1995 function is called from x_make_frame_visible, see comment
1999 poll_for_input_1 (void)
2001 if (! input_blocked_p ()
2002 && !waiting_for_input
)
2006 /* Timer callback function for poll_timer. TIMER is equal to
2010 poll_for_input (struct atimer
*timer
)
2012 if (poll_suppress_count
== 0)
2013 pending_signals
= 1;
2016 #endif /* POLL_FOR_INPUT */
2018 /* Begin signals to poll for input, if they are appropriate.
2019 This function is called unconditionally from various places. */
2022 start_polling (void)
2024 #ifdef POLL_FOR_INPUT
2025 /* XXX This condition was (read_socket_hook && !interrupt_input),
2026 but read_socket_hook is not global anymore. Let's pretend that
2028 if (!interrupt_input
)
2030 /* Turn alarm handling on unconditionally. It might have
2031 been turned off in process.c. */
2032 turn_on_atimers (1);
2034 /* If poll timer doesn't exist, are we need one with
2035 a different interval, start a new one. */
2036 if (poll_timer
== NULL
2037 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2039 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2040 EMACS_TIME interval
= make_emacs_time (period
, 0);
2043 cancel_atimer (poll_timer
);
2045 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2046 poll_for_input
, NULL
);
2049 /* Let the timer's callback function poll for input
2050 if this becomes zero. */
2051 --poll_suppress_count
;
2056 /* Nonzero if we are using polling to handle input asynchronously. */
2059 input_polling_used (void)
2061 #ifdef POLL_FOR_INPUT
2062 /* XXX This condition was (read_socket_hook && !interrupt_input),
2063 but read_socket_hook is not global anymore. Let's pretend that
2065 return !interrupt_input
;
2071 /* Turn off polling. */
2076 #ifdef POLL_FOR_INPUT
2077 /* XXX This condition was (read_socket_hook && !interrupt_input),
2078 but read_socket_hook is not global anymore. Let's pretend that
2080 if (!interrupt_input
)
2081 ++poll_suppress_count
;
2085 /* Set the value of poll_suppress_count to COUNT
2086 and start or stop polling accordingly. */
2089 set_poll_suppress_count (int count
)
2091 #ifdef POLL_FOR_INPUT
2092 if (count
== 0 && poll_suppress_count
!= 0)
2094 poll_suppress_count
= 1;
2097 else if (count
!= 0 && poll_suppress_count
== 0)
2101 poll_suppress_count
= count
;
2105 /* Bind polling_period to a value at least N.
2106 But don't decrease it. */
2109 bind_polling_period (int n
)
2111 #ifdef POLL_FOR_INPUT
2112 EMACS_INT
new = polling_period
;
2117 stop_other_atimers (poll_timer
);
2119 specbind (Qpolling_period
, make_number (new));
2120 /* Start a new alarm with the new period. */
2125 /* Apply the control modifier to CHARACTER. */
2128 make_ctrl_char (int c
)
2130 /* Save the upper bits here. */
2131 int upper
= c
& ~0177;
2133 if (! ASCII_BYTE_P (c
))
2134 return c
|= ctrl_modifier
;
2138 /* Everything in the columns containing the upper-case letters
2139 denotes a control character. */
2140 if (c
>= 0100 && c
< 0140)
2144 /* Set the shift modifier for a control char
2145 made from a shifted letter. But only for letters! */
2146 if (oc
>= 'A' && oc
<= 'Z')
2147 c
|= shift_modifier
;
2150 /* The lower-case letters denote control characters too. */
2151 else if (c
>= 'a' && c
<= 'z')
2154 /* Include the bits for control and shift
2155 only if the basic ASCII code can't indicate them. */
2159 /* Replace the high bits. */
2160 c
|= (upper
& ~ctrl_modifier
);
2165 /* Display the help-echo property of the character after the mouse pointer.
2166 Either show it in the echo area, or call show-help-function to display
2167 it by other means (maybe in a tooltip).
2169 If HELP is nil, that means clear the previous help echo.
2171 If HELP is a string, display that string. If HELP is a function,
2172 call it with OBJECT and POS as arguments; the function should
2173 return a help string or nil for none. For all other types of HELP,
2174 evaluate it to obtain a string.
2176 WINDOW is the window in which the help was generated, if any.
2177 It is nil if not in a window.
2179 If OBJECT is a buffer, POS is the position in the buffer where the
2180 `help-echo' text property was found.
2182 If OBJECT is an overlay, that overlay has a `help-echo' property,
2183 and POS is the position in the overlay's buffer under the mouse.
2185 If OBJECT is a string (an overlay string or a string displayed with
2186 the `display' property). POS is the position in that string under
2189 Note: this function may only be called with HELP nil or a string
2190 from X code running asynchronously. */
2193 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2196 if (!NILP (help
) && !STRINGP (help
))
2198 if (FUNCTIONP (help
))
2199 help
= safe_call (4, help
, window
, object
, pos
);
2201 help
= safe_eval (help
);
2203 if (!STRINGP (help
))
2207 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2208 if (!noninteractive
&& STRINGP (help
))
2210 /* The mouse-fixup-help-message Lisp function can call
2211 mouse_position_hook, which resets the mouse_moved flags.
2212 This causes trouble if we are trying to read a mouse motion
2213 event (i.e., if we are inside a `track-mouse' form), so we
2214 restore the mouse_moved flag. */
2215 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2216 help
= call1 (Qmouse_fixup_help_message
, help
);
2222 if (STRINGP (help
) || NILP (help
))
2224 if (!NILP (Vshow_help_function
))
2225 call1 (Vshow_help_function
, help
);
2226 help_echo_showing_p
= STRINGP (help
);
2232 /* Input of single characters from keyboard */
2234 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2235 EMACS_TIME
*end_time
);
2236 static void record_char (Lisp_Object c
);
2238 static Lisp_Object help_form_saved_window_configs
;
2240 read_char_help_form_unwind (Lisp_Object arg
)
2242 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2243 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2244 if (!NILP (window_config
))
2245 Fset_window_configuration (window_config
);
2249 #define STOP_POLLING \
2250 do { if (! polling_stopped_here) stop_polling (); \
2251 polling_stopped_here = 1; } while (0)
2253 #define RESUME_POLLING \
2254 do { if (polling_stopped_here) start_polling (); \
2255 polling_stopped_here = 0; } while (0)
2257 /* read a character from the keyboard; call the redisplay if needed */
2258 /* commandflag 0 means do not autosave, but do redisplay.
2259 -1 means do not redisplay, but do autosave.
2262 /* The arguments MAPS and NMAPS are for menu prompting.
2263 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2265 PREV_EVENT is the previous input event, or nil if we are reading
2266 the first event of a key sequence (or not reading a key sequence).
2267 If PREV_EVENT is t, that is a "magic" value that says
2268 not to run input methods, but in other respects to act as if
2269 not reading a key sequence.
2271 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2272 if we used a mouse menu to read the input, or zero otherwise. If
2273 USED_MOUSE_MENU is null, we don't dereference it.
2275 Value is -2 when we find input on another keyboard. A second call
2276 to read_char will read it.
2278 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2279 specifying the maximum time to wait until. If no input arrives by
2280 that time, stop waiting and return nil.
2282 Value is t if we showed a menu and the user rejected it. */
2285 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2286 Lisp_Object prev_event
,
2287 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2291 sys_jmp_buf local_getcjmp
;
2292 sys_jmp_buf save_jump
;
2293 Lisp_Object tem
, save
;
2294 volatile Lisp_Object previous_echo_area_message
;
2295 volatile Lisp_Object also_record
;
2296 volatile int reread
;
2297 struct gcpro gcpro1
, gcpro2
;
2298 int volatile polling_stopped_here
= 0;
2299 struct kboard
*orig_kboard
= current_kboard
;
2303 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2304 before_command_key_count
= this_command_key_count
;
2305 before_command_echo_length
= echo_length ();
2308 previous_echo_area_message
= Qnil
;
2310 GCPRO2 (c
, previous_echo_area_message
);
2315 if (CONSP (Vunread_post_input_method_events
))
2317 c
= XCAR (Vunread_post_input_method_events
);
2318 Vunread_post_input_method_events
2319 = XCDR (Vunread_post_input_method_events
);
2321 /* Undo what read_char_x_menu_prompt did when it unread
2322 additional keys returned by Fx_popup_menu. */
2324 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2332 if (CONSP (Vunread_command_events
))
2334 int was_disabled
= 0;
2336 c
= XCAR (Vunread_command_events
);
2337 Vunread_command_events
= XCDR (Vunread_command_events
);
2341 /* Undo what sit-for did when it unread additional keys
2342 inside universal-argument. */
2345 && EQ (XCAR (c
), Qt
))
2351 /* Undo what read_char_x_menu_prompt did when it unread
2352 additional keys returned by Fx_popup_menu. */
2354 && EQ (XCDR (c
), Qdisabled
)
2355 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2361 /* If the queued event is something that used the mouse,
2362 set used_mouse_menu accordingly. */
2364 /* Also check was_disabled so last-nonmenu-event won't return
2365 a bad value when submenus are involved. (Bug#447) */
2366 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2367 *used_mouse_menu
= 1;
2369 goto reread_for_input_method
;
2372 if (CONSP (Vunread_input_method_events
))
2374 c
= XCAR (Vunread_input_method_events
);
2375 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2377 /* Undo what read_char_x_menu_prompt did when it unread
2378 additional keys returned by Fx_popup_menu. */
2380 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2384 goto reread_for_input_method
;
2387 this_command_key_count_reset
= 0;
2389 if (!NILP (Vexecuting_kbd_macro
))
2391 /* We set this to Qmacro; since that's not a frame, nobody will
2392 try to switch frames on us, and the selected window will
2395 Since this event came from a macro, it would be misleading to
2396 leave internal_last_event_frame set to wherever the last
2397 real event came from. Normally, a switch-frame event selects
2398 internal_last_event_frame after each command is read, but
2399 events read from a macro should never cause a new frame to be
2401 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2403 /* Exit the macro if we are at the end.
2404 Also, some things replace the macro with t
2405 to force an early exit. */
2406 if (EQ (Vexecuting_kbd_macro
, Qt
)
2407 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2413 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2414 if (STRINGP (Vexecuting_kbd_macro
)
2415 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2416 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2418 executing_kbd_macro_index
++;
2423 if (!NILP (unread_switch_frame
))
2425 c
= unread_switch_frame
;
2426 unread_switch_frame
= Qnil
;
2428 /* This event should make it into this_command_keys, and get echoed
2429 again, so we do not set `reread'. */
2433 /* if redisplay was requested */
2434 if (commandflag
>= 0)
2436 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2438 /* If there is pending input, process any events which are not
2439 user-visible, such as X selection_request events. */
2441 || detect_input_pending_run_timers (0))
2442 swallow_events (0); /* may clear input_pending */
2444 /* Redisplay if no pending input. */
2445 while (!input_pending
)
2447 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2448 redisplay_preserve_echo_area (5);
2453 /* Normal case: no input arrived during redisplay. */
2456 /* Input arrived and pre-empted redisplay.
2457 Process any events which are not user-visible. */
2459 /* If that cleared input_pending, try again to redisplay. */
2462 /* Prevent the redisplay we just did
2463 from messing up echoing of the input after the prompt. */
2464 if (commandflag
== 0 && echo_current
)
2465 echo_message_buffer
= echo_area_buffer
[0];
2469 /* Message turns off echoing unless more keystrokes turn it on again.
2471 The code in 20.x for the condition was
2473 1. echo_area_glyphs && *echo_area_glyphs
2474 2. && echo_area_glyphs != current_kboard->echobuf
2475 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2477 (1) means there's a current message displayed
2479 (2) means it's not the message from echoing from the current
2482 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2483 is set to a non-null value. This is done in read_char and it is
2484 set to echo_area_glyphs after a call to echo_char. That means
2485 ok_to_echo_at_next_pause is either null or
2486 current_kboard->echobuf with the appropriate current_kboard at
2489 So, condition (3) means in clear text ok_to_echo_at_next_pause
2490 must be either null, or the current message isn't from echoing at
2491 all, or it's from echoing from a different kboard than the
2494 if (/* There currently is something in the echo area. */
2495 !NILP (echo_area_buffer
[0])
2496 && (/* And it's either not from echoing. */
2497 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2498 /* Or it's an echo from a different kboard. */
2499 || echo_kboard
!= current_kboard
2500 /* Or we explicitly allow overwriting whatever there is. */
2501 || ok_to_echo_at_next_pause
== NULL
))
2506 /* Try reading a character via menu prompting in the minibuf.
2507 Try this before the sit-for, because the sit-for
2508 would do the wrong thing if we are supposed to do
2509 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2510 after a mouse event so don't try a minibuf menu. */
2512 if (nmaps
> 0 && INTERACTIVE
2513 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2514 /* Don't bring up a menu if we already have another event. */
2515 && NILP (Vunread_command_events
)
2516 && !detect_input_pending_run_timers (0))
2518 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2520 if (INTEGERP (c
) && XINT (c
) == -2)
2521 return c
; /* wrong_kboard_jmpbuf */
2527 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2528 We will do that below, temporarily for short sections of code,
2529 when appropriate. local_getcjmp must be in effect
2530 around any call to sit_for or kbd_buffer_get_event;
2531 it *must not* be in effect when we call redisplay. */
2533 jmpcount
= SPECPDL_INDEX ();
2534 if (sys_setjmp (local_getcjmp
))
2536 /* Handle quits while reading the keyboard. */
2537 /* We must have saved the outer value of getcjmp here,
2538 so restore it now. */
2539 restore_getcjmp (save_jump
);
2540 unbind_to (jmpcount
, Qnil
);
2541 XSETINT (c
, quit_char
);
2542 internal_last_event_frame
= selected_frame
;
2543 Vlast_event_frame
= internal_last_event_frame
;
2544 /* If we report the quit char as an event,
2545 don't do so more than once. */
2546 if (!NILP (Vinhibit_quit
))
2550 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2551 if (kb
!= current_kboard
)
2553 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2554 /* We shouldn't get here if we were in single-kboard mode! */
2559 while (CONSP (XCDR (last
)))
2561 if (!NILP (XCDR (last
)))
2565 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2567 XSETCDR (last
, Fcons (c
, Qnil
));
2568 kb
->kbd_queue_has_data
= 1;
2569 current_kboard
= kb
;
2570 /* This is going to exit from read_char
2571 so we had better get rid of this frame's stuff. */
2573 return make_number (-2); /* wrong_kboard_jmpbuf */
2579 /* Start idle timers if no time limit is supplied. We don't do it
2580 if a time limit is supplied to avoid an infinite recursion in the
2581 situation where an idle timer calls `sit-for'. */
2584 timer_start_idle ();
2586 /* If in middle of key sequence and minibuffer not active,
2587 start echoing if enough time elapses. */
2589 if (minibuf_level
== 0
2591 && !current_kboard
->immediate_echo
2592 && this_command_key_count
> 0
2594 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2595 && NILP (Fzerop (Vecho_keystrokes
))
2596 && (/* No message. */
2597 NILP (echo_area_buffer
[0])
2598 /* Or empty message. */
2599 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2600 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2601 /* Or already echoing from same kboard. */
2602 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2603 /* Or not echoing before and echoing allowed. */
2604 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2606 /* After a mouse event, start echoing right away.
2607 This is because we are probably about to display a menu,
2608 and we don't want to delay before doing so. */
2609 if (EVENT_HAS_PARAMETERS (prev_event
))
2615 save_getcjmp (save_jump
);
2616 restore_getcjmp (local_getcjmp
);
2617 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2618 restore_getcjmp (save_jump
);
2620 && ! CONSP (Vunread_command_events
))
2625 /* Maybe auto save due to number of keystrokes. */
2627 if (commandflag
!= 0
2628 && auto_save_interval
> 0
2629 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2630 && !detect_input_pending_run_timers (0))
2632 Fdo_auto_save (Qnil
, Qnil
);
2633 /* Hooks can actually change some buffers in auto save. */
2637 /* Try reading using an X menu.
2638 This is never confused with reading using the minibuf
2639 because the recursive call of read_char in read_char_minibuf_menu_prompt
2640 does not pass on any keymaps. */
2642 if (nmaps
> 0 && INTERACTIVE
2643 && !NILP (prev_event
)
2644 && EVENT_HAS_PARAMETERS (prev_event
)
2645 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2646 && !EQ (XCAR (prev_event
), Qtool_bar
)
2647 /* Don't bring up a menu if we already have another event. */
2648 && NILP (Vunread_command_events
))
2650 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2652 /* Now that we have read an event, Emacs is not idle. */
2659 /* Maybe autosave and/or garbage collect due to idleness. */
2661 if (INTERACTIVE
&& NILP (c
))
2664 ptrdiff_t buffer_size
;
2666 /* Slow down auto saves logarithmically in size of current buffer,
2667 and garbage collect while we're at it. */
2668 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2669 last_non_minibuf_size
= Z
- BEG
;
2670 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2672 while (buffer_size
> 64)
2673 delay_level
++, buffer_size
-= buffer_size
>> 2;
2674 if (delay_level
< 4) delay_level
= 4;
2675 /* delay_level is 4 for files under around 50k, 7 at 100k,
2676 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2678 /* Auto save if enough time goes by without input. */
2679 if (commandflag
!= 0
2680 && num_nonmacro_input_events
> last_auto_save
2681 && INTEGERP (Vauto_save_timeout
)
2682 && XINT (Vauto_save_timeout
) > 0)
2685 EMACS_INT timeout
= (delay_level
2686 * min (XFASTINT (Vauto_save_timeout
) / 4,
2687 MOST_POSITIVE_FIXNUM
/ delay_level
));
2688 save_getcjmp (save_jump
);
2689 restore_getcjmp (local_getcjmp
);
2690 tem0
= sit_for (make_number (timeout
), 1, 1);
2691 restore_getcjmp (save_jump
);
2694 && ! CONSP (Vunread_command_events
))
2696 Fdo_auto_save (Qnil
, Qnil
);
2701 /* If there is still no input available, ask for GC. */
2702 if (!detect_input_pending_run_timers (0))
2706 /* Notify the caller if an autosave hook, or a timer, sentinel or
2707 filter in the sit_for calls above have changed the current
2708 kboard. This could happen if they use the minibuffer or start a
2709 recursive edit, like the fancy splash screen in server.el's
2710 filter. If this longjmp wasn't here, read_key_sequence would
2711 interpret the next key sequence using the wrong translation
2712 tables and function keymaps. */
2713 if (NILP (c
) && current_kboard
!= orig_kboard
)
2716 return make_number (-2); /* wrong_kboard_jmpbuf */
2719 /* If this has become non-nil here, it has been set by a timer
2720 or sentinel or filter. */
2721 if (CONSP (Vunread_command_events
))
2723 c
= XCAR (Vunread_command_events
);
2724 Vunread_command_events
= XCDR (Vunread_command_events
);
2727 /* Read something from current KBOARD's side queue, if possible. */
2731 if (current_kboard
->kbd_queue_has_data
)
2733 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2735 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2736 kset_kbd_queue (current_kboard
,
2737 XCDR (KVAR (current_kboard
, kbd_queue
)));
2738 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2739 current_kboard
->kbd_queue_has_data
= 0;
2740 input_pending
= readable_events (0);
2741 if (EVENT_HAS_PARAMETERS (c
)
2742 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2743 internal_last_event_frame
= XCAR (XCDR (c
));
2744 Vlast_event_frame
= internal_last_event_frame
;
2748 /* If current_kboard's side queue is empty check the other kboards.
2749 If one of them has data that we have not yet seen here,
2750 switch to it and process the data waiting for it.
2752 Note: if the events queued up for another kboard
2753 have already been seen here, and therefore are not a complete command,
2754 the kbd_queue_has_data field is 0, so we skip that kboard here.
2755 That's to avoid an infinite loop switching between kboards here. */
2756 if (NILP (c
) && !single_kboard
)
2759 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2760 if (kb
->kbd_queue_has_data
)
2762 current_kboard
= kb
;
2763 /* This is going to exit from read_char
2764 so we had better get rid of this frame's stuff. */
2766 return make_number (-2); /* wrong_kboard_jmpbuf */
2774 /* Finally, we read from the main queue,
2775 and if that gives us something we can't use yet, we put it on the
2776 appropriate side queue and try again. */
2780 KBOARD
*kb
IF_LINT (= NULL
);
2782 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2785 /* Actually read a character, waiting if necessary. */
2786 save_getcjmp (save_jump
);
2787 restore_getcjmp (local_getcjmp
);
2789 timer_start_idle ();
2790 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2791 restore_getcjmp (save_jump
);
2793 if (! NILP (c
) && (kb
!= current_kboard
))
2795 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2798 while (CONSP (XCDR (last
)))
2800 if (!NILP (XCDR (last
)))
2804 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2806 XSETCDR (last
, Fcons (c
, Qnil
));
2807 kb
->kbd_queue_has_data
= 1;
2811 current_kboard
= kb
;
2812 /* This is going to exit from read_char
2813 so we had better get rid of this frame's stuff. */
2815 return make_number (-2);
2819 /* Terminate Emacs in batch mode if at eof. */
2820 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2821 Fkill_emacs (make_number (1));
2825 /* Add in any extra modifiers, where appropriate. */
2826 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2827 || ((extra_keyboard_modifiers
& 0177) < ' '
2828 && (extra_keyboard_modifiers
& 0177) != 0))
2829 XSETINT (c
, make_ctrl_char (XINT (c
)));
2831 /* Transfer any other modifier bits directly from
2832 extra_keyboard_modifiers to c. Ignore the actual character code
2833 in the low 16 bits of extra_keyboard_modifiers. */
2834 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2845 if (commandflag
>= 0
2846 && !input_pending
&& !detect_input_pending_run_timers (0))
2852 /* Buffer switch events are only for internal wakeups
2853 so don't show them to the user.
2854 Also, don't record a key if we already did. */
2858 /* Process special events within read_char
2859 and loop around to read another event. */
2862 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2867 struct buffer
*prev_buffer
= current_buffer
;
2868 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2869 int was_locked
= single_kboard
;
2870 ptrdiff_t count
= SPECPDL_INDEX ();
2871 record_single_kboard_state ();
2874 last_input_event
= c
;
2875 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2877 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2878 /* We stopped being idle for this event; undo that. This
2879 prevents automatic window selection (under
2880 mouse_autoselect_window from acting as a real input event, for
2881 example banishing the mouse under mouse-avoidance-mode. */
2882 timer_resume_idle ();
2884 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2885 /* Resume allowing input from any kboard, if that was true before. */
2887 any_kboard_state ();
2888 unbind_to (count
, Qnil
);
2891 if (current_buffer
!= prev_buffer
)
2893 /* The command may have changed the keymaps. Pretend there
2894 is input in another keyboard and return. This will
2895 recalculate keymaps. */
2896 c
= make_number (-2);
2903 /* Handle things that only apply to characters. */
2906 /* If kbd_buffer_get_event gave us an EOF, return that. */
2910 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2911 && UNSIGNED_CMP (XFASTINT (c
), <,
2912 SCHARS (KVAR (current_kboard
,
2913 Vkeyboard_translate_table
))))
2914 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2915 && UNSIGNED_CMP (XFASTINT (c
), <,
2916 ASIZE (KVAR (current_kboard
,
2917 Vkeyboard_translate_table
))))
2918 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2922 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2923 /* nil in keyboard-translate-table means no translation. */
2929 /* If this event is a mouse click in the menu bar,
2930 return just menu-bar for now. Modify the mouse click event
2931 so we won't do this twice, then queue it up. */
2932 if (EVENT_HAS_PARAMETERS (c
)
2934 && CONSP (EVENT_START (c
))
2935 && CONSP (XCDR (EVENT_START (c
))))
2939 posn
= POSN_POSN (EVENT_START (c
));
2940 /* Handle menu-bar events:
2941 insert the dummy prefix event `menu-bar'. */
2942 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2944 /* Change menu-bar to (menu-bar) as the event "position". */
2945 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2948 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2953 /* Store these characters into recent_keys, the dribble file if any,
2954 and the keyboard macro being defined, if any. */
2956 if (! NILP (also_record
))
2957 record_char (also_record
);
2959 /* Wipe the echo area.
2960 But first, if we are about to use an input method,
2961 save the echo area contents for it to refer to. */
2963 && ! NILP (Vinput_method_function
)
2964 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2966 previous_echo_area_message
= Fcurrent_message ();
2967 Vinput_method_previous_message
= previous_echo_area_message
;
2970 /* Now wipe the echo area, except for help events which do their
2971 own stuff with the echo area. */
2973 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2974 && !(EQ (Qswitch_frame
, XCAR (c
)))
2975 /* Don't wipe echo area for select window events: These might
2976 get delayed via `mouse-autoselect-window' (Bug#11304). */
2977 && !(EQ (Qselect_window
, XCAR (c
)))))
2979 if (!NILP (echo_area_buffer
[0]))
2981 safe_run_hooks (Qecho_area_clear_hook
);
2982 clear_message (1, 0);
2986 reread_for_input_method
:
2988 /* Pass this to the input method, if appropriate. */
2990 && ! NILP (Vinput_method_function
)
2991 /* Don't run the input method within a key sequence,
2992 after the first event of the key sequence. */
2993 && NILP (prev_event
)
2994 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2997 ptrdiff_t key_count
;
2998 int key_count_reset
;
2999 struct gcpro gcpro1
;
3000 ptrdiff_t count
= SPECPDL_INDEX ();
3002 /* Save the echo status. */
3003 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3004 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3005 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3006 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3009 if (before_command_restore_flag
)
3011 this_command_key_count
= before_command_key_count_1
;
3012 if (this_command_key_count
< this_single_command_key_start
)
3013 this_single_command_key_start
= this_command_key_count
;
3014 echo_truncate (before_command_echo_length_1
);
3015 before_command_restore_flag
= 0;
3019 /* Save the this_command_keys status. */
3020 key_count
= this_command_key_count
;
3021 key_count_reset
= this_command_key_count_reset
;
3024 keys
= Fcopy_sequence (this_command_keys
);
3029 /* Clear out this_command_keys. */
3030 this_command_key_count
= 0;
3031 this_command_key_count_reset
= 0;
3033 /* Now wipe the echo area. */
3034 if (!NILP (echo_area_buffer
[0]))
3035 safe_run_hooks (Qecho_area_clear_hook
);
3036 clear_message (1, 0);
3039 /* If we are not reading a key sequence,
3040 never use the echo area. */
3043 specbind (Qinput_method_use_echo_area
, Qt
);
3046 /* Call the input method. */
3047 tem
= call1 (Vinput_method_function
, c
);
3049 tem
= unbind_to (count
, tem
);
3051 /* Restore the saved echoing state
3052 and this_command_keys state. */
3053 this_command_key_count
= key_count
;
3054 this_command_key_count_reset
= key_count_reset
;
3056 this_command_keys
= keys
;
3059 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3060 kset_echo_string (current_kboard
, saved_echo_string
);
3061 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3062 if (saved_immediate_echo
)
3067 /* The input method can return no events. */
3070 /* Bring back the previous message, if any. */
3071 if (! NILP (previous_echo_area_message
))
3072 message_with_string ("%s", previous_echo_area_message
, 0);
3075 /* It returned one event or more. */
3077 Vunread_post_input_method_events
3078 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3083 /* Display help if not echoing. */
3084 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3086 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3087 Lisp_Object help
, object
, position
, window
, htem
;
3089 htem
= Fcdr (XCDR (c
));
3092 window
= Fcar (htem
);
3094 object
= Fcar (htem
);
3096 position
= Fcar (htem
);
3098 show_help_echo (help
, window
, object
, position
);
3100 /* We stopped being idle for this event; undo that. */
3102 timer_resume_idle ();
3106 if ((! reread
|| this_command_key_count
== 0
3107 || this_command_key_count_reset
)
3111 /* Don't echo mouse motion events. */
3112 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3113 && NILP (Fzerop (Vecho_keystrokes
))
3114 && ! (EVENT_HAS_PARAMETERS (c
)
3115 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3118 if (! NILP (also_record
))
3119 echo_char (also_record
);
3120 /* Once we reread a character, echoing can happen
3121 the next time we pause to read a new one. */
3122 ok_to_echo_at_next_pause
= current_kboard
;
3125 /* Record this character as part of the current key. */
3126 add_command_key (c
);
3127 if (! NILP (also_record
))
3128 add_command_key (also_record
);
3131 last_input_event
= c
;
3134 /* Process the help character specially if enabled */
3135 if (!NILP (Vhelp_form
) && help_char_p (c
))
3137 ptrdiff_t count
= SPECPDL_INDEX ();
3139 help_form_saved_window_configs
3140 = Fcons (Fcurrent_window_configuration (Qnil
),
3141 help_form_saved_window_configs
);
3142 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3143 call0 (Qhelp_form_show
);
3148 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3149 if (EVENT_HAS_PARAMETERS (c
)
3150 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3151 XSETCAR (help_form_saved_window_configs
, Qnil
);
3153 while (BUFFERP (c
));
3154 /* Remove the help from the frame */
3155 unbind_to (count
, Qnil
);
3158 if (EQ (c
, make_number (040)))
3162 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3163 while (BUFFERP (c
));
3172 /* Record a key that came from a mouse menu.
3173 Record it for echoing, for this-command-keys, and so on. */
3176 record_menu_key (Lisp_Object c
)
3178 /* Wipe the echo area. */
3179 clear_message (1, 0);
3184 before_command_key_count
= this_command_key_count
;
3185 before_command_echo_length
= echo_length ();
3188 /* Don't echo mouse motion events. */
3189 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3190 && NILP (Fzerop (Vecho_keystrokes
)))
3194 /* Once we reread a character, echoing can happen
3195 the next time we pause to read a new one. */
3196 ok_to_echo_at_next_pause
= 0;
3199 /* Record this character as part of the current key. */
3200 add_command_key (c
);
3202 /* Re-reading in the middle of a command */
3203 last_input_event
= c
;
3207 /* Return 1 if should recognize C as "the help character". */
3210 help_char_p (Lisp_Object c
)
3214 if (EQ (c
, Vhelp_char
))
3216 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3217 if (EQ (c
, XCAR (tail
)))
3222 /* Record the input event C in various ways. */
3225 record_char (Lisp_Object c
)
3229 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3231 /* To avoid filling recent_keys with help-echo and mouse-movement
3232 events, we filter out repeated help-echo events, only store the
3233 first and last in a series of mouse-movement events, and don't
3234 store repeated help-echo events which are only separated by
3235 mouse-movement events. */
3237 Lisp_Object ev1
, ev2
, ev3
;
3240 if ((ix1
= recent_keys_index
- 1) < 0)
3241 ix1
= NUM_RECENT_KEYS
- 1;
3242 ev1
= AREF (recent_keys
, ix1
);
3244 if ((ix2
= ix1
- 1) < 0)
3245 ix2
= NUM_RECENT_KEYS
- 1;
3246 ev2
= AREF (recent_keys
, ix2
);
3248 if ((ix3
= ix2
- 1) < 0)
3249 ix3
= NUM_RECENT_KEYS
- 1;
3250 ev3
= AREF (recent_keys
, ix3
);
3252 if (EQ (XCAR (c
), Qhelp_echo
))
3254 /* Don't record `help-echo' in recent_keys unless it shows some help
3255 message, and a different help than the previously recorded
3257 Lisp_Object help
, last_help
;
3259 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3260 if (!STRINGP (help
))
3262 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3263 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3265 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3266 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3267 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3269 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3270 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3271 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3272 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3275 else if (EQ (XCAR (c
), Qmouse_movement
))
3277 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3278 So additional mouse movement events replace the last element. */
3279 Lisp_Object last_window
, window
;
3281 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3282 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3283 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3284 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3285 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3287 ASET (recent_keys
, ix1
, c
);
3293 store_kbd_macro_char (c
);
3297 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3298 ASET (recent_keys
, recent_keys_index
, c
);
3299 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3300 recent_keys_index
= 0;
3302 else if (recorded
< 0)
3304 /* We need to remove one or two events from recent_keys.
3305 To do this, we simply put nil at those events and move the
3306 recent_keys_index backwards over those events. Usually,
3307 users will never see those nil events, as they will be
3308 overwritten by the command keys entered to see recent_keys
3311 while (recorded
++ < 0 && total_keys
> 0)
3313 if (total_keys
< NUM_RECENT_KEYS
)
3315 if (--recent_keys_index
< 0)
3316 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3317 ASET (recent_keys
, recent_keys_index
, Qnil
);
3321 num_nonmacro_input_events
++;
3323 /* Write c to the dribble file. If c is a lispy event, write
3324 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3325 If you, dear reader, have a better idea, you've got the source. :-) */
3331 if (XUINT (c
) < 0x100)
3332 putc (XUINT (c
), dribble
);
3334 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3338 Lisp_Object dribblee
;
3340 /* If it's a structured event, take the event header. */
3341 dribblee
= EVENT_HEAD (c
);
3343 if (SYMBOLP (dribblee
))
3345 putc ('<', dribble
);
3346 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3347 SBYTES (SYMBOL_NAME (dribblee
)),
3349 putc ('>', dribble
);
3358 /* Copy out or in the info on where C-g should throw to.
3359 This is used when running Lisp code from within get_char,
3360 in case get_char is called recursively.
3361 See read_process_output. */
3364 save_getcjmp (sys_jmp_buf temp
)
3366 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3370 restore_getcjmp (sys_jmp_buf temp
)
3372 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3375 /* Low level keyboard/mouse input.
3376 kbd_buffer_store_event places events in kbd_buffer, and
3377 kbd_buffer_get_event retrieves them. */
3379 /* Return true if there are any events in the queue that read-char
3380 would return. If this returns false, a read-char would block. */
3382 readable_events (int flags
)
3384 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3387 /* If the buffer contains only FOCUS_IN_EVENT events, and
3388 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3389 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3391 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3392 #ifdef USE_TOOLKIT_SCROLL_BARS
3393 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3397 struct input_event
*event
;
3399 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3406 #ifdef USE_TOOLKIT_SCROLL_BARS
3407 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3409 event
->kind
== FOCUS_IN_EVENT
)
3410 #ifdef USE_TOOLKIT_SCROLL_BARS
3411 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3412 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3413 && event
->part
== scroll_bar_handle
3414 && event
->modifiers
== 0)
3419 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3422 while (event
!= kbd_store_ptr
);
3428 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3429 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3430 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3435 if (current_kboard
->kbd_queue_has_data
)
3441 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3442 if (kb
->kbd_queue_has_data
)
3448 /* Set this for debugging, to have a way to get out */
3449 int stop_character EXTERNALLY_VISIBLE
;
3452 event_to_kboard (struct input_event
*event
)
3455 frame
= event
->frame_or_window
;
3457 frame
= XCAR (frame
);
3458 else if (WINDOWP (frame
))
3459 frame
= WINDOW_FRAME (XWINDOW (frame
));
3461 /* There are still some events that don't set this field.
3462 For now, just ignore the problem.
3463 Also ignore dead frames here. */
3464 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3467 return FRAME_KBOARD (XFRAME (frame
));
3471 /* Return the number of slots occupied in kbd_buffer. */
3474 kbd_buffer_nr_stored (void)
3476 return kbd_fetch_ptr
== kbd_store_ptr
3478 : (kbd_fetch_ptr
< kbd_store_ptr
3479 ? kbd_store_ptr
- kbd_fetch_ptr
3480 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3481 + (kbd_store_ptr
- kbd_buffer
)));
3483 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3486 kbd_buffer_store_event (register struct input_event
*event
)
3488 kbd_buffer_store_event_hold (event
, 0);
3491 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3493 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3494 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3495 Else, if EVENT is a quit event, store the quit event
3496 in HOLD_QUIT, and return (thus ignoring further events).
3498 This is used to postpone the processing of the quit event until all
3499 subsequent input events have been parsed (and discarded). */
3502 kbd_buffer_store_event_hold (register struct input_event
*event
,
3503 struct input_event
*hold_quit
)
3505 if (event
->kind
== NO_EVENT
)
3508 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3511 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3513 register int c
= event
->code
& 0377;
3515 if (event
->modifiers
& ctrl_modifier
)
3516 c
= make_ctrl_char (c
);
3518 c
|= (event
->modifiers
3519 & (meta_modifier
| alt_modifier
3520 | hyper_modifier
| super_modifier
));
3524 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3525 struct input_event
*sp
;
3527 if (single_kboard
&& kb
!= current_kboard
)
3530 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3531 Fcons (make_number (c
), Qnil
)));
3532 kb
->kbd_queue_has_data
= 1;
3533 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3535 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3538 if (event_to_kboard (sp
) == kb
)
3540 sp
->kind
= NO_EVENT
;
3541 sp
->frame_or_window
= Qnil
;
3550 *hold_quit
= *event
;
3554 /* If this results in a quit_char being returned to Emacs as
3555 input, set Vlast_event_frame properly. If this doesn't
3556 get returned to Emacs as an event, the next event read
3557 will set Vlast_event_frame again, so this is safe to do. */
3561 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3563 focus
= event
->frame_or_window
;
3564 internal_last_event_frame
= focus
;
3565 Vlast_event_frame
= focus
;
3568 last_event_timestamp
= event
->timestamp
;
3570 handle_interrupt (0);
3574 if (c
&& c
== stop_character
)
3580 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3581 Just ignore the second one. */
3582 else if (event
->kind
== BUFFER_SWITCH_EVENT
3583 && kbd_fetch_ptr
!= kbd_store_ptr
3584 && ((kbd_store_ptr
== kbd_buffer
3585 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3586 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3589 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3590 kbd_store_ptr
= kbd_buffer
;
3592 /* Don't let the very last slot in the buffer become full,
3593 since that would make the two pointers equal,
3594 and that is indistinguishable from an empty buffer.
3595 Discard the event if it would fill the last slot. */
3596 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3598 *kbd_store_ptr
= *event
;
3601 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3603 /* Don't read keyboard input until we have processed kbd_buffer.
3604 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3605 hold_keyboard_input ();
3606 if (!noninteractive
)
3610 #endif /* subprocesses */
3613 /* If we're inside while-no-input, and this event qualifies
3614 as input, set quit-flag to cause an interrupt. */
3615 if (!NILP (Vthrow_on_input
)
3616 && event
->kind
!= FOCUS_IN_EVENT
3617 && event
->kind
!= HELP_EVENT
3618 && event
->kind
!= DEICONIFY_EVENT
)
3620 Vquit_flag
= Vthrow_on_input
;
3621 /* If we're inside a function that wants immediate quits,
3623 if (immediate_quit
&& NILP (Vinhibit_quit
))
3632 /* Put an input event back in the head of the event queue. */
3635 kbd_buffer_unget_event (register struct input_event
*event
)
3637 if (kbd_fetch_ptr
== kbd_buffer
)
3638 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3640 /* Don't let the very last slot in the buffer become full, */
3641 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3644 *kbd_fetch_ptr
= *event
;
3649 /* Generate a HELP_EVENT input_event and store it in the keyboard
3652 HELP is the help form.
3654 FRAME and WINDOW are the frame and window where the help is
3655 generated. OBJECT is the Lisp object where the help was found (a
3656 buffer, a string, an overlay, or nil if neither from a string nor
3657 from a buffer). POS is the position within OBJECT where the help
3661 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3662 Lisp_Object object
, ptrdiff_t pos
)
3664 struct input_event event
;
3668 event
.kind
= HELP_EVENT
;
3669 event
.frame_or_window
= frame
;
3671 event
.x
= WINDOWP (window
) ? window
: frame
;
3674 kbd_buffer_store_event (&event
);
3678 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3681 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3683 struct input_event event
;
3685 event
.kind
= HELP_EVENT
;
3686 event
.frame_or_window
= frame
;
3691 kbd_buffer_store_event (&event
);
3695 /* Discard any mouse events in the event buffer by setting them to
3698 discard_mouse_events (void)
3700 struct input_event
*sp
;
3701 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3703 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3706 if (sp
->kind
== MOUSE_CLICK_EVENT
3707 || sp
->kind
== WHEEL_EVENT
3708 || sp
->kind
== HORIZ_WHEEL_EVENT
3710 || sp
->kind
== GPM_CLICK_EVENT
3712 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3714 sp
->kind
= NO_EVENT
;
3720 /* Return non-zero if there are any real events waiting in the event
3721 buffer, not counting `NO_EVENT's.
3723 If DISCARD is non-zero, discard NO_EVENT events at the front of
3724 the input queue, possibly leaving the input queue empty if there
3725 are no real input events. */
3728 kbd_buffer_events_waiting (int discard
)
3730 struct input_event
*sp
;
3732 for (sp
= kbd_fetch_ptr
;
3733 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3736 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3743 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3747 /* Clear input event EVENT. */
3750 clear_event (struct input_event
*event
)
3752 event
->kind
= NO_EVENT
;
3756 /* Read one event from the event buffer, waiting if necessary.
3757 The value is a Lisp object representing the event.
3758 The value is nil for an event that should be ignored,
3759 or that was handled here.
3760 We always read and discard one event. */
3763 kbd_buffer_get_event (KBOARD
**kbp
,
3764 int *used_mouse_menu
,
3765 EMACS_TIME
*end_time
)
3770 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3772 /* Start reading input again because we have processed enough to
3773 be able to accept new events again. */
3774 unhold_keyboard_input ();
3777 #endif /* subprocesses */
3779 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3781 /* In case we are running as a daemon, only do this before
3782 detaching from the terminal. */
3783 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3787 *kbp
= current_kboard
;
3790 #endif /* ! HAVE_DBUS */
3792 /* Wait until there is input available. */
3795 /* Break loop if there's an unread command event. Needed in
3796 moused window autoselection which uses a timer to insert such
3798 if (CONSP (Vunread_command_events
))
3801 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3803 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3804 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3808 /* If the quit flag is set, then read_char will return
3809 quit_char, so that counts as "available input." */
3810 if (!NILP (Vquit_flag
))
3811 quit_throw_to_read_char (0);
3813 /* One way or another, wait until input is available; then, if
3814 interrupt handlers have not read it, read it now. */
3819 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3821 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3822 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3827 EMACS_TIME now
= current_emacs_time ();
3828 if (EMACS_TIME_LE (*end_time
, now
))
3829 return Qnil
; /* Finished waiting. */
3832 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3833 wait_reading_process_output (min (EMACS_SECS (duration
),
3835 EMACS_NSECS (duration
),
3836 -1, 1, Qnil
, NULL
, 0);
3840 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3842 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3846 if (CONSP (Vunread_command_events
))
3849 first
= XCAR (Vunread_command_events
);
3850 Vunread_command_events
= XCDR (Vunread_command_events
);
3851 *kbp
= current_kboard
;
3855 /* At this point, we know that there is a readable event available
3856 somewhere. If the event queue is empty, then there must be a
3857 mouse movement enabled and available. */
3858 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3860 struct input_event
*event
;
3862 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3866 last_event_timestamp
= event
->timestamp
;
3868 *kbp
= event_to_kboard (event
);
3870 *kbp
= current_kboard
; /* Better than returning null ptr? */
3874 /* These two kinds of events get special handling
3875 and don't actually appear to the command loop.
3876 We return nil for them. */
3877 if (event
->kind
== SELECTION_REQUEST_EVENT
3878 || event
->kind
== SELECTION_CLEAR_EVENT
)
3881 struct input_event copy
;
3883 /* Remove it from the buffer before processing it,
3884 since otherwise swallow_events will see it
3885 and process it again. */
3887 kbd_fetch_ptr
= event
+ 1;
3888 input_pending
= readable_events (0);
3889 x_handle_selection_event (©
);
3891 /* We're getting selection request events, but we don't have
3897 #if defined (HAVE_NS)
3898 else if (event
->kind
== NS_TEXT_EVENT
)
3900 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3901 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3903 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3904 kbd_fetch_ptr
= event
+ 1;
3905 if (used_mouse_menu
)
3906 *used_mouse_menu
= 1;
3910 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3911 || defined (HAVE_NS)
3912 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3914 /* Make an event (delete-frame (FRAME)). */
3915 obj
= Fcons (event
->frame_or_window
, Qnil
);
3916 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3917 kbd_fetch_ptr
= event
+ 1;
3920 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3921 || defined (HAVE_NS)
3922 else if (event
->kind
== ICONIFY_EVENT
)
3924 /* Make an event (iconify-frame (FRAME)). */
3925 obj
= Fcons (event
->frame_or_window
, Qnil
);
3926 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3927 kbd_fetch_ptr
= event
+ 1;
3929 else if (event
->kind
== DEICONIFY_EVENT
)
3931 /* Make an event (make-frame-visible (FRAME)). */
3932 obj
= Fcons (event
->frame_or_window
, Qnil
);
3933 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3934 kbd_fetch_ptr
= event
+ 1;
3937 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3939 /* The value doesn't matter here; only the type is tested. */
3940 XSETBUFFER (obj
, current_buffer
);
3941 kbd_fetch_ptr
= event
+ 1;
3943 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3944 || defined (HAVE_NS) || defined (USE_GTK)
3945 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3947 kbd_fetch_ptr
= event
+ 1;
3948 input_pending
= readable_events (0);
3949 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3950 x_activate_menubar (XFRAME (event
->frame_or_window
));
3954 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3956 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3957 obj
= Fcons (Qlanguage_change
,
3958 list3 (event
->frame_or_window
,
3959 make_number (event
->code
),
3960 make_number (event
->modifiers
)));
3961 kbd_fetch_ptr
= event
+ 1;
3963 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3965 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3966 obj
= Fcons (Qfile_notify
,
3967 list2 (list3 (make_number (event
->code
),
3970 event
->frame_or_window
));
3971 kbd_fetch_ptr
= event
+ 1;
3974 else if (event
->kind
== SAVE_SESSION_EVENT
)
3976 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3977 kbd_fetch_ptr
= event
+ 1;
3979 /* Just discard these, by returning nil.
3980 With MULTI_KBOARD, these events are used as placeholders
3981 when we need to randomly delete events from the queue.
3982 (They shouldn't otherwise be found in the buffer,
3983 but on some machines it appears they do show up
3984 even without MULTI_KBOARD.) */
3985 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3986 mouse events during a popup-menu call. */
3987 else if (event
->kind
== NO_EVENT
)
3988 kbd_fetch_ptr
= event
+ 1;
3989 else if (event
->kind
== HELP_EVENT
)
3991 Lisp_Object object
, position
, help
, frame
, window
;
3993 frame
= event
->frame_or_window
;
3994 object
= event
->arg
;
3995 position
= make_number (event
->code
);
3998 clear_event (event
);
4000 kbd_fetch_ptr
= event
+ 1;
4001 if (!WINDOWP (window
))
4003 obj
= Fcons (Qhelp_echo
,
4004 list5 (frame
, help
, window
, object
, position
));
4006 else if (event
->kind
== FOCUS_IN_EVENT
)
4008 /* Notification of a FocusIn event. The frame receiving the
4009 focus is in event->frame_or_window. Generate a
4010 switch-frame event if necessary. */
4011 Lisp_Object frame
, focus
;
4013 frame
= event
->frame_or_window
;
4014 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4018 if (!EQ (frame
, internal_last_event_frame
)
4019 && !EQ (frame
, selected_frame
))
4020 obj
= make_lispy_switch_frame (frame
);
4021 internal_last_event_frame
= frame
;
4022 kbd_fetch_ptr
= event
+ 1;
4025 else if (event
->kind
== DBUS_EVENT
)
4027 obj
= make_lispy_event (event
);
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4033 obj
= make_lispy_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4038 /* If this event is on a different frame, return a switch-frame this
4039 time, and leave the event in the queue for next time. */
4043 frame
= event
->frame_or_window
;
4045 frame
= XCAR (frame
);
4046 else if (WINDOWP (frame
))
4047 frame
= WINDOW_FRAME (XWINDOW (frame
));
4049 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4053 if (! EQ (frame
, internal_last_event_frame
)
4054 && !EQ (frame
, selected_frame
))
4055 obj
= make_lispy_switch_frame (frame
);
4056 internal_last_event_frame
= frame
;
4058 /* If we didn't decide to make a switch-frame event, go ahead
4059 and build a real event from the queue entry. */
4063 obj
= make_lispy_event (event
);
4065 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4066 || defined (HAVE_NS) || defined (USE_GTK)
4067 /* If this was a menu selection, then set the flag to inhibit
4068 writing to last_nonmenu_event. Don't do this if the event
4069 we're returning is (menu-bar), though; that indicates the
4070 beginning of the menu sequence, and we might as well leave
4071 that as the `event with parameters' for this selection. */
4073 && !EQ (event
->frame_or_window
, event
->arg
)
4074 && (event
->kind
== MENU_BAR_EVENT
4075 || event
->kind
== TOOL_BAR_EVENT
))
4076 *used_mouse_menu
= 1;
4079 /* Certain system events are non-key events. */
4081 && event
->kind
== NS_NONKEY_EVENT
)
4082 *used_mouse_menu
= 1;
4085 /* Wipe out this event, to catch bugs. */
4086 clear_event (event
);
4087 kbd_fetch_ptr
= event
+ 1;
4091 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4092 /* Try generating a mouse motion event. */
4093 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4095 FRAME_PTR f
= some_mouse_moved ();
4096 Lisp_Object bar_window
;
4097 enum scroll_bar_part part
;
4101 *kbp
= current_kboard
;
4102 /* Note that this uses F to determine which terminal to look at.
4103 If there is no valid info, it does not store anything
4104 so x remains nil. */
4107 /* XXX Can f or mouse_position_hook be NULL here? */
4108 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4109 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4114 /* Decide if we should generate a switch-frame event. Don't
4115 generate switch-frame events for motion outside of all Emacs
4121 frame
= FRAME_FOCUS_FRAME (f
);
4123 XSETFRAME (frame
, f
);
4125 if (! EQ (frame
, internal_last_event_frame
)
4126 && !EQ (frame
, selected_frame
))
4127 obj
= make_lispy_switch_frame (frame
);
4128 internal_last_event_frame
= frame
;
4131 /* If we didn't decide to make a switch-frame event, go ahead and
4132 return a mouse-motion event. */
4133 if (!NILP (x
) && NILP (obj
))
4134 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4136 #endif /* HAVE_MOUSE || HAVE GPM */
4138 /* We were promised by the above while loop that there was
4139 something for us to read! */
4142 input_pending
= readable_events (0);
4144 Vlast_event_frame
= internal_last_event_frame
;
4149 /* Process any non-user-visible events (currently X selection events),
4150 without reading any user-visible events. */
4153 process_special_events (void)
4155 struct input_event
*event
;
4157 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4159 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4162 if (event
== kbd_store_ptr
)
4166 /* If we find a stored X selection request, handle it now. */
4167 if (event
->kind
== SELECTION_REQUEST_EVENT
4168 || event
->kind
== SELECTION_CLEAR_EVENT
)
4172 /* Remove the event from the fifo buffer before processing;
4173 otherwise swallow_events called recursively could see it
4174 and process it again. To do this, we move the events
4175 between kbd_fetch_ptr and EVENT one slot to the right,
4178 struct input_event copy
= *event
;
4179 struct input_event
*beg
4180 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4181 ? kbd_buffer
: kbd_fetch_ptr
;
4184 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4185 else if (event
< beg
)
4187 if (event
> kbd_buffer
)
4188 memmove (kbd_buffer
+ 1, kbd_buffer
,
4189 (event
- kbd_buffer
) * sizeof (struct input_event
));
4190 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4191 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4192 memmove (beg
+ 1, beg
,
4193 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4194 * sizeof (struct input_event
));
4197 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4198 kbd_fetch_ptr
= kbd_buffer
+ 1;
4202 /* X wants last_event_timestamp for selection ownership. */
4203 last_event_timestamp
= copy
.timestamp
;
4204 input_pending
= readable_events (0);
4205 x_handle_selection_event (©
);
4207 /* We're getting selection request events, but we don't have
4215 /* Process any events that are not user-visible, run timer events that
4216 are ripe, and return, without reading any user-visible events. */
4219 swallow_events (int do_display
)
4223 process_special_events ();
4225 old_timers_run
= timers_run
;
4226 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4228 if (timers_run
!= old_timers_run
&& do_display
)
4229 redisplay_preserve_echo_area (7);
4232 /* Record the start of when Emacs is idle,
4233 for the sake of running idle-time timers. */
4236 timer_start_idle (void)
4240 /* If we are already in the idle state, do nothing. */
4241 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4244 timer_idleness_start_time
= current_emacs_time ();
4245 timer_last_idleness_start_time
= timer_idleness_start_time
;
4247 /* Mark all idle-time timers as once again candidates for running. */
4248 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4252 timer
= XCAR (timers
);
4254 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4256 ASET (timer
, 0, Qnil
);
4260 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4263 timer_stop_idle (void)
4265 timer_idleness_start_time
= invalid_emacs_time ();
4268 /* Resume idle timer from last idle start time. */
4271 timer_resume_idle (void)
4273 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4276 timer_idleness_start_time
= timer_last_idleness_start_time
;
4279 /* This is only for debugging. */
4280 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4282 /* List of elisp functions to call, delayed because they were generated in
4283 a context where Elisp could not be safely run (e.g. redisplay, signal,
4284 ...). Each element has the form (FUN . ARGS). */
4285 Lisp_Object pending_funcalls
;
4287 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4289 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4291 Lisp_Object
*vector
;
4293 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4295 vector
= XVECTOR (timer
)->contents
;
4296 if (! NILP (vector
[0]))
4299 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4304 /* Check whether a timer has fired. To prevent larger problems we simply
4305 disregard elements that are not proper timers. Do not make a circular
4306 timer list for the time being.
4308 Returns the time to wait until the next timer fires. If a
4309 timer is triggering now, return zero.
4310 If no timer is active, return -1.
4312 If a timer is ripe, we run it, with quitting turned off.
4313 In that case we return 0 to indicate that a new timer_check_2 call
4317 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4319 EMACS_TIME nexttime
;
4321 EMACS_TIME idleness_now
;
4322 Lisp_Object chosen_timer
;
4323 struct gcpro gcpro1
;
4325 nexttime
= invalid_emacs_time ();
4327 chosen_timer
= Qnil
;
4328 GCPRO1 (chosen_timer
);
4330 /* First run the code that was delayed. */
4331 while (CONSP (pending_funcalls
))
4333 Lisp_Object funcall
= XCAR (pending_funcalls
);
4334 pending_funcalls
= XCDR (pending_funcalls
);
4335 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4338 if (CONSP (timers
) || CONSP (idle_timers
))
4340 now
= current_emacs_time ();
4341 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4342 ? sub_emacs_time (now
, timer_idleness_start_time
)
4343 : make_emacs_time (0, 0));
4346 while (CONSP (timers
) || CONSP (idle_timers
))
4348 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4349 EMACS_TIME timer_time
, idle_timer_time
;
4350 EMACS_TIME difference
;
4351 EMACS_TIME timer_difference
= invalid_emacs_time ();
4352 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4353 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4355 /* Set TIMER and TIMER_DIFFERENCE
4356 based on the next ordinary timer.
4357 TIMER_DIFFERENCE is the distance in time from NOW to when
4358 this timer becomes ripe (negative if it's already ripe).
4359 Skip past invalid timers and timers already handled. */
4362 timer
= XCAR (timers
);
4363 if (! decode_timer (timer
, &timer_time
))
4365 timers
= XCDR (timers
);
4369 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4370 timer_difference
= (timer_ripe
4371 ? sub_emacs_time (now
, timer_time
)
4372 : sub_emacs_time (timer_time
, now
));
4375 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4376 based on the next idle timer. */
4377 if (CONSP (idle_timers
))
4379 idle_timer
= XCAR (idle_timers
);
4380 if (! decode_timer (idle_timer
, &idle_timer_time
))
4382 idle_timers
= XCDR (idle_timers
);
4386 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4387 idle_timer_difference
=
4389 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4390 : sub_emacs_time (idle_timer_time
, idleness_now
));
4393 /* Decide which timer is the next timer,
4394 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4395 Also step down the list where we found that timer. */
4397 if (EMACS_TIME_VALID_P (timer_difference
)
4398 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4399 || idle_timer_ripe
< timer_ripe
4400 || (idle_timer_ripe
== timer_ripe
4402 ? EMACS_TIME_LT (idle_timer_difference
,
4404 : EMACS_TIME_LT (timer_difference
,
4405 idle_timer_difference
)))))
4407 chosen_timer
= timer
;
4408 timers
= XCDR (timers
);
4409 difference
= timer_difference
;
4414 chosen_timer
= idle_timer
;
4415 idle_timers
= XCDR (idle_timers
);
4416 difference
= idle_timer_difference
;
4417 ripe
= idle_timer_ripe
;
4420 /* If timer is ripe, run it if it hasn't been run. */
4423 if (NILP (AREF (chosen_timer
, 0)))
4425 ptrdiff_t count
= SPECPDL_INDEX ();
4426 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4428 /* Mark the timer as triggered to prevent problems if the lisp
4429 code fails to reschedule it right. */
4430 ASET (chosen_timer
, 0, Qt
);
4432 specbind (Qinhibit_quit
, Qt
);
4434 call1 (Qtimer_event_handler
, chosen_timer
);
4435 Vdeactivate_mark
= old_deactivate_mark
;
4437 unbind_to (count
, Qnil
);
4439 /* Since we have handled the event,
4440 we don't need to tell the caller to wake up and do it. */
4441 /* But the caller must still wait for the next timer, so
4442 return 0 to indicate that. */
4445 nexttime
= make_emacs_time (0, 0);
4449 /* When we encounter a timer that is still waiting,
4450 return the amount of time to wait before it is ripe. */
4457 /* No timers are pending in the future. */
4458 /* Return 0 if we generated an event, and -1 if not. */
4464 /* Check whether a timer has fired. To prevent larger problems we simply
4465 disregard elements that are not proper timers. Do not make a circular
4466 timer list for the time being.
4468 Returns the time to wait until the next timer fires.
4469 If no timer is active, return an invalid value.
4471 As long as any timer is ripe, we run it. */
4476 EMACS_TIME nexttime
;
4477 Lisp_Object timers
, idle_timers
;
4478 struct gcpro gcpro1
, gcpro2
;
4480 Lisp_Object tem
= Vinhibit_quit
;
4483 /* We use copies of the timers' lists to allow a timer to add itself
4484 again, without locking up Emacs if the newly added timer is
4485 already ripe when added. */
4487 /* Always consider the ordinary timers. */
4488 timers
= Fcopy_sequence (Vtimer_list
);
4489 /* Consider the idle timers only if Emacs is idle. */
4490 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4491 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4495 Vinhibit_quit
= tem
;
4497 GCPRO2 (timers
, idle_timers
);
4501 nexttime
= timer_check_2 (timers
, idle_timers
);
4503 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4509 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4510 doc
: /* Return the current length of Emacs idleness, or nil.
4511 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4512 in the same style as (current-time).
4514 The value when Emacs is not idle is nil.
4516 PSEC is a multiple of the system clock resolution. */)
4519 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4520 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4521 timer_idleness_start_time
));
4526 /* Caches for modify_event_symbol. */
4527 static Lisp_Object accent_key_syms
;
4528 static Lisp_Object func_key_syms
;
4529 static Lisp_Object mouse_syms
;
4530 static Lisp_Object wheel_syms
;
4531 static Lisp_Object drag_n_drop_syms
;
4533 /* This is a list of keysym codes for special "accent" characters.
4534 It parallels lispy_accent_keys. */
4536 static const int lispy_accent_codes
[] =
4538 #ifdef XK_dead_circumflex
4543 #ifdef XK_dead_grave
4548 #ifdef XK_dead_tilde
4553 #ifdef XK_dead_diaeresis
4558 #ifdef XK_dead_macron
4563 #ifdef XK_dead_degree
4568 #ifdef XK_dead_acute
4573 #ifdef XK_dead_cedilla
4578 #ifdef XK_dead_breve
4583 #ifdef XK_dead_ogonek
4588 #ifdef XK_dead_caron
4593 #ifdef XK_dead_doubleacute
4594 XK_dead_doubleacute
,
4598 #ifdef XK_dead_abovedot
4603 #ifdef XK_dead_abovering
4613 #ifdef XK_dead_belowdot
4618 #ifdef XK_dead_voiced_sound
4619 XK_dead_voiced_sound
,
4623 #ifdef XK_dead_semivoiced_sound
4624 XK_dead_semivoiced_sound
,
4640 /* This is a list of Lisp names for special "accent" characters.
4641 It parallels lispy_accent_codes. */
4643 static const char *const lispy_accent_keys
[] =
4661 "dead-voiced-sound",
4662 "dead-semivoiced-sound",
4668 #define FUNCTION_KEY_OFFSET 0x0
4670 const char *const lispy_function_keys
[] =
4674 0, /* VK_LBUTTON 0x01 */
4675 0, /* VK_RBUTTON 0x02 */
4676 "cancel", /* VK_CANCEL 0x03 */
4677 0, /* VK_MBUTTON 0x04 */
4679 0, 0, 0, /* 0x05 .. 0x07 */
4681 "backspace", /* VK_BACK 0x08 */
4682 "tab", /* VK_TAB 0x09 */
4684 0, 0, /* 0x0A .. 0x0B */
4686 "clear", /* VK_CLEAR 0x0C */
4687 "return", /* VK_RETURN 0x0D */
4689 0, 0, /* 0x0E .. 0x0F */
4691 0, /* VK_SHIFT 0x10 */
4692 0, /* VK_CONTROL 0x11 */
4693 0, /* VK_MENU 0x12 */
4694 "pause", /* VK_PAUSE 0x13 */
4695 "capslock", /* VK_CAPITAL 0x14 */
4696 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4698 "junja", /* VK_JUNJA 0x17 */
4699 "final", /* VK_FINAL 0x18 */
4700 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4702 "escape", /* VK_ESCAPE 0x1B */
4703 "convert", /* VK_CONVERT 0x1C */
4704 "non-convert", /* VK_NONCONVERT 0x1D */
4705 "accept", /* VK_ACCEPT 0x1E */
4706 "mode-change", /* VK_MODECHANGE 0x1F */
4707 0, /* VK_SPACE 0x20 */
4708 "prior", /* VK_PRIOR 0x21 */
4709 "next", /* VK_NEXT 0x22 */
4710 "end", /* VK_END 0x23 */
4711 "home", /* VK_HOME 0x24 */
4712 "left", /* VK_LEFT 0x25 */
4713 "up", /* VK_UP 0x26 */
4714 "right", /* VK_RIGHT 0x27 */
4715 "down", /* VK_DOWN 0x28 */
4716 "select", /* VK_SELECT 0x29 */
4717 "print", /* VK_PRINT 0x2A */
4718 "execute", /* VK_EXECUTE 0x2B */
4719 "snapshot", /* VK_SNAPSHOT 0x2C */
4720 "insert", /* VK_INSERT 0x2D */
4721 "delete", /* VK_DELETE 0x2E */
4722 "help", /* VK_HELP 0x2F */
4724 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4726 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4728 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4730 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4732 0, 0, 0, 0, 0, 0, 0, 0, 0,
4733 0, 0, 0, 0, 0, 0, 0, 0, 0,
4734 0, 0, 0, 0, 0, 0, 0, 0,
4736 "lwindow", /* VK_LWIN 0x5B */
4737 "rwindow", /* VK_RWIN 0x5C */
4738 "apps", /* VK_APPS 0x5D */
4741 "kp-0", /* VK_NUMPAD0 0x60 */
4742 "kp-1", /* VK_NUMPAD1 0x61 */
4743 "kp-2", /* VK_NUMPAD2 0x62 */
4744 "kp-3", /* VK_NUMPAD3 0x63 */
4745 "kp-4", /* VK_NUMPAD4 0x64 */
4746 "kp-5", /* VK_NUMPAD5 0x65 */
4747 "kp-6", /* VK_NUMPAD6 0x66 */
4748 "kp-7", /* VK_NUMPAD7 0x67 */
4749 "kp-8", /* VK_NUMPAD8 0x68 */
4750 "kp-9", /* VK_NUMPAD9 0x69 */
4751 "kp-multiply", /* VK_MULTIPLY 0x6A */
4752 "kp-add", /* VK_ADD 0x6B */
4753 "kp-separator", /* VK_SEPARATOR 0x6C */
4754 "kp-subtract", /* VK_SUBTRACT 0x6D */
4755 "kp-decimal", /* VK_DECIMAL 0x6E */
4756 "kp-divide", /* VK_DIVIDE 0x6F */
4757 "f1", /* VK_F1 0x70 */
4758 "f2", /* VK_F2 0x71 */
4759 "f3", /* VK_F3 0x72 */
4760 "f4", /* VK_F4 0x73 */
4761 "f5", /* VK_F5 0x74 */
4762 "f6", /* VK_F6 0x75 */
4763 "f7", /* VK_F7 0x76 */
4764 "f8", /* VK_F8 0x77 */
4765 "f9", /* VK_F9 0x78 */
4766 "f10", /* VK_F10 0x79 */
4767 "f11", /* VK_F11 0x7A */
4768 "f12", /* VK_F12 0x7B */
4769 "f13", /* VK_F13 0x7C */
4770 "f14", /* VK_F14 0x7D */
4771 "f15", /* VK_F15 0x7E */
4772 "f16", /* VK_F16 0x7F */
4773 "f17", /* VK_F17 0x80 */
4774 "f18", /* VK_F18 0x81 */
4775 "f19", /* VK_F19 0x82 */
4776 "f20", /* VK_F20 0x83 */
4777 "f21", /* VK_F21 0x84 */
4778 "f22", /* VK_F22 0x85 */
4779 "f23", /* VK_F23 0x86 */
4780 "f24", /* VK_F24 0x87 */
4782 0, 0, 0, 0, /* 0x88 .. 0x8B */
4783 0, 0, 0, 0, /* 0x8C .. 0x8F */
4785 "kp-numlock", /* VK_NUMLOCK 0x90 */
4786 "scroll", /* VK_SCROLL 0x91 */
4787 /* Not sure where the following block comes from.
4788 Windows headers have NEC and Fujitsu specific keys in
4789 this block, but nothing generic. */
4790 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4791 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4792 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4793 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4794 "kp-end", /* VK_NUMPAD_END 0x96 */
4795 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4796 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4797 "kp-up", /* VK_NUMPAD_UP 0x99 */
4798 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4799 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4800 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4801 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4803 0, 0, /* 0x9E .. 0x9F */
4806 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4807 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4808 * No other API or message will distinguish left and right keys this way.
4813 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4814 to enable them selectively, and gives access to a few more functions.
4815 See lispy_multimedia_keys below. */
4816 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4817 0, 0, 0, /* 0xAD .. 0xAF Volume */
4818 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4819 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4821 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4822 0, 0, 0, 0, 0, 0, 0, 0, 0,
4824 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4825 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4829 "ax", /* VK_OEM_AX 0xE1 */
4830 0, /* VK_OEM_102 0xE2 */
4831 "ico-help", /* VK_ICO_HELP 0xE3 */
4832 "ico-00", /* VK_ICO_00 0xE4 */
4833 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4834 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4835 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4837 "reset", /* VK_OEM_RESET 0xE9 */
4838 "jump", /* VK_OEM_JUMP 0xEA */
4839 "oem-pa1", /* VK_OEM_PA1 0xEB */
4840 "oem-pa2", /* VK_OEM_PA2 0xEC */
4841 "oem-pa3", /* VK_OEM_PA3 0xED */
4842 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4843 "cusel", /* VK_OEM_CUSEL 0xEF */
4844 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4845 "finish", /* VK_OEM_FINISH 0xF1 */
4846 "copy", /* VK_OEM_COPY 0xF2 */
4847 "auto", /* VK_OEM_AUTO 0xF3 */
4848 "enlw", /* VK_OEM_ENLW 0xF4 */
4849 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4850 "attn", /* VK_ATTN 0xF6 */
4851 "crsel", /* VK_CRSEL 0xF7 */
4852 "exsel", /* VK_EXSEL 0xF8 */
4853 "ereof", /* VK_EREOF 0xF9 */
4854 "play", /* VK_PLAY 0xFA */
4855 "zoom", /* VK_ZOOM 0xFB */
4856 "noname", /* VK_NONAME 0xFC */
4857 "pa1", /* VK_PA1 0xFD */
4858 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4862 /* Some of these duplicate the "Media keys" on newer keyboards,
4863 but they are delivered to the application in a different way. */
4864 static const char *const lispy_multimedia_keys
[] =
4872 "browser-favorites",
4909 "toggle-dictate-command",
4915 "media-fast-forward",
4918 "media-channel-down"
4921 #else /* not HAVE_NTGUI */
4923 /* This should be dealt with in XTread_socket now, and that doesn't
4924 depend on the client system having the Kana syms defined. See also
4925 the XK_kana_A case below. */
4928 static const char *const lispy_kana_keys
[] =
4930 /* X Keysym value */
4931 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4932 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4933 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4934 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4935 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4936 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4937 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4941 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4942 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4943 "kana-i", "kana-u", "kana-e", "kana-o",
4944 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4945 "prolongedsound", "kana-A", "kana-I", "kana-U",
4946 "kana-E", "kana-O", "kana-KA", "kana-KI",
4947 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4948 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4949 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4950 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4951 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4952 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4953 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4954 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4955 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4956 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4960 #endif /* XK_kana_A */
4963 #define FUNCTION_KEY_OFFSET 0xff00
4965 /* You'll notice that this table is arranged to be conveniently
4966 indexed by X Windows keysym values. */
4967 static const char *const lispy_function_keys
[] =
4969 /* X Keysym value */
4971 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4972 "backspace", "tab", "linefeed", "clear",
4974 0, 0, 0, "pause", /* 0xff10...1f */
4975 0, 0, 0, 0, 0, 0, 0, "escape",
4977 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4978 "romaji", "hiragana", "katakana", "hiragana-katakana",
4979 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4980 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4981 "eisu-toggle", /* 0xff30...3f */
4982 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4983 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4985 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4986 "down", "prior", "next", "end",
4987 "begin", 0, 0, 0, 0, 0, 0, 0,
4988 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4999 "break", /* 0xff6b */
5002 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5003 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5004 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5005 0, 0, 0, 0, 0, 0, 0, 0,
5006 "kp-tab", /* 0xff89 */
5008 "kp-enter", /* 0xff8d */
5010 "kp-f1", /* 0xff91 */
5014 "kp-home", /* 0xff95 */
5019 "kp-prior", /* kp-page-up */
5020 "kp-next", /* kp-page-down */
5026 0, 0, 0, 0, 0, 0, 0, 0, 0,
5027 "kp-multiply", /* 0xffaa */
5032 "kp-divide", /* 0xffaf */
5033 "kp-0", /* 0xffb0 */
5034 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5037 "kp-equal", /* 0xffbd */
5038 "f1", /* 0xffbe */ /* IsFunctionKey */
5040 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5041 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5042 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5043 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5044 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5045 0, 0, 0, 0, 0, 0, 0, 0,
5046 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5047 0, 0, 0, 0, 0, 0, 0, "delete"
5050 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5051 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5053 static const char *const iso_lispy_function_keys
[] =
5055 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5056 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5057 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5058 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5059 "iso-lefttab", /* 0xfe20 */
5060 "iso-move-line-up", "iso-move-line-down",
5061 "iso-partial-line-up", "iso-partial-line-down",
5062 "iso-partial-space-left", "iso-partial-space-right",
5063 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5064 "iso-release-margin-left", "iso-release-margin-right",
5065 "iso-release-both-margins",
5066 "iso-fast-cursor-left", "iso-fast-cursor-right",
5067 "iso-fast-cursor-up", "iso-fast-cursor-down",
5068 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5069 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5072 #endif /* not HAVE_NTGUI */
5074 static Lisp_Object Vlispy_mouse_stem
;
5076 static const char *const lispy_wheel_names
[] =
5078 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5081 /* drag-n-drop events are generated when a set of selected files are
5082 dragged from another application and dropped onto an Emacs window. */
5083 static const char *const lispy_drag_n_drop_names
[] =
5088 /* Scroll bar parts. */
5089 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5090 Lisp_Object Qup
, Qdown
, Qbottom
;
5091 static Lisp_Object Qend_scroll
;
5093 static Lisp_Object Qratio
;
5095 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5096 static Lisp_Object
*const scroll_bar_parts
[] = {
5097 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5098 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5101 /* A vector, indexed by button number, giving the down-going location
5102 of currently depressed buttons, both scroll bar and non-scroll bar.
5104 The elements have the form
5105 (BUTTON-NUMBER MODIFIER-MASK . REST)
5106 where REST is the cdr of a position as it would be reported in the event.
5108 The make_lispy_event function stores positions here to tell the
5109 difference between click and drag events, and to store the starting
5110 location to be included in drag events. */
5112 static Lisp_Object button_down_location
;
5114 /* Information about the most recent up-going button event: Which
5115 button, what location, and what time. */
5117 static int last_mouse_button
;
5118 static int last_mouse_x
;
5119 static int last_mouse_y
;
5120 static Time button_down_time
;
5122 /* The number of clicks in this multiple-click. */
5124 static int double_click_count
;
5126 /* X and Y are frame-relative coordinates for a click or wheel event.
5127 Return a Lisp-style event list. */
5130 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5133 enum window_part part
;
5134 Lisp_Object posn
= Qnil
;
5135 Lisp_Object extra_info
= Qnil
;
5136 /* Coordinate pixel positions to return. */
5137 int xret
= 0, yret
= 0;
5138 /* The window under frame pixel coordinates (x,y) */
5139 Lisp_Object window
= f
5140 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5143 if (WINDOWP (window
))
5145 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5146 struct window
*w
= XWINDOW (window
);
5147 Lisp_Object string_info
= Qnil
;
5148 ptrdiff_t textpos
= -1;
5149 int col
= -1, row
= -1;
5150 int dx
= -1, dy
= -1;
5151 int width
= -1, height
= -1;
5152 Lisp_Object object
= Qnil
;
5154 /* Pixel coordinates relative to the window corner. */
5155 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5156 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5158 /* For text area clicks, return X, Y relative to the corner of
5159 this text area. Note that dX, dY etc are set below, by
5160 buffer_posn_from_coords. */
5161 if (part
== ON_TEXT
)
5163 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5164 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5166 /* For mode line and header line clicks, return X, Y relative to
5167 the left window edge. Use mode_line_string to look for a
5168 string on the click position. */
5169 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5174 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5175 /* Note that mode_line_string takes COL, ROW as pixels and
5176 converts them to characters. */
5179 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5180 &object
, &dx
, &dy
, &width
, &height
);
5181 if (STRINGP (string
))
5182 string_info
= Fcons (string
, make_number (charpos
));
5183 textpos
= (w
== XWINDOW (selected_window
)
5184 && current_buffer
== XBUFFER (w
->buffer
))
5185 ? PT
: XMARKER (w
->pointm
)->charpos
;
5190 /* For fringes and margins, Y is relative to the area's (and the
5191 window's) top edge, while X is meaningless. */
5192 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5197 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5200 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5201 &object
, &dx
, &dy
, &width
, &height
);
5202 if (STRINGP (string
))
5203 string_info
= Fcons (string
, make_number (charpos
));
5204 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5206 else if (part
== ON_LEFT_FRINGE
)
5208 posn
= Qleft_fringe
;
5211 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5212 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5213 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5215 else if (part
== ON_RIGHT_FRINGE
)
5217 posn
= Qright_fringe
;
5220 - window_box_width (w
, LEFT_MARGIN_AREA
)
5221 - window_box_width (w
, TEXT_AREA
)
5222 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5223 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5225 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5227 else if (part
== ON_VERTICAL_BORDER
)
5229 posn
= Qvertical_line
;
5234 /* Nothing special for part == ON_SCROLL_BAR. */
5236 /* For clicks in the text area, fringes, or margins, call
5237 buffer_posn_from_coords to extract TEXTPOS, the buffer
5238 position nearest to the click. */
5241 Lisp_Object string2
, object2
= Qnil
;
5242 struct display_pos p
;
5244 int width2
, height2
;
5245 /* The pixel X coordinate passed to buffer_posn_from_coords
5246 is the X coordinate relative to the text area for
5247 text-area and right-margin clicks, zero otherwise. */
5249 = (part
== ON_TEXT
) ? xret
5250 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5251 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5255 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5256 &object2
, &dx2
, &dy2
,
5258 textpos
= CHARPOS (p
.pos
);
5259 if (col
< 0) col
= x2
;
5260 if (row
< 0) row
= y2
;
5261 if (dx
< 0) dx
= dx2
;
5262 if (dy
< 0) dy
= dy2
;
5263 if (width
< 0) width
= width2
;
5264 if (height
< 0) height
= height2
;
5268 posn
= make_number (textpos
);
5269 if (STRINGP (string2
))
5270 string_info
= Fcons (string2
,
5271 make_number (CHARPOS (p
.string_pos
)));
5277 #ifdef HAVE_WINDOW_SYSTEM
5278 if (IMAGEP (object
))
5280 Lisp_Object image_map
, hotspot
;
5281 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5283 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5285 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5286 posn
= XCAR (hotspot
);
5293 Fcons (make_number (dx
), make_number (dy
)),
5294 Fcons (make_number (width
), make_number (height
)));
5297 extra_info
= Fcons (string_info
,
5298 Fcons (make_number (textpos
),
5299 Fcons (Fcons (make_number (col
),
5304 XSETFRAME (window
, f
);
5308 return Fcons (window
,
5310 Fcons (Fcons (make_number (xret
),
5311 make_number (yret
)),
5312 Fcons (make_number (t
),
5316 /* Given a struct input_event, build the lisp event which represents
5317 it. If EVENT is 0, build a mouse movement event from the mouse
5318 movement buffer, which should have a movement event in it.
5320 Note that events must be passed to this function in the order they
5321 are received; this function stores the location of button presses
5322 in order to build drag events when the button is released. */
5325 make_lispy_event (struct input_event
*event
)
5329 switch (event
->kind
)
5331 /* A simple keystroke. */
5332 case ASCII_KEYSTROKE_EVENT
:
5333 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5335 Lisp_Object lispy_c
;
5336 EMACS_INT c
= event
->code
;
5337 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5340 eassert (c
== event
->code
);
5341 /* Turn ASCII characters into control characters
5343 if (event
->modifiers
& ctrl_modifier
)
5345 c
= make_ctrl_char (c
);
5346 event
->modifiers
&= ~ctrl_modifier
;
5350 /* Add in the other modifier bits. The shift key was taken care
5351 of by the X code. */
5352 c
|= (event
->modifiers
5353 & (meta_modifier
| alt_modifier
5354 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5355 /* Distinguish Shift-SPC from SPC. */
5356 if ((event
->code
) == 040
5357 && event
->modifiers
& shift_modifier
)
5358 c
|= shift_modifier
;
5359 button_down_time
= 0;
5360 XSETFASTINT (lispy_c
, c
);
5365 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5366 except that they are non-key events (last-nonmenu-event is nil). */
5367 case NS_NONKEY_EVENT
:
5370 /* A function key. The symbol may need to have modifier prefixes
5372 case NON_ASCII_KEYSTROKE_EVENT
:
5373 button_down_time
= 0;
5375 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5376 if (event
->code
== lispy_accent_codes
[i
])
5377 return modify_event_symbol (i
,
5379 Qfunction_key
, Qnil
,
5380 lispy_accent_keys
, &accent_key_syms
,
5381 (sizeof (lispy_accent_keys
)
5382 / sizeof (lispy_accent_keys
[0])));
5386 if (event
->code
>= 0x400 && event
->code
< 0x500)
5387 return modify_event_symbol (event
->code
- 0x400,
5388 event
->modifiers
& ~shift_modifier
,
5389 Qfunction_key
, Qnil
,
5390 lispy_kana_keys
, &func_key_syms
,
5391 (sizeof (lispy_kana_keys
)
5392 / sizeof (lispy_kana_keys
[0])));
5393 #endif /* XK_kana_A */
5396 #ifdef ISO_FUNCTION_KEY_OFFSET
5397 if (event
->code
< FUNCTION_KEY_OFFSET
5398 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5399 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5401 Qfunction_key
, Qnil
,
5402 iso_lispy_function_keys
, &func_key_syms
,
5403 (sizeof (iso_lispy_function_keys
)
5404 / sizeof (iso_lispy_function_keys
[0])));
5407 /* Handle system-specific or unknown keysyms. */
5408 if (event
->code
& (1 << 28)
5409 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5410 || (event
->code
- FUNCTION_KEY_OFFSET
5411 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5412 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5414 /* We need to use an alist rather than a vector as the cache
5415 since we can't make a vector long enough. */
5416 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5417 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5418 return modify_event_symbol (event
->code
,
5421 KVAR (current_kboard
, Vsystem_key_alist
),
5422 0, &KVAR (current_kboard
, system_key_syms
),
5426 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5428 Qfunction_key
, Qnil
,
5429 lispy_function_keys
, &func_key_syms
,
5430 (sizeof (lispy_function_keys
)
5431 / sizeof (lispy_function_keys
[0])));
5434 case MULTIMEDIA_KEY_EVENT
:
5435 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5436 / sizeof (lispy_multimedia_keys
[0]))
5437 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5439 return modify_event_symbol (event
->code
, event
->modifiers
,
5440 Qfunction_key
, Qnil
,
5441 lispy_multimedia_keys
, &func_key_syms
,
5442 (sizeof (lispy_multimedia_keys
)
5443 / sizeof (lispy_multimedia_keys
[0])));
5449 /* A mouse click. Figure out where it is, decide whether it's
5450 a press, click or drag, and build the appropriate structure. */
5451 case MOUSE_CLICK_EVENT
:
5452 #ifndef USE_TOOLKIT_SCROLL_BARS
5453 case SCROLL_BAR_CLICK_EVENT
:
5456 int button
= event
->code
;
5458 Lisp_Object position
;
5459 Lisp_Object
*start_pos_ptr
;
5460 Lisp_Object start_pos
;
5464 /* Build the position as appropriate for this mouse click. */
5465 if (event
->kind
== MOUSE_CLICK_EVENT
)
5467 struct frame
*f
= XFRAME (event
->frame_or_window
);
5468 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5472 /* Ignore mouse events that were made on frame that
5473 have been deleted. */
5474 if (! FRAME_LIVE_P (f
))
5477 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5478 /* EVENT->x and EVENT->y are frame-relative pixel
5479 coordinates at this place. Under old redisplay, COLUMN
5480 and ROW are set to frame relative glyph coordinates
5481 which are then used to determine whether this click is
5482 in a menu (non-toolkit version). */
5483 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5484 &column
, &row
, NULL
, 1);
5486 /* In the non-toolkit version, clicks on the menu bar
5487 are ordinary button events in the event buffer.
5488 Distinguish them, and invoke the menu.
5490 (In the toolkit version, the toolkit handles the menu bar
5491 and Emacs doesn't know about it until after the user
5492 makes a selection.) */
5493 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5494 && (event
->modifiers
& down_modifier
))
5496 Lisp_Object items
, item
;
5498 /* Find the menu bar item under `column'. */
5500 items
= FRAME_MENU_BAR_ITEMS (f
);
5501 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5503 Lisp_Object pos
, string
;
5504 string
= AREF (items
, i
+ 1);
5505 pos
= AREF (items
, i
+ 3);
5508 if (column
>= XINT (pos
)
5509 && column
< XINT (pos
) + SCHARS (string
))
5511 item
= AREF (items
, i
);
5516 /* ELisp manual 2.4b says (x y) are window relative but
5517 code says they are frame-relative. */
5519 = Fcons (event
->frame_or_window
,
5521 Fcons (Fcons (event
->x
, event
->y
),
5522 Fcons (make_number (event
->timestamp
),
5525 return Fcons (item
, Fcons (position
, Qnil
));
5527 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5529 position
= make_lispy_position (f
, event
->x
, event
->y
,
5532 #ifndef USE_TOOLKIT_SCROLL_BARS
5535 /* It's a scrollbar click. */
5537 Lisp_Object portion_whole
;
5540 window
= event
->frame_or_window
;
5541 portion_whole
= Fcons (event
->x
, event
->y
);
5542 part
= *scroll_bar_parts
[(int) event
->part
];
5546 Fcons (Qvertical_scroll_bar
,
5547 Fcons (portion_whole
,
5548 Fcons (make_number (event
->timestamp
),
5549 Fcons (part
, Qnil
)))));
5551 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5553 if (button
>= ASIZE (button_down_location
))
5555 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5556 button_down_location
= larger_vector (button_down_location
,
5558 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5561 start_pos_ptr
= aref_addr (button_down_location
, button
);
5562 start_pos
= *start_pos_ptr
;
5563 *start_pos_ptr
= Qnil
;
5566 /* On window-system frames, use the value of
5567 double-click-fuzz as is. On other frames, interpret it
5568 as a multiple of 1/8 characters. */
5572 if (WINDOWP (event
->frame_or_window
))
5573 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5574 else if (FRAMEP (event
->frame_or_window
))
5575 f
= XFRAME (event
->frame_or_window
);
5579 if (FRAME_WINDOW_P (f
))
5580 fuzz
= double_click_fuzz
;
5582 fuzz
= double_click_fuzz
/ 8;
5584 is_double
= (button
== last_mouse_button
5585 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5586 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5587 && button_down_time
!= 0
5588 && (EQ (Vdouble_click_time
, Qt
)
5589 || (NATNUMP (Vdouble_click_time
)
5590 && (event
->timestamp
- button_down_time
5591 < XFASTINT (Vdouble_click_time
)))));
5594 last_mouse_button
= button
;
5595 last_mouse_x
= XINT (event
->x
);
5596 last_mouse_y
= XINT (event
->y
);
5598 /* If this is a button press, squirrel away the location, so
5599 we can decide later whether it was a click or a drag. */
5600 if (event
->modifiers
& down_modifier
)
5604 double_click_count
++;
5605 event
->modifiers
|= ((double_click_count
> 2)
5610 double_click_count
= 1;
5611 button_down_time
= event
->timestamp
;
5612 *start_pos_ptr
= Fcopy_alist (position
);
5613 ignore_mouse_drag_p
= 0;
5616 /* Now we're releasing a button - check the co-ordinates to
5617 see if this was a click or a drag. */
5618 else if (event
->modifiers
& up_modifier
)
5620 /* If we did not see a down before this up, ignore the up.
5621 Probably this happened because the down event chose a
5622 menu item. It would be an annoyance to treat the
5623 release of the button that chose the menu item as a
5626 if (!CONSP (start_pos
))
5629 event
->modifiers
&= ~up_modifier
;
5632 Lisp_Object new_down
, down
;
5633 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5635 /* The third element of every position
5636 should be the (x,y) pair. */
5637 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5638 new_down
= Fcar (Fcdr (Fcdr (position
)));
5641 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5643 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5644 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5647 if (ignore_mouse_drag_p
)
5649 event
->modifiers
|= click_modifier
;
5650 ignore_mouse_drag_p
= 0;
5652 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5653 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5654 /* Maybe the mouse has moved a lot, caused scrolling, and
5655 eventually ended up at the same screen position (but
5656 not buffer position) in which case it is a drag, not
5658 /* FIXME: OTOH if the buffer position has changed
5659 because of a timer or process filter rather than
5660 because of mouse movement, it should be considered as
5661 a click. But mouse-drag-region completely ignores
5662 this case and it hasn't caused any real problem, so
5663 it's probably OK to ignore it as well. */
5664 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5665 /* Mouse hasn't moved (much). */
5666 event
->modifiers
|= click_modifier
;
5669 button_down_time
= 0;
5670 event
->modifiers
|= drag_modifier
;
5673 /* Don't check is_double; treat this as multiple
5674 if the down-event was multiple. */
5675 if (double_click_count
> 1)
5676 event
->modifiers
|= ((double_click_count
> 2)
5682 /* Every mouse event should either have the down_modifier or
5683 the up_modifier set. */
5687 /* Get the symbol we should use for the mouse click. */
5690 head
= modify_event_symbol (button
,
5692 Qmouse_click
, Vlispy_mouse_stem
,
5695 ASIZE (mouse_syms
));
5696 if (event
->modifiers
& drag_modifier
)
5701 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5704 Fcons (make_number (double_click_count
),
5714 case HORIZ_WHEEL_EVENT
:
5716 Lisp_Object position
;
5719 /* Build the position as appropriate for this mouse click. */
5720 struct frame
*f
= XFRAME (event
->frame_or_window
);
5722 /* Ignore wheel events that were made on frame that have been
5724 if (! FRAME_LIVE_P (f
))
5727 position
= make_lispy_position (f
, event
->x
, event
->y
,
5730 /* Set double or triple modifiers to indicate the wheel speed. */
5732 /* On window-system frames, use the value of
5733 double-click-fuzz as is. On other frames, interpret it
5734 as a multiple of 1/8 characters. */
5740 if (WINDOWP (event
->frame_or_window
))
5741 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5742 else if (FRAMEP (event
->frame_or_window
))
5743 fr
= XFRAME (event
->frame_or_window
);
5747 fuzz
= FRAME_WINDOW_P (fr
)
5748 ? double_click_fuzz
: double_click_fuzz
/ 8;
5750 if (event
->modifiers
& up_modifier
)
5752 /* Emit a wheel-up event. */
5753 event
->modifiers
&= ~up_modifier
;
5756 else if (event
->modifiers
& down_modifier
)
5758 /* Emit a wheel-down event. */
5759 event
->modifiers
&= ~down_modifier
;
5763 /* Every wheel event should either have the down_modifier or
5764 the up_modifier set. */
5767 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5770 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5771 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5772 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5773 && button_down_time
!= 0
5774 && (EQ (Vdouble_click_time
, Qt
)
5775 || (NATNUMP (Vdouble_click_time
)
5776 && (event
->timestamp
- button_down_time
5777 < XFASTINT (Vdouble_click_time
)))));
5780 double_click_count
++;
5781 event
->modifiers
|= ((double_click_count
> 2)
5787 double_click_count
= 1;
5788 event
->modifiers
|= click_modifier
;
5791 button_down_time
= event
->timestamp
;
5792 /* Use a negative value to distinguish wheel from mouse button. */
5793 last_mouse_button
= - (1 + symbol_num
);
5794 last_mouse_x
= XINT (event
->x
);
5795 last_mouse_y
= XINT (event
->y
);
5797 /* Get the symbol we should use for the wheel event. */
5798 head
= modify_event_symbol (symbol_num
,
5804 ASIZE (wheel_syms
));
5807 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5810 Fcons (make_number (double_click_count
),
5819 #ifdef USE_TOOLKIT_SCROLL_BARS
5821 /* We don't have down and up events if using toolkit scroll bars,
5822 so make this always a click event. Store in the `part' of
5823 the Lisp event a symbol which maps to the following actions:
5825 `above_handle' page up
5826 `below_handle' page down
5830 `bottom' bottom of buffer
5831 `handle' thumb has been dragged.
5832 `end-scroll' end of interaction with scroll bar
5834 The incoming input_event contains in its `part' member an
5835 index of type `enum scroll_bar_part' which we can use as an
5836 index in scroll_bar_parts to get the appropriate symbol. */
5838 case SCROLL_BAR_CLICK_EVENT
:
5840 Lisp_Object position
, head
, window
, portion_whole
, part
;
5842 window
= event
->frame_or_window
;
5843 portion_whole
= Fcons (event
->x
, event
->y
);
5844 part
= *scroll_bar_parts
[(int) event
->part
];
5848 Fcons (Qvertical_scroll_bar
,
5849 Fcons (portion_whole
,
5850 Fcons (make_number (event
->timestamp
),
5851 Fcons (part
, Qnil
)))));
5853 /* Always treat scroll bar events as clicks. */
5854 event
->modifiers
|= click_modifier
;
5855 event
->modifiers
&= ~up_modifier
;
5857 if (event
->code
>= ASIZE (mouse_syms
))
5858 mouse_syms
= larger_vector (mouse_syms
,
5859 event
->code
- ASIZE (mouse_syms
) + 1,
5862 /* Get the symbol we should use for the mouse click. */
5863 head
= modify_event_symbol (event
->code
,
5868 ASIZE (mouse_syms
));
5869 return Fcons (head
, Fcons (position
, Qnil
));
5872 #endif /* USE_TOOLKIT_SCROLL_BARS */
5874 case DRAG_N_DROP_EVENT
:
5877 Lisp_Object head
, position
;
5880 f
= XFRAME (event
->frame_or_window
);
5883 /* Ignore mouse events that were made on frames that
5884 have been deleted. */
5885 if (! FRAME_LIVE_P (f
))
5888 position
= make_lispy_position (f
, event
->x
, event
->y
,
5891 head
= modify_event_symbol (0, event
->modifiers
,
5893 lispy_drag_n_drop_names
,
5894 &drag_n_drop_syms
, 1);
5900 #endif /* HAVE_MOUSE */
5902 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5903 || defined (HAVE_NS) || defined (USE_GTK)
5904 case MENU_BAR_EVENT
:
5905 if (EQ (event
->arg
, event
->frame_or_window
))
5906 /* This is the prefix key. We translate this to
5907 `(menu_bar)' because the code in keyboard.c for menu
5908 events, which we use, relies on this. */
5909 return Fcons (Qmenu_bar
, Qnil
);
5913 case SELECT_WINDOW_EVENT
:
5914 /* Make an event (select-window (WINDOW)). */
5915 return Fcons (Qselect_window
,
5916 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5919 case TOOL_BAR_EVENT
:
5920 if (EQ (event
->arg
, event
->frame_or_window
))
5921 /* This is the prefix key. We translate this to
5922 `(tool_bar)' because the code in keyboard.c for tool bar
5923 events, which we use, relies on this. */
5924 return Fcons (Qtool_bar
, Qnil
);
5925 else if (SYMBOLP (event
->arg
))
5926 return apply_modifiers (event
->modifiers
, event
->arg
);
5929 case USER_SIGNAL_EVENT
:
5930 /* A user signal. */
5932 char *name
= find_user_signal_name (event
->code
);
5935 return intern (name
);
5938 case SAVE_SESSION_EVENT
:
5939 return Qsave_session
;
5944 return Fcons (Qdbus_event
, event
->arg
);
5946 #endif /* HAVE_DBUS */
5948 case CONFIG_CHANGED_EVENT
:
5949 return Fcons (Qconfig_changed_event
,
5951 Fcons (event
->frame_or_window
, Qnil
)));
5953 case GPM_CLICK_EVENT
:
5955 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5956 Lisp_Object head
, position
;
5957 Lisp_Object
*start_pos_ptr
;
5958 Lisp_Object start_pos
;
5959 int button
= event
->code
;
5961 if (button
>= ASIZE (button_down_location
))
5963 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5964 button_down_location
= larger_vector (button_down_location
,
5966 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5969 start_pos_ptr
= aref_addr (button_down_location
, button
);
5970 start_pos
= *start_pos_ptr
;
5972 position
= make_lispy_position (f
, event
->x
, event
->y
,
5975 if (event
->modifiers
& down_modifier
)
5976 *start_pos_ptr
= Fcopy_alist (position
);
5977 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5979 if (!CONSP (start_pos
))
5981 event
->modifiers
&= ~up_modifier
;
5984 head
= modify_event_symbol (button
,
5986 Qmouse_click
, Vlispy_mouse_stem
,
5989 ASIZE (mouse_syms
));
5991 if (event
->modifiers
& drag_modifier
)
5996 else if (event
->modifiers
& double_modifier
)
5999 Fcons (make_number (2),
6001 else if (event
->modifiers
& triple_modifier
)
6004 Fcons (make_number (3),
6011 #endif /* HAVE_GPM */
6013 /* The 'kind' field of the event is something we don't recognize. */
6019 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6022 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6023 Lisp_Object x
, Lisp_Object y
, Time t
)
6025 /* Is it a scroll bar movement? */
6026 if (frame
&& ! NILP (bar_window
))
6028 Lisp_Object part_sym
;
6030 part_sym
= *scroll_bar_parts
[(int) part
];
6031 return Fcons (Qscroll_bar_movement
,
6032 Fcons (list5 (bar_window
,
6033 Qvertical_scroll_bar
,
6039 /* Or is it an ordinary mouse movement? */
6042 Lisp_Object position
;
6043 position
= make_lispy_position (frame
, x
, y
, t
);
6044 return list2 (Qmouse_movement
, position
);
6048 #endif /* HAVE_MOUSE || HAVE GPM */
6050 /* Construct a switch frame event. */
6052 make_lispy_switch_frame (Lisp_Object frame
)
6054 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6057 /* Manipulating modifiers. */
6059 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6061 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6062 SYMBOL's name of the end of the modifiers; the string from this
6063 position is the unmodified symbol name.
6065 This doesn't use any caches. */
6068 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6074 CHECK_SYMBOL (symbol
);
6077 name
= SYMBOL_NAME (symbol
);
6079 for (i
= 0; i
< SBYTES (name
) - 1; )
6081 ptrdiff_t this_mod_end
= 0;
6084 /* See if the name continues with a modifier word.
6085 Check that the word appears, but don't check what follows it.
6086 Set this_mod and this_mod_end to record what we find. */
6088 switch (SREF (name
, i
))
6090 #define SINGLE_LETTER_MOD(BIT) \
6091 (this_mod_end = i + 1, this_mod = BIT)
6094 SINGLE_LETTER_MOD (alt_modifier
);
6098 SINGLE_LETTER_MOD (ctrl_modifier
);
6102 SINGLE_LETTER_MOD (hyper_modifier
);
6106 SINGLE_LETTER_MOD (meta_modifier
);
6110 SINGLE_LETTER_MOD (shift_modifier
);
6114 SINGLE_LETTER_MOD (super_modifier
);
6117 #undef SINGLE_LETTER_MOD
6119 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6120 if (i + LEN + 1 <= SBYTES (name) \
6121 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6123 this_mod_end = i + LEN; \
6128 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6129 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6130 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6134 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6136 #undef MULTI_LETTER_MOD
6140 /* If we found no modifier, stop looking for them. */
6141 if (this_mod_end
== 0)
6144 /* Check there is a dash after the modifier, so that it
6145 really is a modifier. */
6146 if (this_mod_end
>= SBYTES (name
)
6147 || SREF (name
, this_mod_end
) != '-')
6150 /* This modifier is real; look for another. */
6151 modifiers
|= this_mod
;
6152 i
= this_mod_end
+ 1;
6155 /* Should we include the `click' modifier? */
6156 if (! (modifiers
& (down_modifier
| drag_modifier
6157 | double_modifier
| triple_modifier
))
6158 && i
+ 7 == SBYTES (name
)
6159 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6160 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6161 modifiers
|= click_modifier
;
6163 if (! (modifiers
& (double_modifier
| triple_modifier
))
6164 && i
+ 6 < SBYTES (name
)
6165 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6166 modifiers
|= click_modifier
;
6174 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6175 prepended to the string BASE[0..BASE_LEN-1].
6176 This doesn't use any caches. */
6178 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6180 /* Since BASE could contain nulls, we can't use intern here; we have
6181 to use Fintern, which expects a genuine Lisp_String, and keeps a
6183 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6189 /* Only the event queue may use the `up' modifier; it should always
6190 be turned into a click or drag event before presented to lisp code. */
6191 if (modifiers
& up_modifier
)
6194 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6195 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6196 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6197 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6198 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6199 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6200 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6201 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6202 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6203 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6204 /* The click modifier is denoted by the absence of other modifiers. */
6208 mod_len
= p
- new_mods
;
6212 Lisp_Object new_name
;
6214 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6215 mod_len
+ base_len_byte
);
6216 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6217 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6219 return Fintern (new_name
, Qnil
);
6224 static const char *const modifier_names
[] =
6226 "up", "down", "drag", "click", "double", "triple", 0, 0,
6227 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6228 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6230 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6232 static Lisp_Object modifier_symbols
;
6234 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6236 lispy_modifier_list (int modifiers
)
6238 Lisp_Object modifier_list
;
6241 modifier_list
= Qnil
;
6242 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6243 if (modifiers
& (1<<i
))
6244 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6247 return modifier_list
;
6251 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6252 where UNMODIFIED is the unmodified form of SYMBOL,
6253 MASK is the set of modifiers present in SYMBOL's name.
6254 This is similar to parse_modifiers_uncached, but uses the cache in
6255 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6256 Qevent_symbol_elements property. */
6258 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6261 parse_modifiers (Lisp_Object symbol
)
6263 Lisp_Object elements
;
6265 if (INTEGERP (symbol
))
6266 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6267 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6269 else if (!SYMBOLP (symbol
))
6272 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6273 if (CONSP (elements
))
6278 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6279 Lisp_Object unmodified
;
6282 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6283 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6286 if (modifiers
& ~INTMASK
)
6288 XSETFASTINT (mask
, modifiers
);
6289 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6291 /* Cache the parsing results on SYMBOL. */
6292 Fput (symbol
, Qevent_symbol_element_mask
,
6294 Fput (symbol
, Qevent_symbol_elements
,
6295 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6297 /* Since we know that SYMBOL is modifiers applied to unmodified,
6298 it would be nice to put that in unmodified's cache.
6299 But we can't, since we're not sure that parse_modifiers is
6306 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6307 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6308 doc
: /* Parse the event symbol. For internal use. */)
6309 (Lisp_Object symbol
)
6311 /* Fill the cache if needed. */
6312 parse_modifiers (symbol
);
6313 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6314 and use the Lispier representation stored on Qevent_symbol_elements
6316 return Fget (symbol
, Qevent_symbol_elements
);
6319 /* Apply the modifiers MODIFIERS to the symbol BASE.
6320 BASE must be unmodified.
6322 This is like apply_modifiers_uncached, but uses BASE's
6323 Qmodifier_cache property, if present. It also builds
6324 Qevent_symbol_elements properties, since it has that info anyway.
6326 apply_modifiers copies the value of BASE's Qevent_kind property to
6327 the modified symbol. */
6329 apply_modifiers (int modifiers
, Lisp_Object base
)
6331 Lisp_Object cache
, idx
, entry
, new_symbol
;
6333 /* Mask out upper bits. We don't know where this value's been. */
6334 modifiers
&= INTMASK
;
6336 if (INTEGERP (base
))
6337 return make_number (XINT (base
) | modifiers
);
6339 /* The click modifier never figures into cache indices. */
6340 cache
= Fget (base
, Qmodifier_cache
);
6341 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6342 entry
= assq_no_quit (idx
, cache
);
6345 new_symbol
= XCDR (entry
);
6348 /* We have to create the symbol ourselves. */
6349 new_symbol
= apply_modifiers_uncached (modifiers
,
6350 SSDATA (SYMBOL_NAME (base
)),
6351 SCHARS (SYMBOL_NAME (base
)),
6352 SBYTES (SYMBOL_NAME (base
)));
6354 /* Add the new symbol to the base's cache. */
6355 entry
= Fcons (idx
, new_symbol
);
6356 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6358 /* We have the parsing info now for free, so we could add it to
6360 XSETFASTINT (idx, modifiers);
6361 Fput (new_symbol, Qevent_symbol_element_mask,
6362 Fcons (base, Fcons (idx, Qnil)));
6363 Fput (new_symbol, Qevent_symbol_elements,
6364 Fcons (base, lispy_modifier_list (modifiers)));
6365 Sadly, this is only correct if `base' is indeed a base event,
6366 which is not necessarily the case. -stef */
6369 /* Make sure this symbol is of the same kind as BASE.
6371 You'd think we could just set this once and for all when we
6372 intern the symbol above, but reorder_modifiers may call us when
6373 BASE's property isn't set right; we can't assume that just
6374 because it has a Qmodifier_cache property it must have its
6375 Qevent_kind set right as well. */
6376 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6380 kind
= Fget (base
, Qevent_kind
);
6382 Fput (new_symbol
, Qevent_kind
, kind
);
6389 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6390 return a symbol with the modifiers placed in the canonical order.
6391 Canonical order is alphabetical, except for down and drag, which
6392 always come last. The 'click' modifier is never written out.
6394 Fdefine_key calls this to make sure that (for example) C-M-foo
6395 and M-C-foo end up being equivalent in the keymap. */
6398 reorder_modifiers (Lisp_Object symbol
)
6400 /* It's hopefully okay to write the code this way, since everything
6401 will soon be in caches, and no consing will be done at all. */
6404 parsed
= parse_modifiers (symbol
);
6405 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6410 /* For handling events, we often want to produce a symbol whose name
6411 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6412 to some base, like the name of a function key or mouse button.
6413 modify_event_symbol produces symbols of this sort.
6415 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6416 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6419 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6420 into symbol names, or a string specifying a name stem used to
6421 construct a symbol name or the form `STEM-N', where N is the decimal
6422 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6423 non-nil; otherwise NAME_TABLE is used.
6425 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6426 persist between calls to modify_event_symbol that it can use to
6427 store a cache of the symbols it's generated for this NAME_TABLE
6428 before. The object stored there may be a vector or an alist.
6430 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6432 MODIFIERS is a set of modifier bits (as given in struct input_events)
6433 whose prefixes should be applied to the symbol name.
6435 SYMBOL_KIND is the value to be placed in the event_kind property of
6436 the returned symbol.
6438 The symbols we create are supposed to have an
6439 `event-symbol-elements' property, which lists the modifiers present
6440 in the symbol's name. */
6443 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6444 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6445 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6448 Lisp_Object symbol_int
;
6450 /* Get rid of the "vendor-specific" bit here. */
6451 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6453 /* Is this a request for a valid symbol? */
6454 if (symbol_num
< 0 || symbol_num
>= table_size
)
6457 if (CONSP (*symbol_table
))
6458 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6460 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6461 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6462 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6463 we've never used that symbol before. */
6466 if (! VECTORP (*symbol_table
)
6467 || ASIZE (*symbol_table
) != table_size
)
6471 XSETFASTINT (size
, table_size
);
6472 *symbol_table
= Fmake_vector (size
, Qnil
);
6475 value
= AREF (*symbol_table
, symbol_num
);
6478 /* Have we already used this symbol before? */
6481 /* No; let's create it. */
6482 if (CONSP (name_alist_or_stem
))
6483 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6484 else if (STRINGP (name_alist_or_stem
))
6487 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6488 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6490 buf
= SAFE_ALLOCA (len
);
6491 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6492 XINT (symbol_int
) + 1);
6493 value
= intern (buf
);
6496 else if (name_table
!= 0 && name_table
[symbol_num
])
6497 value
= intern (name_table
[symbol_num
]);
6499 #ifdef HAVE_WINDOW_SYSTEM
6502 char *name
= x_get_keysym_name (symbol_num
);
6504 value
= intern (name
);
6510 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6511 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6512 value
= intern (buf
);
6515 if (CONSP (*symbol_table
))
6516 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6518 ASET (*symbol_table
, symbol_num
, value
);
6520 /* Fill in the cache entries for this symbol; this also
6521 builds the Qevent_symbol_elements property, which the user
6523 apply_modifiers (modifiers
& click_modifier
, value
);
6524 Fput (value
, Qevent_kind
, symbol_kind
);
6527 /* Apply modifiers to that symbol. */
6528 return apply_modifiers (modifiers
, value
);
6531 /* Convert a list that represents an event type,
6532 such as (ctrl meta backspace), into the usual representation of that
6533 event type as a number or a symbol. */
6535 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6536 doc
: /* Convert the event description list EVENT-DESC to an event type.
6537 EVENT-DESC should contain one base event type (a character or symbol)
6538 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6539 drag, down, double or triple). The base must be last.
6540 The return value is an event type (a character or symbol) which
6541 has the same base event type and all the specified modifiers. */)
6542 (Lisp_Object event_desc
)
6550 while (CONSP (rest
))
6558 /* Given a symbol, see if it is a modifier name. */
6559 if (SYMBOLP (elt
) && CONSP (rest
))
6560 this = parse_solitary_modifier (elt
);
6564 else if (!NILP (base
))
6565 error ("Two bases given in one event");
6571 /* Let the symbol A refer to the character A. */
6572 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6573 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6575 if (INTEGERP (base
))
6577 /* Turn (shift a) into A. */
6578 if ((modifiers
& shift_modifier
) != 0
6579 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6581 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6582 modifiers
&= ~shift_modifier
;
6585 /* Turn (control a) into C-a. */
6586 if (modifiers
& ctrl_modifier
)
6587 return make_number ((modifiers
& ~ctrl_modifier
)
6588 | make_ctrl_char (XINT (base
)));
6590 return make_number (modifiers
| XINT (base
));
6592 else if (SYMBOLP (base
))
6593 return apply_modifiers (modifiers
, base
);
6596 error ("Invalid base event");
6601 /* Try to recognize SYMBOL as a modifier name.
6602 Return the modifier flag bit, or 0 if not recognized. */
6605 parse_solitary_modifier (Lisp_Object symbol
)
6607 Lisp_Object name
= SYMBOL_NAME (symbol
);
6609 switch (SREF (name
, 0))
6611 #define SINGLE_LETTER_MOD(BIT) \
6612 if (SBYTES (name) == 1) \
6615 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6616 if (LEN == SBYTES (name) \
6617 && ! memcmp (SDATA (name), NAME, LEN)) \
6621 SINGLE_LETTER_MOD (alt_modifier
);
6625 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6629 SINGLE_LETTER_MOD (ctrl_modifier
);
6633 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6634 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6638 SINGLE_LETTER_MOD (hyper_modifier
);
6642 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6646 SINGLE_LETTER_MOD (meta_modifier
);
6650 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6654 SINGLE_LETTER_MOD (shift_modifier
);
6658 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6659 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6660 SINGLE_LETTER_MOD (super_modifier
);
6664 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6665 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6666 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6670 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6673 #undef SINGLE_LETTER_MOD
6674 #undef MULTI_LETTER_MOD
6680 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6681 Such a list is not valid as an event,
6682 but it can be a Lucid-style event type list. */
6685 lucid_event_type_list_p (Lisp_Object object
)
6689 if (! CONSP (object
))
6692 if (EQ (XCAR (object
), Qhelp_echo
)
6693 || EQ (XCAR (object
), Qvertical_line
)
6694 || EQ (XCAR (object
), Qmode_line
)
6695 || EQ (XCAR (object
), Qheader_line
))
6698 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6702 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6709 /* Store into *addr a value nonzero if terminal input chars are available.
6710 Serves the purpose of ioctl (0, FIONREAD, addr)
6711 but works even if FIONREAD does not exist.
6712 (In fact, this may actually read some input.)
6714 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6715 timer events that are ripe.
6716 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6717 events (FOCUS_IN_EVENT).
6718 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6719 movements and toolkit scroll bar thumb drags. */
6722 get_input_pending (int *addr
, int flags
)
6724 /* First of all, have we already counted some input? */
6725 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6727 /* If input is being read as it arrives, and we have none, there is none. */
6728 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6731 /* Try to read some input and see how much we get. */
6733 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6736 /* Put a BUFFER_SWITCH_EVENT in the buffer
6737 so that read_key_sequence will notice the new current buffer. */
6740 record_asynch_buffer_change (void)
6742 struct input_event event
;
6746 event
.kind
= BUFFER_SWITCH_EVENT
;
6747 event
.frame_or_window
= Qnil
;
6750 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6751 The purpose of the event is to make read_key_sequence look up the
6752 keymaps again. If we aren't in read_key_sequence, we don't need one,
6753 and the event could cause trouble by messing up (input-pending-p).
6754 Note: Fwaiting_for_user_input_p always returns nil when async
6755 subprocesses aren't supported. */
6756 tem
= Fwaiting_for_user_input_p ();
6760 /* Make sure no interrupt happens while storing the event. */
6762 if (interrupt_input
)
6763 kbd_buffer_store_event (&event
);
6768 kbd_buffer_store_event (&event
);
6773 /* Read any terminal input already buffered up by the system
6774 into the kbd_buffer, but do not wait.
6776 Return the number of keyboard chars read, or -1 meaning
6777 this is a bad time to try to read input. */
6786 /* Store pending user signal events, if any. */
6787 store_user_signal_events ();
6789 /* Loop through the available terminals, and call their input hooks. */
6793 struct terminal
*next
= t
->next_terminal
;
6795 if (t
->read_socket_hook
)
6798 struct input_event hold_quit
;
6800 if (input_blocked_p ())
6802 pending_signals
= 1;
6806 EVENT_INIT (hold_quit
);
6807 hold_quit
.kind
= NO_EVENT
;
6809 /* No need for FIONREAD or fcntl; just say don't wait. */
6810 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6813 if (nr
== -1) /* Not OK to read input now. */
6817 else if (nr
== -2) /* Non-transient error. */
6819 /* The terminal device terminated; it should be closed. */
6821 /* Kill Emacs if this was our last terminal. */
6822 if (!terminal_list
->next_terminal
)
6823 /* Formerly simply reported no input, but that
6824 sometimes led to a failure of Emacs to terminate.
6825 SIGHUP seems appropriate if we can't reach the
6827 /* ??? Is it really right to send the signal just to
6828 this process rather than to the whole process
6829 group? Perhaps on systems with FIONREAD Emacs is
6830 alone in its group. */
6831 terminate_due_to_signal (SIGHUP
, 10);
6833 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6836 XSETTERMINAL (tmp
, t
);
6837 Fdelete_terminal (tmp
, Qnoelisp
);
6841 if (hold_quit
.kind
!= NO_EVENT
)
6842 kbd_buffer_store_event (&hold_quit
);
6851 frame_make_pointer_visible ();
6857 decode_keyboard_code (struct tty_display_info
*tty
,
6858 struct coding_system
*coding
,
6859 unsigned char *buf
, int nbytes
)
6861 unsigned char *src
= buf
;
6862 const unsigned char *p
;
6867 if (tty
->meta_key
!= 2)
6868 for (i
= 0; i
< nbytes
; i
++)
6870 if (coding
->carryover_bytes
> 0)
6872 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6873 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6874 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6875 nbytes
+= coding
->carryover_bytes
;
6877 coding
->destination
= alloca (nbytes
* 4);
6878 coding
->dst_bytes
= nbytes
* 4;
6879 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6880 if (coding
->produced_char
== 0)
6882 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6884 struct input_event event_buf
;
6886 EVENT_INIT (event_buf
);
6887 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6889 (ASCII_CHAR_P (event_buf
.code
)
6890 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6891 /* See the comment in tty_read_avail_input. */
6892 event_buf
.frame_or_window
= tty
->top_frame
;
6893 event_buf
.arg
= Qnil
;
6894 kbd_buffer_store_event (&event_buf
);
6898 /* This is the tty way of reading available input.
6900 Note that each terminal device has its own `struct terminal' object,
6901 and so this function is called once for each individual termcap
6902 terminal. The first parameter indicates which terminal to read from. */
6905 tty_read_avail_input (struct terminal
*terminal
,
6906 struct input_event
*hold_quit
)
6908 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6909 the kbd_buffer can really hold. That may prevent loss
6910 of characters on some systems when input is stuffed at us. */
6911 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6913 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6916 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6918 if (kbd_on_hold_p () || buffer_free
<= 0)
6920 #endif /* subprocesses */
6922 if (!terminal
->name
) /* Don't read from a dead terminal. */
6925 if (terminal
->type
!= output_termcap
6926 && terminal
->type
!= output_msdos_raw
)
6929 /* XXX I think the following code should be moved to separate hook
6930 functions in system-dependent files. */
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_NDELAY
);
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_NDELAY causes
7030 an EAGAIN error. Does anybody know of a situation
7031 where a retry is actually needed? */
7033 nread
< 0 && (errno
== EAGAIN
7046 #ifndef USABLE_FIONREAD
7047 #if defined (USG) || defined (CYGWIN)
7048 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7049 #endif /* USG or CYGWIN */
7050 #endif /* no FIONREAD */
7055 #endif /* not MSDOS */
7056 #endif /* not WINDOWSNT */
7058 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7059 & CODING_REQUIRE_DECODING_MASK
)
7061 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7064 /* Decode the key sequence except for those with meta
7066 for (i
= from
= 0; ; i
++)
7067 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7069 struct input_event buf
;
7071 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7076 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7077 buf
.modifiers
= meta_modifier
;
7078 buf
.code
= cbuf
[i
] & ~0x80;
7079 /* See the comment below. */
7080 buf
.frame_or_window
= tty
->top_frame
;
7082 kbd_buffer_store_event (&buf
);
7088 for (i
= 0; i
< nread
; i
++)
7090 struct input_event buf
;
7092 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7094 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7095 buf
.modifiers
= meta_modifier
;
7096 if (tty
->meta_key
!= 2)
7100 /* Set the frame corresponding to the active tty. Note that the
7101 value of selected_frame is not reliable here, redisplay tends
7102 to temporarily change it. */
7103 buf
.frame_or_window
= tty
->top_frame
;
7106 kbd_buffer_store_event (&buf
);
7107 /* Don't look at input that follows a C-g too closely.
7108 This reduces lossage due to autorepeat on C-g. */
7109 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7110 && buf
.code
== quit_char
)
7118 handle_async_input (void)
7123 int nread
= gobble_input ();
7124 /* -1 means it's not ok to read the input now.
7125 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7126 0 means there was no keyboard input available. */
7134 process_pending_signals (void)
7136 pending_signals
= 0;
7137 handle_async_input ();
7138 do_pending_atimers ();
7141 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7142 and also (if the level is now 0) reinvoke any pending signal. */
7145 unblock_input_to (int level
)
7147 interrupt_input_blocked
= level
;
7150 if (pending_signals
)
7151 process_pending_signals ();
7157 /* End critical section.
7159 If doing signal-driven input, and a signal came in when input was
7160 blocked, reinvoke the signal handler now to deal with it. */
7163 unblock_input (void)
7165 unblock_input_to (interrupt_input_blocked
- 1);
7168 /* Undo any number of BLOCK_INPUT calls,
7169 and also reinvoke any pending signal. */
7172 totally_unblock_input (void)
7174 unblock_input_to (0);
7180 handle_input_available_signal (int sig
)
7182 pending_signals
= 1;
7184 if (input_available_clear_time
)
7185 *input_available_clear_time
= make_emacs_time (0, 0);
7189 deliver_input_available_signal (int sig
)
7191 deliver_process_signal (sig
, handle_input_available_signal
);
7193 #endif /* USABLE_SIGIO */
7196 /* User signal events. */
7198 struct user_signal_info
7200 /* Signal number. */
7203 /* Name of the signal. */
7206 /* Number of pending signals. */
7209 struct user_signal_info
*next
;
7212 /* List of user signals. */
7213 static struct user_signal_info
*user_signals
= NULL
;
7216 add_user_signal (int sig
, const char *name
)
7218 struct sigaction action
;
7219 struct user_signal_info
*p
;
7221 for (p
= user_signals
; p
; p
= p
->next
)
7223 /* Already added. */
7226 p
= xmalloc (sizeof *p
);
7228 p
->name
= xstrdup (name
);
7230 p
->next
= user_signals
;
7233 emacs_sigaction_init (&action
, deliver_user_signal
);
7234 sigaction (sig
, &action
, 0);
7238 handle_user_signal (int sig
)
7240 struct user_signal_info
*p
;
7241 const char *special_event_name
= NULL
;
7243 if (SYMBOLP (Vdebug_on_event
))
7244 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7246 for (p
= user_signals
; p
; p
= p
->next
)
7249 if (special_event_name
7250 && strcmp (special_event_name
, p
->name
) == 0)
7252 /* Enter the debugger in many ways. */
7253 debug_on_next_call
= 1;
7256 Vinhibit_quit
= Qnil
;
7258 /* Eat the event. */
7264 if (interrupt_input
)
7265 handle_input_available_signal (sig
);
7269 /* Tell wait_reading_process_output that it needs to wake
7270 up and look around. */
7271 if (input_available_clear_time
)
7272 *input_available_clear_time
= make_emacs_time (0, 0);
7279 deliver_user_signal (int sig
)
7281 deliver_process_signal (sig
, handle_user_signal
);
7285 find_user_signal_name (int sig
)
7287 struct user_signal_info
*p
;
7289 for (p
= user_signals
; p
; p
= p
->next
)
7297 store_user_signal_events (void)
7299 struct user_signal_info
*p
;
7300 struct input_event buf
;
7301 bool buf_initialized
= 0;
7303 for (p
= user_signals
; p
; p
= p
->next
)
7304 if (p
->npending
> 0)
7306 if (! buf_initialized
)
7308 memset (&buf
, 0, sizeof buf
);
7309 buf
.kind
= USER_SIGNAL_EVENT
;
7310 buf
.frame_or_window
= selected_frame
;
7311 buf_initialized
= 1;
7317 kbd_buffer_store_event (&buf
);
7320 while (p
->npending
> 0);
7325 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7326 static Lisp_Object menu_bar_one_keymap_changed_items
;
7328 /* These variables hold the vector under construction within
7329 menu_bar_items and its subroutines, and the current index
7330 for storing into that vector. */
7331 static Lisp_Object menu_bar_items_vector
;
7332 static int menu_bar_items_index
;
7335 static const char* separator_names
[] = {
7340 "single-dashed-line",
7341 "double-dashed-line",
7343 "shadow-etched-out",
7344 "shadow-etched-in-dash",
7345 "shadow-etched-out-dash",
7346 "shadow-double-etched-in",
7347 "shadow-double-etched-out",
7348 "shadow-double-etched-in-dash",
7349 "shadow-double-etched-out-dash",
7353 /* Return non-zero if LABEL specifies a separator. */
7356 menu_separator_name_p (const char *label
)
7360 else if (strlen (label
) > 3
7361 && memcmp (label
, "--", 2) == 0
7366 for (i
= 0; separator_names
[i
]; ++i
)
7367 if (strcmp (label
, separator_names
[i
]) == 0)
7372 /* It's a separator if it contains only dashes. */
7373 while (*label
== '-')
7375 return (*label
== 0);
7382 /* Return a vector of menu items for a menu bar, appropriate
7383 to the current buffer. Each item has three elements in the vector:
7386 OLD is an old vector we can optionally reuse, or nil. */
7389 menu_bar_items (Lisp_Object old
)
7391 /* The number of keymaps we're scanning right now, and the number of
7392 keymaps we have allocated space for. */
7395 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7396 in the current keymaps, or nil where it is not a prefix. */
7399 Lisp_Object def
, tail
;
7404 /* In order to build the menus, we need to call the keymap
7405 accessors. They all call QUIT. But this function is called
7406 during redisplay, during which a quit is fatal. So inhibit
7407 quitting while building the menus.
7408 We do this instead of specbind because (1) errors will clear it anyway
7409 and (2) this avoids risk of specpdl overflow. */
7410 oquit
= Vinhibit_quit
;
7414 menu_bar_items_vector
= old
;
7416 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7417 menu_bar_items_index
= 0;
7419 /* Build our list of keymaps.
7420 If we recognize a function key and replace its escape sequence in
7421 keybuf with its symbol, or if the sequence starts with a mouse
7422 click and we need to switch buffers, we jump back here to rebuild
7423 the initial keymaps from the current buffer. */
7427 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7428 if (!NILP (Voverriding_local_map_menu_flag
))
7430 /* Yes, use them (if non-nil) as well as the global map. */
7431 maps
= alloca (3 * sizeof (maps
[0]));
7433 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7434 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7435 if (!NILP (Voverriding_local_map
))
7436 maps
[nmaps
++] = Voverriding_local_map
;
7440 /* No, so use major and minor mode keymaps and keymap property.
7441 Note that menu-bar bindings in the local-map and keymap
7442 properties may not work reliable, as they are only
7443 recognized when the menu-bar (or mode-line) is updated,
7444 which does not normally happen after every command. */
7447 nminor
= current_minor_maps (NULL
, &tmaps
);
7448 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7450 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7451 maps
[nmaps
++] = tem
;
7452 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7454 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7456 maps
[nmaps
++] = current_global_map
;
7459 /* Look up in each map the dummy prefix key `menu-bar'. */
7461 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7462 if (!NILP (maps
[mapno
]))
7464 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7468 menu_bar_one_keymap_changed_items
= Qnil
;
7469 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7473 /* Move to the end those items that should be at the end. */
7475 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7478 int end
= menu_bar_items_index
;
7480 for (i
= 0; i
< end
; i
+= 4)
7481 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7483 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7484 /* Move the item at index I to the end,
7485 shifting all the others forward. */
7486 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7487 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7488 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7489 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7491 memmove (aref_addr (menu_bar_items_vector
, i
),
7492 aref_addr (menu_bar_items_vector
, i
+ 4),
7493 (end
- i
- 4) * word_size
);
7494 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7495 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7496 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7497 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7502 /* Add nil, nil, nil, nil at the end. */
7504 int i
= menu_bar_items_index
;
7505 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7506 menu_bar_items_vector
=
7507 larger_vector (menu_bar_items_vector
, 4, -1);
7508 /* Add this item. */
7509 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7510 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7511 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7512 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7513 menu_bar_items_index
= i
;
7516 Vinhibit_quit
= oquit
;
7517 return menu_bar_items_vector
;
7520 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7521 If there's already an item for KEY, add this DEF to it. */
7523 Lisp_Object item_properties
;
7526 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7528 struct gcpro gcpro1
;
7532 if (EQ (item
, Qundefined
))
7534 /* If a map has an explicit `undefined' as definition,
7535 discard any previously made menu bar item. */
7537 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7538 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7540 if (menu_bar_items_index
> i
+ 4)
7541 memmove (aref_addr (menu_bar_items_vector
, i
),
7542 aref_addr (menu_bar_items_vector
, i
+ 4),
7543 (menu_bar_items_index
- i
- 4) * word_size
);
7544 menu_bar_items_index
-= 4;
7548 /* If this keymap has already contributed to this KEY,
7549 don't contribute to it a second time. */
7550 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7551 if (!NILP (tem
) || NILP (item
))
7554 menu_bar_one_keymap_changed_items
7555 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7557 /* We add to menu_bar_one_keymap_changed_items before doing the
7558 parse_menu_item, so that if it turns out it wasn't a menu item,
7559 it still correctly hides any further menu item. */
7561 i
= parse_menu_item (item
, 1);
7566 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7568 /* Find any existing item for this KEY. */
7569 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7570 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7573 /* If we did not find this KEY, add it at the end. */
7574 if (i
== menu_bar_items_index
)
7576 /* If vector is too small, get a bigger one. */
7577 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7578 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7579 /* Add this item. */
7580 ASET (menu_bar_items_vector
, i
, key
); i
++;
7581 ASET (menu_bar_items_vector
, i
,
7582 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7583 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7584 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7585 menu_bar_items_index
= i
;
7587 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7591 old
= AREF (menu_bar_items_vector
, i
+ 2);
7592 /* If the new and the old items are not both keymaps,
7593 the lookup will only find `item'. */
7594 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7595 ASET (menu_bar_items_vector
, i
+ 2, item
);
7599 /* This is used as the handler when calling menu_item_eval_property. */
7601 menu_item_eval_property_1 (Lisp_Object arg
)
7603 /* If we got a quit from within the menu computation,
7604 quit all the way out of it. This takes care of C-] in the debugger. */
7605 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7606 Fsignal (Qquit
, Qnil
);
7612 eval_dyn (Lisp_Object form
)
7614 return Feval (form
, Qnil
);
7617 /* Evaluate an expression and return the result (or nil if something
7618 went wrong). Used to evaluate dynamic parts of menu items. */
7620 menu_item_eval_property (Lisp_Object sexpr
)
7622 ptrdiff_t count
= SPECPDL_INDEX ();
7624 specbind (Qinhibit_redisplay
, Qt
);
7625 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7626 menu_item_eval_property_1
);
7627 return unbind_to (count
, val
);
7630 /* This function parses a menu item and leaves the result in the
7631 vector item_properties.
7632 ITEM is a key binding, a possible menu item.
7633 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7635 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7636 parse_menu_item returns true if the item is a menu item and false
7640 parse_menu_item (Lisp_Object item
, int inmenubar
)
7642 Lisp_Object def
, tem
, item_string
, start
;
7644 Lisp_Object keyhint
;
7653 /* Create item_properties vector if necessary. */
7654 if (NILP (item_properties
))
7656 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7658 /* Initialize optional entries. */
7659 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7660 ASET (item_properties
, i
, Qnil
);
7661 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7663 /* Save the item here to protect it from GC. */
7664 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7666 item_string
= XCAR (item
);
7670 if (STRINGP (item_string
))
7672 /* Old format menu item. */
7673 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7675 /* Maybe help string. */
7676 if (CONSP (item
) && STRINGP (XCAR (item
)))
7678 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7683 /* Maybe an obsolete key binding cache. */
7684 if (CONSP (item
) && CONSP (XCAR (item
))
7685 && (NILP (XCAR (XCAR (item
)))
7686 || VECTORP (XCAR (XCAR (item
)))))
7689 /* This is the real definition--the function to run. */
7690 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7692 /* Get enable property, if any. */
7695 tem
= Fget (item
, Qmenu_enable
);
7696 if (!NILP (Venable_disabled_menus_and_buttons
))
7697 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7698 else if (!NILP (tem
))
7699 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7702 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7704 /* New format menu item. */
7705 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7706 start
= XCDR (item
);
7709 /* We have a real binding. */
7710 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7712 item
= XCDR (start
);
7713 /* Is there an obsolete cache list with key equivalences. */
7714 if (CONSP (item
) && CONSP (XCAR (item
)))
7717 /* Parse properties. */
7718 while (CONSP (item
) && CONSP (XCDR (item
)))
7723 if (EQ (tem
, QCenable
))
7725 if (!NILP (Venable_disabled_menus_and_buttons
))
7726 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7728 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7730 else if (EQ (tem
, QCvisible
))
7732 /* If got a visible property and that evaluates to nil
7733 then ignore this item. */
7734 tem
= menu_item_eval_property (XCAR (item
));
7738 else if (EQ (tem
, QChelp
))
7739 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7740 else if (EQ (tem
, QCfilter
))
7742 else if (EQ (tem
, QCkey_sequence
))
7745 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7746 /* Be GC protected. Set keyhint to item instead of tem. */
7749 else if (EQ (tem
, QCkeys
))
7752 if (CONSP (tem
) || STRINGP (tem
))
7753 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7755 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7760 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7762 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7764 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7770 else if (inmenubar
|| !NILP (start
))
7774 return 0; /* not a menu item */
7776 /* If item string is not a string, evaluate it to get string.
7777 If we don't get a string, skip this item. */
7778 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7779 if (!(STRINGP (item_string
)))
7781 item_string
= menu_item_eval_property (item_string
);
7782 if (!STRINGP (item_string
))
7784 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7787 /* If got a filter apply it on definition. */
7788 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7791 def
= menu_item_eval_property (list2 (XCAR (filter
),
7792 list2 (Qquote
, def
)));
7794 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7797 /* Enable or disable selection of item. */
7798 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7801 tem
= menu_item_eval_property (tem
);
7802 if (inmenubar
&& NILP (tem
))
7803 return 0; /* Ignore disabled items in menu bar. */
7804 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7807 /* If we got no definition, this item is just unselectable text which
7808 is OK in a submenu but not in the menubar. */
7810 return (!inmenubar
);
7812 /* See if this is a separate pane or a submenu. */
7813 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7814 tem
= get_keymap (def
, 0, 1);
7815 /* For a subkeymap, just record its details and exit. */
7818 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7819 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7823 /* At the top level in the menu bar, do likewise for commands also.
7824 The menu bar does not display equivalent key bindings anyway.
7825 ITEM_PROPERTY_DEF is already set up properly. */
7829 { /* This is a command. See if there is an equivalent key binding. */
7830 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7832 /* The previous code preferred :key-sequence to :keys, so we
7833 preserve this behavior. */
7834 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7835 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7838 Lisp_Object prefix
= keyeq
;
7839 Lisp_Object keys
= Qnil
;
7843 def
= XCAR (prefix
);
7844 prefix
= XCDR (prefix
);
7847 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7849 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7851 keys
= XCAR (keyhint
);
7852 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7854 /* We have a suggested key. Is it bound to the command? */
7857 /* If the command is an alias for another
7858 (such as lmenu.el set it up), check if the
7859 original command matches the cached command. */
7861 && EQ (tem
, XSYMBOL (def
)->function
))))
7866 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7870 tem
= Fkey_description (keys
, Qnil
);
7873 if (STRINGP (XCAR (prefix
)))
7874 tem
= concat2 (XCAR (prefix
), tem
);
7875 if (STRINGP (XCDR (prefix
)))
7876 tem
= concat2 (tem
, XCDR (prefix
));
7878 keyeq
= concat2 (build_string (" "), tem
);
7879 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7885 /* If we have an equivalent key binding, use that. */
7886 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7889 /* Include this when menu help is implemented.
7890 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7891 if (!(NILP (tem) || STRINGP (tem)))
7893 tem = menu_item_eval_property (tem);
7896 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7900 /* Handle radio buttons or toggle boxes. */
7901 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7903 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7904 menu_item_eval_property (tem
));
7911 /***********************************************************************
7913 ***********************************************************************/
7915 /* A vector holding tool bar items while they are parsed in function
7916 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7919 static Lisp_Object tool_bar_items_vector
;
7921 /* A vector holding the result of parse_tool_bar_item. Layout is like
7922 the one for a single item in tool_bar_items_vector. */
7924 static Lisp_Object tool_bar_item_properties
;
7926 /* Next free index in tool_bar_items_vector. */
7928 static int ntool_bar_items
;
7930 /* The symbols `:image' and `:rtl'. */
7932 static Lisp_Object QCimage
;
7933 static Lisp_Object QCrtl
;
7935 /* Function prototypes. */
7937 static void init_tool_bar_items (Lisp_Object
);
7938 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7939 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7940 static void append_tool_bar_item (void);
7943 /* Return a vector of tool bar items for keymaps currently in effect.
7944 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7945 tool bar items found. */
7948 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7957 /* In order to build the menus, we need to call the keymap
7958 accessors. They all call QUIT. But this function is called
7959 during redisplay, during which a quit is fatal. So inhibit
7960 quitting while building the menus. We do this instead of
7961 specbind because (1) errors will clear it anyway and (2) this
7962 avoids risk of specpdl overflow. */
7963 oquit
= Vinhibit_quit
;
7966 /* Initialize tool_bar_items_vector and protect it from GC. */
7967 init_tool_bar_items (reuse
);
7969 /* Build list of keymaps in maps. Set nmaps to the number of maps
7972 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7973 if (!NILP (Voverriding_local_map_menu_flag
))
7975 /* Yes, use them (if non-nil) as well as the global map. */
7976 maps
= alloca (3 * sizeof *maps
);
7978 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7979 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7980 if (!NILP (Voverriding_local_map
))
7981 maps
[nmaps
++] = Voverriding_local_map
;
7985 /* No, so use major and minor mode keymaps and keymap property.
7986 Note that tool-bar bindings in the local-map and keymap
7987 properties may not work reliable, as they are only
7988 recognized when the tool-bar (or mode-line) is updated,
7989 which does not normally happen after every command. */
7992 nminor
= current_minor_maps (NULL
, &tmaps
);
7993 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7995 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7996 maps
[nmaps
++] = tem
;
7997 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7999 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8002 /* Add global keymap at the end. */
8003 maps
[nmaps
++] = current_global_map
;
8005 /* Process maps in reverse order and look up in each map the prefix
8007 for (i
= nmaps
- 1; i
>= 0; --i
)
8008 if (!NILP (maps
[i
]))
8012 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8014 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8017 Vinhibit_quit
= oquit
;
8018 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8019 return tool_bar_items_vector
;
8023 /* Process the definition of KEY which is DEF. */
8026 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8029 struct gcpro gcpro1
, gcpro2
;
8031 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8035 if (EQ (def
, Qundefined
))
8037 /* If a map has an explicit `undefined' as definition,
8038 discard any previously made item. */
8039 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8041 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8043 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8045 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8046 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8047 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8049 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8054 else if (parse_tool_bar_item (key
, def
))
8055 /* Append a new tool bar item to tool_bar_items_vector. Accept
8056 more than one definition for the same key. */
8057 append_tool_bar_item ();
8062 /* Access slot with index IDX of vector tool_bar_item_properties. */
8063 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8065 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8067 ASET (tool_bar_item_properties
, idx
, val
);
8071 /* Parse a tool bar item specification ITEM for key KEY and return the
8072 result in tool_bar_item_properties. Value is zero if ITEM is
8075 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8077 CAPTION is the caption of the item, If it's not a string, it is
8078 evaluated to get a string.
8080 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8081 as binding are currently ignored.
8083 The following properties are recognized:
8087 FORM is evaluated and specifies whether the tool bar item is
8088 enabled or disabled.
8092 FORM is evaluated and specifies whether the tool bar item is visible.
8094 - `:filter FUNCTION'
8096 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8097 result is stored as the new binding.
8099 - `:button (TYPE SELECTED)'
8101 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8102 and specifies whether the button is selected (pressed) or not.
8106 IMAGES is either a single image specification or a vector of four
8107 image specifications. See enum tool_bar_item_images.
8109 - `:help HELP-STRING'.
8111 Gives a help string to display for the tool bar item.
8113 - `:label LABEL-STRING'.
8115 A text label to show with the tool bar button if labels are enabled. */
8118 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8120 Lisp_Object filter
= Qnil
;
8121 Lisp_Object caption
;
8122 int i
, have_label
= 0;
8124 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8125 Rule out items that aren't lists, don't start with
8126 `menu-item' or whose rest following `tool-bar-item' is not a
8131 /* As an exception, allow old-style menu separators. */
8132 if (STRINGP (XCAR (item
)))
8133 item
= Fcons (XCAR (item
), Qnil
);
8134 else if (!EQ (XCAR (item
), Qmenu_item
)
8135 || (item
= XCDR (item
), !CONSP (item
)))
8138 /* Create tool_bar_item_properties vector if necessary. Reset it to
8140 if (VECTORP (tool_bar_item_properties
))
8142 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8146 tool_bar_item_properties
8147 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8150 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8151 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8153 /* Get the caption of the item. If the caption is not a string,
8154 evaluate it to get a string. If we don't get a string, skip this
8156 caption
= XCAR (item
);
8157 if (!STRINGP (caption
))
8159 caption
= menu_item_eval_property (caption
);
8160 if (!STRINGP (caption
))
8163 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8165 /* If the rest following the caption is not a list, the menu item is
8166 either a separator, or invalid. */
8170 if (menu_separator_name_p (SSDATA (caption
)))
8172 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8173 #if !defined (USE_GTK) && !defined (HAVE_NS)
8174 /* If we use build_desired_tool_bar_string to render the
8175 tool bar, the separator is rendered as an image. */
8176 PROP (TOOL_BAR_ITEM_IMAGES
)
8177 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8178 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8179 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8180 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8187 /* Store the binding. */
8188 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8191 /* Ignore cached key binding, if any. */
8192 if (CONSP (item
) && CONSP (XCAR (item
)))
8195 /* Process the rest of the properties. */
8196 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8198 Lisp_Object ikey
, value
;
8201 value
= XCAR (XCDR (item
));
8203 if (EQ (ikey
, QCenable
))
8205 /* `:enable FORM'. */
8206 if (!NILP (Venable_disabled_menus_and_buttons
))
8207 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8209 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8211 else if (EQ (ikey
, QCvisible
))
8213 /* `:visible FORM'. If got a visible property and that
8214 evaluates to nil then ignore this item. */
8215 if (NILP (menu_item_eval_property (value
)))
8218 else if (EQ (ikey
, QChelp
))
8219 /* `:help HELP-STRING'. */
8220 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8221 else if (EQ (ikey
, QCvert_only
))
8222 /* `:vert-only t/nil'. */
8223 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8224 else if (EQ (ikey
, QClabel
))
8226 const char *bad_label
= "!!?GARBLED ITEM?!!";
8227 /* `:label LABEL-STRING'. */
8228 set_prop (TOOL_BAR_ITEM_LABEL
,
8229 STRINGP (value
) ? value
: build_string (bad_label
));
8232 else if (EQ (ikey
, QCfilter
))
8233 /* ':filter FORM'. */
8235 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8237 /* `:button (TYPE . SELECTED)'. */
8238 Lisp_Object type
, selected
;
8240 type
= XCAR (value
);
8241 selected
= XCDR (value
);
8242 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8244 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8245 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8248 else if (EQ (ikey
, QCimage
)
8250 || (VECTORP (value
) && ASIZE (value
) == 4)))
8251 /* Value is either a single image specification or a vector
8252 of 4 such specifications for the different button states. */
8253 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8254 else if (EQ (ikey
, QCrtl
))
8256 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8262 /* Try to make one from caption and key. */
8263 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8264 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8265 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8266 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8268 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8269 char *buf
= xmalloc (max_lbl
+ 1);
8270 Lisp_Object new_lbl
;
8271 ptrdiff_t caption_len
= strlen (capt
);
8273 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8276 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8278 buf
[caption_len
] = '\0';
8282 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8286 strcpy (buf
, label
);
8288 for (j
= 0; buf
[j
] != '\0'; ++j
)
8296 new_lbl
= Fupcase_initials (build_string (label
));
8297 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8298 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8300 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8304 /* If got a filter apply it on binding. */
8306 set_prop (TOOL_BAR_ITEM_BINDING
,
8307 (menu_item_eval_property
8310 PROP (TOOL_BAR_ITEM_BINDING
))))));
8312 /* See if the binding is a keymap. Give up if it is. */
8313 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8316 /* Enable or disable selection of item. */
8317 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8318 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8319 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8321 /* Handle radio buttons or toggle boxes. */
8322 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8323 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8324 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8332 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8333 that can be reused. */
8336 init_tool_bar_items (Lisp_Object reuse
)
8338 if (VECTORP (reuse
))
8339 tool_bar_items_vector
= reuse
;
8341 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8342 ntool_bar_items
= 0;
8346 /* Append parsed tool bar item properties from
8347 tool_bar_item_properties */
8350 append_tool_bar_item (void)
8354 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8356 /* Enlarge tool_bar_items_vector if necessary. */
8358 tool_bar_items_vector
8359 = larger_vector (tool_bar_items_vector
, incr
, -1);
8361 /* Append entries from tool_bar_item_properties to the end of
8362 tool_bar_items_vector. */
8363 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8364 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8365 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8372 /* Read a character using menus based on maps in the array MAPS.
8373 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8374 Return t if we displayed a menu but the user rejected it.
8376 PREV_EVENT is the previous input event, or nil if we are reading
8377 the first event of a key sequence.
8379 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8380 if we used a mouse menu to read the input, or zero otherwise. If
8381 USED_MOUSE_MENU is null, we don't dereference it.
8383 The prompting is done based on the prompt-string of the map
8384 and the strings associated with various map elements.
8386 This can be done with X menus or with menus put in the minibuf.
8387 These are done in different ways, depending on how the input will be read.
8388 Menus using X are done after auto-saving in read-char, getting the input
8389 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8390 and do auto-saving in the inner call of read_char. */
8393 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8394 Lisp_Object prev_event
, int *used_mouse_menu
)
8400 if (used_mouse_menu
)
8401 *used_mouse_menu
= 0;
8403 /* Use local over global Menu maps */
8405 if (! menu_prompting
)
8408 /* Optionally disregard all but the global map. */
8409 if (inhibit_local_menu_bar_menus
)
8411 maps
+= (nmaps
- 1);
8416 /* If we got to this point via a mouse click,
8417 use a real menu for mouse selection. */
8418 if (EVENT_HAS_PARAMETERS (prev_event
)
8419 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8420 && !EQ (XCAR (prev_event
), Qtool_bar
))
8422 /* Display the menu and get the selection. */
8423 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8425 ptrdiff_t nmaps1
= 0;
8427 /* Use the maps that are not nil. */
8428 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8429 if (!NILP (maps
[mapno
]))
8430 realmaps
[nmaps1
++] = maps
[mapno
];
8432 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8437 record_menu_key (XCAR (value
));
8439 /* If we got multiple events, unread all but
8441 There is no way to prevent those unread events
8442 from showing up later in last_nonmenu_event.
8443 So turn symbol and integer events into lists,
8444 to indicate that they came from a mouse menu,
8445 so that when present in last_nonmenu_event
8446 they won't confuse things. */
8447 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8449 record_menu_key (XCAR (tem
));
8450 if (SYMBOLP (XCAR (tem
))
8451 || INTEGERP (XCAR (tem
)))
8452 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8455 /* If we got more than one event, put all but the first
8456 onto this list to be read later.
8457 Return just the first event now. */
8458 Vunread_command_events
8459 = nconc2 (XCDR (value
), Vunread_command_events
);
8460 value
= XCAR (value
);
8462 else if (NILP (value
))
8464 if (used_mouse_menu
)
8465 *used_mouse_menu
= 1;
8468 #endif /* HAVE_MENUS */
8472 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8473 We make this bigger when necessary, and never free it. */
8474 static char *read_char_minibuf_menu_text
;
8475 /* Size of that buffer. */
8476 static ptrdiff_t read_char_minibuf_menu_width
;
8479 read_char_minibuf_menu_prompt (int commandflag
,
8480 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8483 register Lisp_Object name
;
8485 /* FIXME: Use the minibuffer's frame width. */
8486 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8489 Lisp_Object rest
, vector
;
8495 if (! menu_prompting
)
8498 /* Get the menu name from the first map that has one (a prompt string). */
8499 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8501 name
= Fkeymap_prompt (maps
[mapno
]);
8506 /* If we don't have any menus, just read a character normally. */
8507 if (!STRINGP (name
))
8510 /* Make sure we have a big enough buffer for the menu text. */
8511 width
= max (width
, SBYTES (name
));
8512 if (STRING_BYTES_BOUND
- 4 < width
)
8513 memory_full (SIZE_MAX
);
8514 if (width
+ 4 > read_char_minibuf_menu_width
)
8516 read_char_minibuf_menu_text
8517 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8518 read_char_minibuf_menu_width
= width
+ 4;
8520 menu
= read_char_minibuf_menu_text
;
8522 /* Prompt string always starts with map's prompt, and a space. */
8523 strcpy (menu
, SSDATA (name
));
8524 nlength
= SBYTES (name
);
8525 menu
[nlength
++] = ':';
8526 menu
[nlength
++] = ' ';
8529 /* Start prompting at start of first map. */
8533 /* Present the documented bindings, a line at a time. */
8537 ptrdiff_t i
= nlength
;
8539 Lisp_Object orig_defn_macro
;
8541 /* Loop over elements of map. */
8546 /* If reached end of map, start at beginning of next map. */
8550 /* At end of last map, wrap around to first map if just starting,
8551 or end this line if already have something on it. */
8555 if (notfirst
|| nobindings
) break;
8560 /* Look at the next element of the map. */
8562 elt
= AREF (vector
, idx
);
8564 elt
= Fcar_safe (rest
);
8566 if (idx
< 0 && VECTORP (elt
))
8568 /* If we found a dense table in the keymap,
8569 advanced past it, but start scanning its contents. */
8570 rest
= Fcdr_safe (rest
);
8576 /* An ordinary element. */
8577 Lisp_Object event
, tem
;
8581 event
= Fcar_safe (elt
); /* alist */
8582 elt
= Fcdr_safe (elt
);
8586 XSETINT (event
, idx
); /* vector */
8589 /* Ignore the element if it has no prompt string. */
8590 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8592 /* 1 if the char to type matches the string. */
8594 Lisp_Object upcased_event
, downcased_event
;
8595 Lisp_Object desc
= Qnil
;
8597 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8599 upcased_event
= Fupcase (event
);
8600 downcased_event
= Fdowncase (event
);
8601 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8602 || XINT (downcased_event
) == SREF (s
, 0));
8604 desc
= Fsingle_key_description (event
, Qnil
);
8606 #if 0 /* It is redundant to list the equivalent key bindings because
8607 the prefix is what the user has already typed. */
8609 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8611 /* Insert equivalent keybinding. */
8612 s
= concat2 (s
, tem
);
8615 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8616 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8618 /* Insert button prefix. */
8619 Lisp_Object selected
8620 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8621 if (EQ (tem
, QCradio
))
8622 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8624 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8625 s
= concat2 (tem
, s
);
8629 /* If we have room for the prompt string, add it to this line.
8630 If this is the first on the line, always add it. */
8631 if ((SCHARS (s
) + i
+ 2
8632 + (char_matches
? 0 : SCHARS (desc
) + 3))
8636 ptrdiff_t thiswidth
;
8638 /* Punctuate between strings. */
8641 strcpy (menu
+ i
, ", ");
8647 /* If the char to type doesn't match the string's
8648 first char, explicitly show what char to type. */
8651 /* Add as much of string as fits. */
8652 thiswidth
= min (SCHARS (desc
), width
- i
);
8653 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8655 strcpy (menu
+ i
, " = ");
8659 /* Add as much of string as fits. */
8660 thiswidth
= min (SCHARS (s
), width
- i
);
8661 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8667 /* If this element does not fit, end the line now,
8668 and save the element for the next line. */
8669 strcpy (menu
+ i
, "...");
8674 /* Move past this element. */
8675 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8676 /* Handle reaching end of dense table. */
8681 rest
= Fcdr_safe (rest
);
8685 /* Prompt with that and read response. */
8686 message2_nolog (menu
, strlen (menu
),
8687 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8689 /* Make believe its not a keyboard macro in case the help char
8690 is pressed. Help characters are not recorded because menu prompting
8691 is not used on replay.
8693 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8694 kset_defining_kbd_macro (current_kboard
, Qnil
);
8696 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8697 while (BUFFERP (obj
));
8698 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8700 if (!INTEGERP (obj
))
8702 else if (XINT (obj
) == -2)
8705 if (! EQ (obj
, menu_prompt_more_char
)
8706 && (!INTEGERP (menu_prompt_more_char
)
8707 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8709 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8710 store_kbd_macro_char (obj
);
8713 /* Help char - go round again */
8717 /* Reading key sequences. */
8719 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8720 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8721 keymap, or nil otherwise. Return the index of the first keymap in
8722 which KEY has any binding, or NMAPS if no map has a binding.
8724 If KEY is a meta ASCII character, treat it like meta-prefix-char
8725 followed by the corresponding non-meta character. Keymaps in
8726 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8729 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8732 NEXT may be the same array as CURRENT. */
8735 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8736 Lisp_Object
*defs
, Lisp_Object
*next
)
8738 ptrdiff_t i
, first_binding
;
8740 first_binding
= nmaps
;
8741 for (i
= nmaps
- 1; i
>= 0; i
--)
8743 if (! NILP (current
[i
]))
8745 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8746 if (! NILP (defs
[i
]))
8753 /* Given the set of bindings we've found, produce the next set of maps. */
8754 if (first_binding
< nmaps
)
8755 for (i
= 0; i
< nmaps
; i
++)
8756 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8758 return first_binding
;
8761 /* Structure used to keep track of partial application of key remapping
8762 such as Vfunction_key_map and Vkey_translation_map. */
8763 typedef struct keyremap
8765 /* This is the map originally specified for this use. */
8767 /* This is a submap reached by looking up, in PARENT,
8768 the events from START to END. */
8770 /* Positions [START, END) in the key sequence buffer
8771 are the key that we have scanned so far.
8772 Those events are the ones that we will replace
8773 if PARENT maps them into a key sequence. */
8777 /* Lookup KEY in MAP.
8778 MAP is a keymap mapping keys to key vectors or functions.
8779 If the mapping is a function and DO_FUNCTION is non-zero, then
8780 the function is called with PROMPT as parameter and its return
8781 value is used as the return value of this function (after checking
8782 that it is indeed a vector). */
8785 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8790 next
= access_keymap (map
, key
, 1, 0, 1);
8792 /* Handle a symbol whose function definition is a keymap
8794 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8795 && (ARRAYP (XSYMBOL (next
)->function
)
8796 || KEYMAPP (XSYMBOL (next
)->function
)))
8797 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8799 /* If the keymap gives a function, not an
8800 array, then call the function with one arg and use
8801 its value instead. */
8802 if (do_funcall
&& FUNCTIONP (next
))
8807 next
= call1 (next
, prompt
);
8808 /* If the function returned something invalid,
8809 barf--don't ignore it.
8810 (To ignore it safely, we would need to gcpro a bunch of
8811 other variables.) */
8812 if (! (VECTORP (next
) || STRINGP (next
)))
8813 error ("Function %s returns invalid key sequence",
8814 SSDATA (SYMBOL_NAME (tem
)));
8819 /* Do one step of the key remapping used for function-key-map and
8820 key-translation-map:
8821 KEYBUF is the buffer holding the input events.
8822 BUFSIZE is its maximum size.
8823 FKEY is a pointer to the keyremap structure to use.
8824 INPUT is the index of the last element in KEYBUF.
8825 DOIT if non-zero says that the remapping can actually take place.
8826 DIFF is used to return the number of keys added/removed by the remapping.
8827 PARENT is the root of the keymap.
8828 PROMPT is the prompt to use if the remapping happens through a function.
8829 The return value is non-zero if the remapping actually took place. */
8832 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8833 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8835 Lisp_Object next
, key
;
8837 key
= keybuf
[fkey
->end
++];
8839 if (KEYMAPP (fkey
->parent
))
8840 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8844 /* If keybuf[fkey->start..fkey->end] is bound in the
8845 map and we're in a position to do the key remapping, replace it with
8846 the binding and restart with fkey->start at the end. */
8847 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8849 int len
= XFASTINT (Flength (next
));
8852 *diff
= len
- (fkey
->end
- fkey
->start
);
8854 if (bufsize
- input
<= *diff
)
8855 error ("Key sequence too long");
8857 /* Shift the keys that follow fkey->end. */
8859 for (i
= fkey
->end
; i
< input
; i
++)
8860 keybuf
[i
+ *diff
] = keybuf
[i
];
8862 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8863 keybuf
[i
+ *diff
] = keybuf
[i
];
8864 /* Overwrite the old keys with the new ones. */
8865 for (i
= 0; i
< len
; i
++)
8866 keybuf
[fkey
->start
+ i
]
8867 = Faref (next
, make_number (i
));
8869 fkey
->start
= fkey
->end
+= *diff
;
8870 fkey
->map
= fkey
->parent
;
8875 fkey
->map
= get_keymap (next
, 0, 1);
8877 /* If we no longer have a bound suffix, try a new position for
8879 if (!CONSP (fkey
->map
))
8881 fkey
->end
= ++fkey
->start
;
8882 fkey
->map
= fkey
->parent
;
8888 test_undefined (Lisp_Object binding
)
8890 return (EQ (binding
, Qundefined
)
8891 || (!NILP (binding
) && SYMBOLP (binding
)
8892 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8895 /* Read a sequence of keys that ends with a non prefix character,
8896 storing it in KEYBUF, a buffer of size BUFSIZE.
8898 Return the length of the key sequence stored.
8899 Return -1 if the user rejected a command menu.
8901 Echo starting immediately unless `prompt' is 0.
8903 Where a key sequence ends depends on the currently active keymaps.
8904 These include any minor mode keymaps active in the current buffer,
8905 the current buffer's local map, and the global map.
8907 If a key sequence has no other bindings, we check Vfunction_key_map
8908 to see if some trailing subsequence might be the beginning of a
8909 function key's sequence. If so, we try to read the whole function
8910 key, and substitute its symbolic name into the key sequence.
8912 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8913 `double-' events into similar click events, if that would make them
8914 bound. We try to turn `triple-' events first into `double-' events,
8917 If we get a mouse click in a mode line, vertical divider, or other
8918 non-text area, we treat the click as if it were prefixed by the
8919 symbol denoting that area - `mode-line', `vertical-line', or
8922 If the sequence starts with a mouse click, we read the key sequence
8923 with respect to the buffer clicked on, not the current buffer.
8925 If the user switches frames in the midst of a key sequence, we put
8926 off the switch-frame event until later; the next call to
8927 read_char will return it.
8929 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8930 from the selected window's buffer. */
8933 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8934 int dont_downcase_last
, int can_return_switch_frame
,
8935 int fix_current_buffer
)
8937 Lisp_Object from_string
;
8938 ptrdiff_t count
= SPECPDL_INDEX ();
8940 /* How many keys there are in the current key sequence. */
8943 /* The length of the echo buffer when we started reading, and
8944 the length of this_command_keys when we started reading. */
8945 ptrdiff_t echo_start
IF_LINT (= 0);
8946 ptrdiff_t keys_start
;
8948 /* The number of keymaps we're scanning right now, and the number of
8949 keymaps we have allocated space for. */
8951 ptrdiff_t nmaps_allocated
= 0;
8953 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8954 the current keymaps. */
8955 Lisp_Object
*defs
= NULL
;
8957 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8958 in the current keymaps, or nil where it is not a prefix. */
8959 Lisp_Object
*submaps
= NULL
;
8961 /* The local map to start out with at start of key sequence. */
8962 Lisp_Object orig_local_map
;
8964 /* The map from the `keymap' property to start out with at start of
8966 Lisp_Object orig_keymap
;
8968 /* 1 if we have already considered switching to the local-map property
8969 of the place where a mouse click occurred. */
8970 int localized_local_map
= 0;
8972 /* The index in submaps[] of the first keymap that has a binding for
8973 this key sequence. In other words, the lowest i such that
8974 submaps[i] is non-nil. */
8975 ptrdiff_t first_binding
;
8976 /* Index of the first key that has no binding.
8977 It is useless to try fkey.start larger than that. */
8980 /* If t < mock_input, then KEYBUF[t] should be read as the next
8983 We use this to recover after recognizing a function key. Once we
8984 realize that a suffix of the current key sequence is actually a
8985 function key's escape sequence, we replace the suffix with the
8986 function key's binding from Vfunction_key_map. Now keybuf
8987 contains a new and different key sequence, so the echo area,
8988 this_command_keys, and the submaps and defs arrays are wrong. In
8989 this situation, we set mock_input to t, set t to 0, and jump to
8990 restart_sequence; the loop will read keys from keybuf up until
8991 mock_input, thus rebuilding the state; and then it will resume
8992 reading characters from the keyboard. */
8995 /* If the sequence is unbound in submaps[], then
8996 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8997 and fkey.map is its binding.
8999 These might be > t, indicating that all function key scanning
9000 should hold off until t reaches them. We do this when we've just
9001 recognized a function key, to avoid searching for the function
9002 key's again in Vfunction_key_map. */
9005 /* Likewise, for key_translation_map and input-decode-map. */
9006 keyremap keytran
, indec
;
9008 /* Non-zero if we are trying to map a key by changing an upper-case
9009 letter to lower case, or a shifted function key to an unshifted
9011 int shift_translated
= 0;
9013 /* If we receive a `switch-frame' or `select-window' event in the middle of
9014 a key sequence, we put it off for later.
9015 While we're reading, we keep the event here. */
9016 Lisp_Object delayed_switch_frame
;
9018 /* See the comment below... */
9019 #if defined (GOBBLE_FIRST_EVENT)
9020 Lisp_Object first_event
;
9023 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9024 int original_uppercase_position
= -1;
9026 /* Gets around Microsoft compiler limitations. */
9029 struct buffer
*starting_buffer
;
9031 /* List of events for which a fake prefix key has been generated. */
9032 Lisp_Object fake_prefixed_keys
= Qnil
;
9034 #if defined (GOBBLE_FIRST_EVENT)
9038 struct gcpro gcpro1
;
9040 GCPRO1 (fake_prefixed_keys
);
9041 raw_keybuf_count
= 0;
9043 last_nonmenu_event
= Qnil
;
9045 delayed_switch_frame
= Qnil
;
9051 /* Install the string STR as the beginning of the string of
9052 echoing, so that it serves as a prompt for the next
9054 kset_echo_string (current_kboard
, prompt
);
9055 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9058 else if (cursor_in_echo_area
9059 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9060 && NILP (Fzerop (Vecho_keystrokes
)))
9061 /* This doesn't put in a dash if the echo buffer is empty, so
9062 you don't always see a dash hanging out in the minibuffer. */
9066 /* Record the initial state of the echo area and this_command_keys;
9067 we will need to restore them if we replay a key sequence. */
9069 echo_start
= echo_length ();
9070 keys_start
= this_command_key_count
;
9071 this_single_command_key_start
= keys_start
;
9073 #if defined (GOBBLE_FIRST_EVENT)
9074 /* This doesn't quite work, because some of the things that read_char
9075 does cannot safely be bypassed. It seems too risky to try to make
9078 /* Read the first char of the sequence specially, before setting
9079 up any keymaps, in case a filter runs and switches buffers on us. */
9080 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9082 #endif /* GOBBLE_FIRST_EVENT */
9084 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9085 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9088 /* We jump here when we need to reinitialize fkey and keytran; this
9089 happens if we switch keyboards between rescans. */
9090 replay_entire_sequence
:
9092 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9093 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9094 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9095 indec
.start
= indec
.end
= 0;
9096 fkey
.start
= fkey
.end
= 0;
9097 keytran
.start
= keytran
.end
= 0;
9099 /* We jump here when the key sequence has been thoroughly changed, and
9100 we need to rescan it starting from the beginning. When we jump here,
9101 keybuf[0..mock_input] holds the sequence we should reread. */
9104 starting_buffer
= current_buffer
;
9105 first_unbound
= bufsize
+ 1;
9107 /* Build our list of keymaps.
9108 If we recognize a function key and replace its escape sequence in
9109 keybuf with its symbol, or if the sequence starts with a mouse
9110 click and we need to switch buffers, we jump back here to rebuild
9111 the initial keymaps from the current buffer. */
9114 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9116 if (2 > nmaps_allocated
)
9118 submaps
= alloca (2 * sizeof *submaps
);
9119 defs
= alloca (2 * sizeof *defs
);
9120 nmaps_allocated
= 2;
9122 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9124 else if (!NILP (Voverriding_local_map
))
9126 if (2 > nmaps_allocated
)
9128 submaps
= alloca (2 * sizeof *submaps
);
9129 defs
= alloca (2 * sizeof *defs
);
9130 nmaps_allocated
= 2;
9132 submaps
[nmaps
++] = Voverriding_local_map
;
9140 nminor
= current_minor_maps (0, &maps
);
9141 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9143 if (total
> nmaps_allocated
)
9145 submaps
= alloca (total
* sizeof *submaps
);
9146 defs
= alloca (total
* sizeof *defs
);
9147 nmaps_allocated
= total
;
9150 if (!NILP (orig_keymap
))
9151 submaps
[nmaps
++] = orig_keymap
;
9153 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9157 submaps
[nmaps
++] = orig_local_map
;
9159 submaps
[nmaps
++] = current_global_map
;
9161 /* Find an accurate initial value for first_binding. */
9162 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9163 if (! NILP (submaps
[first_binding
]))
9166 /* Start from the beginning in keybuf. */
9169 /* These are no-ops the first time through, but if we restart, they
9170 revert the echo area and this_command_keys to their original state. */
9171 this_command_key_count
= keys_start
;
9172 if (INTERACTIVE
&& t
< mock_input
)
9173 echo_truncate (echo_start
);
9175 /* If the best binding for the current key sequence is a keymap, or
9176 we may be looking at a function key's escape sequence, keep on
9178 while (first_binding
< nmaps
9179 /* Keep reading as long as there's a prefix binding. */
9180 ? !NILP (submaps
[first_binding
])
9181 /* Don't return in the middle of a possible function key sequence,
9182 if the only bindings we found were via case conversion.
9183 Thus, if ESC O a has a function-key-map translation
9184 and ESC o has a binding, don't return after ESC O,
9185 so that we can translate ESC O plus the next character. */
9186 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9189 int used_mouse_menu
= 0;
9191 /* Where the last real key started. If we need to throw away a
9192 key that has expanded into more than one element of keybuf
9193 (say, a mouse click on the mode line which is being treated
9194 as [mode-line (mouse-...)], then we backtrack to this point
9196 int last_real_key_start
;
9198 /* These variables are analogous to echo_start and keys_start;
9199 while those allow us to restart the entire key sequence,
9200 echo_local_start and keys_local_start allow us to throw away
9202 ptrdiff_t echo_local_start
IF_LINT (= 0);
9203 int keys_local_start
;
9204 ptrdiff_t local_first_binding
;
9206 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9207 eassert (indec
.start
<= indec
.end
);
9208 eassert (fkey
.start
<= fkey
.end
);
9209 eassert (keytran
.start
<= keytran
.end
);
9210 /* key-translation-map is applied *after* function-key-map
9211 which is itself applied *after* input-decode-map. */
9212 eassert (fkey
.end
<= indec
.start
);
9213 eassert (keytran
.end
<= fkey
.start
);
9215 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9216 first_unbound
< keytran
.start
)
9217 { /* The prefix upto first_unbound has no binding and has
9218 no translation left to do either, so we know it's unbound.
9219 If we don't stop now, we risk staying here indefinitely
9220 (if the user keeps entering fkey or keytran prefixes
9221 like C-c ESC ESC ESC ESC ...) */
9223 for (i
= first_unbound
+ 1; i
< t
; i
++)
9224 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9225 mock_input
= t
- first_unbound
- 1;
9226 indec
.end
= indec
.start
-= first_unbound
+ 1;
9227 indec
.map
= indec
.parent
;
9228 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9229 fkey
.map
= fkey
.parent
;
9230 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9231 keytran
.map
= keytran
.parent
;
9232 goto replay_sequence
;
9236 error ("Key sequence too long");
9239 echo_local_start
= echo_length ();
9240 keys_local_start
= this_command_key_count
;
9241 local_first_binding
= first_binding
;
9244 /* These are no-ops, unless we throw away a keystroke below and
9245 jumped back up to replay_key; in that case, these restore the
9246 variables to their original state, allowing us to replay the
9248 if (INTERACTIVE
&& t
< mock_input
)
9249 echo_truncate (echo_local_start
);
9250 this_command_key_count
= keys_local_start
;
9251 first_binding
= local_first_binding
;
9253 /* By default, assume each event is "real". */
9254 last_real_key_start
= t
;
9256 /* Does mock_input indicate that we are re-reading a key sequence? */
9260 add_command_key (key
);
9261 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9262 && NILP (Fzerop (Vecho_keystrokes
)))
9266 /* If not, we should actually read a character. */
9270 KBOARD
*interrupted_kboard
= current_kboard
;
9271 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9272 key
= read_char (NILP (prompt
), nmaps
,
9273 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9274 &used_mouse_menu
, NULL
);
9275 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9276 /* When switching to a new tty (with a new keyboard),
9277 read_char returns the new buffer, rather than -2
9278 (Bug#5095). This is because `terminal-init-xterm'
9279 calls read-char, which eats the wrong_kboard_jmpbuf
9280 return. Any better way to fix this? -- cyd */
9281 || (interrupted_kboard
!= current_kboard
))
9286 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9287 if (k
== interrupted_kboard
)
9292 /* Don't touch interrupted_kboard when it's been
9294 delayed_switch_frame
= Qnil
;
9295 goto replay_entire_sequence
;
9298 if (!NILP (delayed_switch_frame
))
9301 (interrupted_kboard
,
9302 Fcons (delayed_switch_frame
,
9303 KVAR (interrupted_kboard
, kbd_queue
)));
9304 delayed_switch_frame
= Qnil
;
9309 (interrupted_kboard
,
9310 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9312 /* If the side queue is non-empty, ensure it begins with a
9313 switch-frame, so we'll replay it in the right context. */
9314 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9315 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9316 !(EVENT_HAS_PARAMETERS (key
)
9317 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9321 XSETFRAME (frame
, interrupted_frame
);
9323 (interrupted_kboard
,
9324 Fcons (make_lispy_switch_frame (frame
),
9325 KVAR (interrupted_kboard
, kbd_queue
)));
9328 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9329 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9330 goto replay_entire_sequence
;
9334 /* read_char returns t when it shows a menu and the user rejects it.
9338 unbind_to (count
, Qnil
);
9343 /* read_char returns -1 at the end of a macro.
9344 Emacs 18 handles this by returning immediately with a
9345 zero, so that's what we'll do. */
9346 if (INTEGERP (key
) && XINT (key
) == -1)
9349 /* The Microsoft C compiler can't handle the goto that
9355 /* If the current buffer has been changed from under us, the
9356 keymap may have changed, so replay the sequence. */
9359 timer_resume_idle ();
9362 /* Reset the current buffer from the selected window
9363 in case something changed the former and not the latter.
9364 This is to be more consistent with the behavior
9365 of the command_loop_1. */
9366 if (fix_current_buffer
)
9368 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9370 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9371 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9374 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9375 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9376 goto replay_sequence
;
9379 /* If we have a quit that was typed in another frame, and
9380 quit_throw_to_read_char switched buffers,
9381 replay to get the right keymap. */
9383 && XINT (key
) == quit_char
9384 && current_buffer
!= starting_buffer
)
9387 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9392 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9393 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9394 goto replay_sequence
;
9399 if (EVENT_HAS_PARAMETERS (key
)
9400 /* Either a `switch-frame' or a `select-window' event. */
9401 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9403 /* If we're at the beginning of a key sequence, and the caller
9404 says it's okay, go ahead and return this event. If we're
9405 in the midst of a key sequence, delay it until the end. */
9406 if (t
> 0 || !can_return_switch_frame
)
9408 delayed_switch_frame
= key
;
9414 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9418 /* Clicks in non-text areas get prefixed by the symbol
9419 in their CHAR-ADDRESS field. For example, a click on
9420 the mode line is prefixed by the symbol `mode-line'.
9422 Furthermore, key sequences beginning with mouse clicks
9423 are read using the keymaps of the buffer clicked on, not
9424 the current buffer. So we may have to switch the buffer
9427 When we turn one event into two events, we must make sure
9428 that neither of the two looks like the original--so that,
9429 if we replay the events, they won't be expanded again.
9430 If not for this, such reexpansion could happen either here
9431 or when user programs play with this-command-keys. */
9432 if (EVENT_HAS_PARAMETERS (key
))
9437 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9438 if (EQ (kind
, Qmouse_click
))
9440 Lisp_Object window
, posn
;
9442 window
= POSN_WINDOW (EVENT_START (key
));
9443 posn
= POSN_POSN (EVENT_START (key
));
9446 || (!NILP (fake_prefixed_keys
)
9447 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9449 /* We're looking a second time at an event for which
9450 we generated a fake prefix key. Set
9451 last_real_key_start appropriately. */
9453 last_real_key_start
= t
- 1;
9456 if (last_real_key_start
== 0)
9458 /* Key sequences beginning with mouse clicks are
9459 read using the keymaps in the buffer clicked on,
9460 not the current buffer. If we're at the
9461 beginning of a key sequence, switch buffers. */
9462 if (WINDOWP (window
)
9463 && BUFFERP (XWINDOW (window
)->buffer
)
9464 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9466 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9471 /* Arrange to go back to the original buffer once we're
9472 done reading the key sequence. Note that we can't
9473 use save_excursion_{save,restore} here, because they
9474 save point as well as the current buffer; we don't
9475 want to save point, because redisplay may change it,
9476 to accommodate a Fset_window_start or something. We
9477 don't want to do this at the top of the function,
9478 because we may get input from a subprocess which
9479 wants to change the selected window and stuff (say,
9481 record_unwind_current_buffer ();
9483 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9485 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9486 orig_local_map
= get_local_map (PT
, current_buffer
,
9488 orig_keymap
= get_local_map (PT
, current_buffer
,
9490 goto replay_sequence
;
9493 /* For a mouse click, get the local text-property keymap
9494 of the place clicked on, rather than point. */
9495 if (CONSP (XCDR (key
))
9496 && ! localized_local_map
)
9498 Lisp_Object map_here
, start
, pos
;
9500 localized_local_map
= 1;
9501 start
= EVENT_START (key
);
9503 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9505 pos
= POSN_BUFFER_POSN (start
);
9507 && XINT (pos
) >= BEGV
9508 && XINT (pos
) <= ZV
)
9510 map_here
= get_local_map (XINT (pos
),
9513 if (!EQ (map_here
, orig_local_map
))
9515 orig_local_map
= map_here
;
9516 ++localized_local_map
;
9519 map_here
= get_local_map (XINT (pos
),
9522 if (!EQ (map_here
, orig_keymap
))
9524 orig_keymap
= map_here
;
9525 ++localized_local_map
;
9528 if (localized_local_map
> 1)
9533 goto replay_sequence
;
9540 /* Expand mode-line and scroll-bar events into two events:
9541 use posn as a fake prefix key. */
9543 && (NILP (fake_prefixed_keys
)
9544 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9546 if (bufsize
- t
<= 1)
9547 error ("Key sequence too long");
9550 keybuf
[t
+ 1] = key
;
9553 /* Record that a fake prefix key has been generated
9554 for KEY. Don't modify the event; this would
9555 prevent proper action when the event is pushed
9556 back into unread-command-events. */
9557 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9559 /* If on a mode line string with a local keymap,
9560 reconsider the key sequence with that keymap. */
9561 if (string
= POSN_STRING (EVENT_START (key
)),
9562 (CONSP (string
) && STRINGP (XCAR (string
))))
9564 Lisp_Object pos
, map
, map2
;
9566 pos
= XCDR (string
);
9567 string
= XCAR (string
);
9569 && XINT (pos
) < SCHARS (string
))
9571 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9573 orig_local_map
= map
;
9574 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9577 if (!NILP (map
) || !NILP (map2
))
9578 goto replay_sequence
;
9584 else if (NILP (from_string
)
9585 && (string
= POSN_STRING (EVENT_START (key
)),
9586 (CONSP (string
) && STRINGP (XCAR (string
)))))
9588 /* For a click on a string, i.e. overlay string or a
9589 string displayed via the `display' property,
9590 consider `local-map' and `keymap' properties of
9592 Lisp_Object pos
, map
, map2
;
9594 pos
= XCDR (string
);
9595 string
= XCAR (string
);
9597 && XINT (pos
) < SCHARS (string
))
9599 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9601 orig_local_map
= map
;
9602 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9606 if (!NILP (map
) || !NILP (map2
))
9608 from_string
= string
;
9611 goto replay_sequence
;
9616 else if (CONSP (XCDR (key
))
9617 && CONSP (EVENT_START (key
))
9618 && CONSP (XCDR (EVENT_START (key
))))
9622 posn
= POSN_POSN (EVENT_START (key
));
9623 /* Handle menu-bar events:
9624 insert the dummy prefix event `menu-bar'. */
9625 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9627 if (bufsize
- t
<= 1)
9628 error ("Key sequence too long");
9632 /* Zap the position in key, so we know that we've
9633 expanded it, and don't try to do so again. */
9634 POSN_SET_POSN (EVENT_START (key
),
9635 Fcons (posn
, Qnil
));
9638 goto replay_sequence
;
9640 else if (CONSP (posn
))
9642 /* We're looking at the second event of a
9643 sequence which we expanded before. Set
9644 last_real_key_start appropriately. */
9645 if (last_real_key_start
== t
&& t
> 0)
9646 last_real_key_start
= t
- 1;
9651 /* We have finally decided that KEY is something we might want
9653 first_binding
= (follow_key (key
,
9654 nmaps
- first_binding
,
9655 submaps
+ first_binding
,
9656 defs
+ first_binding
,
9657 submaps
+ first_binding
)
9660 /* If KEY wasn't bound, we'll try some fallbacks. */
9661 if (first_binding
< nmaps
)
9662 /* This is needed for the following scenario:
9663 event 0: a down-event that gets dropped by calling replay_key.
9664 event 1: some normal prefix like C-h.
9665 After event 0, first_unbound is 0, after event 1 indec.start,
9666 fkey.start, and keytran.start are all 1, so when we see that
9667 C-h is bound, we need to update first_unbound. */
9668 first_unbound
= max (t
+ 1, first_unbound
);
9673 /* Remember the position to put an upper bound on indec.start. */
9674 first_unbound
= min (t
, first_unbound
);
9676 head
= EVENT_HEAD (key
);
9677 if (help_char_p (head
) && t
> 0)
9679 read_key_sequence_cmd
= Vprefix_help_command
;
9681 last_nonmenu_event
= key
;
9682 /* The Microsoft C compiler can't handle the goto that
9690 Lisp_Object breakdown
;
9693 breakdown
= parse_modifiers (head
);
9694 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9695 /* Attempt to reduce an unbound mouse event to a simpler
9696 event that is bound:
9697 Drags reduce to clicks.
9698 Double-clicks reduce to clicks.
9699 Triple-clicks reduce to double-clicks, then to clicks.
9700 Down-clicks are eliminated.
9701 Double-downs reduce to downs, then are eliminated.
9702 Triple-downs reduce to double-downs, then to downs,
9703 then are eliminated. */
9704 if (modifiers
& (down_modifier
| drag_modifier
9705 | double_modifier
| triple_modifier
))
9707 while (modifiers
& (down_modifier
| drag_modifier
9708 | double_modifier
| triple_modifier
))
9710 Lisp_Object new_head
, new_click
;
9711 if (modifiers
& triple_modifier
)
9712 modifiers
^= (double_modifier
| triple_modifier
);
9713 else if (modifiers
& double_modifier
)
9714 modifiers
&= ~double_modifier
;
9715 else if (modifiers
& drag_modifier
)
9716 modifiers
&= ~drag_modifier
;
9719 /* Dispose of this `down' event by simply jumping
9720 back to replay_key, to get another event.
9722 Note that if this event came from mock input,
9723 then just jumping back to replay_key will just
9724 hand it to us again. So we have to wipe out any
9727 We could delete keybuf[t] and shift everything
9728 after that to the left by one spot, but we'd also
9729 have to fix up any variable that points into
9730 keybuf, and shifting isn't really necessary
9733 Adding prefixes for non-textual mouse clicks
9734 creates two characters of mock input, and both
9735 must be thrown away. If we're only looking at
9736 the prefix now, we can just jump back to
9737 replay_key. On the other hand, if we've already
9738 processed the prefix, and now the actual click
9739 itself is giving us trouble, then we've lost the
9740 state of the keymaps we want to backtrack to, and
9741 we need to replay the whole sequence to rebuild
9744 Beyond that, only function key expansion could
9745 create more than two keys, but that should never
9746 generate mouse events, so it's okay to zero
9747 mock_input in that case too.
9749 FIXME: The above paragraph seems just plain
9750 wrong, if you consider things like
9751 xterm-mouse-mode. -stef
9753 Isn't this just the most wonderful code ever? */
9755 /* If mock_input > t + 1, the above simplification
9756 will actually end up dropping keys on the floor.
9757 This is probably OK for now, but even
9758 if mock_input <= t + 1, we need to adjust indec,
9760 Typical case [header-line down-mouse-N]:
9761 mock_input = 2, t = 1, fkey.end = 1,
9762 last_real_key_start = 0. */
9763 if (indec
.end
> last_real_key_start
)
9765 indec
.end
= indec
.start
9766 = min (last_real_key_start
, indec
.start
);
9767 indec
.map
= indec
.parent
;
9768 if (fkey
.end
> last_real_key_start
)
9770 fkey
.end
= fkey
.start
9771 = min (last_real_key_start
, fkey
.start
);
9772 fkey
.map
= fkey
.parent
;
9773 if (keytran
.end
> last_real_key_start
)
9775 keytran
.end
= keytran
.start
9776 = min (last_real_key_start
, keytran
.start
);
9777 keytran
.map
= keytran
.parent
;
9781 if (t
== last_real_key_start
)
9788 mock_input
= last_real_key_start
;
9789 goto replay_sequence
;
9794 = apply_modifiers (modifiers
, XCAR (breakdown
));
9796 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9798 /* Look for a binding for this new key. follow_key
9799 promises that it didn't munge submaps the
9800 last time we called it, since key was unbound. */
9802 = (follow_key (new_click
,
9803 nmaps
- local_first_binding
,
9804 submaps
+ local_first_binding
,
9805 defs
+ local_first_binding
,
9806 submaps
+ local_first_binding
)
9807 + local_first_binding
);
9809 /* If that click is bound, go for it. */
9810 if (first_binding
< nmaps
)
9815 /* Otherwise, we'll leave key set to the drag event. */
9822 /* Normally, last_nonmenu_event gets the previous key we read.
9823 But when a mouse popup menu is being used,
9824 we don't update last_nonmenu_event; it continues to hold the mouse
9825 event that preceded the first level of menu. */
9826 if (!used_mouse_menu
)
9827 last_nonmenu_event
= key
;
9829 /* Record what part of this_command_keys is the current key sequence. */
9830 this_single_command_key_start
= this_command_key_count
- t
;
9832 /* Look for this sequence in input-decode-map.
9833 Scan from indec.end until we find a bound suffix. */
9834 while (indec
.end
< t
)
9836 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9839 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9840 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9845 mock_input
= diff
+ max (t
, mock_input
);
9846 goto replay_sequence
;
9850 if (first_binding
< nmaps
9851 && NILP (submaps
[first_binding
])
9852 && !test_undefined (defs
[first_binding
])
9853 && indec
.start
>= t
)
9854 /* There is a binding and it's not a prefix.
9855 (and it doesn't have any input-decode-map translation pending).
9856 There is thus no function-key in this sequence.
9857 Moving fkey.start is important in this case to allow keytran.start
9858 to go over the sequence before we return (since we keep the
9859 invariant that keytran.end <= fkey.start). */
9862 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9865 /* If the sequence is unbound, see if we can hang a function key
9866 off the end of it. */
9867 /* Continue scan from fkey.end until we find a bound suffix. */
9868 while (fkey
.end
< indec
.start
)
9870 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9873 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9874 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9875 max (t
, mock_input
),
9876 /* If there's a binding (i.e.
9877 first_binding >= nmaps) we don't want
9878 to apply this function-key-mapping. */
9880 && (first_binding
>= nmaps
9881 || test_undefined (defs
[first_binding
])),
9886 mock_input
= diff
+ max (t
, mock_input
);
9887 /* Adjust the input-decode-map counters. */
9889 indec
.start
+= diff
;
9891 goto replay_sequence
;
9895 /* Look for this sequence in key-translation-map.
9896 Scan from keytran.end until we find a bound suffix. */
9897 while (keytran
.end
< fkey
.start
)
9899 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9902 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9903 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9908 mock_input
= diff
+ max (t
, mock_input
);
9909 /* Adjust the function-key-map and input-decode-map counters. */
9911 indec
.start
+= diff
;
9915 goto replay_sequence
;
9919 /* If KEY is not defined in any of the keymaps,
9920 and cannot be part of a function key or translation,
9921 and is an upper case letter
9922 use the corresponding lower-case letter instead. */
9923 if (first_binding
>= nmaps
9924 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9926 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9927 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9928 || (XINT (key
) & shift_modifier
)))
9930 Lisp_Object new_key
;
9932 original_uppercase
= key
;
9933 original_uppercase_position
= t
- 1;
9935 if (XINT (key
) & shift_modifier
)
9936 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9938 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9939 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9941 /* We have to do this unconditionally, regardless of whether
9942 the lower-case char is defined in the keymaps, because they
9943 might get translated through function-key-map. */
9944 keybuf
[t
- 1] = new_key
;
9945 mock_input
= max (t
, mock_input
);
9946 shift_translated
= 1;
9948 goto replay_sequence
;
9950 /* If KEY is not defined in any of the keymaps,
9951 and cannot be part of a function key or translation,
9952 and is a shifted function key,
9953 use the corresponding unshifted function key instead. */
9954 if (first_binding
>= nmaps
9955 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9957 Lisp_Object breakdown
= parse_modifiers (key
);
9959 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9961 if (modifiers
& shift_modifier
9962 /* Treat uppercase keys as shifted. */
9964 && (KEY_TO_CHAR (key
)
9965 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9966 && uppercasep (KEY_TO_CHAR (key
))))
9969 = (modifiers
& shift_modifier
9970 ? apply_modifiers (modifiers
& ~shift_modifier
,
9972 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9974 original_uppercase
= key
;
9975 original_uppercase_position
= t
- 1;
9977 /* We have to do this unconditionally, regardless of whether
9978 the lower-case char is defined in the keymaps, because they
9979 might get translated through function-key-map. */
9980 keybuf
[t
- 1] = new_key
;
9981 mock_input
= max (t
, mock_input
);
9982 /* Reset fkey (and consequently keytran) to apply
9983 function-key-map on the result, so that S-backspace is
9984 correctly mapped to DEL (via backspace). OTOH,
9985 input-decode-map doesn't need to go through it again. */
9986 fkey
.start
= fkey
.end
= 0;
9987 keytran
.start
= keytran
.end
= 0;
9988 shift_translated
= 1;
9990 goto replay_sequence
;
9995 read_key_sequence_cmd
= (first_binding
< nmaps
9996 ? defs
[first_binding
]
9998 read_key_sequence_remapped
9999 /* Remap command through active keymaps.
10000 Do the remapping here, before the unbind_to so it uses the keymaps
10001 of the appropriate buffer. */
10002 = SYMBOLP (read_key_sequence_cmd
)
10003 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10006 unread_switch_frame
= delayed_switch_frame
;
10007 unbind_to (count
, Qnil
);
10009 /* Don't downcase the last character if the caller says don't.
10010 Don't downcase it if the result is undefined, either. */
10011 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10013 && t
- 1 == original_uppercase_position
)
10015 keybuf
[t
- 1] = original_uppercase
;
10016 shift_translated
= 0;
10019 if (shift_translated
)
10020 Vthis_command_keys_shift_translated
= Qt
;
10022 /* Occasionally we fabricate events, perhaps by expanding something
10023 according to function-key-map, or by adding a prefix symbol to a
10024 mouse click in the scroll bar or modeline. In this cases, return
10025 the entire generated key sequence, even if we hit an unbound
10026 prefix or a definition before the end. This means that you will
10027 be able to push back the event properly, and also means that
10028 read-key-sequence will always return a logical unit.
10031 for (; t
< mock_input
; t
++)
10033 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10034 && NILP (Fzerop (Vecho_keystrokes
)))
10035 echo_char (keybuf
[t
]);
10036 add_command_key (keybuf
[t
]);
10043 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10044 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10045 The sequence is sufficient to specify a non-prefix command in the
10046 current local and global maps.
10048 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10049 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10050 as a continuation of the previous key.
10052 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10053 convert the last event to lower case. (Normally any upper case event
10054 is converted to lower case if the original event is undefined and the lower
10055 case equivalent is defined.) A non-nil value is appropriate for reading
10056 a key sequence to be defined.
10058 A C-g typed while in this function is treated like any other character,
10059 and `quit-flag' is not set.
10061 If the key sequence starts with a mouse click, then the sequence is read
10062 using the keymaps of the buffer of the window clicked in, not the buffer
10063 of the selected window as normal.
10065 `read-key-sequence' drops unbound button-down events, since you normally
10066 only care about the click or drag events which follow them. If a drag
10067 or multi-click event is unbound, but the corresponding click event would
10068 be bound, `read-key-sequence' turns the event into a click event at the
10069 drag's starting position. This means that you don't have to distinguish
10070 between click and drag, double, or triple events unless you want to.
10072 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10073 lines separating windows, and scroll bars with imaginary keys
10074 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10076 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10077 function will process a switch-frame event if the user switches frames
10078 before typing anything. If the user switches frames in the middle of a
10079 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10080 is nil, then the event will be put off until after the current key sequence.
10082 `read-key-sequence' checks `function-key-map' for function key
10083 sequences, where they wouldn't conflict with ordinary bindings. See
10084 `function-key-map' for more details.
10086 The optional fifth argument CMD-LOOP, if non-nil, means
10087 that this key sequence is being read by something that will
10088 read commands one after another. It should be nil if the caller
10089 will read just one key sequence. */)
10090 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10092 Lisp_Object keybuf
[30];
10094 struct gcpro gcpro1
;
10095 ptrdiff_t count
= SPECPDL_INDEX ();
10097 if (!NILP (prompt
))
10098 CHECK_STRING (prompt
);
10101 specbind (Qinput_method_exit_on_first_char
,
10102 (NILP (cmd_loop
) ? Qt
: Qnil
));
10103 specbind (Qinput_method_use_echo_area
,
10104 (NILP (cmd_loop
) ? Qt
: Qnil
));
10106 memset (keybuf
, 0, sizeof keybuf
);
10107 GCPRO1 (keybuf
[0]);
10108 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10110 if (NILP (continue_echo
))
10112 this_command_key_count
= 0;
10113 this_command_key_count_reset
= 0;
10114 this_single_command_key_start
= 0;
10117 #ifdef HAVE_WINDOW_SYSTEM
10118 if (display_hourglass_p
)
10119 cancel_hourglass ();
10122 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10123 prompt
, ! NILP (dont_downcase_last
),
10124 ! NILP (can_return_switch_frame
), 0);
10126 #if 0 /* The following is fine for code reading a key sequence and
10127 then proceeding with a lengthy computation, but it's not good
10128 for code reading keys in a loop, like an input method. */
10129 #ifdef HAVE_WINDOW_SYSTEM
10130 if (display_hourglass_p
)
10131 start_hourglass ();
10141 return unbind_to (count
, make_event_array (i
, keybuf
));
10144 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10145 Sread_key_sequence_vector
, 1, 5, 0,
10146 doc
: /* Like `read-key-sequence' but always return a vector. */)
10147 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10149 Lisp_Object keybuf
[30];
10151 struct gcpro gcpro1
;
10152 ptrdiff_t count
= SPECPDL_INDEX ();
10154 if (!NILP (prompt
))
10155 CHECK_STRING (prompt
);
10158 specbind (Qinput_method_exit_on_first_char
,
10159 (NILP (cmd_loop
) ? Qt
: Qnil
));
10160 specbind (Qinput_method_use_echo_area
,
10161 (NILP (cmd_loop
) ? Qt
: Qnil
));
10163 memset (keybuf
, 0, sizeof keybuf
);
10164 GCPRO1 (keybuf
[0]);
10165 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10167 if (NILP (continue_echo
))
10169 this_command_key_count
= 0;
10170 this_command_key_count_reset
= 0;
10171 this_single_command_key_start
= 0;
10174 #ifdef HAVE_WINDOW_SYSTEM
10175 if (display_hourglass_p
)
10176 cancel_hourglass ();
10179 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10180 prompt
, ! NILP (dont_downcase_last
),
10181 ! NILP (can_return_switch_frame
), 0);
10183 #ifdef HAVE_WINDOW_SYSTEM
10184 if (display_hourglass_p
)
10185 start_hourglass ();
10194 return unbind_to (count
, Fvector (i
, keybuf
));
10197 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10198 doc
: /* Execute CMD as an editor command.
10199 CMD must be a symbol that satisfies the `commandp' predicate.
10200 Optional second arg RECORD-FLAG non-nil
10201 means unconditionally put this command in `command-history'.
10202 Otherwise, that is done only if an arg is read using the minibuffer.
10203 The argument KEYS specifies the value to use instead of (this-command-keys)
10204 when reading the arguments; if it is nil, (this-command-keys) is used.
10205 The argument SPECIAL, if non-nil, means that this command is executing
10206 a special event, so ignore the prefix argument and don't clear it. */)
10207 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10209 register Lisp_Object final
;
10210 register Lisp_Object tem
;
10211 Lisp_Object prefixarg
;
10213 debug_on_next_call
= 0;
10215 if (NILP (special
))
10217 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10218 Vcurrent_prefix_arg
= prefixarg
;
10219 kset_prefix_arg (current_kboard
, Qnil
);
10226 tem
= Fget (cmd
, Qdisabled
);
10229 tem
= Fsymbol_value (Qdisabled_command_function
);
10231 return Frun_hooks (1, &Qdisabled_command_function
);
10237 final
= Findirect_function (cmd
, Qnil
);
10239 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10241 struct gcpro gcpro1
, gcpro2
;
10243 GCPRO2 (cmd
, prefixarg
);
10244 Fautoload_do_load (final
, cmd
, Qnil
);
10251 if (STRINGP (final
) || VECTORP (final
))
10253 /* If requested, place the macro in the command history. For
10254 other sorts of commands, call-interactively takes care of
10256 if (!NILP (record_flag
))
10259 = Fcons (Fcons (Qexecute_kbd_macro
,
10260 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10263 /* Don't keep command history around forever. */
10264 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10266 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10268 XSETCDR (tem
, Qnil
);
10272 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10275 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10276 /* Don't call Fcall_interactively directly because we want to make
10277 sure the backtrace has an entry for `call-interactively'.
10278 For the same reason, pass `cmd' rather than `final'. */
10279 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10286 /* Return nonzero if input events are pending. */
10289 detect_input_pending (void)
10291 if (!input_pending
)
10292 get_input_pending (&input_pending
, 0);
10294 return input_pending
;
10297 /* Return nonzero if input events other than mouse movements are
10301 detect_input_pending_ignore_squeezables (void)
10303 if (!input_pending
)
10304 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10306 return input_pending
;
10309 /* Return nonzero if input events are pending, and run any pending timers. */
10312 detect_input_pending_run_timers (int do_display
)
10314 int old_timers_run
= timers_run
;
10316 if (!input_pending
)
10317 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10319 if (old_timers_run
!= timers_run
&& do_display
)
10321 redisplay_preserve_echo_area (8);
10322 /* The following fixes a bug when using lazy-lock with
10323 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10324 from an idle timer function. The symptom of the bug is that
10325 the cursor sometimes doesn't become visible until the next X
10326 event is processed. --gerd. */
10328 Lisp_Object tail
, frame
;
10329 FOR_EACH_FRAME (tail
, frame
)
10330 if (FRAME_RIF (XFRAME (frame
)))
10331 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10335 return input_pending
;
10338 /* This is called in some cases before a possible quit.
10339 It cases the next call to detect_input_pending to recompute input_pending.
10340 So calling this function unnecessarily can't do any harm. */
10343 clear_input_pending (void)
10348 /* Return nonzero if there are pending requeued events.
10349 This isn't used yet. The hope is to make wait_reading_process_output
10350 call it, and return if it runs Lisp code that unreads something.
10351 The problem is, kbd_buffer_get_event needs to be fixed to know what
10352 to do in that case. It isn't trivial. */
10355 requeued_events_pending_p (void)
10357 return (!NILP (Vunread_command_events
));
10361 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10362 doc
: /* Return t if command input is currently available with no wait.
10363 Actually, the value is nil only if we can be sure that no input is available;
10364 if there is a doubt, the value is t. */)
10367 if (!NILP (Vunread_command_events
)
10368 || !NILP (Vunread_post_input_method_events
)
10369 || !NILP (Vunread_input_method_events
))
10372 /* Process non-user-visible events (Bug#10195). */
10373 process_special_events ();
10375 get_input_pending (&input_pending
,
10376 READABLE_EVENTS_DO_TIMERS_NOW
10377 | READABLE_EVENTS_FILTER_EVENTS
);
10378 return input_pending
> 0 ? Qt
: Qnil
;
10381 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10382 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10385 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10388 if (total_keys
< NUM_RECENT_KEYS
)
10389 return Fvector (total_keys
, keys
);
10392 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10393 vcopy (val
, 0, keys
+ recent_keys_index
,
10394 NUM_RECENT_KEYS
- recent_keys_index
);
10395 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10396 keys
, recent_keys_index
);
10401 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10402 doc
: /* Return the key sequence that invoked this command.
10403 However, if the command has called `read-key-sequence', it returns
10404 the last key sequence that has been read.
10405 The value is a string or a vector.
10407 See also `this-command-keys-vector'. */)
10410 return make_event_array (this_command_key_count
,
10411 XVECTOR (this_command_keys
)->contents
);
10414 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10415 doc
: /* Return the key sequence that invoked this command, as a vector.
10416 However, if the command has called `read-key-sequence', it returns
10417 the last key sequence that has been read.
10419 See also `this-command-keys'. */)
10422 return Fvector (this_command_key_count
,
10423 XVECTOR (this_command_keys
)->contents
);
10426 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10427 Sthis_single_command_keys
, 0, 0, 0,
10428 doc
: /* Return the key sequence that invoked this command.
10429 More generally, it returns the last key sequence read, either by
10430 the command loop or by `read-key-sequence'.
10431 Unlike `this-command-keys', this function's value
10432 does not include prefix arguments.
10433 The value is always a vector. */)
10436 return Fvector (this_command_key_count
10437 - this_single_command_key_start
,
10438 (XVECTOR (this_command_keys
)->contents
10439 + this_single_command_key_start
));
10442 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10443 Sthis_single_command_raw_keys
, 0, 0, 0,
10444 doc
: /* Return the raw events that were read for this command.
10445 More generally, it returns the last key sequence read, either by
10446 the command loop or by `read-key-sequence'.
10447 Unlike `this-single-command-keys', this function's value
10448 shows the events before all translations (except for input methods).
10449 The value is always a vector. */)
10452 return Fvector (raw_keybuf_count
,
10453 (XVECTOR (raw_keybuf
)->contents
));
10456 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10457 Sreset_this_command_lengths
, 0, 0, 0,
10458 doc
: /* Make the unread events replace the last command and echo.
10459 Used in `universal-argument-other-key'.
10461 `universal-argument-other-key' rereads the event just typed.
10462 It then gets translated through `function-key-map'.
10463 The translated event has to replace the real events,
10464 both in the value of (this-command-keys) and in echoing.
10465 To achieve this, `universal-argument-other-key' calls
10466 `reset-this-command-lengths', which discards the record of reading
10467 these events the first time. */)
10470 this_command_key_count
= before_command_key_count
;
10471 if (this_command_key_count
< this_single_command_key_start
)
10472 this_single_command_key_start
= this_command_key_count
;
10474 echo_truncate (before_command_echo_length
);
10476 /* Cause whatever we put into unread-command-events
10477 to echo as if it were being freshly read from the keyboard. */
10478 this_command_key_count_reset
= 1;
10483 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10484 Sclear_this_command_keys
, 0, 1, 0,
10485 doc
: /* Clear out the vector that `this-command-keys' returns.
10486 Also clear the record of the last 100 events, unless optional arg
10487 KEEP-RECORD is non-nil. */)
10488 (Lisp_Object keep_record
)
10492 this_command_key_count
= 0;
10493 this_command_key_count_reset
= 0;
10495 if (NILP (keep_record
))
10497 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10498 ASET (recent_keys
, i
, Qnil
);
10500 recent_keys_index
= 0;
10505 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10506 doc
: /* Return the current depth in recursive edits. */)
10510 /* Wrap around reliably on integer overflow. */
10511 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10512 XSETINT (temp
, sum
);
10516 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10517 "FOpen dribble file: ",
10518 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10519 If FILE is nil, close any open dribble file.
10520 The file will be closed when Emacs exits. */)
10532 file
= Fexpand_file_name (file
, Qnil
);
10533 dribble
= fopen (SSDATA (file
), "w");
10535 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10540 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10541 doc
: /* Discard the contents of the terminal input buffer.
10542 Also end any kbd macro being defined. */)
10545 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10547 /* Discard the last command from the macro. */
10548 Fcancel_kbd_macro_events ();
10552 update_mode_lines
++;
10554 Vunread_command_events
= Qnil
;
10556 discard_tty_input ();
10558 kbd_fetch_ptr
= kbd_store_ptr
;
10564 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10565 doc
: /* Stop Emacs and return to superior process. You can resume later.
10566 If `cannot-suspend' is non-nil, or if the system doesn't support job
10567 control, run a subshell instead.
10569 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10570 to be read as terminal input by Emacs's parent, after suspension.
10572 Before suspending, run the normal hook `suspend-hook'.
10573 After resumption run the normal hook `suspend-resume-hook'.
10575 Some operating systems cannot stop the Emacs process and resume it later.
10576 On such systems, Emacs starts a subshell instead of suspending. */)
10577 (Lisp_Object stuffstring
)
10579 ptrdiff_t count
= SPECPDL_INDEX ();
10580 int old_height
, old_width
;
10582 struct gcpro gcpro1
;
10585 if (tty_list
&& tty_list
->next
)
10586 error ("There are other tty frames open; close them before suspending Emacs");
10588 if (!NILP (stuffstring
))
10589 CHECK_STRING (stuffstring
);
10591 /* Run the functions in suspend-hook. */
10592 hook
= intern ("suspend-hook");
10593 Frun_hooks (1, &hook
);
10595 GCPRO1 (stuffstring
);
10596 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10597 reset_all_sys_modes ();
10598 /* sys_suspend can get an error if it tries to fork a subshell
10599 and the system resources aren't available for that. */
10600 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10602 stuff_buffered_input (stuffstring
);
10603 if (cannot_suspend
)
10607 unbind_to (count
, Qnil
);
10609 /* Check if terminal/window size has changed.
10610 Note that this is not useful when we are running directly
10611 with a window system; but suspend should be disabled in that case. */
10612 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10613 if (width
!= old_width
|| height
!= old_height
)
10614 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10616 /* Run suspend-resume-hook. */
10617 hook
= intern ("suspend-resume-hook");
10618 Frun_hooks (1, &hook
);
10624 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10625 Then in any case stuff anything Emacs has read ahead and not used. */
10628 stuff_buffered_input (Lisp_Object stuffstring
)
10630 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10631 register unsigned char *p
;
10633 if (STRINGP (stuffstring
))
10635 register ptrdiff_t count
;
10637 p
= SDATA (stuffstring
);
10638 count
= SBYTES (stuffstring
);
10639 while (count
-- > 0)
10644 /* Anything we have read ahead, put back for the shell to read. */
10645 /* ?? What should this do when we have multiple keyboards??
10646 Should we ignore anything that was typed in at the "wrong" kboard?
10648 rms: we should stuff everything back into the kboard
10650 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10653 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10654 kbd_fetch_ptr
= kbd_buffer
;
10655 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10656 stuff_char (kbd_fetch_ptr
->code
);
10658 clear_event (kbd_fetch_ptr
);
10662 #endif /* SIGTSTP */
10666 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10668 input_available_clear_time
= time_to_clear
;
10670 /* Tell handle_interrupt to throw back to read_char, */
10671 waiting_for_input
= 1;
10673 /* If handle_interrupt was called before and buffered a C-g,
10674 make it run again now, to avoid timing error. */
10675 if (!NILP (Vquit_flag
))
10676 quit_throw_to_read_char (0);
10680 clear_waiting_for_input (void)
10682 /* Tell handle_interrupt not to throw back to read_char, */
10683 waiting_for_input
= 0;
10684 input_available_clear_time
= 0;
10687 /* The SIGINT handler.
10689 If we have a frame on the controlling tty, we assume that the
10690 SIGINT was generated by C-g, so we call handle_interrupt.
10691 Otherwise, tell QUIT to kill Emacs. */
10694 handle_interrupt_signal (int sig
)
10696 /* See if we have an active terminal on our controlling tty. */
10697 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10700 /* If there are no frames there, let's pretend that we are a
10701 well-behaving UN*X program and quit. We must not call Lisp
10702 in a signal handler, so tell QUIT to exit when it is
10704 Vquit_flag
= Qkill_emacs
;
10708 /* Otherwise, the SIGINT was probably generated by C-g. */
10710 /* Set internal_last_event_frame to the top frame of the
10711 controlling tty, if we have a frame there. We disable the
10712 interrupt key on secondary ttys, so the SIGINT must have come
10713 from the controlling tty. */
10714 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10716 handle_interrupt (1);
10721 deliver_interrupt_signal (int sig
)
10723 deliver_process_signal (sig
, handle_interrupt_signal
);
10727 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10728 of the number of times C-g has been requested. If C-g is pressed
10729 enough times, then quit anyway. See bug#6585. */
10730 static int volatile force_quit_count
;
10732 /* This routine is called at interrupt level in response to C-g.
10734 It is called from the SIGINT handler or kbd_buffer_store_event.
10736 If `waiting_for_input' is non zero, then unless `echoing' is
10737 nonzero, immediately throw back to read_char.
10739 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10740 eval to throw, when it gets a chance. If quit-flag is already
10741 non-nil, it stops the job right away. */
10744 handle_interrupt (bool in_signal_handler
)
10750 /* XXX This code needs to be revised for multi-tty support. */
10751 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10753 if (! in_signal_handler
)
10755 /* If SIGINT isn't blocked, don't let us be interrupted by
10756 a SIGINT. It might be harmful due to non-reentrancy
10757 in I/O functions. */
10759 sigemptyset (&blocked
);
10760 sigaddset (&blocked
, SIGINT
);
10761 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10765 reset_all_sys_modes ();
10767 #ifdef SIGTSTP /* Support possible in later USG versions */
10769 * On systems which can suspend the current process and return to the original
10770 * shell, this command causes the user to end up back at the shell.
10771 * The "Auto-save" and "Abort" questions are not asked until
10772 * the user elects to return to emacs, at which point he can save the current
10773 * job and either dump core or continue.
10777 /* Perhaps should really fork an inferior shell?
10778 But that would not provide any way to get back
10779 to the original shell, ever. */
10780 printf ("No support for stopping a process on this operating system;\n");
10781 printf ("you can continue or abort.\n");
10782 #endif /* not SIGTSTP */
10784 /* We must remain inside the screen area when the internal terminal
10785 is used. Note that [Enter] is not echoed by dos. */
10786 cursor_to (SELECTED_FRAME (), 0, 0);
10788 /* It doesn't work to autosave while GC is in progress;
10789 the code used for auto-saving doesn't cope with the mark bit. */
10790 if (!gc_in_progress
)
10792 printf ("Auto-save? (y or n) ");
10794 if (((c
= getchar ()) & ~040) == 'Y')
10796 Fdo_auto_save (Qt
, Qnil
);
10798 printf ("\r\nAuto-save done");
10799 #else /* not MSDOS */
10800 printf ("Auto-save done\n");
10801 #endif /* not MSDOS */
10803 while (c
!= '\n') c
= getchar ();
10807 /* During GC, it must be safe to reenable quitting again. */
10808 Vinhibit_quit
= Qnil
;
10811 #endif /* not MSDOS */
10812 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10813 printf ("but will instead do a real quit after garbage collection ends\r\n");
10818 printf ("\r\nAbort? (y or n) ");
10819 #else /* not MSDOS */
10820 printf ("Abort (and dump core)? (y or n) ");
10821 #endif /* not MSDOS */
10823 if (((c
= getchar ()) & ~040) == 'Y')
10825 while (c
!= '\n') c
= getchar ();
10827 printf ("\r\nContinuing...\r\n");
10828 #else /* not MSDOS */
10829 printf ("Continuing...\n");
10830 #endif /* not MSDOS */
10832 init_all_sys_modes ();
10836 /* If executing a function that wants to be interrupted out of
10837 and the user has not deferred quitting by binding `inhibit-quit'
10838 then quit right away. */
10839 if (immediate_quit
&& NILP (Vinhibit_quit
))
10841 struct gl_state_s saved
;
10842 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10844 immediate_quit
= 0;
10845 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10847 GCPRO4 (saved
.object
, saved
.global_code
,
10848 saved
.current_syntax_table
, saved
.old_prop
);
10849 Fsignal (Qquit
, Qnil
);
10854 { /* Else request quit when it's safe. */
10855 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10856 force_quit_count
= count
;
10859 immediate_quit
= 1;
10860 Vinhibit_quit
= Qnil
;
10866 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10868 /* TODO: The longjmp in this call throws the NS event loop integration off,
10869 and it seems to do fine without this. Probably some attention
10870 needs to be paid to the setting of waiting_for_input in
10871 wait_reading_process_output() under HAVE_NS because of the call
10872 to ns_select there (needed because otherwise events aren't picked up
10873 outside of polling since we don't get SIGIO like X and we don't have a
10874 separate event loop thread like W32. */
10876 if (waiting_for_input
&& !echoing
)
10877 quit_throw_to_read_char (in_signal_handler
);
10881 /* Handle a C-g by making read_char return C-g. */
10884 quit_throw_to_read_char (int from_signal
)
10886 /* When not called from a signal handler it is safe to call
10888 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10889 Fkill_emacs (Qnil
);
10891 /* Prevent another signal from doing this before we finish. */
10892 clear_waiting_for_input ();
10895 Vunread_command_events
= Qnil
;
10897 if (FRAMEP (internal_last_event_frame
)
10898 && !EQ (internal_last_event_frame
, selected_frame
))
10899 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10902 sys_longjmp (getcjmp
, 1);
10905 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10906 Sset_input_interrupt_mode
, 1, 1, 0,
10907 doc
: /* Set interrupt mode of reading keyboard input.
10908 If INTERRUPT is non-nil, Emacs will use input interrupts;
10909 otherwise Emacs uses CBREAK mode.
10911 See also `current-input-mode'. */)
10912 (Lisp_Object interrupt
)
10914 int new_interrupt_input
;
10915 #ifdef USABLE_SIGIO
10916 #ifdef HAVE_X_WINDOWS
10917 if (x_display_list
!= NULL
)
10919 /* When using X, don't give the user a real choice,
10920 because we haven't implemented the mechanisms to support it. */
10921 new_interrupt_input
= 1;
10924 #endif /* HAVE_X_WINDOWS */
10925 new_interrupt_input
= !NILP (interrupt
);
10926 #else /* not USABLE_SIGIO */
10927 new_interrupt_input
= 0;
10928 #endif /* not USABLE_SIGIO */
10930 if (new_interrupt_input
!= interrupt_input
)
10932 #ifdef POLL_FOR_INPUT
10936 /* this causes startup screen to be restored and messes with the mouse */
10937 reset_all_sys_modes ();
10938 interrupt_input
= new_interrupt_input
;
10939 init_all_sys_modes ();
10941 interrupt_input
= new_interrupt_input
;
10944 #ifdef POLL_FOR_INPUT
10945 poll_suppress_count
= 1;
10952 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10953 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10954 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10955 C-q in key sequences.
10957 This setting only has an effect on tty terminals and only when
10958 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10960 See also `current-input-mode'. */)
10961 (Lisp_Object flow
, Lisp_Object terminal
)
10963 struct terminal
*t
= get_terminal (terminal
, 1);
10964 struct tty_display_info
*tty
;
10965 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10967 tty
= t
->display_info
.tty
;
10969 if (tty
->flow_control
!= !NILP (flow
))
10972 /* this causes startup screen to be restored and messes with the mouse */
10973 reset_sys_modes (tty
);
10976 tty
->flow_control
= !NILP (flow
);
10979 init_sys_modes (tty
);
10985 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10986 doc
: /* Enable or disable 8-bit input on TERMINAL.
10987 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10988 bit as the Meta modifier.
10990 If META is nil, Emacs will ignore the top bit, on the assumption it is
10993 Otherwise, Emacs will accept and pass through 8-bit input without
10994 specially interpreting the top bit.
10996 This setting only has an effect on tty terminal devices.
10998 Optional parameter TERMINAL specifies the tty terminal device to use.
10999 It may be a terminal object, a frame, or nil for the terminal used by
11000 the currently selected frame.
11002 See also `current-input-mode'. */)
11003 (Lisp_Object meta
, Lisp_Object terminal
)
11005 struct terminal
*t
= get_terminal (terminal
, 1);
11006 struct tty_display_info
*tty
;
11009 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11011 tty
= t
->display_info
.tty
;
11015 else if (EQ (meta
, Qt
))
11020 if (tty
->meta_key
!= new_meta
)
11023 /* this causes startup screen to be restored and messes with the mouse */
11024 reset_sys_modes (tty
);
11027 tty
->meta_key
= new_meta
;
11030 init_sys_modes (tty
);
11036 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11037 doc
: /* Specify character used for quitting.
11038 QUIT must be an ASCII character.
11040 This function only has an effect on the controlling tty of the Emacs
11043 See also `current-input-mode'. */)
11046 struct terminal
*t
= get_named_tty ("/dev/tty");
11047 struct tty_display_info
*tty
;
11048 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11050 tty
= t
->display_info
.tty
;
11052 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11053 error ("QUIT must be an ASCII character");
11056 /* this causes startup screen to be restored and messes with the mouse */
11057 reset_sys_modes (tty
);
11060 /* Don't let this value be out of range. */
11061 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11064 init_sys_modes (tty
);
11070 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11071 doc
: /* Set mode of reading keyboard input.
11072 First arg INTERRUPT non-nil means use input interrupts;
11073 nil means use CBREAK mode.
11074 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11075 (no effect except in CBREAK mode).
11076 Third arg META t means accept 8-bit input (for a Meta key).
11077 META nil means ignore the top bit, on the assumption it is parity.
11078 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11079 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11080 See also `current-input-mode'. */)
11081 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11083 Fset_input_interrupt_mode (interrupt
);
11084 Fset_output_flow_control (flow
, Qnil
);
11085 Fset_input_meta_mode (meta
, Qnil
);
11087 Fset_quit_char (quit
);
11091 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11092 doc
: /* Return information about the way Emacs currently reads keyboard input.
11093 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11094 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11095 nil, Emacs is using CBREAK mode.
11096 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11097 terminal; this does not apply if Emacs uses interrupt-driven input.
11098 META is t if accepting 8-bit input with 8th bit as Meta flag.
11099 META nil means ignoring the top bit, on the assumption it is parity.
11100 META is neither t nor nil if accepting 8-bit input and using
11101 all 8 bits as the character code.
11102 QUIT is the character Emacs currently uses to quit.
11103 The elements of this list correspond to the arguments of
11104 `set-input-mode'. */)
11107 Lisp_Object val
[4];
11108 struct frame
*sf
= XFRAME (selected_frame
);
11110 val
[0] = interrupt_input
? Qt
: Qnil
;
11111 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11113 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11114 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11116 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11123 XSETFASTINT (val
[3], quit_char
);
11125 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11128 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11129 doc
: /* Return position information for pixel coordinates X and Y.
11130 By default, X and Y are relative to text area of the selected window.
11131 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11132 If optional fourth arg WHOLE is non-nil, X is relative to the left
11133 edge of the window.
11135 The return value is similar to a mouse click position:
11136 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11137 IMAGE (DX . DY) (WIDTH . HEIGHT))
11138 The `posn-' functions access elements of such lists. */)
11139 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11144 if (NILP (frame_or_window
))
11145 frame_or_window
= selected_window
;
11147 if (WINDOWP (frame_or_window
))
11149 struct window
*w
= decode_live_window (frame_or_window
);
11151 XSETINT (x
, (XINT (x
)
11152 + WINDOW_LEFT_EDGE_X (w
)
11154 ? window_box_left_offset (w
, TEXT_AREA
)
11156 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11157 frame_or_window
= w
->frame
;
11160 CHECK_LIVE_FRAME (frame_or_window
);
11162 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11165 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11166 doc
: /* Return position information for buffer POS in WINDOW.
11167 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11169 Return nil if position is not visible in window. Otherwise,
11170 the return value is similar to that returned by `event-start' for
11171 a mouse click at the upper left corner of the glyph corresponding
11172 to the given buffer position:
11173 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11174 IMAGE (DX . DY) (WIDTH . HEIGHT))
11175 The `posn-' functions access elements of such lists. */)
11176 (Lisp_Object pos
, Lisp_Object window
)
11181 window
= selected_window
;
11183 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11186 Lisp_Object x
= XCAR (tem
);
11187 Lisp_Object y
= XCAR (XCDR (tem
));
11189 /* Point invisible due to hscrolling? */
11192 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11200 * Set up a new kboard object with reasonable initial values.
11203 init_kboard (KBOARD
*kb
)
11205 kset_overriding_terminal_local_map (kb
, Qnil
);
11206 kset_last_command (kb
, Qnil
);
11207 kset_real_last_command (kb
, Qnil
);
11208 kset_keyboard_translate_table (kb
, Qnil
);
11209 kset_last_repeatable_command (kb
, Qnil
);
11210 kset_prefix_arg (kb
, Qnil
);
11211 kset_last_prefix_arg (kb
, Qnil
);
11212 kset_kbd_queue (kb
, Qnil
);
11213 kb
->kbd_queue_has_data
= 0;
11214 kb
->immediate_echo
= 0;
11215 kset_echo_string (kb
, Qnil
);
11216 kb
->echo_after_prompt
= -1;
11217 kb
->kbd_macro_buffer
= 0;
11218 kb
->kbd_macro_bufsize
= 0;
11219 kset_defining_kbd_macro (kb
, Qnil
);
11220 kset_last_kbd_macro (kb
, Qnil
);
11221 kb
->reference_count
= 0;
11222 kset_system_key_alist (kb
, Qnil
);
11223 kset_system_key_syms (kb
, Qnil
);
11224 kset_window_system (kb
, Qt
); /* Unset. */
11225 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11226 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11227 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11228 kset_default_minibuffer_frame (kb
, Qnil
);
11232 * Destroy the contents of a kboard object, but not the object itself.
11233 * We use this just before deleting it, or if we're going to initialize
11234 * it a second time.
11237 wipe_kboard (KBOARD
*kb
)
11239 xfree (kb
->kbd_macro_buffer
);
11242 /* Free KB and memory referenced from it. */
11245 delete_kboard (KBOARD
*kb
)
11249 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11252 *kbp
= kb
->next_kboard
;
11254 /* Prevent a dangling reference to KB. */
11255 if (kb
== current_kboard
11256 && FRAMEP (selected_frame
)
11257 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11259 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11261 if (current_kboard
== kb
)
11270 init_keyboard (void)
11272 /* This is correct before outermost invocation of the editor loop. */
11273 command_loop_level
= -1;
11274 immediate_quit
= 0;
11275 quit_char
= Ctl ('g');
11276 Vunread_command_events
= Qnil
;
11277 timer_idleness_start_time
= invalid_emacs_time ();
11279 recent_keys_index
= 0;
11280 kbd_fetch_ptr
= kbd_buffer
;
11281 kbd_store_ptr
= kbd_buffer
;
11282 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11283 do_mouse_tracking
= Qnil
;
11286 interrupt_input_blocked
= 0;
11287 pending_signals
= 0;
11289 /* This means that command_loop_1 won't try to select anything the first
11291 internal_last_event_frame
= Qnil
;
11292 Vlast_event_frame
= internal_last_event_frame
;
11294 current_kboard
= initial_kboard
;
11295 /* Re-initialize the keyboard again. */
11296 wipe_kboard (current_kboard
);
11297 init_kboard (current_kboard
);
11298 /* A value of nil for Vwindow_system normally means a tty, but we also use
11299 it for the initial terminal since there is no window system there. */
11300 kset_window_system (current_kboard
, Qnil
);
11302 if (!noninteractive
)
11304 /* Before multi-tty support, these handlers used to be installed
11305 only if the current session was a tty session. Now an Emacs
11306 session may have multiple display types, so we always handle
11307 SIGINT. There is special code in handle_interrupt_signal to exit
11308 Emacs on SIGINT when there are no termcap frames on the
11309 controlling terminal. */
11310 struct sigaction action
;
11311 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11312 sigaction (SIGINT
, &action
, 0);
11314 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11315 SIGQUIT and we can't tell which one it will give us. */
11316 sigaction (SIGQUIT
, &action
, 0);
11317 #endif /* not DOS_NT */
11319 #ifdef USABLE_SIGIO
11320 if (!noninteractive
)
11322 struct sigaction action
;
11323 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11324 sigaction (SIGIO
, &action
, 0);
11328 /* Use interrupt input by default, if it works and noninterrupt input
11329 has deficiencies. */
11331 #ifdef INTERRUPT_INPUT
11332 interrupt_input
= 1;
11334 interrupt_input
= 0;
11337 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11340 if (keyboard_init_hook
)
11341 (*keyboard_init_hook
) ();
11343 #ifdef POLL_FOR_INPUT
11345 poll_suppress_count
= 1;
11350 /* This type's only use is in syms_of_keyboard, to initialize the
11351 event header symbols and put properties on them. */
11352 struct event_head
{
11358 static const struct event_head head_table
[] = {
11359 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11360 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11361 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11362 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11363 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11364 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11365 /* `select-window' should be handled just like `switch-frame'
11366 in read_key_sequence. */
11367 {&Qselect_window
, "select-window", &Qswitch_frame
}
11371 syms_of_keyboard (void)
11373 pending_funcalls
= Qnil
;
11374 staticpro (&pending_funcalls
);
11376 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11377 staticpro (&Vlispy_mouse_stem
);
11380 DEFSYM (QCimage
, ":image");
11381 DEFSYM (Qhelp_echo
, "help-echo");
11382 DEFSYM (QCrtl
, ":rtl");
11384 staticpro (&item_properties
);
11385 item_properties
= Qnil
;
11387 staticpro (&tool_bar_item_properties
);
11388 tool_bar_item_properties
= Qnil
;
11389 staticpro (&tool_bar_items_vector
);
11390 tool_bar_items_vector
= Qnil
;
11392 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11393 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11394 DEFSYM (Qself_insert_command
, "self-insert-command");
11395 DEFSYM (Qforward_char
, "forward-char");
11396 DEFSYM (Qbackward_char
, "backward-char");
11397 DEFSYM (Qdisabled
, "disabled");
11398 DEFSYM (Qundefined
, "undefined");
11399 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11400 DEFSYM (Qpost_command_hook
, "post-command-hook");
11401 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11402 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11403 DEFSYM (Qfunction_key
, "function-key");
11404 DEFSYM (Qmouse_click
, "mouse-click");
11405 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11406 DEFSYM (Qsave_session
, "save-session");
11407 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11408 DEFSYM (Qmenu_enable
, "menu-enable");
11411 DEFSYM (Qlanguage_change
, "language-change");
11412 DEFSYM (Qfile_notify
, "file-notify");
11416 DEFSYM (Qdbus_event
, "dbus-event");
11419 DEFSYM (QCenable
, ":enable");
11420 DEFSYM (QCvisible
, ":visible");
11421 DEFSYM (QChelp
, ":help");
11422 DEFSYM (QCfilter
, ":filter");
11423 DEFSYM (QCbutton
, ":button");
11424 DEFSYM (QCkeys
, ":keys");
11425 DEFSYM (QCkey_sequence
, ":key-sequence");
11426 DEFSYM (QCtoggle
, ":toggle");
11427 DEFSYM (QCradio
, ":radio");
11428 DEFSYM (QClabel
, ":label");
11429 DEFSYM (QCvert_only
, ":vert-only");
11431 DEFSYM (Qmode_line
, "mode-line");
11432 DEFSYM (Qvertical_line
, "vertical-line");
11433 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11434 DEFSYM (Qmenu_bar
, "menu-bar");
11436 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11437 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11440 DEFSYM (Qabove_handle
, "above-handle");
11441 DEFSYM (Qhandle
, "handle");
11442 DEFSYM (Qbelow_handle
, "below-handle");
11443 DEFSYM (Qup
, "up");
11444 DEFSYM (Qdown
, "down");
11445 DEFSYM (Qtop
, "top");
11446 DEFSYM (Qbottom
, "bottom");
11447 DEFSYM (Qend_scroll
, "end-scroll");
11448 DEFSYM (Qratio
, "ratio");
11450 DEFSYM (Qevent_kind
, "event-kind");
11451 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11452 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11453 DEFSYM (Qmodifier_cache
, "modifier-cache");
11455 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11456 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11458 DEFSYM (Qpolling_period
, "polling-period");
11460 DEFSYM (Qx_set_selection
, "x-set-selection");
11461 DEFSYM (QPRIMARY
, "PRIMARY");
11462 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11463 DEFSYM (Qhandle_select_window
, "handle-select-window");
11465 DEFSYM (Qinput_method_function
, "input-method-function");
11466 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11467 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11469 DEFSYM (Qhelp_form_show
, "help-form-show");
11471 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11472 Fset (Qinput_method_use_echo_area
, Qnil
);
11474 last_point_position_buffer
= Qnil
;
11475 last_point_position_window
= Qnil
;
11479 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11481 for (i
= 0; i
< len
; i
++)
11483 const struct event_head
*p
= &head_table
[i
];
11484 *p
->var
= intern_c_string (p
->name
);
11485 staticpro (p
->var
);
11486 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11487 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11491 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11492 staticpro (&button_down_location
);
11493 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11494 staticpro (&mouse_syms
);
11495 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11496 / sizeof (lispy_wheel_names
[0])),
11498 staticpro (&wheel_syms
);
11502 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11504 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11505 for (i
= 0; i
< len
; i
++)
11506 if (modifier_names
[i
])
11507 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11508 staticpro (&modifier_symbols
);
11511 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11512 staticpro (&recent_keys
);
11514 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11515 staticpro (&this_command_keys
);
11517 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11518 staticpro (&raw_keybuf
);
11520 DEFSYM (Qextended_command_history
, "extended-command-history");
11521 Fset (Qextended_command_history
, Qnil
);
11523 accent_key_syms
= Qnil
;
11524 staticpro (&accent_key_syms
);
11526 func_key_syms
= Qnil
;
11527 staticpro (&func_key_syms
);
11529 drag_n_drop_syms
= Qnil
;
11530 staticpro (&drag_n_drop_syms
);
11532 unread_switch_frame
= Qnil
;
11533 staticpro (&unread_switch_frame
);
11535 internal_last_event_frame
= Qnil
;
11536 staticpro (&internal_last_event_frame
);
11538 read_key_sequence_cmd
= Qnil
;
11539 staticpro (&read_key_sequence_cmd
);
11540 read_key_sequence_remapped
= Qnil
;
11541 staticpro (&read_key_sequence_remapped
);
11543 menu_bar_one_keymap_changed_items
= Qnil
;
11544 staticpro (&menu_bar_one_keymap_changed_items
);
11546 menu_bar_items_vector
= Qnil
;
11547 staticpro (&menu_bar_items_vector
);
11549 help_form_saved_window_configs
= Qnil
;
11550 staticpro (&help_form_saved_window_configs
);
11552 defsubr (&Scurrent_idle_time
);
11553 defsubr (&Sevent_symbol_parse_modifiers
);
11554 defsubr (&Sevent_convert_list
);
11555 defsubr (&Sread_key_sequence
);
11556 defsubr (&Sread_key_sequence_vector
);
11557 defsubr (&Srecursive_edit
);
11558 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11559 defsubr (&Strack_mouse
);
11561 defsubr (&Sinput_pending_p
);
11562 defsubr (&Scommand_execute
);
11563 defsubr (&Srecent_keys
);
11564 defsubr (&Sthis_command_keys
);
11565 defsubr (&Sthis_command_keys_vector
);
11566 defsubr (&Sthis_single_command_keys
);
11567 defsubr (&Sthis_single_command_raw_keys
);
11568 defsubr (&Sreset_this_command_lengths
);
11569 defsubr (&Sclear_this_command_keys
);
11570 defsubr (&Ssuspend_emacs
);
11571 defsubr (&Sabort_recursive_edit
);
11572 defsubr (&Sexit_recursive_edit
);
11573 defsubr (&Srecursion_depth
);
11574 defsubr (&Stop_level
);
11575 defsubr (&Sdiscard_input
);
11576 defsubr (&Sopen_dribble_file
);
11577 defsubr (&Sset_input_interrupt_mode
);
11578 defsubr (&Sset_output_flow_control
);
11579 defsubr (&Sset_input_meta_mode
);
11580 defsubr (&Sset_quit_char
);
11581 defsubr (&Sset_input_mode
);
11582 defsubr (&Scurrent_input_mode
);
11583 defsubr (&Sposn_at_point
);
11584 defsubr (&Sposn_at_x_y
);
11586 DEFVAR_LISP ("last-command-event", last_command_event
,
11587 doc
: /* Last input event that was part of a command. */);
11589 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11590 doc
: /* Last input event in a command, except for mouse menu events.
11591 Mouse menus give back keys that don't look like mouse events;
11592 this variable holds the actual mouse event that led to the menu,
11593 so that you can determine whether the command was run by mouse or not. */);
11595 DEFVAR_LISP ("last-input-event", last_input_event
,
11596 doc
: /* Last input event. */);
11598 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11599 doc
: /* List of events to be read as the command input.
11600 These events are processed first, before actual keyboard input.
11601 Events read from this list are not normally added to `this-command-keys',
11602 as they will already have been added once as they were read for the first time.
11603 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11604 Vunread_command_events
= Qnil
;
11606 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11607 doc
: /* List of events to be processed as input by input methods.
11608 These events are processed before `unread-command-events'
11609 and actual keyboard input, but are not given to `input-method-function'. */);
11610 Vunread_post_input_method_events
= Qnil
;
11612 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11613 doc
: /* List of events to be processed as input by input methods.
11614 These events are processed after `unread-command-events', but
11615 before actual keyboard input.
11616 If there's an active input method, the events are given to
11617 `input-method-function'. */);
11618 Vunread_input_method_events
= Qnil
;
11620 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11621 doc
: /* Meta-prefix character code.
11622 Meta-foo as command input turns into this character followed by foo. */);
11623 XSETINT (meta_prefix_char
, 033);
11625 DEFVAR_KBOARD ("last-command", Vlast_command
,
11626 doc
: /* The last command executed.
11627 Normally a symbol with a function definition, but can be whatever was found
11628 in the keymap, or whatever the variable `this-command' was set to by that
11631 The value `mode-exit' is special; it means that the previous command
11632 read an event that told it to exit, and it did so and unread that event.
11633 In other words, the present command is the event that made the previous
11636 The value `kill-region' is special; it means that the previous command
11637 was a kill command.
11639 `last-command' has a separate binding for each terminal device.
11640 See Info node `(elisp)Multiple Terminals'. */);
11642 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11643 doc
: /* Same as `last-command', but never altered by Lisp code.
11644 Taken from the previous value of `real-this-command'. */);
11646 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11647 doc
: /* Last command that may be repeated.
11648 The last command executed that was not bound to an input event.
11649 This is the command `repeat' will try to repeat.
11650 Taken from a previous value of `real-this-command'. */);
11652 DEFVAR_LISP ("this-command", Vthis_command
,
11653 doc
: /* The command now being executed.
11654 The command can set this variable; whatever is put here
11655 will be in `last-command' during the following command. */);
11656 Vthis_command
= Qnil
;
11658 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11659 doc
: /* This is like `this-command', except that commands should never modify it. */);
11660 Vreal_this_command
= Qnil
;
11662 DEFVAR_LISP ("this-command-keys-shift-translated",
11663 Vthis_command_keys_shift_translated
,
11664 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11665 Shift-translation occurs when there is no binding for the key sequence
11666 as entered, but a binding was found by changing an upper-case letter
11667 to lower-case, or a shifted function key to an unshifted one. */);
11668 Vthis_command_keys_shift_translated
= Qnil
;
11670 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11671 doc
: /* The command bound to the current key sequence before remapping.
11672 It equals `this-command' if the original command was not remapped through
11673 any of the active keymaps. Otherwise, the value of `this-command' is the
11674 result of looking up the original command in the active keymaps. */);
11675 Vthis_original_command
= Qnil
;
11677 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11678 doc
: /* Number of input events between auto-saves.
11679 Zero means disable autosaving due to number of characters typed. */);
11680 auto_save_interval
= 300;
11682 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11683 doc
: /* Number of seconds idle time before auto-save.
11684 Zero or nil means disable auto-saving due to idleness.
11685 After auto-saving due to this many seconds of idle time,
11686 Emacs also does a garbage collection if that seems to be warranted. */);
11687 XSETFASTINT (Vauto_save_timeout
, 30);
11689 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11690 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11691 The value may be integer or floating point.
11692 If the value is zero, don't echo at all. */);
11693 Vecho_keystrokes
= make_number (1);
11695 DEFVAR_INT ("polling-period", polling_period
,
11696 doc
: /* Interval between polling for input during Lisp execution.
11697 The reason for polling is to make C-g work to stop a running program.
11698 Polling is needed only when using X windows and SIGIO does not work.
11699 Polling is automatically disabled in all other cases. */);
11700 polling_period
= 2;
11702 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11703 doc
: /* Maximum time between mouse clicks to make a double-click.
11704 Measured in milliseconds. The value nil means disable double-click
11705 recognition; t means double-clicks have no time limit and are detected
11706 by position only. */);
11707 Vdouble_click_time
= make_number (500);
11709 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11710 doc
: /* Maximum mouse movement between clicks to make a double-click.
11711 On window-system frames, value is the number of pixels the mouse may have
11712 moved horizontally or vertically between two clicks to make a double-click.
11713 On non window-system frames, value is interpreted in units of 1/8 characters
11716 This variable is also the threshold for motion of the mouse
11717 to count as a drag. */);
11718 double_click_fuzz
= 3;
11720 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11721 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11722 inhibit_local_menu_bar_menus
= 0;
11724 DEFVAR_INT ("num-input-keys", num_input_keys
,
11725 doc
: /* Number of complete key sequences read as input so far.
11726 This includes key sequences read from keyboard macros.
11727 The number is effectively the number of interactive command invocations. */);
11728 num_input_keys
= 0;
11730 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11731 doc
: /* Number of input events read from the keyboard so far.
11732 This does not include events generated by keyboard macros. */);
11733 num_nonmacro_input_events
= 0;
11735 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11736 doc
: /* The frame in which the most recently read event occurred.
11737 If the last event came from a keyboard macro, this is set to `macro'. */);
11738 Vlast_event_frame
= Qnil
;
11740 /* This variable is set up in sysdep.c. */
11741 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11742 doc
: /* The ERASE character as set by the user with stty. */);
11744 DEFVAR_LISP ("help-char", Vhelp_char
,
11745 doc
: /* Character to recognize as meaning Help.
11746 When it is read, do `(eval help-form)', and display result if it's a string.
11747 If the value of `help-form' is nil, this char can be read normally. */);
11748 XSETINT (Vhelp_char
, Ctl ('H'));
11750 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11751 doc
: /* List of input events to recognize as meaning Help.
11752 These work just like the value of `help-char' (see that). */);
11753 Vhelp_event_list
= Qnil
;
11755 DEFVAR_LISP ("help-form", Vhelp_form
,
11756 doc
: /* Form to execute when character `help-char' is read.
11757 If the form returns a string, that string is displayed.
11758 If `help-form' is nil, the help char is not recognized. */);
11761 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11762 doc
: /* Command to run when `help-char' character follows a prefix key.
11763 This command is used only when there is no actual binding
11764 for that character after that prefix key. */);
11765 Vprefix_help_command
= Qnil
;
11767 DEFVAR_LISP ("top-level", Vtop_level
,
11768 doc
: /* Form to evaluate when Emacs starts up.
11769 Useful to set before you dump a modified Emacs. */);
11772 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11773 doc
: /* Translate table for local keyboard input, or nil.
11774 If non-nil, the value should be a char-table. Each character read
11775 from the keyboard is looked up in this char-table. If the value found
11776 there is non-nil, then it is used instead of the actual input character.
11778 The value can also be a string or vector, but this is considered obsolete.
11779 If it is a string or vector of length N, character codes N and up are left
11780 untranslated. In a vector, an element which is nil means "no translation".
11782 This is applied to the characters supplied to input methods, not their
11783 output. See also `translation-table-for-input'.
11785 This variable has a separate binding for each terminal.
11786 See Info node `(elisp)Multiple Terminals'. */);
11788 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11789 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11790 \(Even if the operating system has support for stopping a process.\) */);
11791 cannot_suspend
= 0;
11793 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11794 doc
: /* Non-nil means prompt with menus when appropriate.
11795 This is done when reading from a keymap that has a prompt string,
11796 for elements that have prompt strings.
11797 The menu is displayed on the screen
11798 if X menus were enabled at configuration
11799 time and the previous event was a mouse click prefix key.
11800 Otherwise, menu prompting uses the echo area. */);
11801 menu_prompting
= 1;
11803 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11804 doc
: /* Character to see next line of menu prompt.
11805 Type this character while in a menu prompt to rotate around the lines of it. */);
11806 XSETINT (menu_prompt_more_char
, ' ');
11808 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11809 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11810 Emacs applies the modifiers of the character stored here to each keyboard
11811 character it reads. For example, after evaluating the expression
11812 (setq extra-keyboard-modifiers ?\\C-x)
11813 all input characters will have the control modifier applied to them.
11815 Note that the character ?\\C-@, equivalent to the integer zero, does
11816 not count as a control character; rather, it counts as a character
11817 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11818 cancels any modification. */);
11819 extra_keyboard_modifiers
= 0;
11821 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11822 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11823 The command loop sets this to nil before each command,
11824 and tests the value when the command returns.
11825 Buffer modification stores t in this variable. */);
11826 Vdeactivate_mark
= Qnil
;
11827 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11829 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11830 doc
: /* Normal hook run before each command is executed.
11831 If an unhandled error happens in running this hook,
11832 the function in which the error occurred is unconditionally removed, since
11833 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11834 Vpre_command_hook
= Qnil
;
11836 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11837 doc
: /* Normal hook run after each command is executed.
11838 If an unhandled error happens in running this hook,
11839 the function in which the error occurred is unconditionally removed, since
11840 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11841 Vpost_command_hook
= Qnil
;
11844 DEFVAR_LISP ("echo-area-clear-hook", ...,
11845 doc
: /* Normal hook run when clearing the echo area. */);
11847 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11848 Fset (Qecho_area_clear_hook
, Qnil
);
11850 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11851 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11852 Vlucid_menu_bar_dirty_flag
= Qnil
;
11854 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11855 doc
: /* List of menu bar items to move to the end of the menu bar.
11856 The elements of the list are event types that may have menu bar bindings. */);
11857 Vmenu_bar_final_items
= Qnil
;
11859 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11860 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11861 This is used internally by graphical displays that do not render
11862 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11863 Vtool_bar_separator_image_expression
= Qnil
;
11865 DEFVAR_KBOARD ("overriding-terminal-local-map",
11866 Voverriding_terminal_local_map
,
11867 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11868 If this variable is non-nil, it is used as a keymap instead of the
11869 buffer's local map, and the minor mode keymaps and text property keymaps.
11870 It also replaces `overriding-local-map'.
11872 This variable is intended to let commands such as `universal-argument'
11873 set up a different keymap for reading the next command.
11875 `overriding-terminal-local-map' has a separate binding for each
11877 See Info node `(elisp)Multiple Terminals'. */);
11879 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11880 doc
: /* Keymap that overrides all other local keymaps.
11881 If this variable is non-nil, it is used as a keymap--replacing the
11882 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11883 Voverriding_local_map
= Qnil
;
11885 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11886 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11887 Otherwise, the menu bar continues to reflect the buffer's local map
11888 and the minor mode maps regardless of `overriding-local-map'. */);
11889 Voverriding_local_map_menu_flag
= Qnil
;
11891 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11892 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11893 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11895 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11896 doc
: /* Non-nil means generate motion events for mouse motion. */);
11898 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11899 doc
: /* Alist of system-specific X windows key symbols.
11900 Each element should have the form (N . SYMBOL) where N is the
11901 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11902 and SYMBOL is its name.
11904 `system-key-alist' has a separate binding for each terminal device.
11905 See Info node `(elisp)Multiple Terminals'. */);
11907 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11908 doc
: /* Keymap that translates key sequences to key sequences during input.
11909 This is used mainly for mapping key sequences into some preferred
11910 key events (symbols).
11912 The `read-key-sequence' function replaces any subsequence bound by
11913 `local-function-key-map' with its binding. More precisely, when the
11914 active keymaps have no binding for the current key sequence but
11915 `local-function-key-map' binds a suffix of the sequence to a vector or
11916 string, `read-key-sequence' replaces the matching suffix with its
11917 binding, and continues with the new sequence.
11919 If the binding is a function, it is called with one argument (the prompt)
11920 and its return value (a key sequence) is used.
11922 The events that come from bindings in `local-function-key-map' are not
11923 themselves looked up in `local-function-key-map'.
11925 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11926 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11927 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11928 typing `ESC O P x' would return [f1 x].
11930 `local-function-key-map' has a separate binding for each terminal
11931 device. See Info node `(elisp)Multiple Terminals'. If you need to
11932 define a binding on all terminals, change `function-key-map'
11933 instead. Initially, `local-function-key-map' is an empty keymap that
11934 has `function-key-map' as its parent on all terminal devices. */);
11936 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11937 doc
: /* Keymap that decodes input escape sequences.
11938 This is used mainly for mapping ASCII function key sequences into
11939 real Emacs function key events (symbols).
11941 The `read-key-sequence' function replaces any subsequence bound by
11942 `input-decode-map' with its binding. Contrary to `function-key-map',
11943 this map applies its rebinding regardless of the presence of an ordinary
11944 binding. So it is more like `key-translation-map' except that it applies
11945 before `function-key-map' rather than after.
11947 If the binding is a function, it is called with one argument (the prompt)
11948 and its return value (a key sequence) is used.
11950 The events that come from bindings in `input-decode-map' are not
11951 themselves looked up in `input-decode-map'.
11953 This variable is keyboard-local. */);
11955 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11956 doc
: /* The parent keymap of all `local-function-key-map' instances.
11957 Function key definitions that apply to all terminal devices should go
11958 here. If a mapping is defined in both the current
11959 `local-function-key-map' binding and this variable, then the local
11960 definition will take precedence. */);
11961 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11963 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11964 doc
: /* Keymap of key translations that can override keymaps.
11965 This keymap works like `function-key-map', but comes after that,
11966 and its non-prefix bindings override ordinary bindings.
11967 Another difference is that it is global rather than keyboard-local. */);
11968 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11970 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11971 doc
: /* List of deferred actions to be performed at a later time.
11972 The precise format isn't relevant here; we just check whether it is nil. */);
11973 Vdeferred_action_list
= Qnil
;
11975 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11976 doc
: /* Function to call to handle deferred actions, after each command.
11977 This function is called with no arguments after each command
11978 whenever `deferred-action-list' is non-nil. */);
11979 Vdeferred_action_function
= Qnil
;
11981 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11982 doc
: /* List of warnings to be displayed after this command.
11983 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11984 as per the args of `display-warning' (which see).
11985 If this variable is non-nil, `delayed-warnings-hook' will be run
11986 immediately after running `post-command-hook'. */);
11987 Vdelayed_warnings_list
= Qnil
;
11989 DEFVAR_LISP ("timer-list", Vtimer_list
,
11990 doc
: /* List of active absolute time timers in order of increasing time. */);
11991 Vtimer_list
= Qnil
;
11993 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11994 doc
: /* List of active idle-time timers in order of increasing time. */);
11995 Vtimer_idle_list
= Qnil
;
11997 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11998 doc
: /* If non-nil, the function that implements the current input method.
11999 It's called with one argument, a printing character that was just read.
12000 \(That means a character with code 040...0176.)
12001 Typically this function uses `read-event' to read additional events.
12002 When it does so, it should first bind `input-method-function' to nil
12003 so it will not be called recursively.
12005 The function should return a list of zero or more events
12006 to be used as input. If it wants to put back some events
12007 to be reconsidered, separately, by the input method,
12008 it can add them to the beginning of `unread-command-events'.
12010 The input method function can find in `input-method-previous-message'
12011 the previous echo area message.
12013 The input method function should refer to the variables
12014 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12015 for guidance on what to do. */);
12016 Vinput_method_function
= Qnil
;
12018 DEFVAR_LISP ("input-method-previous-message",
12019 Vinput_method_previous_message
,
12020 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12021 This variable exists because `read-event' clears the echo area
12022 before running the input method. It is nil if there was no message. */);
12023 Vinput_method_previous_message
= Qnil
;
12025 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12026 doc
: /* If non-nil, the function that implements the display of help.
12027 It's called with one argument, the help string to display. */);
12028 Vshow_help_function
= Qnil
;
12030 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12031 doc
: /* If non-nil, suppress point adjustment after executing a command.
12033 After a command is executed, if point is moved into a region that has
12034 special properties (e.g. composition, display), we adjust point to
12035 the boundary of the region. But, when a command sets this variable to
12036 non-nil, we suppress the point adjustment.
12038 This variable is set to nil before reading a command, and is checked
12039 just after executing the command. */);
12040 Vdisable_point_adjustment
= Qnil
;
12042 DEFVAR_LISP ("global-disable-point-adjustment",
12043 Vglobal_disable_point_adjustment
,
12044 doc
: /* If non-nil, always suppress point adjustment.
12046 The default value is nil, in which case, point adjustment are
12047 suppressed only after special commands that set
12048 `disable-point-adjustment' (which see) to non-nil. */);
12049 Vglobal_disable_point_adjustment
= Qnil
;
12051 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12052 doc
: /* How long to display an echo-area message when the minibuffer is active.
12053 If the value is not a number, such messages don't time out. */);
12054 Vminibuffer_message_timeout
= make_number (2);
12056 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12057 doc
: /* If non-nil, any keyboard input throws to this symbol.
12058 The value of that variable is passed to `quit-flag' and later causes a
12059 peculiar kind of quitting. */);
12060 Vthrow_on_input
= Qnil
;
12062 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12063 doc
: /* If non-nil, function to output error messages.
12064 The arguments are the error data, a list of the form
12065 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12066 such as just as `condition-case' would bind its variable to,
12067 the context (a string which normally goes at the start of the message),
12068 and the Lisp function within which the error was signaled. */);
12069 Vcommand_error_function
= Qnil
;
12071 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12072 Venable_disabled_menus_and_buttons
,
12073 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12075 Help functions bind this to allow help on disabled menu items
12076 and tool-bar buttons. */);
12077 Venable_disabled_menus_and_buttons
= Qnil
;
12079 DEFVAR_LISP ("select-active-regions",
12080 Vselect_active_regions
,
12081 doc
: /* If non-nil, an active region automatically sets the primary selection.
12082 If the value is `only', only temporarily active regions (usually made
12083 by mouse-dragging or shift-selection) set the window selection.
12085 This takes effect only when Transient Mark mode is enabled. */);
12086 Vselect_active_regions
= Qt
;
12088 DEFVAR_LISP ("saved-region-selection",
12089 Vsaved_region_selection
,
12090 doc
: /* Contents of active region prior to buffer modification.
12091 If `select-active-regions' is non-nil, Emacs sets this to the
12092 text in the region before modifying the buffer. The next
12093 `deactivate-mark' call uses this to set the window selection. */);
12094 Vsaved_region_selection
= Qnil
;
12096 DEFVAR_LISP ("selection-inhibit-update-commands",
12097 Vselection_inhibit_update_commands
,
12098 doc
: /* List of commands which should not update the selection.
12099 Normally, if `select-active-regions' is non-nil and the mark remains
12100 active after a command (i.e. the mark was not deactivated), the Emacs
12101 command loop sets the selection to the text in the region. However,
12102 if the command is in this list, the selection is not updated. */);
12103 Vselection_inhibit_update_commands
12104 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12106 DEFVAR_LISP ("debug-on-event",
12108 doc
: /* Enter debugger on this event. When Emacs
12109 receives the special event specified by this variable, it will try to
12110 break into the debugger as soon as possible instead of processing the
12111 event normally through `special-event-map'.
12113 Currently, the only supported values for this
12114 variable are `sigusr1' and `sigusr2'. */);
12115 Vdebug_on_event
= intern_c_string ("sigusr2");
12117 /* Create the initial keyboard. */
12118 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12119 init_kboard (initial_kboard
);
12120 /* Vwindow_system is left at t for now. */
12121 initial_kboard
->next_kboard
= all_kboards
;
12122 all_kboards
= initial_kboard
;
12126 keys_of_keyboard (void)
12128 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12129 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12130 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12131 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12132 initial_define_key (meta_map
, 'x', "execute-extended-command");
12134 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12135 "handle-delete-frame");
12136 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12137 "ns-put-working-text");
12138 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12139 "ns-unput-working-text");
12140 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12141 current-prefix-arg, as is done in `handle-switch-frame'.
12142 But `handle-switch-frame is not run from the special-map.
12143 Commands from that map are run in a special way that automatically
12144 preserves the prefix-arg. Restoring the prefix arg here is not just
12145 redundant but harmful:
12147 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12148 - after the first prompt, the exit-minibuffer-hook is run which may
12149 iconify a frame and thus push a `iconify-frame' event.
12150 - after running exit-minibuffer-hook, current-prefix-arg is
12151 restored to the non-nil value it had before the prompt.
12152 - we enter the second prompt.
12153 current-prefix-arg is non-nil, prefix-arg is nil.
12154 - before running the first real event, we run the special iconify-frame
12155 event, but we pass the `special' arg to execute-command so
12156 current-prefix-arg and prefix-arg are left untouched.
12157 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12158 - the next key event will have a spuriously non-nil current-prefix-arg. */
12159 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12161 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12163 /* Handling it at such a low-level causes read_key_sequence to get
12164 * confused because it doesn't realize that the current_buffer was
12165 * changed by read_char.
12167 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12168 * "handle-select-window"); */
12169 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12170 "handle-save-session");
12173 /* Define a special event which is raised for dbus callback
12175 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12176 "dbus-handle-event");
12179 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12181 #if defined (WINDOWSNT)
12182 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12184 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
12185 "w32notify-handle-event");
12189 /* Mark the pointers in the kboard objects.
12190 Called by Fgarbage_collect. */
12192 mark_kboards (void)
12196 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12198 if (kb
->kbd_macro_buffer
)
12199 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12201 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12202 mark_object (KVAR (kb
, Vlast_command
));
12203 mark_object (KVAR (kb
, Vreal_last_command
));
12204 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12205 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12206 mark_object (KVAR (kb
, Vprefix_arg
));
12207 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12208 mark_object (KVAR (kb
, kbd_queue
));
12209 mark_object (KVAR (kb
, defining_kbd_macro
));
12210 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12211 mark_object (KVAR (kb
, Vsystem_key_alist
));
12212 mark_object (KVAR (kb
, system_key_syms
));
12213 mark_object (KVAR (kb
, Vwindow_system
));
12214 mark_object (KVAR (kb
, Vinput_decode_map
));
12215 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12216 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12217 mark_object (KVAR (kb
, echo_string
));
12220 struct input_event
*event
;
12221 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12223 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12224 event
= kbd_buffer
;
12225 if (event
->kind
!= SELECTION_REQUEST_EVENT
12226 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12228 mark_object (event
->x
);
12229 mark_object (event
->y
);
12231 mark_object (event
->frame_or_window
);
12232 mark_object (event
->arg
);