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 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 #include "syssignal.h"
62 #include <sys/types.h>
66 /* This is to get the definitions of the XK_ symbols. */
73 #endif /* HAVE_NTGUI */
79 /* Variables for blockinput.h: */
81 /* Non-zero if interrupt input is blocked right now. */
82 volatile int interrupt_input_blocked
;
84 /* Nonzero means an input interrupt has arrived
85 during the current critical section. */
86 int interrupt_input_pending
;
88 /* This var should be (interrupt_input_pending || pending_atimers).
89 The QUIT macro checks this instead of interrupt_input_pending and
90 pending_atimers separately, to reduce code size. So, any code that
91 changes interrupt_input_pending or pending_atimers should update
97 #define KBD_BUFFER_SIZE 4096
99 KBOARD
*initial_kboard
;
100 KBOARD
*current_kboard
;
103 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
104 static int single_kboard
;
106 /* Non-nil disable property on a command means
107 do not execute it; call disabled-command-function's value instead. */
108 Lisp_Object Qdisabled
;
109 static Lisp_Object Qdisabled_command_function
;
111 #define NUM_RECENT_KEYS (300)
113 /* Index for storing next element into recent_keys. */
114 static int recent_keys_index
;
116 /* Total number of elements stored into recent_keys. */
117 static int total_keys
;
119 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
120 static Lisp_Object recent_keys
;
122 /* Vector holding the key sequence that invoked the current command.
123 It is reused for each command, and it may be longer than the current
124 sequence; this_command_key_count indicates how many elements
125 actually mean something.
126 It's easier to staticpro a single Lisp_Object than an array. */
127 Lisp_Object this_command_keys
;
128 ptrdiff_t this_command_key_count
;
130 /* 1 after calling Freset_this_command_lengths.
132 static int this_command_key_count_reset
;
134 /* This vector is used as a buffer to record the events that were actually read
135 by read_key_sequence. */
136 static Lisp_Object raw_keybuf
;
137 static int raw_keybuf_count
;
139 #define GROW_RAW_KEYBUF \
140 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
141 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
143 /* Number of elements of this_command_keys
144 that precede this key sequence. */
145 static ptrdiff_t this_single_command_key_start
;
147 /* Record values of this_command_key_count and echo_length ()
148 before this command was read. */
149 static ptrdiff_t before_command_key_count
;
150 static ptrdiff_t before_command_echo_length
;
152 /* For longjmp to where kbd input is being done. */
154 static jmp_buf getcjmp
;
156 /* True while doing kbd input. */
157 int waiting_for_input
;
159 /* True while displaying for echoing. Delays C-g throwing. */
163 /* Non-null means we can start echoing at the next input pause even
164 though there is something in the echo area. */
166 static struct kboard
*ok_to_echo_at_next_pause
;
168 /* The kboard last echoing, or null for none. Reset to 0 in
169 cancel_echoing. If non-null, and a current echo area message
170 exists, and echo_message_buffer is eq to the current message
171 buffer, we know that the message comes from echo_kboard. */
173 struct kboard
*echo_kboard
;
175 /* The buffer used for echoing. Set in echo_now, reset in
178 Lisp_Object echo_message_buffer
;
180 /* Nonzero means C-g should cause immediate error-signal. */
183 /* Character that causes a quit. Normally C-g.
185 If we are running on an ordinary terminal, this must be an ordinary
186 ASCII char, since we want to make it our interrupt character.
188 If we are not running on an ordinary terminal, it still needs to be
189 an ordinary ASCII char. This character needs to be recognized in
190 the input interrupt handler. At this point, the keystroke is
191 represented as a struct input_event, while the desired quit
192 character is specified as a lispy event. The mapping from struct
193 input_events to lispy events cannot run in an interrupt handler,
194 and the reverse mapping is difficult for anything but ASCII
197 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
201 /* Current depth in recursive edits. */
202 EMACS_INT command_loop_level
;
204 /* If not Qnil, this is a switch-frame event which we decided to put
205 off until the end of a key sequence. This should be read as the
206 next command input, after any unread_command_events.
208 read_key_sequence uses this to delay switch-frame events until the
209 end of the key sequence; Fread_char uses it to put off switch-frame
210 events until a non-ASCII event is acceptable as input. */
211 Lisp_Object unread_switch_frame
;
213 /* Last size recorded for a current buffer which is not a minibuffer. */
214 static ptrdiff_t last_non_minibuf_size
;
216 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
217 uintmax_t num_input_events
;
219 /* Value of num_nonmacro_input_events as of last auto save. */
221 static EMACS_INT last_auto_save
;
223 /* The value of point when the last command was started. */
224 static ptrdiff_t last_point_position
;
226 /* The buffer that was current when the last command was started. */
227 static Lisp_Object last_point_position_buffer
;
229 /* The window that was selected when the last command was started. */
230 static Lisp_Object last_point_position_window
;
232 /* The frame in which the last input event occurred, or Qmacro if the
233 last event came from a macro. We use this to determine when to
234 generate switch-frame events. This may be cleared by functions
235 like Fselect_frame, to make sure that a switch-frame event is
236 generated by the next character. */
237 Lisp_Object internal_last_event_frame
;
239 /* The timestamp of the last input event we received from the X server.
240 X Windows wants this for selection ownership. */
241 Time last_event_timestamp
;
243 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
244 static Lisp_Object Qhandle_select_window
;
245 Lisp_Object QPRIMARY
;
247 static Lisp_Object Qself_insert_command
;
248 static Lisp_Object Qforward_char
;
249 static Lisp_Object Qbackward_char
;
250 Lisp_Object Qundefined
;
251 static Lisp_Object Qtimer_event_handler
;
253 /* read_key_sequence stores here the command definition of the
254 key sequence that it reads. */
255 static Lisp_Object read_key_sequence_cmd
;
256 static Lisp_Object read_key_sequence_remapped
;
258 static Lisp_Object Qinput_method_function
;
260 static Lisp_Object Qdeactivate_mark
;
262 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
264 static Lisp_Object Qecho_area_clear_hook
;
266 /* Hooks to run before and after each command. */
267 static Lisp_Object Qpre_command_hook
;
268 static Lisp_Object Qpost_command_hook
;
270 static Lisp_Object Qdeferred_action_function
;
272 static Lisp_Object Qdelayed_warnings_hook
;
274 static Lisp_Object Qinput_method_exit_on_first_char
;
275 static Lisp_Object Qinput_method_use_echo_area
;
277 static Lisp_Object Qhelp_form_show
;
279 /* File in which we write all commands we read. */
280 static FILE *dribble
;
282 /* Nonzero if input is available. */
285 /* Circular buffer for pre-read keyboard input. */
287 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
289 /* Pointer to next available character in kbd_buffer.
290 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
291 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
292 next available char is in kbd_buffer[0]. */
293 static struct input_event
*kbd_fetch_ptr
;
295 /* Pointer to next place to store character in kbd_buffer. This
296 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
297 character should go in kbd_buffer[0]. */
298 static struct input_event
* volatile kbd_store_ptr
;
300 /* The above pair of variables forms a "queue empty" flag. When we
301 enqueue a non-hook event, we increment kbd_store_ptr. When we
302 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
303 there is input available if the two pointers are not equal.
305 Why not just have a flag set and cleared by the enqueuing and
306 dequeuing functions? Such a flag could be screwed up by interrupts
307 at inopportune times. */
309 /* Symbols to head events. */
310 static Lisp_Object Qmouse_movement
;
311 static Lisp_Object Qscroll_bar_movement
;
312 Lisp_Object Qswitch_frame
;
313 static Lisp_Object Qdelete_frame
;
314 static Lisp_Object Qiconify_frame
;
315 static Lisp_Object Qmake_frame_visible
;
316 static Lisp_Object Qselect_window
;
317 Lisp_Object Qhelp_echo
;
319 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
320 static Lisp_Object Qmouse_fixup_help_message
;
323 /* Symbols to denote kinds of events. */
324 static Lisp_Object Qfunction_key
;
325 Lisp_Object Qmouse_click
;
326 #if defined (WINDOWSNT)
327 Lisp_Object Qlanguage_change
;
329 static Lisp_Object Qdrag_n_drop
;
330 static Lisp_Object Qsave_session
;
332 static Lisp_Object Qdbus_event
;
334 static Lisp_Object Qconfig_changed_event
;
336 /* Lisp_Object Qmouse_movement; - also an event header */
338 /* Properties of event headers. */
339 Lisp_Object Qevent_kind
;
340 static Lisp_Object Qevent_symbol_elements
;
342 /* Menu and tool bar item parts. */
343 static Lisp_Object Qmenu_enable
;
344 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
345 Lisp_Object QCfilter
;
347 /* Non-nil disable property on a command means
348 do not execute it; call disabled-command-function's value instead. */
349 Lisp_Object QCtoggle
, QCradio
;
350 static Lisp_Object QCbutton
, QClabel
;
352 static Lisp_Object QCvert_only
;
354 /* An event header symbol HEAD may have a property named
355 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
356 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
357 mask of modifiers applied to it. If present, this is used to help
358 speed up parse_modifiers. */
359 Lisp_Object Qevent_symbol_element_mask
;
361 /* An unmodified event header BASE may have a property named
362 Qmodifier_cache, which is an alist mapping modifier masks onto
363 modified versions of BASE. If present, this helps speed up
365 static Lisp_Object Qmodifier_cache
;
367 /* Symbols to use for parts of windows. */
368 Lisp_Object Qmode_line
;
369 Lisp_Object Qvertical_line
;
370 static Lisp_Object Qvertical_scroll_bar
;
371 Lisp_Object Qmenu_bar
;
373 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
374 static Lisp_Object
command_loop (void);
375 static Lisp_Object Qextended_command_history
;
376 EMACS_TIME
timer_check (void);
378 static void record_menu_key (Lisp_Object c
);
379 static void echo_now (void);
380 static ptrdiff_t echo_length (void);
382 static Lisp_Object Qpolling_period
;
384 /* Incremented whenever a timer is run. */
387 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
389 EMACS_TIME
*input_available_clear_time
;
391 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
392 Default is 1 if INTERRUPT_INPUT is defined. */
395 /* Nonzero while interrupts are temporarily deferred during redisplay. */
396 int interrupts_deferred
;
398 /* Allow configure to inhibit use of FIONREAD. */
399 #ifdef BROKEN_FIONREAD
403 /* We are unable to use interrupts if FIONREAD is not available,
404 so flush SIGIO so we won't try. */
405 #if !defined (FIONREAD)
411 /* If we support a window system, turn on the code to poll periodically
412 to detect C-g. It isn't actually used when doing interrupt input. */
413 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
414 #define POLL_FOR_INPUT
417 /* The time when Emacs started being idle. */
419 static EMACS_TIME timer_idleness_start_time
;
421 /* After Emacs stops being idle, this saves the last value
422 of timer_idleness_start_time from when it was idle. */
424 static EMACS_TIME timer_last_idleness_start_time
;
427 /* Global variable declarations. */
429 /* Flags for readable_events. */
430 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
431 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
432 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
434 /* Function for init_keyboard to call with no args (if nonzero). */
435 static void (*keyboard_init_hook
) (void);
437 static int read_avail_input (int);
438 static void get_input_pending (int *, int);
439 static int readable_events (int);
440 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
442 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
444 static Lisp_Object
make_lispy_event (struct input_event
*);
445 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
446 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
447 enum scroll_bar_part
,
448 Lisp_Object
, Lisp_Object
,
451 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
452 Lisp_Object
, const char *const *,
453 Lisp_Object
*, ptrdiff_t);
454 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
455 static int help_char_p (Lisp_Object
);
456 static void save_getcjmp (jmp_buf);
457 static void restore_getcjmp (jmp_buf);
458 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
459 static void clear_event (struct input_event
*);
460 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
461 static void interrupt_signal (int signalnum
);
463 static void input_available_signal (int signo
);
465 static void handle_interrupt (void);
466 static _Noreturn
void quit_throw_to_read_char (int);
467 static void process_special_events (void);
468 static void timer_start_idle (void);
469 static void timer_stop_idle (void);
470 static void timer_resume_idle (void);
471 static void handle_user_signal (int);
472 static char *find_user_signal_name (int);
473 static int store_user_signal_events (void);
475 /* These setters are used only in this file, so they can be private. */
477 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (echo_string
) = val
;
482 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
484 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
487 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
489 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
492 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
494 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
497 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
499 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
502 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
504 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
507 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
509 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
512 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
514 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
517 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
519 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
523 /* Add C to the echo string, if echoing is going on.
524 C can be a character, which is printed prettily ("M-C-x" and all that
525 jazz), or a symbol, whose name is printed. */
528 echo_char (Lisp_Object c
)
530 if (current_kboard
->immediate_echo
)
532 int size
= KEY_DESCRIPTION_SIZE
+ 100;
533 char *buffer
= alloca (size
);
535 Lisp_Object echo_string
;
537 echo_string
= KVAR (current_kboard
, echo_string
);
539 /* If someone has passed us a composite event, use its head symbol. */
544 ptr
= push_key_description (XINT (c
), ptr
, 1);
546 else if (SYMBOLP (c
))
548 Lisp_Object name
= SYMBOL_NAME (c
);
549 int nbytes
= SBYTES (name
);
551 if (size
- (ptr
- buffer
) < nbytes
)
553 int offset
= ptr
- buffer
;
554 size
= max (2 * size
, size
+ nbytes
);
555 buffer
= alloca (size
);
556 ptr
= buffer
+ offset
;
559 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
560 STRING_MULTIBYTE (name
), 1);
563 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
566 const char *text
= " (Type ? for further options)";
567 int len
= strlen (text
);
569 if (size
- (ptr
- buffer
) < len
)
571 int offset
= ptr
- buffer
;
573 buffer
= alloca (size
);
574 ptr
= buffer
+ offset
;
577 memcpy (ptr
, text
, len
);
581 /* Replace a dash from echo_dash with a space, otherwise
582 add a space at the end as a separator between keys. */
583 if (STRINGP (echo_string
)
584 && SCHARS (echo_string
) > 1)
586 Lisp_Object last_char
, prev_char
, idx
;
588 idx
= make_number (SCHARS (echo_string
) - 2);
589 prev_char
= Faref (echo_string
, idx
);
591 idx
= make_number (SCHARS (echo_string
) - 1);
592 last_char
= Faref (echo_string
, idx
);
594 /* We test PREV_CHAR to make sure this isn't the echoing
596 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
597 Faset (echo_string
, idx
, make_number (' '));
599 echo_string
= concat2 (echo_string
, build_string (" "));
601 else if (STRINGP (echo_string
))
602 echo_string
= concat2 (echo_string
, build_string (" "));
606 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
612 /* Temporarily add a dash to the end of the echo string if it's not
613 empty, so that it serves as a mini-prompt for the very next character. */
618 /* Do nothing if not echoing at all. */
619 if (NILP (KVAR (current_kboard
, echo_string
)))
622 if (this_command_key_count
== 0)
625 if (!current_kboard
->immediate_echo
626 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
629 /* Do nothing if we just printed a prompt. */
630 if (current_kboard
->echo_after_prompt
631 == SCHARS (KVAR (current_kboard
, echo_string
)))
634 /* Do nothing if we have already put a dash at the end. */
635 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
637 Lisp_Object last_char
, prev_char
, idx
;
639 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
640 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
642 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
643 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
645 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
649 /* Put a dash at the end of the buffer temporarily,
650 but make it go away when the next character is added. */
653 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
657 /* Display the current echo string, and begin echoing if not already
663 if (!current_kboard
->immediate_echo
)
666 current_kboard
->immediate_echo
= 1;
668 for (i
= 0; i
< this_command_key_count
; i
++)
672 /* Set before_command_echo_length to the value that would
673 have been saved before the start of this subcommand in
674 command_loop_1, if we had already been echoing then. */
675 if (i
== this_single_command_key_start
)
676 before_command_echo_length
= echo_length ();
678 c
= AREF (this_command_keys
, i
);
679 if (! (EVENT_HAS_PARAMETERS (c
)
680 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
684 /* Set before_command_echo_length to the value that would
685 have been saved before the start of this subcommand in
686 command_loop_1, if we had already been echoing then. */
687 if (this_command_key_count
== this_single_command_key_start
)
688 before_command_echo_length
= echo_length ();
690 /* Put a dash at the end to invite the user to type more. */
695 message3_nolog (KVAR (current_kboard
, echo_string
),
696 SBYTES (KVAR (current_kboard
, echo_string
)),
697 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
700 /* Record in what buffer we echoed, and from which kboard. */
701 echo_message_buffer
= echo_area_buffer
[0];
702 echo_kboard
= current_kboard
;
704 if (waiting_for_input
&& !NILP (Vquit_flag
))
705 quit_throw_to_read_char (0);
708 /* Turn off echoing, for the start of a new command. */
711 cancel_echoing (void)
713 current_kboard
->immediate_echo
= 0;
714 current_kboard
->echo_after_prompt
= -1;
715 kset_echo_string (current_kboard
, Qnil
);
716 ok_to_echo_at_next_pause
= NULL
;
718 echo_message_buffer
= Qnil
;
721 /* Return the length of the current echo string. */
726 return (STRINGP (KVAR (current_kboard
, echo_string
))
727 ? SCHARS (KVAR (current_kboard
, echo_string
))
731 /* Truncate the current echo message to its first LEN chars.
732 This and echo_char get used by read_key_sequence when the user
733 switches frames while entering a key sequence. */
736 echo_truncate (ptrdiff_t nchars
)
738 if (STRINGP (KVAR (current_kboard
, echo_string
)))
739 kset_echo_string (current_kboard
,
740 Fsubstring (KVAR (current_kboard
, echo_string
),
741 make_number (0), make_number (nchars
)));
742 truncate_echo_area (nchars
);
746 /* Functions for manipulating this_command_keys. */
748 add_command_key (Lisp_Object key
)
750 #if 0 /* Not needed after we made Freset_this_command_lengths
751 do the job immediately. */
752 /* If reset-this-command-length was called recently, obey it now.
753 See the doc string of that function for an explanation of why. */
754 if (before_command_restore_flag
)
756 this_command_key_count
= before_command_key_count_1
;
757 if (this_command_key_count
< this_single_command_key_start
)
758 this_single_command_key_start
= this_command_key_count
;
759 echo_truncate (before_command_echo_length_1
);
760 before_command_restore_flag
= 0;
764 if (this_command_key_count
>= ASIZE (this_command_keys
))
765 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
767 ASET (this_command_keys
, this_command_key_count
, key
);
768 ++this_command_key_count
;
773 recursive_edit_1 (void)
775 ptrdiff_t count
= SPECPDL_INDEX ();
778 if (command_loop_level
> 0)
780 specbind (Qstandard_output
, Qt
);
781 specbind (Qstandard_input
, Qt
);
784 #ifdef HAVE_WINDOW_SYSTEM
785 /* The command loop has started an hourglass timer, so we have to
786 cancel it here, otherwise it will fire because the recursive edit
787 can take some time. Do not check for display_hourglass_p here,
788 because it could already be nil. */
792 /* This function may have been called from a debugger called from
793 within redisplay, for instance by Edebugging a function called
794 from fontification-functions. We want to allow redisplay in
795 the debugging session.
797 The recursive edit is left with a `(throw exit ...)'. The `exit'
798 tag is not caught anywhere in redisplay, i.e. when we leave the
799 recursive edit, the original redisplay leading to the recursive
800 edit will be unwound. The outcome should therefore be safe. */
801 specbind (Qinhibit_redisplay
, Qnil
);
804 val
= command_loop ();
806 Fsignal (Qquit
, Qnil
);
807 /* Handle throw from read_minibuf when using minibuffer
808 while it's active but we're in another window. */
810 xsignal1 (Qerror
, val
);
812 return unbind_to (count
, Qnil
);
815 /* When an auto-save happens, record the "time", and don't do again soon. */
818 record_auto_save (void)
820 last_auto_save
= num_nonmacro_input_events
;
823 /* Make an auto save happen as soon as possible at command level. */
827 force_auto_save_soon (void)
829 last_auto_save
= - auto_save_interval
- 1;
831 record_asynch_buffer_change ();
835 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
836 doc
: /* Invoke the editor command loop recursively.
837 To get out of the recursive edit, a command can do `(throw 'exit nil)';
838 that tells this function to return.
839 Alternatively, `(throw 'exit t)' makes this function signal an error.
840 This function is called by the editor initialization to begin editing. */)
843 ptrdiff_t count
= SPECPDL_INDEX ();
846 /* If we enter while input is blocked, don't lock up here.
847 This may happen through the debugger during redisplay. */
851 command_loop_level
++;
852 update_mode_lines
= 1;
854 if (command_loop_level
855 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
856 buffer
= Fcurrent_buffer ();
860 /* If we leave recursive_edit_1 below with a `throw' for instance,
861 like it is done in the splash screen display, we have to
862 make sure that we restore single_kboard as command_loop_1
863 would have done if it were left normally. */
864 if (command_loop_level
> 0)
865 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
866 record_unwind_protect (recursive_edit_unwind
, buffer
);
869 return unbind_to (count
, Qnil
);
873 recursive_edit_unwind (Lisp_Object buffer
)
875 if (BUFFERP (buffer
))
876 Fset_buffer (buffer
);
878 command_loop_level
--;
879 update_mode_lines
= 1;
884 #if 0 /* These two functions are now replaced with
885 temporarily_switch_to_single_kboard. */
889 #if 0 /* Theory: if there's anything in Vunread_command_events,
890 it will right away be read by read_key_sequence,
891 and then if we do switch KBOARDS, it will go into the side
892 queue then. So we don't need to do anything special here -- rms. */
893 if (CONSP (Vunread_command_events
))
895 current_kboard
->kbd_queue
896 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
897 current_kboard
->kbd_queue_has_data
= 1;
899 Vunread_command_events
= Qnil
;
904 /* Switch to the single-kboard state, making current_kboard
905 the only KBOARD from which further input is accepted. */
908 single_kboard_state ()
914 /* If we're in single_kboard state for kboard KBOARD,
918 not_single_kboard_state (KBOARD
*kboard
)
920 if (kboard
== current_kboard
)
924 /* Maintain a stack of kboards, so other parts of Emacs
925 can switch temporarily to the kboard of a given frame
926 and then revert to the previous status. */
931 struct kboard_stack
*next
;
934 static struct kboard_stack
*kboard_stack
;
937 push_kboard (struct kboard
*k
)
939 struct kboard_stack
*p
= xmalloc (sizeof *p
);
941 p
->next
= kboard_stack
;
942 p
->kboard
= current_kboard
;
952 struct kboard_stack
*p
= kboard_stack
;
954 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
956 if (t
->kboard
== p
->kboard
)
958 current_kboard
= p
->kboard
;
965 /* The terminal we remembered has been deleted. */
966 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
969 kboard_stack
= p
->next
;
973 /* Switch to single_kboard mode, making current_kboard the only KBOARD
974 from which further input is accepted. If F is non-nil, set its
975 KBOARD as the current keyboard.
977 This function uses record_unwind_protect to return to the previous
980 If Emacs is already in single_kboard mode, and F's keyboard is
981 locked, then this function will throw an error. */
984 temporarily_switch_to_single_kboard (struct frame
*f
)
986 int was_locked
= single_kboard
;
989 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
990 /* We can not switch keyboards while in single_kboard mode.
991 In rare cases, Lisp code may call `recursive-edit' (or
992 `read-minibuffer' or `y-or-n-p') after it switched to a
993 locked frame. For example, this is likely to happen
994 when server.el connects to a new terminal while Emacs is in
995 single_kboard mode. It is best to throw an error instead
996 of presenting the user with a frozen screen. */
997 error ("Terminal %d is locked, cannot read from it",
998 FRAME_TERMINAL (f
)->id
);
1000 /* This call is unnecessary, but helps
1001 `restore_kboard_configuration' discover if somebody changed
1002 `current_kboard' behind our back. */
1003 push_kboard (current_kboard
);
1006 current_kboard
= FRAME_KBOARD (f
);
1008 record_unwind_protect (restore_kboard_configuration
,
1009 (was_locked
? Qt
: Qnil
));
1012 #if 0 /* This function is not needed anymore. */
1014 record_single_kboard_state ()
1017 push_kboard (current_kboard
);
1018 record_unwind_protect (restore_kboard_configuration
,
1019 (single_kboard
? Qt
: Qnil
));
1024 restore_kboard_configuration (Lisp_Object was_locked
)
1026 if (NILP (was_locked
))
1030 struct kboard
*prev
= current_kboard
;
1033 /* The pop should not change the kboard. */
1034 if (single_kboard
&& current_kboard
!= prev
)
1041 /* Handle errors that are not handled at inner levels
1042 by printing an error message and returning to the editor command loop. */
1045 cmd_error (Lisp_Object data
)
1047 Lisp_Object old_level
, old_length
;
1048 char macroerror
[sizeof "After..kbd macro iterations: "
1049 + INT_STRLEN_BOUND (EMACS_INT
)];
1051 #ifdef HAVE_WINDOW_SYSTEM
1052 if (display_hourglass_p
)
1053 cancel_hourglass ();
1056 if (!NILP (executing_kbd_macro
))
1058 if (executing_kbd_macro_iterations
== 1)
1059 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1061 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1062 executing_kbd_macro_iterations
);
1067 Vstandard_output
= Qt
;
1068 Vstandard_input
= Qt
;
1069 Vexecuting_kbd_macro
= Qnil
;
1070 executing_kbd_macro
= Qnil
;
1071 kset_prefix_arg (current_kboard
, Qnil
);
1072 kset_last_prefix_arg (current_kboard
, Qnil
);
1075 /* Avoid unquittable loop if data contains a circular list. */
1076 old_level
= Vprint_level
;
1077 old_length
= Vprint_length
;
1078 XSETFASTINT (Vprint_level
, 10);
1079 XSETFASTINT (Vprint_length
, 10);
1080 cmd_error_internal (data
, macroerror
);
1081 Vprint_level
= old_level
;
1082 Vprint_length
= old_length
;
1086 Vinhibit_quit
= Qnil
;
1087 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1088 if (command_loop_level
== 0 && minibuf_level
== 0)
1089 any_kboard_state ();
1092 return make_number (0);
1095 /* Take actions on handling an error. DATA is the data that describes
1098 CONTEXT is a C-string containing ASCII characters only which
1099 describes the context in which the error happened. If we need to
1100 generalize CONTEXT to allow multibyte characters, make it a Lisp
1104 cmd_error_internal (Lisp_Object data
, const char *context
)
1106 struct frame
*sf
= SELECTED_FRAME ();
1108 /* The immediate context is not interesting for Quits,
1109 since they are asynchronous. */
1110 if (EQ (XCAR (data
), Qquit
))
1111 Vsignaling_function
= Qnil
;
1116 /* Use user's specified output function if any. */
1117 if (!NILP (Vcommand_error_function
))
1118 call3 (Vcommand_error_function
, data
,
1119 context
? build_string (context
) : empty_unibyte_string
,
1120 Vsignaling_function
);
1121 /* If the window system or terminal frame hasn't been initialized
1122 yet, or we're not interactive, write the message to stderr and exit. */
1123 else if (!sf
->glyphs_initialized_p
1124 /* The initial frame is a special non-displaying frame. It
1125 will be current in daemon mode when there are no frames
1126 to display, and in non-daemon mode before the real frame
1127 has finished initializing. If an error is thrown in the
1128 latter case while creating the frame, then the frame
1129 will never be displayed, so the safest thing to do is
1130 write to stderr and quit. In daemon mode, there are
1131 many other potential errors that do not prevent frames
1132 from being created, so continuing as normal is better in
1134 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1137 print_error_message (data
, Qexternal_debugging_output
,
1138 context
, Vsignaling_function
);
1139 Fterpri (Qexternal_debugging_output
);
1140 Fkill_emacs (make_number (-1));
1144 clear_message (1, 0);
1146 message_log_maybe_newline ();
1149 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1152 Vsignaling_function
= Qnil
;
1155 Lisp_Object
command_loop_1 (void);
1156 static Lisp_Object
command_loop_2 (Lisp_Object
);
1157 static Lisp_Object
top_level_1 (Lisp_Object
);
1159 /* Entry to editor-command-loop.
1160 This level has the catches for exiting/returning to editor command loop.
1161 It returns nil to exit recursive edit, t to abort it. */
1166 if (command_loop_level
> 0 || minibuf_level
> 0)
1169 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1170 executing_kbd_macro
= Qnil
;
1176 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1177 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1178 /* Reset single_kboard in case top-level set it while
1179 evaluating an -f option, or we are stuck there for some
1181 any_kboard_state ();
1183 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1184 executing_kbd_macro
= Qnil
;
1186 /* End of file in -batch run causes exit here. */
1192 /* Here we catch errors in execution of commands within the
1193 editing loop, and reenter the editing loop.
1194 When there is an error, cmd_error runs and returns a non-nil
1195 value to us. A value of nil means that command_loop_1 itself
1196 returned due to end of file (or end of kbd macro). */
1199 command_loop_2 (Lisp_Object ignore
)
1201 register Lisp_Object val
;
1204 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1205 while (!NILP (val
));
1213 return Feval (Vtop_level
, Qnil
);
1217 top_level_1 (Lisp_Object ignore
)
1219 /* On entry to the outer level, run the startup file */
1220 if (!NILP (Vtop_level
))
1221 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1222 else if (!NILP (Vpurify_flag
))
1223 message ("Bare impure Emacs (standard Lisp code not loaded)");
1225 message ("Bare Emacs (standard Lisp code not loaded)");
1229 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1230 doc
: /* Exit all recursive editing levels.
1231 This also exits all active minibuffers. */)
1234 #ifdef HAVE_WINDOW_SYSTEM
1235 if (display_hourglass_p
)
1236 cancel_hourglass ();
1239 /* Unblock input if we enter with input blocked. This may happen if
1240 redisplay traps e.g. during tool-bar update with input blocked. */
1241 while (INPUT_BLOCKED_P
)
1244 Fthrow (Qtop_level
, Qnil
);
1247 static _Noreturn
void
1248 user_error (const char *msg
)
1250 xsignal1 (Quser_error
, build_string (msg
));
1254 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1255 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1258 if (command_loop_level
> 0 || minibuf_level
> 0)
1259 Fthrow (Qexit
, Qnil
);
1261 user_error ("No recursive edit is in progress");
1265 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1266 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1269 if (command_loop_level
> 0 || minibuf_level
> 0)
1272 user_error ("No recursive edit is in progress");
1275 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1277 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1278 of this function. */
1281 tracking_off (Lisp_Object old_value
)
1283 do_mouse_tracking
= old_value
;
1284 if (NILP (old_value
))
1286 /* Redisplay may have been preempted because there was input
1287 available, and it assumes it will be called again after the
1288 input has been processed. If the only input available was
1289 the sort that we have just disabled, then we need to call
1291 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1293 redisplay_preserve_echo_area (6);
1294 get_input_pending (&input_pending
,
1295 READABLE_EVENTS_DO_TIMERS_NOW
);
1301 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1302 doc
: /* Evaluate BODY with mouse movement events enabled.
1303 Within a `track-mouse' form, mouse motion generates input events that
1304 you can read with `read-event'.
1305 Normally, mouse motion is ignored.
1306 usage: (track-mouse BODY...) */)
1309 ptrdiff_t count
= SPECPDL_INDEX ();
1312 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1314 do_mouse_tracking
= Qt
;
1316 val
= Fprogn (args
);
1317 return unbind_to (count
, val
);
1320 /* If mouse has moved on some frame, return one of those frames.
1324 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1325 after resizing the tool-bar window. */
1327 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1330 int ignore_mouse_drag_p
;
1333 some_mouse_moved (void)
1335 Lisp_Object tail
, frame
;
1337 if (ignore_mouse_drag_p
)
1339 /* ignore_mouse_drag_p = 0; */
1343 FOR_EACH_FRAME (tail
, frame
)
1345 if (XFRAME (frame
)->mouse_moved
)
1346 return XFRAME (frame
);
1352 #endif /* HAVE_MOUSE || HAVE_GPM */
1354 /* This is the actual command reading loop,
1355 sans error-handling encapsulation. */
1357 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1359 void safe_run_hooks (Lisp_Object
);
1360 static void adjust_point_for_property (ptrdiff_t, int);
1362 /* Cancel hourglass from protect_unwind.
1364 #ifdef HAVE_WINDOW_SYSTEM
1366 cancel_hourglass_unwind (Lisp_Object arg
)
1368 cancel_hourglass ();
1373 /* The last boundary auto-added to buffer-undo-list. */
1374 Lisp_Object last_undo_boundary
;
1376 /* FIXME: This is wrong rather than test window-system, we should call
1377 a new set-selection, which will then dispatch to x-set-selection, or
1378 tty-set-selection, or w32-set-selection, ... */
1381 command_loop_1 (void)
1384 Lisp_Object keybuf
[30];
1386 EMACS_INT prev_modiff
= 0;
1387 struct buffer
*prev_buffer
= NULL
;
1388 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1389 int was_locked
= single_kboard
;
1391 int already_adjusted
= 0;
1393 kset_prefix_arg (current_kboard
, Qnil
);
1394 kset_last_prefix_arg (current_kboard
, Qnil
);
1395 Vdeactivate_mark
= Qnil
;
1396 waiting_for_input
= 0;
1399 this_command_key_count
= 0;
1400 this_command_key_count_reset
= 0;
1401 this_single_command_key_start
= 0;
1403 if (NILP (Vmemory_full
))
1405 /* Make sure this hook runs after commands that get errors and
1406 throw to top level. */
1407 /* Note that the value cell will never directly contain nil
1408 if the symbol is a local variable. */
1409 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1410 safe_run_hooks (Qpost_command_hook
);
1412 /* If displaying a message, resize the echo area window to fit
1413 that message's size exactly. */
1414 if (!NILP (echo_area_buffer
[0]))
1415 resize_echo_area_exactly ();
1417 /* If there are warnings waiting, process them. */
1418 if (!NILP (Vdelayed_warnings_list
))
1419 safe_run_hooks (Qdelayed_warnings_hook
);
1421 if (!NILP (Vdeferred_action_list
))
1422 safe_run_hooks (Qdeferred_action_function
);
1425 /* Do this after running Vpost_command_hook, for consistency. */
1426 kset_last_command (current_kboard
, Vthis_command
);
1427 kset_real_last_command (current_kboard
, Vreal_this_command
);
1428 if (!CONSP (last_command_event
))
1429 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1433 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1436 /* Make sure the current window's buffer is selected. */
1437 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1438 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1440 /* Display any malloc warning that just came out. Use while because
1441 displaying one warning can cause another. */
1443 while (pending_malloc_warning
)
1444 display_malloc_warning ();
1446 Vdeactivate_mark
= Qnil
;
1448 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1450 /* Don't ignore mouse movements for more than a single command
1451 loop. (This flag is set in xdisp.c whenever the tool bar is
1452 resized, because the resize moves text up or down, and would
1453 generate false mouse drag events if we don't ignore them.) */
1454 ignore_mouse_drag_p
= 0;
1457 /* If minibuffer on and echo area in use,
1458 wait a short time and redraw minibuffer. */
1461 && !NILP (echo_area_buffer
[0])
1462 && EQ (minibuf_window
, echo_area_window
)
1463 && NUMBERP (Vminibuffer_message_timeout
))
1465 /* Bind inhibit-quit to t so that C-g gets read in
1466 rather than quitting back to the minibuffer. */
1467 ptrdiff_t count
= SPECPDL_INDEX ();
1468 specbind (Qinhibit_quit
, Qt
);
1470 sit_for (Vminibuffer_message_timeout
, 0, 2);
1472 /* Clear the echo area. */
1474 safe_run_hooks (Qecho_area_clear_hook
);
1476 unbind_to (count
, Qnil
);
1478 /* If a C-g came in before, treat it as input now. */
1479 if (!NILP (Vquit_flag
))
1482 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1487 /* Select the frame that the last event came from. Usually,
1488 switch-frame events will take care of this, but if some lisp
1489 code swallows a switch-frame event, we'll fix things up here.
1490 Is this a good idea? */
1491 if (FRAMEP (internal_last_event_frame
)
1492 && !EQ (internal_last_event_frame
, selected_frame
))
1493 Fselect_frame (internal_last_event_frame
, Qnil
);
1495 /* If it has changed current-menubar from previous value,
1496 really recompute the menubar from the value. */
1497 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1498 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1499 call0 (Qrecompute_lucid_menubar
);
1501 before_command_key_count
= this_command_key_count
;
1502 before_command_echo_length
= echo_length ();
1504 Vthis_command
= Qnil
;
1505 Vreal_this_command
= Qnil
;
1506 Vthis_original_command
= Qnil
;
1507 Vthis_command_keys_shift_translated
= Qnil
;
1509 /* Read next key sequence; i gets its length. */
1510 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1513 /* A filter may have run while we were reading the input. */
1514 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1516 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1517 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1521 /* Now we have read a key sequence of length I,
1522 or else I is 0 and we found end of file. */
1524 if (i
== 0) /* End of file -- happens only in */
1525 return Qnil
; /* a kbd macro, at the end. */
1526 /* -1 means read_key_sequence got a menu that was rejected.
1527 Just loop around and read another command. */
1531 this_command_key_count
= 0;
1532 this_command_key_count_reset
= 0;
1533 this_single_command_key_start
= 0;
1537 last_command_event
= keybuf
[i
- 1];
1539 /* If the previous command tried to force a specific window-start,
1540 forget about that, in case this command moves point far away
1541 from that position. But also throw away beg_unchanged and
1542 end_unchanged information in that case, so that redisplay will
1543 update the whole window properly. */
1544 if (XWINDOW (selected_window
)->force_start
)
1547 XWINDOW (selected_window
)->force_start
= 0;
1548 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1549 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1552 cmd
= read_key_sequence_cmd
;
1553 if (!NILP (Vexecuting_kbd_macro
))
1555 if (!NILP (Vquit_flag
))
1557 Vexecuting_kbd_macro
= Qt
;
1558 QUIT
; /* Make some noise. */
1559 /* Will return since macro now empty. */
1563 /* Do redisplay processing after this command except in special
1564 cases identified below. */
1565 prev_buffer
= current_buffer
;
1566 prev_modiff
= MODIFF
;
1567 last_point_position
= PT
;
1568 last_point_position_window
= selected_window
;
1569 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1571 /* By default, we adjust point to a boundary of a region that
1572 has such a property that should be treated intangible
1573 (e.g. composition, display). But, some commands will set
1574 this variable differently. */
1575 Vdisable_point_adjustment
= Qnil
;
1577 /* Process filters and timers may have messed with deactivate-mark.
1578 reset it before we execute the command. */
1579 Vdeactivate_mark
= Qnil
;
1581 /* Remap command through active keymaps. */
1582 Vthis_original_command
= cmd
;
1583 if (!NILP (read_key_sequence_remapped
))
1584 cmd
= read_key_sequence_remapped
;
1586 /* Execute the command. */
1588 Vthis_command
= cmd
;
1589 Vreal_this_command
= cmd
;
1590 safe_run_hooks (Qpre_command_hook
);
1592 already_adjusted
= 0;
1594 if (NILP (Vthis_command
))
1596 /* nil means key is undefined. */
1597 Lisp_Object keys
= Fvector (i
, keybuf
);
1598 keys
= Fkey_description (keys
, Qnil
);
1600 message_with_string ("%s is undefined", keys
, 0);
1601 kset_defining_kbd_macro (current_kboard
, Qnil
);
1602 update_mode_lines
= 1;
1603 /* If this is a down-mouse event, don't reset prefix-arg;
1604 pass it to the command run by the up event. */
1605 if (EVENT_HAS_PARAMETERS (last_command_event
))
1607 Lisp_Object breakdown
1608 = parse_modifiers (EVENT_HEAD (last_command_event
));
1609 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1610 if (!(modifiers
& down_modifier
))
1611 kset_prefix_arg (current_kboard
, Qnil
);
1614 kset_prefix_arg (current_kboard
, Qnil
);
1618 /* Here for a command that isn't executed directly. */
1620 #ifdef HAVE_WINDOW_SYSTEM
1621 ptrdiff_t scount
= SPECPDL_INDEX ();
1623 if (display_hourglass_p
1624 && NILP (Vexecuting_kbd_macro
))
1626 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1631 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1633 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1636 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1637 ? Qnil
: BVAR (current_buffer
, undo_list
));
1639 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1641 #ifdef HAVE_WINDOW_SYSTEM
1642 /* Do not check display_hourglass_p here, because
1643 Fcommand_execute could change it, but we should cancel
1644 hourglass cursor anyway.
1645 But don't cancel the hourglass within a macro
1646 just because a command in the macro finishes. */
1647 if (NILP (Vexecuting_kbd_macro
))
1648 unbind_to (scount
, Qnil
);
1651 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1653 safe_run_hooks (Qpost_command_hook
);
1655 /* If displaying a message, resize the echo area window to fit
1656 that message's size exactly. */
1657 if (!NILP (echo_area_buffer
[0]))
1658 resize_echo_area_exactly ();
1660 /* If there are warnings waiting, process them. */
1661 if (!NILP (Vdelayed_warnings_list
))
1662 safe_run_hooks (Qdelayed_warnings_hook
);
1664 safe_run_hooks (Qdeferred_action_function
);
1666 /* If there is a prefix argument,
1667 1) We don't want Vlast_command to be ``universal-argument''
1668 (that would be dumb), so don't set Vlast_command,
1669 2) we want to leave echoing on so that the prefix will be
1670 echoed as part of this key sequence, so don't call
1672 3) we want to leave this_command_key_count non-zero, so that
1673 read_char will realize that it is re-reading a character, and
1674 not echo it a second time.
1676 If the command didn't actually create a prefix arg,
1677 but is merely a frame event that is transparent to prefix args,
1678 then the above doesn't apply. */
1679 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1680 || CONSP (last_command_event
))
1682 kset_last_command (current_kboard
, Vthis_command
);
1683 kset_real_last_command (current_kboard
, Vreal_this_command
);
1684 if (!CONSP (last_command_event
))
1685 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1687 this_command_key_count
= 0;
1688 this_command_key_count_reset
= 0;
1689 this_single_command_key_start
= 0;
1692 if (!NILP (BVAR (current_buffer
, mark_active
))
1693 && !NILP (Vrun_hooks
))
1695 /* In Emacs 22, setting transient-mark-mode to `only' was a
1696 way of turning it on for just one command. This usage is
1697 obsolete, but support it anyway. */
1698 if (EQ (Vtransient_mark_mode
, Qidentity
))
1699 Vtransient_mark_mode
= Qnil
;
1700 else if (EQ (Vtransient_mark_mode
, Qonly
))
1701 Vtransient_mark_mode
= Qidentity
;
1703 if (!NILP (Vdeactivate_mark
))
1704 /* If `select-active-regions' is non-nil, this call to
1705 `deactivate-mark' also sets the PRIMARY selection. */
1706 call0 (Qdeactivate_mark
);
1709 /* Even if not deactivating the mark, set PRIMARY if
1710 `select-active-regions' is non-nil. */
1711 if (!NILP (Fwindow_system (Qnil
))
1712 /* Even if mark_active is non-nil, the actual buffer
1713 marker may not have been set yet (Bug#7044). */
1714 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1715 && (EQ (Vselect_active_regions
, Qonly
)
1716 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1717 : (!NILP (Vselect_active_regions
)
1718 && !NILP (Vtransient_mark_mode
)))
1719 && NILP (Fmemq (Vthis_command
,
1720 Vselection_inhibit_update_commands
)))
1723 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1726 call2 (Qx_set_selection
, QPRIMARY
,
1727 make_buffer_string (beg
, end
, 0));
1729 call2 (Qx_set_selection
, QPRIMARY
,
1730 make_buffer_string (end
, beg
, 0));
1731 /* Don't set empty selections. */
1734 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1736 Lisp_Object hook
= intern ("activate-mark-hook");
1737 Frun_hooks (1, &hook
);
1741 Vsaved_region_selection
= Qnil
;
1746 if (current_buffer
== prev_buffer
1747 && last_point_position
!= PT
1748 && NILP (Vdisable_point_adjustment
)
1749 && NILP (Vglobal_disable_point_adjustment
))
1751 if (last_point_position
> BEGV
1752 && last_point_position
< ZV
1753 && (composition_adjust_point (last_point_position
,
1754 last_point_position
)
1755 != last_point_position
))
1756 /* The last point was temporarily set within a grapheme
1757 cluster to prevent automatic composition. To recover
1758 the automatic composition, we must update the
1760 windows_or_buffers_changed
++;
1761 if (!already_adjusted
)
1762 adjust_point_for_property (last_point_position
,
1763 MODIFF
!= prev_modiff
);
1766 /* Install chars successfully executed in kbd macro. */
1768 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1769 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1770 finalize_kbd_macro_chars ();
1771 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1773 any_kboard_state ();
1778 /* Adjust point to a boundary of a region that has such a property
1779 that should be treated intangible. For the moment, we check
1780 `composition', `display' and `invisible' properties.
1781 LAST_PT is the last position of point. */
1784 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1787 Lisp_Object val
, overlay
, tmp
;
1788 /* When called after buffer modification, we should temporarily
1789 suppress the point adjustment for automatic composition so that a
1790 user can keep inserting another character at point or keep
1791 deleting characters around point. */
1792 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1793 ptrdiff_t orig_pt
= PT
;
1795 /* FIXME: cycling is probably not necessary because these properties
1796 can't be usefully combined anyway. */
1797 while (check_composition
|| check_display
|| check_invisible
)
1799 /* FIXME: check `intangible'. */
1800 if (check_composition
1801 && PT
> BEGV
&& PT
< ZV
1802 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1805 check_display
= check_invisible
= 1;
1807 check_composition
= 0;
1809 && PT
> BEGV
&& PT
< ZV
1810 && !NILP (val
= get_char_property_and_overlay
1811 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1812 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1813 && (!OVERLAYP (overlay
)
1814 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1815 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1816 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1817 && (beg
< PT
/* && end > PT <- It's always the case. */
1818 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1821 SET_PT (PT
< last_pt
1822 ? (STRINGP (val
) && SCHARS (val
) == 0
1823 ? max (beg
- 1, BEGV
)
1826 check_composition
= check_invisible
= 1;
1829 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1831 int inv
, ellipsis
= 0;
1834 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1837 /* FIXME: We should stop if we find a spot between
1838 two runs of `invisible' where inserted text would
1839 be visible. This is important when we have two
1840 invisible boundaries that enclose an area: if the
1841 area is empty, we need this test in order to make
1842 it possible to place point in the middle rather
1843 than skip both boundaries. However, this code
1844 also stops anywhere in a non-sticky text-property,
1845 which breaks (e.g.) Org mode. */
1846 && (val
= get_pos_property (make_number (end
),
1848 TEXT_PROP_MEANS_INVISIBLE (val
))
1850 && !NILP (val
= get_char_property_and_overlay
1851 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1852 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1854 ellipsis
= ellipsis
|| inv
> 1
1855 || (OVERLAYP (overlay
)
1856 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1857 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1858 tmp
= Fnext_single_char_property_change
1859 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1860 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1864 && (val
= get_pos_property (make_number (beg
),
1866 TEXT_PROP_MEANS_INVISIBLE (val
))
1868 && !NILP (val
= get_char_property_and_overlay
1869 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1870 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1872 ellipsis
= ellipsis
|| inv
> 1
1873 || (OVERLAYP (overlay
)
1874 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1875 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1876 tmp
= Fprevious_single_char_property_change
1877 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1878 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1881 /* Move away from the inside area. */
1882 if (beg
< PT
&& end
> PT
)
1884 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1885 /* We haven't moved yet (so we don't need to fear
1886 infinite-looping) and we were outside the range
1887 before (so either end of the range still corresponds
1888 to a move in the right direction): pretend we moved
1889 less than we actually did, so that we still have
1890 more freedom below in choosing which end of the range
1892 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1893 /* We either have moved already or the last point
1894 was already in the range: we don't get to choose
1895 which end of the range we have to go to. */
1896 : (PT
< last_pt
? beg
: end
));
1897 check_composition
= check_display
= 1;
1899 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1900 the point to something other than its argument, due to
1901 point-motion hooks, intangibility, etc. */
1902 eassert (PT
== beg
|| PT
== end
);
1905 /* Pretend the area doesn't exist if the buffer is not
1907 if (!modified
&& !ellipsis
&& beg
< end
)
1909 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1910 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1911 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1912 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1913 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1914 /* We've already moved as far as we can. Trying to go
1915 to the other end would mean moving backwards and thus
1916 could lead to an infinite loop. */
1918 else if (val
= get_pos_property (make_number (PT
),
1920 TEXT_PROP_MEANS_INVISIBLE (val
)
1921 && (val
= get_pos_property
1922 (make_number (PT
== beg
? end
: beg
),
1924 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1925 (check_composition
= check_display
= 1,
1926 SET_PT (PT
== beg
? end
: beg
));
1929 check_invisible
= 0;
1933 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1936 safe_run_hooks_1 (void)
1938 eassert (CONSP (Vinhibit_quit
));
1939 return call0 (XCDR (Vinhibit_quit
));
1942 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1946 safe_run_hooks_error (Lisp_Object error_data
)
1949 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1950 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1951 Lisp_Object args
[4];
1952 args
[0] = build_string ("Error in %s (%s): %S");
1955 args
[3] = error_data
;
1961 Lisp_Object newval
= Qnil
;
1962 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1963 if (EQ (fun
, XCAR (val
)))
1966 newval
= Fcons (XCAR (val
), newval
);
1968 return Fset (hook
, Fnreverse (newval
));
1969 /* Not found in the local part of the hook. Let's look at the global
1972 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1973 : Fdefault_value (hook
));
1974 CONSP (val
); val
= XCDR (val
))
1975 if (EQ (fun
, XCAR (val
)))
1978 newval
= Fcons (XCAR (val
), newval
);
1980 return Fset_default (hook
, Fnreverse (newval
));
1986 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1988 eassert (nargs
== 1);
1989 if (CONSP (Vinhibit_quit
))
1990 XSETCDR (Vinhibit_quit
, args
[0]);
1992 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1994 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1998 /* If we get an error while running the hook, cause the hook variable
1999 to be nil. Also inhibit quits, so that C-g won't cause the hook
2000 to mysteriously evaporate. */
2003 safe_run_hooks (Lisp_Object hook
)
2005 /* FIXME: our `internal_condition_case' does not provide any way to pass data
2006 to its body or to its handlers other than via globals such as
2007 dynamically-bound variables ;-) */
2008 ptrdiff_t count
= SPECPDL_INDEX ();
2009 specbind (Qinhibit_quit
, hook
);
2011 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
2013 unbind_to (count
, Qnil
);
2017 /* Nonzero means polling for input is temporarily suppressed. */
2019 int poll_suppress_count
;
2021 /* Asynchronous timer for polling. */
2023 static struct atimer
*poll_timer
;
2026 #ifdef POLL_FOR_INPUT
2028 /* Poll for input, so that we catch a C-g if it comes in. This
2029 function is called from x_make_frame_visible, see comment
2033 poll_for_input_1 (void)
2035 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2036 doing anything dangerous. */
2040 if (interrupt_input_blocked
== 0
2041 && !waiting_for_input
)
2042 read_avail_input (0);
2048 /* Timer callback function for poll_timer. TIMER is equal to
2052 poll_for_input (struct atimer
*timer
)
2054 if (poll_suppress_count
== 0)
2057 interrupt_input_pending
= 1;
2058 pending_signals
= 1;
2060 poll_for_input_1 ();
2065 #endif /* POLL_FOR_INPUT */
2067 /* Begin signals to poll for input, if they are appropriate.
2068 This function is called unconditionally from various places. */
2071 start_polling (void)
2073 #ifdef POLL_FOR_INPUT
2074 /* XXX This condition was (read_socket_hook && !interrupt_input),
2075 but read_socket_hook is not global anymore. Let's pretend that
2077 if (!interrupt_input
)
2079 /* Turn alarm handling on unconditionally. It might have
2080 been turned off in process.c. */
2081 turn_on_atimers (1);
2083 /* If poll timer doesn't exist, are we need one with
2084 a different interval, start a new one. */
2085 if (poll_timer
== NULL
2086 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2088 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2089 EMACS_TIME interval
= make_emacs_time (period
, 0);
2092 cancel_atimer (poll_timer
);
2094 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2095 poll_for_input
, NULL
);
2098 /* Let the timer's callback function poll for input
2099 if this becomes zero. */
2100 --poll_suppress_count
;
2105 /* Nonzero if we are using polling to handle input asynchronously. */
2108 input_polling_used (void)
2110 #ifdef POLL_FOR_INPUT
2111 /* XXX This condition was (read_socket_hook && !interrupt_input),
2112 but read_socket_hook is not global anymore. Let's pretend that
2114 return !interrupt_input
;
2120 /* Turn off polling. */
2125 #ifdef POLL_FOR_INPUT
2126 /* XXX This condition was (read_socket_hook && !interrupt_input),
2127 but read_socket_hook is not global anymore. Let's pretend that
2129 if (!interrupt_input
)
2130 ++poll_suppress_count
;
2134 /* Set the value of poll_suppress_count to COUNT
2135 and start or stop polling accordingly. */
2138 set_poll_suppress_count (int count
)
2140 #ifdef POLL_FOR_INPUT
2141 if (count
== 0 && poll_suppress_count
!= 0)
2143 poll_suppress_count
= 1;
2146 else if (count
!= 0 && poll_suppress_count
== 0)
2150 poll_suppress_count
= count
;
2154 /* Bind polling_period to a value at least N.
2155 But don't decrease it. */
2158 bind_polling_period (int n
)
2160 #ifdef POLL_FOR_INPUT
2161 EMACS_INT
new = polling_period
;
2166 stop_other_atimers (poll_timer
);
2168 specbind (Qpolling_period
, make_number (new));
2169 /* Start a new alarm with the new period. */
2174 /* Apply the control modifier to CHARACTER. */
2177 make_ctrl_char (int c
)
2179 /* Save the upper bits here. */
2180 int upper
= c
& ~0177;
2182 if (! ASCII_BYTE_P (c
))
2183 return c
|= ctrl_modifier
;
2187 /* Everything in the columns containing the upper-case letters
2188 denotes a control character. */
2189 if (c
>= 0100 && c
< 0140)
2193 /* Set the shift modifier for a control char
2194 made from a shifted letter. But only for letters! */
2195 if (oc
>= 'A' && oc
<= 'Z')
2196 c
|= shift_modifier
;
2199 /* The lower-case letters denote control characters too. */
2200 else if (c
>= 'a' && c
<= 'z')
2203 /* Include the bits for control and shift
2204 only if the basic ASCII code can't indicate them. */
2208 /* Replace the high bits. */
2209 c
|= (upper
& ~ctrl_modifier
);
2214 /* Display the help-echo property of the character after the mouse pointer.
2215 Either show it in the echo area, or call show-help-function to display
2216 it by other means (maybe in a tooltip).
2218 If HELP is nil, that means clear the previous help echo.
2220 If HELP is a string, display that string. If HELP is a function,
2221 call it with OBJECT and POS as arguments; the function should
2222 return a help string or nil for none. For all other types of HELP,
2223 evaluate it to obtain a string.
2225 WINDOW is the window in which the help was generated, if any.
2226 It is nil if not in a window.
2228 If OBJECT is a buffer, POS is the position in the buffer where the
2229 `help-echo' text property was found.
2231 If OBJECT is an overlay, that overlay has a `help-echo' property,
2232 and POS is the position in the overlay's buffer under the mouse.
2234 If OBJECT is a string (an overlay string or a string displayed with
2235 the `display' property). POS is the position in that string under
2238 Note: this function may only be called with HELP nil or a string
2239 from X code running asynchronously. */
2242 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2245 if (!NILP (help
) && !STRINGP (help
))
2247 if (FUNCTIONP (help
))
2248 help
= safe_call (4, help
, window
, object
, pos
);
2250 help
= safe_eval (help
);
2252 if (!STRINGP (help
))
2256 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2257 if (!noninteractive
&& STRINGP (help
))
2259 /* The mouse-fixup-help-message Lisp function can call
2260 mouse_position_hook, which resets the mouse_moved flags.
2261 This causes trouble if we are trying to read a mouse motion
2262 event (i.e., if we are inside a `track-mouse' form), so we
2263 restore the mouse_moved flag. */
2264 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2265 help
= call1 (Qmouse_fixup_help_message
, help
);
2271 if (STRINGP (help
) || NILP (help
))
2273 if (!NILP (Vshow_help_function
))
2274 call1 (Vshow_help_function
, help
);
2275 help_echo_showing_p
= STRINGP (help
);
2281 /* Input of single characters from keyboard */
2283 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2284 EMACS_TIME
*end_time
);
2285 static void record_char (Lisp_Object c
);
2287 static Lisp_Object help_form_saved_window_configs
;
2289 read_char_help_form_unwind (Lisp_Object arg
)
2291 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2292 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2293 if (!NILP (window_config
))
2294 Fset_window_configuration (window_config
);
2298 #define STOP_POLLING \
2299 do { if (! polling_stopped_here) stop_polling (); \
2300 polling_stopped_here = 1; } while (0)
2302 #define RESUME_POLLING \
2303 do { if (polling_stopped_here) start_polling (); \
2304 polling_stopped_here = 0; } while (0)
2306 /* read a character from the keyboard; call the redisplay if needed */
2307 /* commandflag 0 means do not autosave, but do redisplay.
2308 -1 means do not redisplay, but do autosave.
2311 /* The arguments MAPS and NMAPS are for menu prompting.
2312 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2314 PREV_EVENT is the previous input event, or nil if we are reading
2315 the first event of a key sequence (or not reading a key sequence).
2316 If PREV_EVENT is t, that is a "magic" value that says
2317 not to run input methods, but in other respects to act as if
2318 not reading a key sequence.
2320 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2321 if we used a mouse menu to read the input, or zero otherwise. If
2322 USED_MOUSE_MENU is null, we don't dereference it.
2324 Value is -2 when we find input on another keyboard. A second call
2325 to read_char will read it.
2327 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2328 specifying the maximum time to wait until. If no input arrives by
2329 that time, stop waiting and return nil.
2331 Value is t if we showed a menu and the user rejected it. */
2334 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2335 Lisp_Object prev_event
,
2336 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2338 volatile Lisp_Object c
;
2340 jmp_buf local_getcjmp
;
2342 volatile int key_already_recorded
= 0;
2343 Lisp_Object tem
, save
;
2344 volatile Lisp_Object previous_echo_area_message
;
2345 volatile Lisp_Object also_record
;
2346 volatile int reread
;
2347 struct gcpro gcpro1
, gcpro2
;
2348 int volatile polling_stopped_here
= 0;
2349 struct kboard
*orig_kboard
= current_kboard
;
2353 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2354 before_command_key_count
= this_command_key_count
;
2355 before_command_echo_length
= echo_length ();
2358 previous_echo_area_message
= Qnil
;
2360 GCPRO2 (c
, previous_echo_area_message
);
2365 if (CONSP (Vunread_post_input_method_events
))
2367 c
= XCAR (Vunread_post_input_method_events
);
2368 Vunread_post_input_method_events
2369 = XCDR (Vunread_post_input_method_events
);
2371 /* Undo what read_char_x_menu_prompt did when it unread
2372 additional keys returned by Fx_popup_menu. */
2374 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2382 if (unread_command_char
!= -1)
2384 XSETINT (c
, unread_command_char
);
2385 unread_command_char
= -1;
2391 if (CONSP (Vunread_command_events
))
2393 int was_disabled
= 0;
2395 c
= XCAR (Vunread_command_events
);
2396 Vunread_command_events
= XCDR (Vunread_command_events
);
2400 /* Undo what sit-for did when it unread additional keys
2401 inside universal-argument. */
2404 && EQ (XCAR (c
), Qt
))
2410 /* Undo what read_char_x_menu_prompt did when it unread
2411 additional keys returned by Fx_popup_menu. */
2413 && EQ (XCDR (c
), Qdisabled
)
2414 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2420 /* If the queued event is something that used the mouse,
2421 set used_mouse_menu accordingly. */
2423 /* Also check was_disabled so last-nonmenu-event won't return
2424 a bad value when submenus are involved. (Bug#447) */
2425 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2426 *used_mouse_menu
= 1;
2428 goto reread_for_input_method
;
2431 if (CONSP (Vunread_input_method_events
))
2433 c
= XCAR (Vunread_input_method_events
);
2434 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2436 /* Undo what read_char_x_menu_prompt did when it unread
2437 additional keys returned by Fx_popup_menu. */
2439 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2443 goto reread_for_input_method
;
2446 this_command_key_count_reset
= 0;
2448 if (!NILP (Vexecuting_kbd_macro
))
2450 /* We set this to Qmacro; since that's not a frame, nobody will
2451 try to switch frames on us, and the selected window will
2454 Since this event came from a macro, it would be misleading to
2455 leave internal_last_event_frame set to wherever the last
2456 real event came from. Normally, a switch-frame event selects
2457 internal_last_event_frame after each command is read, but
2458 events read from a macro should never cause a new frame to be
2460 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2462 /* Exit the macro if we are at the end.
2463 Also, some things replace the macro with t
2464 to force an early exit. */
2465 if (EQ (Vexecuting_kbd_macro
, Qt
)
2466 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2472 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2473 if (STRINGP (Vexecuting_kbd_macro
)
2474 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2475 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2477 executing_kbd_macro_index
++;
2482 if (!NILP (unread_switch_frame
))
2484 c
= unread_switch_frame
;
2485 unread_switch_frame
= Qnil
;
2487 /* This event should make it into this_command_keys, and get echoed
2488 again, so we do not set `reread'. */
2492 /* if redisplay was requested */
2493 if (commandflag
>= 0)
2495 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2497 /* If there is pending input, process any events which are not
2498 user-visible, such as X selection_request events. */
2500 || detect_input_pending_run_timers (0))
2501 swallow_events (0); /* may clear input_pending */
2503 /* Redisplay if no pending input. */
2504 while (!input_pending
)
2506 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2507 redisplay_preserve_echo_area (5);
2512 /* Normal case: no input arrived during redisplay. */
2515 /* Input arrived and pre-empted redisplay.
2516 Process any events which are not user-visible. */
2518 /* If that cleared input_pending, try again to redisplay. */
2521 /* Prevent the redisplay we just did
2522 from messing up echoing of the input after the prompt. */
2523 if (commandflag
== 0 && echo_current
)
2524 echo_message_buffer
= echo_area_buffer
[0];
2528 /* Message turns off echoing unless more keystrokes turn it on again.
2530 The code in 20.x for the condition was
2532 1. echo_area_glyphs && *echo_area_glyphs
2533 2. && echo_area_glyphs != current_kboard->echobuf
2534 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2536 (1) means there's a current message displayed
2538 (2) means it's not the message from echoing from the current
2541 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2542 is set to a non-null value. This is done in read_char and it is
2543 set to echo_area_glyphs after a call to echo_char. That means
2544 ok_to_echo_at_next_pause is either null or
2545 current_kboard->echobuf with the appropriate current_kboard at
2548 So, condition (3) means in clear text ok_to_echo_at_next_pause
2549 must be either null, or the current message isn't from echoing at
2550 all, or it's from echoing from a different kboard than the
2553 if (/* There currently is something in the echo area. */
2554 !NILP (echo_area_buffer
[0])
2555 && (/* And it's either not from echoing. */
2556 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2557 /* Or it's an echo from a different kboard. */
2558 || echo_kboard
!= current_kboard
2559 /* Or we explicitly allow overwriting whatever there is. */
2560 || ok_to_echo_at_next_pause
== NULL
))
2565 /* Try reading a character via menu prompting in the minibuf.
2566 Try this before the sit-for, because the sit-for
2567 would do the wrong thing if we are supposed to do
2568 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2569 after a mouse event so don't try a minibuf menu. */
2571 if (nmaps
> 0 && INTERACTIVE
2572 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2573 /* Don't bring up a menu if we already have another event. */
2574 && NILP (Vunread_command_events
)
2575 && unread_command_char
< 0
2576 && !detect_input_pending_run_timers (0))
2578 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2580 if (INTEGERP (c
) && XINT (c
) == -2)
2581 return c
; /* wrong_kboard_jmpbuf */
2585 key_already_recorded
= 1;
2590 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2591 We will do that below, temporarily for short sections of code,
2592 when appropriate. local_getcjmp must be in effect
2593 around any call to sit_for or kbd_buffer_get_event;
2594 it *must not* be in effect when we call redisplay. */
2596 jmpcount
= SPECPDL_INDEX ();
2597 if (_setjmp (local_getcjmp
))
2599 /* Handle quits while reading the keyboard. */
2600 /* We must have saved the outer value of getcjmp here,
2601 so restore it now. */
2602 restore_getcjmp (save_jump
);
2603 unbind_to (jmpcount
, Qnil
);
2604 XSETINT (c
, quit_char
);
2605 internal_last_event_frame
= selected_frame
;
2606 Vlast_event_frame
= internal_last_event_frame
;
2607 /* If we report the quit char as an event,
2608 don't do so more than once. */
2609 if (!NILP (Vinhibit_quit
))
2613 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2614 if (kb
!= current_kboard
)
2616 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2617 /* We shouldn't get here if we were in single-kboard mode! */
2622 while (CONSP (XCDR (last
)))
2624 if (!NILP (XCDR (last
)))
2628 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2630 XSETCDR (last
, Fcons (c
, Qnil
));
2631 kb
->kbd_queue_has_data
= 1;
2632 current_kboard
= kb
;
2633 /* This is going to exit from read_char
2634 so we had better get rid of this frame's stuff. */
2636 return make_number (-2); /* wrong_kboard_jmpbuf */
2642 /* Start idle timers if no time limit is supplied. We don't do it
2643 if a time limit is supplied to avoid an infinite recursion in the
2644 situation where an idle timer calls `sit-for'. */
2647 timer_start_idle ();
2649 /* If in middle of key sequence and minibuffer not active,
2650 start echoing if enough time elapses. */
2652 if (minibuf_level
== 0
2654 && !current_kboard
->immediate_echo
2655 && this_command_key_count
> 0
2657 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2658 && NILP (Fzerop (Vecho_keystrokes
))
2659 && (/* No message. */
2660 NILP (echo_area_buffer
[0])
2661 /* Or empty message. */
2662 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2663 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2664 /* Or already echoing from same kboard. */
2665 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2666 /* Or not echoing before and echoing allowed. */
2667 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2669 /* After a mouse event, start echoing right away.
2670 This is because we are probably about to display a menu,
2671 and we don't want to delay before doing so. */
2672 if (EVENT_HAS_PARAMETERS (prev_event
))
2678 save_getcjmp (save_jump
);
2679 restore_getcjmp (local_getcjmp
);
2680 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2681 restore_getcjmp (save_jump
);
2683 && ! CONSP (Vunread_command_events
))
2688 /* Maybe auto save due to number of keystrokes. */
2690 if (commandflag
!= 0
2691 && auto_save_interval
> 0
2692 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2693 && !detect_input_pending_run_timers (0))
2695 Fdo_auto_save (Qnil
, Qnil
);
2696 /* Hooks can actually change some buffers in auto save. */
2700 /* Try reading using an X menu.
2701 This is never confused with reading using the minibuf
2702 because the recursive call of read_char in read_char_minibuf_menu_prompt
2703 does not pass on any keymaps. */
2705 if (nmaps
> 0 && INTERACTIVE
2706 && !NILP (prev_event
)
2707 && EVENT_HAS_PARAMETERS (prev_event
)
2708 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2709 && !EQ (XCAR (prev_event
), Qtool_bar
)
2710 /* Don't bring up a menu if we already have another event. */
2711 && NILP (Vunread_command_events
)
2712 && unread_command_char
< 0)
2714 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2716 /* Now that we have read an event, Emacs is not idle. */
2723 /* Maybe autosave and/or garbage collect due to idleness. */
2725 if (INTERACTIVE
&& NILP (c
))
2728 ptrdiff_t buffer_size
;
2730 /* Slow down auto saves logarithmically in size of current buffer,
2731 and garbage collect while we're at it. */
2732 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2733 last_non_minibuf_size
= Z
- BEG
;
2734 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2736 while (buffer_size
> 64)
2737 delay_level
++, buffer_size
-= buffer_size
>> 2;
2738 if (delay_level
< 4) delay_level
= 4;
2739 /* delay_level is 4 for files under around 50k, 7 at 100k,
2740 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2742 /* Auto save if enough time goes by without input. */
2743 if (commandflag
!= 0
2744 && num_nonmacro_input_events
> last_auto_save
2745 && INTEGERP (Vauto_save_timeout
)
2746 && XINT (Vauto_save_timeout
) > 0)
2749 EMACS_INT timeout
= (delay_level
2750 * min (XFASTINT (Vauto_save_timeout
) / 4,
2751 MOST_POSITIVE_FIXNUM
/ delay_level
));
2752 save_getcjmp (save_jump
);
2753 restore_getcjmp (local_getcjmp
);
2754 tem0
= sit_for (make_number (timeout
), 1, 1);
2755 restore_getcjmp (save_jump
);
2758 && ! CONSP (Vunread_command_events
))
2760 Fdo_auto_save (Qnil
, Qnil
);
2765 /* If there is still no input available, ask for GC. */
2766 if (!detect_input_pending_run_timers (0))
2770 /* Notify the caller if an autosave hook, or a timer, sentinel or
2771 filter in the sit_for calls above have changed the current
2772 kboard. This could happen if they use the minibuffer or start a
2773 recursive edit, like the fancy splash screen in server.el's
2774 filter. If this longjmp wasn't here, read_key_sequence would
2775 interpret the next key sequence using the wrong translation
2776 tables and function keymaps. */
2777 if (NILP (c
) && current_kboard
!= orig_kboard
)
2780 return make_number (-2); /* wrong_kboard_jmpbuf */
2783 /* If this has become non-nil here, it has been set by a timer
2784 or sentinel or filter. */
2785 if (CONSP (Vunread_command_events
))
2787 c
= XCAR (Vunread_command_events
);
2788 Vunread_command_events
= XCDR (Vunread_command_events
);
2791 /* Read something from current KBOARD's side queue, if possible. */
2795 if (current_kboard
->kbd_queue_has_data
)
2797 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2799 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2800 kset_kbd_queue (current_kboard
,
2801 XCDR (KVAR (current_kboard
, kbd_queue
)));
2802 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2803 current_kboard
->kbd_queue_has_data
= 0;
2804 input_pending
= readable_events (0);
2805 if (EVENT_HAS_PARAMETERS (c
)
2806 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2807 internal_last_event_frame
= XCAR (XCDR (c
));
2808 Vlast_event_frame
= internal_last_event_frame
;
2812 /* If current_kboard's side queue is empty check the other kboards.
2813 If one of them has data that we have not yet seen here,
2814 switch to it and process the data waiting for it.
2816 Note: if the events queued up for another kboard
2817 have already been seen here, and therefore are not a complete command,
2818 the kbd_queue_has_data field is 0, so we skip that kboard here.
2819 That's to avoid an infinite loop switching between kboards here. */
2820 if (NILP (c
) && !single_kboard
)
2823 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2824 if (kb
->kbd_queue_has_data
)
2826 current_kboard
= kb
;
2827 /* This is going to exit from read_char
2828 so we had better get rid of this frame's stuff. */
2830 return make_number (-2); /* wrong_kboard_jmpbuf */
2838 /* Finally, we read from the main queue,
2839 and if that gives us something we can't use yet, we put it on the
2840 appropriate side queue and try again. */
2844 KBOARD
*kb
IF_LINT (= NULL
);
2846 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2849 /* Actually read a character, waiting if necessary. */
2850 save_getcjmp (save_jump
);
2851 restore_getcjmp (local_getcjmp
);
2853 timer_start_idle ();
2854 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2855 restore_getcjmp (save_jump
);
2857 if (! NILP (c
) && (kb
!= current_kboard
))
2859 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2862 while (CONSP (XCDR (last
)))
2864 if (!NILP (XCDR (last
)))
2868 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2870 XSETCDR (last
, Fcons (c
, Qnil
));
2871 kb
->kbd_queue_has_data
= 1;
2875 current_kboard
= kb
;
2876 /* This is going to exit from read_char
2877 so we had better get rid of this frame's stuff. */
2879 return make_number (-2);
2883 /* Terminate Emacs in batch mode if at eof. */
2884 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2885 Fkill_emacs (make_number (1));
2889 /* Add in any extra modifiers, where appropriate. */
2890 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2891 || ((extra_keyboard_modifiers
& 0177) < ' '
2892 && (extra_keyboard_modifiers
& 0177) != 0))
2893 XSETINT (c
, make_ctrl_char (XINT (c
)));
2895 /* Transfer any other modifier bits directly from
2896 extra_keyboard_modifiers to c. Ignore the actual character code
2897 in the low 16 bits of extra_keyboard_modifiers. */
2898 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2909 if (commandflag
>= 0
2910 && !input_pending
&& !detect_input_pending_run_timers (0))
2918 /* Buffer switch events are only for internal wakeups
2919 so don't show them to the user.
2920 Also, don't record a key if we already did. */
2921 if (BUFFERP (c
) || key_already_recorded
)
2924 /* Process special events within read_char
2925 and loop around to read another event. */
2928 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2933 struct buffer
*prev_buffer
= current_buffer
;
2934 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2935 int was_locked
= single_kboard
;
2936 ptrdiff_t count
= SPECPDL_INDEX ();
2937 record_single_kboard_state ();
2940 last_input_event
= c
;
2941 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2943 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2944 /* We stopped being idle for this event; undo that. This
2945 prevents automatic window selection (under
2946 mouse_autoselect_window from acting as a real input event, for
2947 example banishing the mouse under mouse-avoidance-mode. */
2948 timer_resume_idle ();
2950 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2951 /* Resume allowing input from any kboard, if that was true before. */
2953 any_kboard_state ();
2954 unbind_to (count
, Qnil
);
2957 if (current_buffer
!= prev_buffer
)
2959 /* The command may have changed the keymaps. Pretend there
2960 is input in another keyboard and return. This will
2961 recalculate keymaps. */
2962 c
= make_number (-2);
2969 /* Handle things that only apply to characters. */
2972 /* If kbd_buffer_get_event gave us an EOF, return that. */
2976 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2977 && UNSIGNED_CMP (XFASTINT (c
), <,
2978 SCHARS (KVAR (current_kboard
,
2979 Vkeyboard_translate_table
))))
2980 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2981 && UNSIGNED_CMP (XFASTINT (c
), <,
2982 ASIZE (KVAR (current_kboard
,
2983 Vkeyboard_translate_table
))))
2984 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2988 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2989 /* nil in keyboard-translate-table means no translation. */
2995 /* If this event is a mouse click in the menu bar,
2996 return just menu-bar for now. Modify the mouse click event
2997 so we won't do this twice, then queue it up. */
2998 if (EVENT_HAS_PARAMETERS (c
)
3000 && CONSP (EVENT_START (c
))
3001 && CONSP (XCDR (EVENT_START (c
))))
3005 posn
= POSN_POSN (EVENT_START (c
));
3006 /* Handle menu-bar events:
3007 insert the dummy prefix event `menu-bar'. */
3008 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3010 /* Change menu-bar to (menu-bar) as the event "position". */
3011 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3014 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3019 /* Store these characters into recent_keys, the dribble file if any,
3020 and the keyboard macro being defined, if any. */
3022 if (! NILP (also_record
))
3023 record_char (also_record
);
3025 /* Wipe the echo area.
3026 But first, if we are about to use an input method,
3027 save the echo area contents for it to refer to. */
3029 && ! NILP (Vinput_method_function
)
3030 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3032 previous_echo_area_message
= Fcurrent_message ();
3033 Vinput_method_previous_message
= previous_echo_area_message
;
3036 /* Now wipe the echo area, except for help events which do their
3037 own stuff with the echo area. */
3039 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3040 && !(EQ (Qswitch_frame
, XCAR (c
)))
3041 /* Don't wipe echo area for select window events: These might
3042 get delayed via `mouse-autoselect-window' (Bug#11304). */
3043 && !(EQ (Qselect_window
, XCAR (c
)))))
3045 if (!NILP (echo_area_buffer
[0]))
3047 safe_run_hooks (Qecho_area_clear_hook
);
3048 clear_message (1, 0);
3052 reread_for_input_method
:
3054 /* Pass this to the input method, if appropriate. */
3056 && ! NILP (Vinput_method_function
)
3057 /* Don't run the input method within a key sequence,
3058 after the first event of the key sequence. */
3059 && NILP (prev_event
)
3060 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3063 ptrdiff_t key_count
;
3064 int key_count_reset
;
3065 struct gcpro gcpro1
;
3066 ptrdiff_t count
= SPECPDL_INDEX ();
3068 /* Save the echo status. */
3069 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3070 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3071 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3072 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3075 if (before_command_restore_flag
)
3077 this_command_key_count
= before_command_key_count_1
;
3078 if (this_command_key_count
< this_single_command_key_start
)
3079 this_single_command_key_start
= this_command_key_count
;
3080 echo_truncate (before_command_echo_length_1
);
3081 before_command_restore_flag
= 0;
3085 /* Save the this_command_keys status. */
3086 key_count
= this_command_key_count
;
3087 key_count_reset
= this_command_key_count_reset
;
3090 keys
= Fcopy_sequence (this_command_keys
);
3095 /* Clear out this_command_keys. */
3096 this_command_key_count
= 0;
3097 this_command_key_count_reset
= 0;
3099 /* Now wipe the echo area. */
3100 if (!NILP (echo_area_buffer
[0]))
3101 safe_run_hooks (Qecho_area_clear_hook
);
3102 clear_message (1, 0);
3105 /* If we are not reading a key sequence,
3106 never use the echo area. */
3109 specbind (Qinput_method_use_echo_area
, Qt
);
3112 /* Call the input method. */
3113 tem
= call1 (Vinput_method_function
, c
);
3115 tem
= unbind_to (count
, tem
);
3117 /* Restore the saved echoing state
3118 and this_command_keys state. */
3119 this_command_key_count
= key_count
;
3120 this_command_key_count_reset
= key_count_reset
;
3122 this_command_keys
= keys
;
3125 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3126 kset_echo_string (current_kboard
, saved_echo_string
);
3127 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3128 if (saved_immediate_echo
)
3133 /* The input method can return no events. */
3136 /* Bring back the previous message, if any. */
3137 if (! NILP (previous_echo_area_message
))
3138 message_with_string ("%s", previous_echo_area_message
, 0);
3141 /* It returned one event or more. */
3143 Vunread_post_input_method_events
3144 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3149 /* Display help if not echoing. */
3150 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3152 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3153 Lisp_Object help
, object
, position
, window
, htem
;
3155 htem
= Fcdr (XCDR (c
));
3158 window
= Fcar (htem
);
3160 object
= Fcar (htem
);
3162 position
= Fcar (htem
);
3164 show_help_echo (help
, window
, object
, position
);
3166 /* We stopped being idle for this event; undo that. */
3168 timer_resume_idle ();
3172 if ((! reread
|| this_command_key_count
== 0
3173 || this_command_key_count_reset
)
3177 /* Don't echo mouse motion events. */
3178 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3179 && NILP (Fzerop (Vecho_keystrokes
))
3180 && ! (EVENT_HAS_PARAMETERS (c
)
3181 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3184 if (! NILP (also_record
))
3185 echo_char (also_record
);
3186 /* Once we reread a character, echoing can happen
3187 the next time we pause to read a new one. */
3188 ok_to_echo_at_next_pause
= current_kboard
;
3191 /* Record this character as part of the current key. */
3192 add_command_key (c
);
3193 if (! NILP (also_record
))
3194 add_command_key (also_record
);
3197 last_input_event
= c
;
3200 /* Process the help character specially if enabled */
3201 if (!NILP (Vhelp_form
) && help_char_p (c
))
3203 ptrdiff_t count
= SPECPDL_INDEX ();
3205 help_form_saved_window_configs
3206 = Fcons (Fcurrent_window_configuration (Qnil
),
3207 help_form_saved_window_configs
);
3208 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3209 call0 (Qhelp_form_show
);
3214 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3215 if (EVENT_HAS_PARAMETERS (c
)
3216 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3217 XSETCAR (help_form_saved_window_configs
, Qnil
);
3219 while (BUFFERP (c
));
3220 /* Remove the help from the frame */
3221 unbind_to (count
, Qnil
);
3224 if (EQ (c
, make_number (040)))
3228 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3229 while (BUFFERP (c
));
3238 /* Record a key that came from a mouse menu.
3239 Record it for echoing, for this-command-keys, and so on. */
3242 record_menu_key (Lisp_Object c
)
3244 /* Wipe the echo area. */
3245 clear_message (1, 0);
3250 before_command_key_count
= this_command_key_count
;
3251 before_command_echo_length
= echo_length ();
3254 /* Don't echo mouse motion events. */
3255 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3256 && NILP (Fzerop (Vecho_keystrokes
)))
3260 /* Once we reread a character, echoing can happen
3261 the next time we pause to read a new one. */
3262 ok_to_echo_at_next_pause
= 0;
3265 /* Record this character as part of the current key. */
3266 add_command_key (c
);
3268 /* Re-reading in the middle of a command */
3269 last_input_event
= c
;
3273 /* Return 1 if should recognize C as "the help character". */
3276 help_char_p (Lisp_Object c
)
3280 if (EQ (c
, Vhelp_char
))
3282 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3283 if (EQ (c
, XCAR (tail
)))
3288 /* Record the input event C in various ways. */
3291 record_char (Lisp_Object c
)
3295 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3297 /* To avoid filling recent_keys with help-echo and mouse-movement
3298 events, we filter out repeated help-echo events, only store the
3299 first and last in a series of mouse-movement events, and don't
3300 store repeated help-echo events which are only separated by
3301 mouse-movement events. */
3303 Lisp_Object ev1
, ev2
, ev3
;
3306 if ((ix1
= recent_keys_index
- 1) < 0)
3307 ix1
= NUM_RECENT_KEYS
- 1;
3308 ev1
= AREF (recent_keys
, ix1
);
3310 if ((ix2
= ix1
- 1) < 0)
3311 ix2
= NUM_RECENT_KEYS
- 1;
3312 ev2
= AREF (recent_keys
, ix2
);
3314 if ((ix3
= ix2
- 1) < 0)
3315 ix3
= NUM_RECENT_KEYS
- 1;
3316 ev3
= AREF (recent_keys
, ix3
);
3318 if (EQ (XCAR (c
), Qhelp_echo
))
3320 /* Don't record `help-echo' in recent_keys unless it shows some help
3321 message, and a different help than the previously recorded
3323 Lisp_Object help
, last_help
;
3325 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3326 if (!STRINGP (help
))
3328 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3329 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3331 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3332 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3333 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3335 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3336 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3337 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3338 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3341 else if (EQ (XCAR (c
), Qmouse_movement
))
3343 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3344 So additional mouse movement events replace the last element. */
3345 Lisp_Object last_window
, window
;
3347 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3348 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3349 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3350 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3351 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3353 ASET (recent_keys
, ix1
, c
);
3359 store_kbd_macro_char (c
);
3363 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3364 ASET (recent_keys
, recent_keys_index
, c
);
3365 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3366 recent_keys_index
= 0;
3368 else if (recorded
< 0)
3370 /* We need to remove one or two events from recent_keys.
3371 To do this, we simply put nil at those events and move the
3372 recent_keys_index backwards over those events. Usually,
3373 users will never see those nil events, as they will be
3374 overwritten by the command keys entered to see recent_keys
3377 while (recorded
++ < 0 && total_keys
> 0)
3379 if (total_keys
< NUM_RECENT_KEYS
)
3381 if (--recent_keys_index
< 0)
3382 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3383 ASET (recent_keys
, recent_keys_index
, Qnil
);
3387 num_nonmacro_input_events
++;
3389 /* Write c to the dribble file. If c is a lispy event, write
3390 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3391 If you, dear reader, have a better idea, you've got the source. :-) */
3397 if (XUINT (c
) < 0x100)
3398 putc (XUINT (c
), dribble
);
3400 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3404 Lisp_Object dribblee
;
3406 /* If it's a structured event, take the event header. */
3407 dribblee
= EVENT_HEAD (c
);
3409 if (SYMBOLP (dribblee
))
3411 putc ('<', dribble
);
3412 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3413 SBYTES (SYMBOL_NAME (dribblee
)),
3415 putc ('>', dribble
);
3424 /* Copy out or in the info on where C-g should throw to.
3425 This is used when running Lisp code from within get_char,
3426 in case get_char is called recursively.
3427 See read_process_output. */
3430 save_getcjmp (jmp_buf temp
)
3432 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3436 restore_getcjmp (jmp_buf temp
)
3438 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3441 /* Low level keyboard/mouse input.
3442 kbd_buffer_store_event places events in kbd_buffer, and
3443 kbd_buffer_get_event retrieves them. */
3445 /* Return true if there are any events in the queue that read-char
3446 would return. If this returns false, a read-char would block. */
3448 readable_events (int flags
)
3450 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3453 /* If the buffer contains only FOCUS_IN_EVENT events, and
3454 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3455 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3457 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3458 #ifdef USE_TOOLKIT_SCROLL_BARS
3459 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3463 struct input_event
*event
;
3465 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3472 #ifdef USE_TOOLKIT_SCROLL_BARS
3473 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3475 event
->kind
== FOCUS_IN_EVENT
)
3476 #ifdef USE_TOOLKIT_SCROLL_BARS
3477 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3478 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3479 && event
->part
== scroll_bar_handle
3480 && event
->modifiers
== 0)
3485 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3488 while (event
!= kbd_store_ptr
);
3494 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3495 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3496 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3501 if (current_kboard
->kbd_queue_has_data
)
3507 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3508 if (kb
->kbd_queue_has_data
)
3514 /* Set this for debugging, to have a way to get out */
3515 int stop_character EXTERNALLY_VISIBLE
;
3518 event_to_kboard (struct input_event
*event
)
3521 frame
= event
->frame_or_window
;
3523 frame
= XCAR (frame
);
3524 else if (WINDOWP (frame
))
3525 frame
= WINDOW_FRAME (XWINDOW (frame
));
3527 /* There are still some events that don't set this field.
3528 For now, just ignore the problem.
3529 Also ignore dead frames here. */
3530 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3533 return FRAME_KBOARD (XFRAME (frame
));
3537 /* Return the number of slots occupied in kbd_buffer. */
3540 kbd_buffer_nr_stored (void)
3542 return kbd_fetch_ptr
== kbd_store_ptr
3544 : (kbd_fetch_ptr
< kbd_store_ptr
3545 ? kbd_store_ptr
- kbd_fetch_ptr
3546 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3547 + (kbd_store_ptr
- kbd_buffer
)));
3549 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3552 kbd_buffer_store_event (register struct input_event
*event
)
3554 kbd_buffer_store_event_hold (event
, 0);
3557 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3559 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3560 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3561 Else, if EVENT is a quit event, store the quit event
3562 in HOLD_QUIT, and return (thus ignoring further events).
3564 This is used in read_avail_input to postpone the processing
3565 of the quit event until all subsequent input events have been
3566 parsed (and discarded).
3570 kbd_buffer_store_event_hold (register struct input_event
*event
,
3571 struct input_event
*hold_quit
)
3573 if (event
->kind
== NO_EVENT
)
3576 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3579 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3581 register int c
= event
->code
& 0377;
3583 if (event
->modifiers
& ctrl_modifier
)
3584 c
= make_ctrl_char (c
);
3586 c
|= (event
->modifiers
3587 & (meta_modifier
| alt_modifier
3588 | hyper_modifier
| super_modifier
));
3592 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3593 struct input_event
*sp
;
3595 if (single_kboard
&& kb
!= current_kboard
)
3598 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3599 Fcons (make_number (c
), Qnil
)));
3600 kb
->kbd_queue_has_data
= 1;
3601 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3603 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3606 if (event_to_kboard (sp
) == kb
)
3608 sp
->kind
= NO_EVENT
;
3609 sp
->frame_or_window
= Qnil
;
3618 memcpy (hold_quit
, event
, sizeof (*event
));
3622 /* If this results in a quit_char being returned to Emacs as
3623 input, set Vlast_event_frame properly. If this doesn't
3624 get returned to Emacs as an event, the next event read
3625 will set Vlast_event_frame again, so this is safe to do. */
3629 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3631 focus
= event
->frame_or_window
;
3632 internal_last_event_frame
= focus
;
3633 Vlast_event_frame
= focus
;
3636 last_event_timestamp
= event
->timestamp
;
3637 handle_interrupt ();
3641 if (c
&& c
== stop_character
)
3647 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3648 Just ignore the second one. */
3649 else if (event
->kind
== BUFFER_SWITCH_EVENT
3650 && kbd_fetch_ptr
!= kbd_store_ptr
3651 && ((kbd_store_ptr
== kbd_buffer
3652 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3653 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3656 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3657 kbd_store_ptr
= kbd_buffer
;
3659 /* Don't let the very last slot in the buffer become full,
3660 since that would make the two pointers equal,
3661 and that is indistinguishable from an empty buffer.
3662 Discard the event if it would fill the last slot. */
3663 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3665 *kbd_store_ptr
= *event
;
3668 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3670 /* Don't read keyboard input until we have processed kbd_buffer.
3671 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3672 hold_keyboard_input ();
3674 if (!noninteractive
)
3675 signal (SIGIO
, SIG_IGN
);
3679 #endif /* subprocesses */
3682 /* If we're inside while-no-input, and this event qualifies
3683 as input, set quit-flag to cause an interrupt. */
3684 if (!NILP (Vthrow_on_input
)
3685 && event
->kind
!= FOCUS_IN_EVENT
3686 && event
->kind
!= HELP_EVENT
3687 && event
->kind
!= DEICONIFY_EVENT
)
3689 Vquit_flag
= Vthrow_on_input
;
3690 /* If we're inside a function that wants immediate quits,
3692 if (immediate_quit
&& NILP (Vinhibit_quit
))
3702 /* Put an input event back in the head of the event queue. */
3705 kbd_buffer_unget_event (register struct input_event
*event
)
3707 if (kbd_fetch_ptr
== kbd_buffer
)
3708 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3710 /* Don't let the very last slot in the buffer become full, */
3711 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3714 *kbd_fetch_ptr
= *event
;
3719 /* Generate a HELP_EVENT input_event and store it in the keyboard
3722 HELP is the help form.
3724 FRAME and WINDOW are the frame and window where the help is
3725 generated. OBJECT is the Lisp object where the help was found (a
3726 buffer, a string, an overlay, or nil if neither from a string nor
3727 from a buffer). POS is the position within OBJECT where the help
3731 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3732 Lisp_Object object
, ptrdiff_t pos
)
3734 struct input_event event
;
3738 event
.kind
= HELP_EVENT
;
3739 event
.frame_or_window
= frame
;
3741 event
.x
= WINDOWP (window
) ? window
: frame
;
3744 kbd_buffer_store_event (&event
);
3748 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3751 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3753 struct input_event event
;
3755 event
.kind
= HELP_EVENT
;
3756 event
.frame_or_window
= frame
;
3761 kbd_buffer_store_event (&event
);
3765 /* Discard any mouse events in the event buffer by setting them to
3768 discard_mouse_events (void)
3770 struct input_event
*sp
;
3771 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3773 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3776 if (sp
->kind
== MOUSE_CLICK_EVENT
3777 || sp
->kind
== WHEEL_EVENT
3778 || sp
->kind
== HORIZ_WHEEL_EVENT
3780 || sp
->kind
== GPM_CLICK_EVENT
3782 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3784 sp
->kind
= NO_EVENT
;
3790 /* Return non-zero if there are any real events waiting in the event
3791 buffer, not counting `NO_EVENT's.
3793 If DISCARD is non-zero, discard NO_EVENT events at the front of
3794 the input queue, possibly leaving the input queue empty if there
3795 are no real input events. */
3798 kbd_buffer_events_waiting (int discard
)
3800 struct input_event
*sp
;
3802 for (sp
= kbd_fetch_ptr
;
3803 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3806 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3813 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3817 /* Clear input event EVENT. */
3820 clear_event (struct input_event
*event
)
3822 event
->kind
= NO_EVENT
;
3826 /* Read one event from the event buffer, waiting if necessary.
3827 The value is a Lisp object representing the event.
3828 The value is nil for an event that should be ignored,
3829 or that was handled here.
3830 We always read and discard one event. */
3833 kbd_buffer_get_event (KBOARD
**kbp
,
3834 int *used_mouse_menu
,
3835 EMACS_TIME
*end_time
)
3840 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3842 /* Start reading input again, we have processed enough so we can
3843 accept new events again. */
3844 unhold_keyboard_input ();
3846 if (!noninteractive
)
3847 signal (SIGIO
, input_available_signal
);
3851 #endif /* subprocesses */
3853 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3855 /* In case we are running as a daemon, only do this before
3856 detaching from the terminal. */
3857 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3861 *kbp
= current_kboard
;
3864 #endif /* ! HAVE_DBUS */
3866 /* Wait until there is input available. */
3869 /* Break loop if there's an unread command event. Needed in
3870 moused window autoselection which uses a timer to insert such
3872 if (CONSP (Vunread_command_events
))
3875 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3877 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3878 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3882 /* If the quit flag is set, then read_char will return
3883 quit_char, so that counts as "available input." */
3884 if (!NILP (Vquit_flag
))
3885 quit_throw_to_read_char (0);
3887 /* One way or another, wait until input is available; then, if
3888 interrupt handlers have not read it, read it now. */
3890 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3894 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3896 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3897 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3902 EMACS_TIME now
= current_emacs_time ();
3903 if (EMACS_TIME_LE (*end_time
, now
))
3904 return Qnil
; /* Finished waiting. */
3907 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3908 wait_reading_process_output (min (EMACS_SECS (duration
),
3910 EMACS_NSECS (duration
),
3911 -1, 1, Qnil
, NULL
, 0);
3915 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3917 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3918 /* Pass 1 for EXPECT since we just waited to have input. */
3919 read_avail_input (1);
3922 if (CONSP (Vunread_command_events
))
3925 first
= XCAR (Vunread_command_events
);
3926 Vunread_command_events
= XCDR (Vunread_command_events
);
3927 *kbp
= current_kboard
;
3931 /* At this point, we know that there is a readable event available
3932 somewhere. If the event queue is empty, then there must be a
3933 mouse movement enabled and available. */
3934 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3936 struct input_event
*event
;
3938 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3942 last_event_timestamp
= event
->timestamp
;
3944 *kbp
= event_to_kboard (event
);
3946 *kbp
= current_kboard
; /* Better than returning null ptr? */
3950 /* These two kinds of events get special handling
3951 and don't actually appear to the command loop.
3952 We return nil for them. */
3953 if (event
->kind
== SELECTION_REQUEST_EVENT
3954 || event
->kind
== SELECTION_CLEAR_EVENT
)
3957 struct input_event copy
;
3959 /* Remove it from the buffer before processing it,
3960 since otherwise swallow_events will see it
3961 and process it again. */
3963 kbd_fetch_ptr
= event
+ 1;
3964 input_pending
= readable_events (0);
3965 x_handle_selection_event (©
);
3967 /* We're getting selection request events, but we don't have
3973 #if defined (HAVE_NS)
3974 else if (event
->kind
== NS_TEXT_EVENT
)
3976 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3977 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3979 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3980 kbd_fetch_ptr
= event
+ 1;
3981 if (used_mouse_menu
)
3982 *used_mouse_menu
= 1;
3986 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3987 || defined (HAVE_NS)
3988 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3990 /* Make an event (delete-frame (FRAME)). */
3991 obj
= Fcons (event
->frame_or_window
, Qnil
);
3992 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3993 kbd_fetch_ptr
= event
+ 1;
3996 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3997 || defined (HAVE_NS)
3998 else if (event
->kind
== ICONIFY_EVENT
)
4000 /* Make an event (iconify-frame (FRAME)). */
4001 obj
= Fcons (event
->frame_or_window
, Qnil
);
4002 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4003 kbd_fetch_ptr
= event
+ 1;
4005 else if (event
->kind
== DEICONIFY_EVENT
)
4007 /* Make an event (make-frame-visible (FRAME)). */
4008 obj
= Fcons (event
->frame_or_window
, Qnil
);
4009 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4010 kbd_fetch_ptr
= event
+ 1;
4013 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4015 /* The value doesn't matter here; only the type is tested. */
4016 XSETBUFFER (obj
, current_buffer
);
4017 kbd_fetch_ptr
= event
+ 1;
4019 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4020 || defined (HAVE_NS) || defined (USE_GTK)
4021 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4023 kbd_fetch_ptr
= event
+ 1;
4024 input_pending
= readable_events (0);
4025 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4026 x_activate_menubar (XFRAME (event
->frame_or_window
));
4029 #if defined (WINDOWSNT)
4030 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4032 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
4033 obj
= Fcons (Qlanguage_change
,
4034 list3 (event
->frame_or_window
,
4035 make_number (event
->code
),
4036 make_number (event
->modifiers
)));
4037 kbd_fetch_ptr
= event
+ 1;
4040 else if (event
->kind
== SAVE_SESSION_EVENT
)
4042 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
4043 kbd_fetch_ptr
= event
+ 1;
4045 /* Just discard these, by returning nil.
4046 With MULTI_KBOARD, these events are used as placeholders
4047 when we need to randomly delete events from the queue.
4048 (They shouldn't otherwise be found in the buffer,
4049 but on some machines it appears they do show up
4050 even without MULTI_KBOARD.) */
4051 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4052 mouse events during a popup-menu call. */
4053 else if (event
->kind
== NO_EVENT
)
4054 kbd_fetch_ptr
= event
+ 1;
4055 else if (event
->kind
== HELP_EVENT
)
4057 Lisp_Object object
, position
, help
, frame
, window
;
4059 frame
= event
->frame_or_window
;
4060 object
= event
->arg
;
4061 position
= make_number (event
->code
);
4064 clear_event (event
);
4066 kbd_fetch_ptr
= event
+ 1;
4067 if (!WINDOWP (window
))
4069 obj
= Fcons (Qhelp_echo
,
4070 list5 (frame
, help
, window
, object
, position
));
4072 else if (event
->kind
== FOCUS_IN_EVENT
)
4074 /* Notification of a FocusIn event. The frame receiving the
4075 focus is in event->frame_or_window. Generate a
4076 switch-frame event if necessary. */
4077 Lisp_Object frame
, focus
;
4079 frame
= event
->frame_or_window
;
4080 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4084 if (!EQ (frame
, internal_last_event_frame
)
4085 && !EQ (frame
, selected_frame
))
4086 obj
= make_lispy_switch_frame (frame
);
4087 internal_last_event_frame
= frame
;
4088 kbd_fetch_ptr
= event
+ 1;
4091 else if (event
->kind
== DBUS_EVENT
)
4093 obj
= make_lispy_event (event
);
4094 kbd_fetch_ptr
= event
+ 1;
4097 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4099 obj
= make_lispy_event (event
);
4100 kbd_fetch_ptr
= event
+ 1;
4104 /* If this event is on a different frame, return a switch-frame this
4105 time, and leave the event in the queue for next time. */
4109 frame
= event
->frame_or_window
;
4111 frame
= XCAR (frame
);
4112 else if (WINDOWP (frame
))
4113 frame
= WINDOW_FRAME (XWINDOW (frame
));
4115 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4119 if (! EQ (frame
, internal_last_event_frame
)
4120 && !EQ (frame
, selected_frame
))
4121 obj
= make_lispy_switch_frame (frame
);
4122 internal_last_event_frame
= frame
;
4124 /* If we didn't decide to make a switch-frame event, go ahead
4125 and build a real event from the queue entry. */
4129 obj
= make_lispy_event (event
);
4131 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4132 || defined (HAVE_NS) || defined (USE_GTK)
4133 /* If this was a menu selection, then set the flag to inhibit
4134 writing to last_nonmenu_event. Don't do this if the event
4135 we're returning is (menu-bar), though; that indicates the
4136 beginning of the menu sequence, and we might as well leave
4137 that as the `event with parameters' for this selection. */
4139 && !EQ (event
->frame_or_window
, event
->arg
)
4140 && (event
->kind
== MENU_BAR_EVENT
4141 || event
->kind
== TOOL_BAR_EVENT
))
4142 *used_mouse_menu
= 1;
4145 /* certain system events are non-key events */
4147 && event
->kind
== NS_NONKEY_EVENT
)
4148 *used_mouse_menu
= 1;
4151 /* Wipe out this event, to catch bugs. */
4152 clear_event (event
);
4153 kbd_fetch_ptr
= event
+ 1;
4157 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4158 /* Try generating a mouse motion event. */
4159 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4161 FRAME_PTR f
= some_mouse_moved ();
4162 Lisp_Object bar_window
;
4163 enum scroll_bar_part part
;
4167 *kbp
= current_kboard
;
4168 /* Note that this uses F to determine which terminal to look at.
4169 If there is no valid info, it does not store anything
4170 so x remains nil. */
4173 /* XXX Can f or mouse_position_hook be NULL here? */
4174 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4175 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4180 /* Decide if we should generate a switch-frame event. Don't
4181 generate switch-frame events for motion outside of all Emacs
4187 frame
= FRAME_FOCUS_FRAME (f
);
4189 XSETFRAME (frame
, f
);
4191 if (! EQ (frame
, internal_last_event_frame
)
4192 && !EQ (frame
, selected_frame
))
4193 obj
= make_lispy_switch_frame (frame
);
4194 internal_last_event_frame
= frame
;
4197 /* If we didn't decide to make a switch-frame event, go ahead and
4198 return a mouse-motion event. */
4199 if (!NILP (x
) && NILP (obj
))
4200 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4202 #endif /* HAVE_MOUSE || HAVE GPM */
4204 /* We were promised by the above while loop that there was
4205 something for us to read! */
4208 input_pending
= readable_events (0);
4210 Vlast_event_frame
= internal_last_event_frame
;
4215 /* Process any non-user-visible events (currently X selection events),
4216 without reading any user-visible events. */
4219 process_special_events (void)
4221 struct input_event
*event
;
4223 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4225 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4228 if (event
== kbd_store_ptr
)
4232 /* If we find a stored X selection request, handle it now. */
4233 if (event
->kind
== SELECTION_REQUEST_EVENT
4234 || event
->kind
== SELECTION_CLEAR_EVENT
)
4238 /* Remove the event from the fifo buffer before processing;
4239 otherwise swallow_events called recursively could see it
4240 and process it again. To do this, we move the events
4241 between kbd_fetch_ptr and EVENT one slot to the right,
4244 struct input_event copy
= *event
;
4245 struct input_event
*beg
4246 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4247 ? kbd_buffer
: kbd_fetch_ptr
;
4250 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4251 else if (event
< beg
)
4253 if (event
> kbd_buffer
)
4254 memmove (kbd_buffer
+ 1, kbd_buffer
,
4255 (event
- kbd_buffer
) * sizeof (struct input_event
));
4256 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4257 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4258 memmove (beg
+ 1, beg
,
4259 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4260 * sizeof (struct input_event
));
4263 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4264 kbd_fetch_ptr
= kbd_buffer
+ 1;
4268 /* X wants last_event_timestamp for selection ownership. */
4269 last_event_timestamp
= copy
.timestamp
;
4270 input_pending
= readable_events (0);
4271 x_handle_selection_event (©
);
4273 /* We're getting selection request events, but we don't have
4281 /* Process any events that are not user-visible, run timer events that
4282 are ripe, and return, without reading any user-visible events. */
4285 swallow_events (int do_display
)
4289 process_special_events ();
4291 old_timers_run
= timers_run
;
4292 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4294 if (timers_run
!= old_timers_run
&& do_display
)
4295 redisplay_preserve_echo_area (7);
4298 /* Record the start of when Emacs is idle,
4299 for the sake of running idle-time timers. */
4302 timer_start_idle (void)
4306 /* If we are already in the idle state, do nothing. */
4307 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4310 timer_idleness_start_time
= current_emacs_time ();
4311 timer_last_idleness_start_time
= timer_idleness_start_time
;
4313 /* Mark all idle-time timers as once again candidates for running. */
4314 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4318 timer
= XCAR (timers
);
4320 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4322 ASET (timer
, 0, Qnil
);
4326 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4329 timer_stop_idle (void)
4331 timer_idleness_start_time
= invalid_emacs_time ();
4334 /* Resume idle timer from last idle start time. */
4337 timer_resume_idle (void)
4339 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4342 timer_idleness_start_time
= timer_last_idleness_start_time
;
4345 /* This is only for debugging. */
4346 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4348 /* List of elisp functions to call, delayed because they were generated in
4349 a context where Elisp could not be safely run (e.g. redisplay, signal,
4350 ...). Each element has the form (FUN . ARGS). */
4351 Lisp_Object pending_funcalls
;
4353 /* If TIMER is a valid timer, return nonzero and place its value into
4354 *RESULT. Otherwise return zero. */
4356 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4358 Lisp_Object
*vector
;
4360 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4362 vector
= XVECTOR (timer
)->contents
;
4363 if (! NILP (vector
[0]))
4366 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[4],
4371 /* Check whether a timer has fired. To prevent larger problems we simply
4372 disregard elements that are not proper timers. Do not make a circular
4373 timer list for the time being.
4375 Returns the time to wait until the next timer fires. If a
4376 timer is triggering now, return zero.
4377 If no timer is active, return -1.
4379 If a timer is ripe, we run it, with quitting turned off.
4380 In that case we return 0 to indicate that a new timer_check_2 call
4384 timer_check_2 (void)
4386 EMACS_TIME nexttime
;
4388 EMACS_TIME idleness_now
;
4389 Lisp_Object timers
, idle_timers
, chosen_timer
;
4390 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4392 nexttime
= invalid_emacs_time ();
4394 /* Always consider the ordinary timers. */
4395 timers
= Vtimer_list
;
4396 /* Consider the idle timers only if Emacs is idle. */
4397 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4398 idle_timers
= Vtimer_idle_list
;
4401 chosen_timer
= Qnil
;
4402 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4404 /* First run the code that was delayed. */
4405 while (CONSP (pending_funcalls
))
4407 Lisp_Object funcall
= XCAR (pending_funcalls
);
4408 pending_funcalls
= XCDR (pending_funcalls
);
4409 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4412 if (CONSP (timers
) || CONSP (idle_timers
))
4414 now
= current_emacs_time ();
4415 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4416 ? sub_emacs_time (now
, timer_idleness_start_time
)
4417 : make_emacs_time (0, 0));
4420 while (CONSP (timers
) || CONSP (idle_timers
))
4422 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4423 EMACS_TIME timer_time
, idle_timer_time
;
4424 EMACS_TIME difference
;
4425 EMACS_TIME timer_difference
= invalid_emacs_time ();
4426 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4427 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4429 /* Set TIMER and TIMER_DIFFERENCE
4430 based on the next ordinary timer.
4431 TIMER_DIFFERENCE is the distance in time from NOW to when
4432 this timer becomes ripe (negative if it's already ripe).
4433 Skip past invalid timers and timers already handled. */
4436 timer
= XCAR (timers
);
4437 if (! decode_timer (timer
, &timer_time
))
4439 timers
= XCDR (timers
);
4443 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4444 timer_difference
= (timer_ripe
4445 ? sub_emacs_time (now
, timer_time
)
4446 : sub_emacs_time (timer_time
, now
));
4449 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4450 based on the next idle timer. */
4451 if (CONSP (idle_timers
))
4453 idle_timer
= XCAR (idle_timers
);
4454 if (! decode_timer (idle_timer
, &idle_timer_time
))
4456 idle_timers
= XCDR (idle_timers
);
4460 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4461 idle_timer_difference
=
4463 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4464 : sub_emacs_time (idle_timer_time
, idleness_now
));
4467 /* Decide which timer is the next timer,
4468 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4469 Also step down the list where we found that timer. */
4471 if (EMACS_TIME_VALID_P (timer_difference
)
4472 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4473 || idle_timer_ripe
< timer_ripe
4474 || (idle_timer_ripe
== timer_ripe
4476 ? EMACS_TIME_LT (idle_timer_difference
,
4478 : EMACS_TIME_LT (timer_difference
,
4479 idle_timer_difference
)))))
4481 chosen_timer
= timer
;
4482 timers
= XCDR (timers
);
4483 difference
= timer_difference
;
4488 chosen_timer
= idle_timer
;
4489 idle_timers
= XCDR (idle_timers
);
4490 difference
= idle_timer_difference
;
4491 ripe
= idle_timer_ripe
;
4494 /* If timer is ripe, run it if it hasn't been run. */
4497 if (NILP (AREF (chosen_timer
, 0)))
4499 ptrdiff_t count
= SPECPDL_INDEX ();
4500 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4502 /* Mark the timer as triggered to prevent problems if the lisp
4503 code fails to reschedule it right. */
4504 ASET (chosen_timer
, 0, Qt
);
4506 specbind (Qinhibit_quit
, Qt
);
4508 call1 (Qtimer_event_handler
, chosen_timer
);
4509 Vdeactivate_mark
= old_deactivate_mark
;
4511 unbind_to (count
, Qnil
);
4513 /* Since we have handled the event,
4514 we don't need to tell the caller to wake up and do it. */
4515 /* But the caller must still wait for the next timer, so
4516 return 0 to indicate that. */
4519 nexttime
= make_emacs_time (0, 0);
4523 /* When we encounter a timer that is still waiting,
4524 return the amount of time to wait before it is ripe. */
4531 /* No timers are pending in the future. */
4532 /* Return 0 if we generated an event, and -1 if not. */
4538 /* Check whether a timer has fired. To prevent larger problems we simply
4539 disregard elements that are not proper timers. Do not make a circular
4540 timer list for the time being.
4542 Returns the time to wait until the next timer fires.
4543 If no timer is active, return an invalid value.
4545 As long as any timer is ripe, we run it. */
4550 EMACS_TIME nexttime
;
4554 nexttime
= timer_check_2 ();
4556 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4561 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4562 doc
: /* Return the current length of Emacs idleness, or nil.
4563 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4564 in the same style as (current-time).
4566 The value when Emacs is not idle is nil.
4568 NSEC is a multiple of the system clock resolution. */)
4571 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4572 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4573 timer_idleness_start_time
));
4578 /* Caches for modify_event_symbol. */
4579 static Lisp_Object accent_key_syms
;
4580 static Lisp_Object func_key_syms
;
4581 static Lisp_Object mouse_syms
;
4582 static Lisp_Object wheel_syms
;
4583 static Lisp_Object drag_n_drop_syms
;
4585 /* This is a list of keysym codes for special "accent" characters.
4586 It parallels lispy_accent_keys. */
4588 static const int lispy_accent_codes
[] =
4590 #ifdef XK_dead_circumflex
4595 #ifdef XK_dead_grave
4600 #ifdef XK_dead_tilde
4605 #ifdef XK_dead_diaeresis
4610 #ifdef XK_dead_macron
4615 #ifdef XK_dead_degree
4620 #ifdef XK_dead_acute
4625 #ifdef XK_dead_cedilla
4630 #ifdef XK_dead_breve
4635 #ifdef XK_dead_ogonek
4640 #ifdef XK_dead_caron
4645 #ifdef XK_dead_doubleacute
4646 XK_dead_doubleacute
,
4650 #ifdef XK_dead_abovedot
4655 #ifdef XK_dead_abovering
4665 #ifdef XK_dead_belowdot
4670 #ifdef XK_dead_voiced_sound
4671 XK_dead_voiced_sound
,
4675 #ifdef XK_dead_semivoiced_sound
4676 XK_dead_semivoiced_sound
,
4692 /* This is a list of Lisp names for special "accent" characters.
4693 It parallels lispy_accent_codes. */
4695 static const char *const lispy_accent_keys
[] =
4713 "dead-voiced-sound",
4714 "dead-semivoiced-sound",
4720 #define FUNCTION_KEY_OFFSET 0x0
4722 const char *const lispy_function_keys
[] =
4726 0, /* VK_LBUTTON 0x01 */
4727 0, /* VK_RBUTTON 0x02 */
4728 "cancel", /* VK_CANCEL 0x03 */
4729 0, /* VK_MBUTTON 0x04 */
4731 0, 0, 0, /* 0x05 .. 0x07 */
4733 "backspace", /* VK_BACK 0x08 */
4734 "tab", /* VK_TAB 0x09 */
4736 0, 0, /* 0x0A .. 0x0B */
4738 "clear", /* VK_CLEAR 0x0C */
4739 "return", /* VK_RETURN 0x0D */
4741 0, 0, /* 0x0E .. 0x0F */
4743 0, /* VK_SHIFT 0x10 */
4744 0, /* VK_CONTROL 0x11 */
4745 0, /* VK_MENU 0x12 */
4746 "pause", /* VK_PAUSE 0x13 */
4747 "capslock", /* VK_CAPITAL 0x14 */
4748 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4750 "junja", /* VK_JUNJA 0x17 */
4751 "final", /* VK_FINAL 0x18 */
4752 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4754 "escape", /* VK_ESCAPE 0x1B */
4755 "convert", /* VK_CONVERT 0x1C */
4756 "non-convert", /* VK_NONCONVERT 0x1D */
4757 "accept", /* VK_ACCEPT 0x1E */
4758 "mode-change", /* VK_MODECHANGE 0x1F */
4759 0, /* VK_SPACE 0x20 */
4760 "prior", /* VK_PRIOR 0x21 */
4761 "next", /* VK_NEXT 0x22 */
4762 "end", /* VK_END 0x23 */
4763 "home", /* VK_HOME 0x24 */
4764 "left", /* VK_LEFT 0x25 */
4765 "up", /* VK_UP 0x26 */
4766 "right", /* VK_RIGHT 0x27 */
4767 "down", /* VK_DOWN 0x28 */
4768 "select", /* VK_SELECT 0x29 */
4769 "print", /* VK_PRINT 0x2A */
4770 "execute", /* VK_EXECUTE 0x2B */
4771 "snapshot", /* VK_SNAPSHOT 0x2C */
4772 "insert", /* VK_INSERT 0x2D */
4773 "delete", /* VK_DELETE 0x2E */
4774 "help", /* VK_HELP 0x2F */
4776 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4778 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4780 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4782 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4784 0, 0, 0, 0, 0, 0, 0, 0, 0,
4785 0, 0, 0, 0, 0, 0, 0, 0, 0,
4786 0, 0, 0, 0, 0, 0, 0, 0,
4788 "lwindow", /* VK_LWIN 0x5B */
4789 "rwindow", /* VK_RWIN 0x5C */
4790 "apps", /* VK_APPS 0x5D */
4793 "kp-0", /* VK_NUMPAD0 0x60 */
4794 "kp-1", /* VK_NUMPAD1 0x61 */
4795 "kp-2", /* VK_NUMPAD2 0x62 */
4796 "kp-3", /* VK_NUMPAD3 0x63 */
4797 "kp-4", /* VK_NUMPAD4 0x64 */
4798 "kp-5", /* VK_NUMPAD5 0x65 */
4799 "kp-6", /* VK_NUMPAD6 0x66 */
4800 "kp-7", /* VK_NUMPAD7 0x67 */
4801 "kp-8", /* VK_NUMPAD8 0x68 */
4802 "kp-9", /* VK_NUMPAD9 0x69 */
4803 "kp-multiply", /* VK_MULTIPLY 0x6A */
4804 "kp-add", /* VK_ADD 0x6B */
4805 "kp-separator", /* VK_SEPARATOR 0x6C */
4806 "kp-subtract", /* VK_SUBTRACT 0x6D */
4807 "kp-decimal", /* VK_DECIMAL 0x6E */
4808 "kp-divide", /* VK_DIVIDE 0x6F */
4809 "f1", /* VK_F1 0x70 */
4810 "f2", /* VK_F2 0x71 */
4811 "f3", /* VK_F3 0x72 */
4812 "f4", /* VK_F4 0x73 */
4813 "f5", /* VK_F5 0x74 */
4814 "f6", /* VK_F6 0x75 */
4815 "f7", /* VK_F7 0x76 */
4816 "f8", /* VK_F8 0x77 */
4817 "f9", /* VK_F9 0x78 */
4818 "f10", /* VK_F10 0x79 */
4819 "f11", /* VK_F11 0x7A */
4820 "f12", /* VK_F12 0x7B */
4821 "f13", /* VK_F13 0x7C */
4822 "f14", /* VK_F14 0x7D */
4823 "f15", /* VK_F15 0x7E */
4824 "f16", /* VK_F16 0x7F */
4825 "f17", /* VK_F17 0x80 */
4826 "f18", /* VK_F18 0x81 */
4827 "f19", /* VK_F19 0x82 */
4828 "f20", /* VK_F20 0x83 */
4829 "f21", /* VK_F21 0x84 */
4830 "f22", /* VK_F22 0x85 */
4831 "f23", /* VK_F23 0x86 */
4832 "f24", /* VK_F24 0x87 */
4834 0, 0, 0, 0, /* 0x88 .. 0x8B */
4835 0, 0, 0, 0, /* 0x8C .. 0x8F */
4837 "kp-numlock", /* VK_NUMLOCK 0x90 */
4838 "scroll", /* VK_SCROLL 0x91 */
4839 /* Not sure where the following block comes from.
4840 Windows headers have NEC and Fujitsu specific keys in
4841 this block, but nothing generic. */
4842 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4843 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4844 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4845 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4846 "kp-end", /* VK_NUMPAD_END 0x96 */
4847 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4848 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4849 "kp-up", /* VK_NUMPAD_UP 0x99 */
4850 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4851 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4852 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4853 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4855 0, 0, /* 0x9E .. 0x9F */
4858 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4859 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4860 * No other API or message will distinguish left and right keys this way.
4865 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4866 to enable them selectively, and gives access to a few more functions.
4867 See lispy_multimedia_keys below. */
4868 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4869 0, 0, 0, /* 0xAD .. 0xAF Volume */
4870 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4871 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4873 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4874 0, 0, 0, 0, 0, 0, 0, 0, 0,
4876 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4877 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4878 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4881 "ax", /* VK_OEM_AX 0xE1 */
4882 0, /* VK_OEM_102 0xE2 */
4883 "ico-help", /* VK_ICO_HELP 0xE3 */
4884 "ico-00", /* VK_ICO_00 0xE4 */
4885 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4886 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4887 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4889 "reset", /* VK_OEM_RESET 0xE9 */
4890 "jump", /* VK_OEM_JUMP 0xEA */
4891 "oem-pa1", /* VK_OEM_PA1 0xEB */
4892 "oem-pa2", /* VK_OEM_PA2 0xEC */
4893 "oem-pa3", /* VK_OEM_PA3 0xED */
4894 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4895 "cusel", /* VK_OEM_CUSEL 0xEF */
4896 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4897 "finish", /* VK_OEM_FINISH 0xF1 */
4898 "copy", /* VK_OEM_COPY 0xF2 */
4899 "auto", /* VK_OEM_AUTO 0xF3 */
4900 "enlw", /* VK_OEM_ENLW 0xF4 */
4901 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4902 "attn", /* VK_ATTN 0xF6 */
4903 "crsel", /* VK_CRSEL 0xF7 */
4904 "exsel", /* VK_EXSEL 0xF8 */
4905 "ereof", /* VK_EREOF 0xF9 */
4906 "play", /* VK_PLAY 0xFA */
4907 "zoom", /* VK_ZOOM 0xFB */
4908 "noname", /* VK_NONAME 0xFC */
4909 "pa1", /* VK_PA1 0xFD */
4910 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4914 /* Some of these duplicate the "Media keys" on newer keyboards,
4915 but they are delivered to the application in a different way. */
4916 static const char *const lispy_multimedia_keys
[] =
4924 "browser-favorites",
4961 "toggle-dictate-command",
4967 "media-fast-forward",
4970 "media-channel-down"
4973 #else /* not HAVE_NTGUI */
4975 /* This should be dealt with in XTread_socket now, and that doesn't
4976 depend on the client system having the Kana syms defined. See also
4977 the XK_kana_A case below. */
4980 static const char *const lispy_kana_keys
[] =
4982 /* X Keysym value */
4983 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4984 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4985 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4986 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4987 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4988 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4989 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4990 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4991 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4992 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4993 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4994 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4995 "kana-i", "kana-u", "kana-e", "kana-o",
4996 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4997 "prolongedsound", "kana-A", "kana-I", "kana-U",
4998 "kana-E", "kana-O", "kana-KA", "kana-KI",
4999 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5000 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5001 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5002 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5003 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5004 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5005 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5006 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5007 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5008 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5012 #endif /* XK_kana_A */
5015 #define FUNCTION_KEY_OFFSET 0xff00
5017 /* You'll notice that this table is arranged to be conveniently
5018 indexed by X Windows keysym values. */
5019 static const char *const lispy_function_keys
[] =
5021 /* X Keysym value */
5023 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5024 "backspace", "tab", "linefeed", "clear",
5026 0, 0, 0, "pause", /* 0xff10...1f */
5027 0, 0, 0, 0, 0, 0, 0, "escape",
5029 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5030 "romaji", "hiragana", "katakana", "hiragana-katakana",
5031 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5032 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5033 "eisu-toggle", /* 0xff30...3f */
5034 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5035 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5037 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5038 "down", "prior", "next", "end",
5039 "begin", 0, 0, 0, 0, 0, 0, 0,
5040 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5051 "break", /* 0xff6b */
5054 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5055 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5056 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5057 0, 0, 0, 0, 0, 0, 0, 0,
5058 "kp-tab", /* 0xff89 */
5060 "kp-enter", /* 0xff8d */
5062 "kp-f1", /* 0xff91 */
5066 "kp-home", /* 0xff95 */
5071 "kp-prior", /* kp-page-up */
5072 "kp-next", /* kp-page-down */
5078 0, 0, 0, 0, 0, 0, 0, 0, 0,
5079 "kp-multiply", /* 0xffaa */
5084 "kp-divide", /* 0xffaf */
5085 "kp-0", /* 0xffb0 */
5086 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5089 "kp-equal", /* 0xffbd */
5090 "f1", /* 0xffbe */ /* IsFunctionKey */
5092 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5093 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5094 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5095 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5096 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5097 0, 0, 0, 0, 0, 0, 0, 0,
5098 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5099 0, 0, 0, 0, 0, 0, 0, "delete"
5102 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5103 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5105 static const char *const iso_lispy_function_keys
[] =
5107 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5108 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5109 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5110 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5111 "iso-lefttab", /* 0xfe20 */
5112 "iso-move-line-up", "iso-move-line-down",
5113 "iso-partial-line-up", "iso-partial-line-down",
5114 "iso-partial-space-left", "iso-partial-space-right",
5115 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5116 "iso-release-margin-left", "iso-release-margin-right",
5117 "iso-release-both-margins",
5118 "iso-fast-cursor-left", "iso-fast-cursor-right",
5119 "iso-fast-cursor-up", "iso-fast-cursor-down",
5120 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5121 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5124 #endif /* not HAVE_NTGUI */
5126 static Lisp_Object Vlispy_mouse_stem
;
5128 static const char *const lispy_wheel_names
[] =
5130 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5133 /* drag-n-drop events are generated when a set of selected files are
5134 dragged from another application and dropped onto an Emacs window. */
5135 static const char *const lispy_drag_n_drop_names
[] =
5140 /* Scroll bar parts. */
5141 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5142 Lisp_Object Qup
, Qdown
, Qbottom
;
5143 static Lisp_Object Qend_scroll
;
5145 static Lisp_Object Qratio
;
5147 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5148 static Lisp_Object
*const scroll_bar_parts
[] = {
5149 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5150 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5153 /* A vector, indexed by button number, giving the down-going location
5154 of currently depressed buttons, both scroll bar and non-scroll bar.
5156 The elements have the form
5157 (BUTTON-NUMBER MODIFIER-MASK . REST)
5158 where REST is the cdr of a position as it would be reported in the event.
5160 The make_lispy_event function stores positions here to tell the
5161 difference between click and drag events, and to store the starting
5162 location to be included in drag events. */
5164 static Lisp_Object button_down_location
;
5166 /* Information about the most recent up-going button event: Which
5167 button, what location, and what time. */
5169 static int last_mouse_button
;
5170 static int last_mouse_x
;
5171 static int last_mouse_y
;
5172 static Time button_down_time
;
5174 /* The number of clicks in this multiple-click. */
5176 static int double_click_count
;
5178 /* X and Y are frame-relative coordinates for a click or wheel event.
5179 Return a Lisp-style event list. */
5182 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5185 enum window_part part
;
5186 Lisp_Object posn
= Qnil
;
5187 Lisp_Object extra_info
= Qnil
;
5188 /* Coordinate pixel positions to return. */
5189 int xret
= 0, yret
= 0;
5190 /* The window under frame pixel coordinates (x,y) */
5191 Lisp_Object window
= f
5192 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5195 if (WINDOWP (window
))
5197 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5198 struct window
*w
= XWINDOW (window
);
5199 Lisp_Object string_info
= Qnil
;
5200 ptrdiff_t textpos
= -1;
5201 int col
= -1, row
= -1;
5202 int dx
= -1, dy
= -1;
5203 int width
= -1, height
= -1;
5204 Lisp_Object object
= Qnil
;
5206 /* Pixel coordinates relative to the window corner. */
5207 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5208 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5210 /* For text area clicks, return X, Y relative to the corner of
5211 this text area. Note that dX, dY etc are set below, by
5212 buffer_posn_from_coords. */
5213 if (part
== ON_TEXT
)
5215 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5216 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5218 /* For mode line and header line clicks, return X, Y relative to
5219 the left window edge. Use mode_line_string to look for a
5220 string on the click position. */
5221 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5226 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5227 /* Note that mode_line_string takes COL, ROW as pixels and
5228 converts them to characters. */
5231 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5232 &object
, &dx
, &dy
, &width
, &height
);
5233 if (STRINGP (string
))
5234 string_info
= Fcons (string
, make_number (charpos
));
5235 textpos
= (w
== XWINDOW (selected_window
)
5236 && current_buffer
== XBUFFER (w
->buffer
))
5237 ? PT
: XMARKER (w
->pointm
)->charpos
;
5242 /* For fringes and margins, Y is relative to the area's (and the
5243 window's) top edge, while X is meaningless. */
5244 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5249 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5252 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5253 &object
, &dx
, &dy
, &width
, &height
);
5254 if (STRINGP (string
))
5255 string_info
= Fcons (string
, make_number (charpos
));
5256 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5258 else if (part
== ON_LEFT_FRINGE
)
5260 posn
= Qleft_fringe
;
5263 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5264 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5265 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5267 else if (part
== ON_RIGHT_FRINGE
)
5269 posn
= Qright_fringe
;
5272 - window_box_width (w
, LEFT_MARGIN_AREA
)
5273 - window_box_width (w
, TEXT_AREA
)
5274 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5275 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5277 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5279 else if (part
== ON_VERTICAL_BORDER
)
5281 posn
= Qvertical_line
;
5286 /* Nothing special for part == ON_SCROLL_BAR. */
5288 /* For clicks in the text area, fringes, or margins, call
5289 buffer_posn_from_coords to extract TEXTPOS, the buffer
5290 position nearest to the click. */
5293 Lisp_Object string2
, object2
= Qnil
;
5294 struct display_pos p
;
5296 int width2
, height2
;
5297 /* The pixel X coordinate passed to buffer_posn_from_coords
5298 is the X coordinate relative to the text area for
5299 text-area and right-margin clicks, zero otherwise. */
5301 = (part
== ON_TEXT
) ? xret
5302 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5303 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5307 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5308 &object2
, &dx2
, &dy2
,
5310 textpos
= CHARPOS (p
.pos
);
5311 if (col
< 0) col
= x2
;
5312 if (row
< 0) row
= y2
;
5313 if (dx
< 0) dx
= dx2
;
5314 if (dy
< 0) dy
= dy2
;
5315 if (width
< 0) width
= width2
;
5316 if (height
< 0) height
= height2
;
5320 posn
= make_number (textpos
);
5321 if (STRINGP (string2
))
5322 string_info
= Fcons (string2
,
5323 make_number (CHARPOS (p
.string_pos
)));
5329 #ifdef HAVE_WINDOW_SYSTEM
5330 if (IMAGEP (object
))
5332 Lisp_Object image_map
, hotspot
;
5333 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5335 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5337 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5338 posn
= XCAR (hotspot
);
5345 Fcons (make_number (dx
), make_number (dy
)),
5346 Fcons (make_number (width
), make_number (height
)));
5349 extra_info
= Fcons (string_info
,
5350 Fcons (make_number (textpos
),
5351 Fcons (Fcons (make_number (col
),
5356 XSETFRAME (window
, f
);
5360 return Fcons (window
,
5362 Fcons (Fcons (make_number (xret
),
5363 make_number (yret
)),
5364 Fcons (make_number (t
),
5368 /* Given a struct input_event, build the lisp event which represents
5369 it. If EVENT is 0, build a mouse movement event from the mouse
5370 movement buffer, which should have a movement event in it.
5372 Note that events must be passed to this function in the order they
5373 are received; this function stores the location of button presses
5374 in order to build drag events when the button is released. */
5377 make_lispy_event (struct input_event
*event
)
5381 switch (event
->kind
)
5383 /* A simple keystroke. */
5384 case ASCII_KEYSTROKE_EVENT
:
5385 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5387 Lisp_Object lispy_c
;
5388 EMACS_INT c
= event
->code
;
5389 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5392 eassert (c
== event
->code
);
5393 /* Turn ASCII characters into control characters
5395 if (event
->modifiers
& ctrl_modifier
)
5397 c
= make_ctrl_char (c
);
5398 event
->modifiers
&= ~ctrl_modifier
;
5402 /* Add in the other modifier bits. The shift key was taken care
5403 of by the X code. */
5404 c
|= (event
->modifiers
5405 & (meta_modifier
| alt_modifier
5406 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5407 /* Distinguish Shift-SPC from SPC. */
5408 if ((event
->code
) == 040
5409 && event
->modifiers
& shift_modifier
)
5410 c
|= shift_modifier
;
5411 button_down_time
= 0;
5412 XSETFASTINT (lispy_c
, c
);
5417 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5418 except that they are non-key events (last-nonmenu-event is nil). */
5419 case NS_NONKEY_EVENT
:
5422 /* A function key. The symbol may need to have modifier prefixes
5424 case NON_ASCII_KEYSTROKE_EVENT
:
5425 button_down_time
= 0;
5427 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5428 if (event
->code
== lispy_accent_codes
[i
])
5429 return modify_event_symbol (i
,
5431 Qfunction_key
, Qnil
,
5432 lispy_accent_keys
, &accent_key_syms
,
5433 (sizeof (lispy_accent_keys
)
5434 / sizeof (lispy_accent_keys
[0])));
5438 if (event
->code
>= 0x400 && event
->code
< 0x500)
5439 return modify_event_symbol (event
->code
- 0x400,
5440 event
->modifiers
& ~shift_modifier
,
5441 Qfunction_key
, Qnil
,
5442 lispy_kana_keys
, &func_key_syms
,
5443 (sizeof (lispy_kana_keys
)
5444 / sizeof (lispy_kana_keys
[0])));
5445 #endif /* XK_kana_A */
5448 #ifdef ISO_FUNCTION_KEY_OFFSET
5449 if (event
->code
< FUNCTION_KEY_OFFSET
5450 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5451 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5453 Qfunction_key
, Qnil
,
5454 iso_lispy_function_keys
, &func_key_syms
,
5455 (sizeof (iso_lispy_function_keys
)
5456 / sizeof (iso_lispy_function_keys
[0])));
5459 /* Handle system-specific or unknown keysyms. */
5460 if (event
->code
& (1 << 28)
5461 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5462 || (event
->code
- FUNCTION_KEY_OFFSET
5463 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5464 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5466 /* We need to use an alist rather than a vector as the cache
5467 since we can't make a vector long enough. */
5468 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5469 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5470 return modify_event_symbol (event
->code
,
5473 KVAR (current_kboard
, Vsystem_key_alist
),
5474 0, &KVAR (current_kboard
, system_key_syms
),
5478 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5480 Qfunction_key
, Qnil
,
5481 lispy_function_keys
, &func_key_syms
,
5482 (sizeof (lispy_function_keys
)
5483 / sizeof (lispy_function_keys
[0])));
5486 case MULTIMEDIA_KEY_EVENT
:
5487 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5488 / sizeof (lispy_multimedia_keys
[0]))
5489 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5491 return modify_event_symbol (event
->code
, event
->modifiers
,
5492 Qfunction_key
, Qnil
,
5493 lispy_multimedia_keys
, &func_key_syms
,
5494 (sizeof (lispy_multimedia_keys
)
5495 / sizeof (lispy_multimedia_keys
[0])));
5501 /* A mouse click. Figure out where it is, decide whether it's
5502 a press, click or drag, and build the appropriate structure. */
5503 case MOUSE_CLICK_EVENT
:
5504 #ifndef USE_TOOLKIT_SCROLL_BARS
5505 case SCROLL_BAR_CLICK_EVENT
:
5508 int button
= event
->code
;
5510 Lisp_Object position
;
5511 Lisp_Object
*start_pos_ptr
;
5512 Lisp_Object start_pos
;
5516 /* Build the position as appropriate for this mouse click. */
5517 if (event
->kind
== MOUSE_CLICK_EVENT
)
5519 struct frame
*f
= XFRAME (event
->frame_or_window
);
5520 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5524 /* Ignore mouse events that were made on frame that
5525 have been deleted. */
5526 if (! FRAME_LIVE_P (f
))
5529 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5530 /* EVENT->x and EVENT->y are frame-relative pixel
5531 coordinates at this place. Under old redisplay, COLUMN
5532 and ROW are set to frame relative glyph coordinates
5533 which are then used to determine whether this click is
5534 in a menu (non-toolkit version). */
5535 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5536 &column
, &row
, NULL
, 1);
5538 /* In the non-toolkit version, clicks on the menu bar
5539 are ordinary button events in the event buffer.
5540 Distinguish them, and invoke the menu.
5542 (In the toolkit version, the toolkit handles the menu bar
5543 and Emacs doesn't know about it until after the user
5544 makes a selection.) */
5545 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5546 && (event
->modifiers
& down_modifier
))
5548 Lisp_Object items
, item
;
5550 /* Find the menu bar item under `column'. */
5552 items
= FRAME_MENU_BAR_ITEMS (f
);
5553 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5555 Lisp_Object pos
, string
;
5556 string
= AREF (items
, i
+ 1);
5557 pos
= AREF (items
, i
+ 3);
5560 if (column
>= XINT (pos
)
5561 && column
< XINT (pos
) + SCHARS (string
))
5563 item
= AREF (items
, i
);
5568 /* ELisp manual 2.4b says (x y) are window relative but
5569 code says they are frame-relative. */
5571 = Fcons (event
->frame_or_window
,
5573 Fcons (Fcons (event
->x
, event
->y
),
5574 Fcons (make_number (event
->timestamp
),
5577 return Fcons (item
, Fcons (position
, Qnil
));
5579 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5581 position
= make_lispy_position (f
, event
->x
, event
->y
,
5584 #ifndef USE_TOOLKIT_SCROLL_BARS
5587 /* It's a scrollbar click. */
5589 Lisp_Object portion_whole
;
5592 window
= event
->frame_or_window
;
5593 portion_whole
= Fcons (event
->x
, event
->y
);
5594 part
= *scroll_bar_parts
[(int) event
->part
];
5598 Fcons (Qvertical_scroll_bar
,
5599 Fcons (portion_whole
,
5600 Fcons (make_number (event
->timestamp
),
5601 Fcons (part
, Qnil
)))));
5603 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5605 if (button
>= ASIZE (button_down_location
))
5607 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5608 button_down_location
= larger_vector (button_down_location
,
5610 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5613 start_pos_ptr
= aref_addr (button_down_location
, button
);
5614 start_pos
= *start_pos_ptr
;
5615 *start_pos_ptr
= Qnil
;
5618 /* On window-system frames, use the value of
5619 double-click-fuzz as is. On other frames, interpret it
5620 as a multiple of 1/8 characters. */
5624 if (WINDOWP (event
->frame_or_window
))
5625 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5626 else if (FRAMEP (event
->frame_or_window
))
5627 f
= XFRAME (event
->frame_or_window
);
5631 if (FRAME_WINDOW_P (f
))
5632 fuzz
= double_click_fuzz
;
5634 fuzz
= double_click_fuzz
/ 8;
5636 is_double
= (button
== last_mouse_button
5637 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5638 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5639 && button_down_time
!= 0
5640 && (EQ (Vdouble_click_time
, Qt
)
5641 || (NATNUMP (Vdouble_click_time
)
5642 && (event
->timestamp
- button_down_time
5643 < XFASTINT (Vdouble_click_time
)))));
5646 last_mouse_button
= button
;
5647 last_mouse_x
= XINT (event
->x
);
5648 last_mouse_y
= XINT (event
->y
);
5650 /* If this is a button press, squirrel away the location, so
5651 we can decide later whether it was a click or a drag. */
5652 if (event
->modifiers
& down_modifier
)
5656 double_click_count
++;
5657 event
->modifiers
|= ((double_click_count
> 2)
5662 double_click_count
= 1;
5663 button_down_time
= event
->timestamp
;
5664 *start_pos_ptr
= Fcopy_alist (position
);
5665 ignore_mouse_drag_p
= 0;
5668 /* Now we're releasing a button - check the co-ordinates to
5669 see if this was a click or a drag. */
5670 else if (event
->modifiers
& up_modifier
)
5672 /* If we did not see a down before this up, ignore the up.
5673 Probably this happened because the down event chose a
5674 menu item. It would be an annoyance to treat the
5675 release of the button that chose the menu item as a
5678 if (!CONSP (start_pos
))
5681 event
->modifiers
&= ~up_modifier
;
5684 Lisp_Object new_down
, down
;
5685 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5687 /* The third element of every position
5688 should be the (x,y) pair. */
5689 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5690 new_down
= Fcar (Fcdr (Fcdr (position
)));
5693 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5695 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5696 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5699 if (ignore_mouse_drag_p
)
5701 event
->modifiers
|= click_modifier
;
5702 ignore_mouse_drag_p
= 0;
5704 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5705 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5706 /* Maybe the mouse has moved a lot, caused scrolling, and
5707 eventually ended up at the same screen position (but
5708 not buffer position) in which case it is a drag, not
5710 /* FIXME: OTOH if the buffer position has changed
5711 because of a timer or process filter rather than
5712 because of mouse movement, it should be considered as
5713 a click. But mouse-drag-region completely ignores
5714 this case and it hasn't caused any real problem, so
5715 it's probably OK to ignore it as well. */
5716 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5717 /* Mouse hasn't moved (much). */
5718 event
->modifiers
|= click_modifier
;
5721 button_down_time
= 0;
5722 event
->modifiers
|= drag_modifier
;
5725 /* Don't check is_double; treat this as multiple
5726 if the down-event was multiple. */
5727 if (double_click_count
> 1)
5728 event
->modifiers
|= ((double_click_count
> 2)
5734 /* Every mouse event should either have the down_modifier or
5735 the up_modifier set. */
5739 /* Get the symbol we should use for the mouse click. */
5742 head
= modify_event_symbol (button
,
5744 Qmouse_click
, Vlispy_mouse_stem
,
5747 ASIZE (mouse_syms
));
5748 if (event
->modifiers
& drag_modifier
)
5753 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5756 Fcons (make_number (double_click_count
),
5766 case HORIZ_WHEEL_EVENT
:
5768 Lisp_Object position
;
5771 /* Build the position as appropriate for this mouse click. */
5772 struct frame
*f
= XFRAME (event
->frame_or_window
);
5774 /* Ignore wheel events that were made on frame that have been
5776 if (! FRAME_LIVE_P (f
))
5779 position
= make_lispy_position (f
, event
->x
, event
->y
,
5782 /* Set double or triple modifiers to indicate the wheel speed. */
5784 /* On window-system frames, use the value of
5785 double-click-fuzz as is. On other frames, interpret it
5786 as a multiple of 1/8 characters. */
5792 if (WINDOWP (event
->frame_or_window
))
5793 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5794 else if (FRAMEP (event
->frame_or_window
))
5795 fr
= XFRAME (event
->frame_or_window
);
5799 fuzz
= FRAME_WINDOW_P (fr
)
5800 ? double_click_fuzz
: double_click_fuzz
/ 8;
5802 if (event
->modifiers
& up_modifier
)
5804 /* Emit a wheel-up event. */
5805 event
->modifiers
&= ~up_modifier
;
5808 else if (event
->modifiers
& down_modifier
)
5810 /* Emit a wheel-down event. */
5811 event
->modifiers
&= ~down_modifier
;
5815 /* Every wheel event should either have the down_modifier or
5816 the up_modifier set. */
5819 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5822 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5823 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5824 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5825 && button_down_time
!= 0
5826 && (EQ (Vdouble_click_time
, Qt
)
5827 || (NATNUMP (Vdouble_click_time
)
5828 && (event
->timestamp
- button_down_time
5829 < XFASTINT (Vdouble_click_time
)))));
5832 double_click_count
++;
5833 event
->modifiers
|= ((double_click_count
> 2)
5839 double_click_count
= 1;
5840 event
->modifiers
|= click_modifier
;
5843 button_down_time
= event
->timestamp
;
5844 /* Use a negative value to distinguish wheel from mouse button. */
5845 last_mouse_button
= - (1 + symbol_num
);
5846 last_mouse_x
= XINT (event
->x
);
5847 last_mouse_y
= XINT (event
->y
);
5849 /* Get the symbol we should use for the wheel event. */
5850 head
= modify_event_symbol (symbol_num
,
5856 ASIZE (wheel_syms
));
5859 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5862 Fcons (make_number (double_click_count
),
5871 #ifdef USE_TOOLKIT_SCROLL_BARS
5873 /* We don't have down and up events if using toolkit scroll bars,
5874 so make this always a click event. Store in the `part' of
5875 the Lisp event a symbol which maps to the following actions:
5877 `above_handle' page up
5878 `below_handle' page down
5882 `bottom' bottom of buffer
5883 `handle' thumb has been dragged.
5884 `end-scroll' end of interaction with scroll bar
5886 The incoming input_event contains in its `part' member an
5887 index of type `enum scroll_bar_part' which we can use as an
5888 index in scroll_bar_parts to get the appropriate symbol. */
5890 case SCROLL_BAR_CLICK_EVENT
:
5892 Lisp_Object position
, head
, window
, portion_whole
, part
;
5894 window
= event
->frame_or_window
;
5895 portion_whole
= Fcons (event
->x
, event
->y
);
5896 part
= *scroll_bar_parts
[(int) event
->part
];
5900 Fcons (Qvertical_scroll_bar
,
5901 Fcons (portion_whole
,
5902 Fcons (make_number (event
->timestamp
),
5903 Fcons (part
, Qnil
)))));
5905 /* Always treat scroll bar events as clicks. */
5906 event
->modifiers
|= click_modifier
;
5907 event
->modifiers
&= ~up_modifier
;
5909 if (event
->code
>= ASIZE (mouse_syms
))
5910 mouse_syms
= larger_vector (mouse_syms
,
5911 event
->code
- ASIZE (mouse_syms
) + 1,
5914 /* Get the symbol we should use for the mouse click. */
5915 head
= modify_event_symbol (event
->code
,
5920 ASIZE (mouse_syms
));
5921 return Fcons (head
, Fcons (position
, Qnil
));
5924 #endif /* USE_TOOLKIT_SCROLL_BARS */
5926 case DRAG_N_DROP_EVENT
:
5929 Lisp_Object head
, position
;
5932 f
= XFRAME (event
->frame_or_window
);
5935 /* Ignore mouse events that were made on frames that
5936 have been deleted. */
5937 if (! FRAME_LIVE_P (f
))
5940 position
= make_lispy_position (f
, event
->x
, event
->y
,
5943 head
= modify_event_symbol (0, event
->modifiers
,
5945 lispy_drag_n_drop_names
,
5946 &drag_n_drop_syms
, 1);
5952 #endif /* HAVE_MOUSE */
5954 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5955 || defined (HAVE_NS) || defined (USE_GTK)
5956 case MENU_BAR_EVENT
:
5957 if (EQ (event
->arg
, event
->frame_or_window
))
5958 /* This is the prefix key. We translate this to
5959 `(menu_bar)' because the code in keyboard.c for menu
5960 events, which we use, relies on this. */
5961 return Fcons (Qmenu_bar
, Qnil
);
5965 case SELECT_WINDOW_EVENT
:
5966 /* Make an event (select-window (WINDOW)). */
5967 return Fcons (Qselect_window
,
5968 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5971 case TOOL_BAR_EVENT
:
5972 if (EQ (event
->arg
, event
->frame_or_window
))
5973 /* This is the prefix key. We translate this to
5974 `(tool_bar)' because the code in keyboard.c for tool bar
5975 events, which we use, relies on this. */
5976 return Fcons (Qtool_bar
, Qnil
);
5977 else if (SYMBOLP (event
->arg
))
5978 return apply_modifiers (event
->modifiers
, event
->arg
);
5981 case USER_SIGNAL_EVENT
:
5982 /* A user signal. */
5984 char *name
= find_user_signal_name (event
->code
);
5987 return intern (name
);
5990 case SAVE_SESSION_EVENT
:
5991 return Qsave_session
;
5996 return Fcons (Qdbus_event
, event
->arg
);
5998 #endif /* HAVE_DBUS */
6000 case CONFIG_CHANGED_EVENT
:
6001 return Fcons (Qconfig_changed_event
,
6003 Fcons (event
->frame_or_window
, Qnil
)));
6005 case GPM_CLICK_EVENT
:
6007 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6008 Lisp_Object head
, position
;
6009 Lisp_Object
*start_pos_ptr
;
6010 Lisp_Object start_pos
;
6011 int button
= event
->code
;
6013 if (button
>= ASIZE (button_down_location
))
6015 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
6016 button_down_location
= larger_vector (button_down_location
,
6018 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
6021 start_pos_ptr
= aref_addr (button_down_location
, button
);
6022 start_pos
= *start_pos_ptr
;
6024 position
= make_lispy_position (f
, event
->x
, event
->y
,
6027 if (event
->modifiers
& down_modifier
)
6028 *start_pos_ptr
= Fcopy_alist (position
);
6029 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6031 if (!CONSP (start_pos
))
6033 event
->modifiers
&= ~up_modifier
;
6036 head
= modify_event_symbol (button
,
6038 Qmouse_click
, Vlispy_mouse_stem
,
6041 ASIZE (mouse_syms
));
6043 if (event
->modifiers
& drag_modifier
)
6048 else if (event
->modifiers
& double_modifier
)
6051 Fcons (make_number (2),
6053 else if (event
->modifiers
& triple_modifier
)
6056 Fcons (make_number (3),
6063 #endif /* HAVE_GPM */
6065 /* The 'kind' field of the event is something we don't recognize. */
6071 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6074 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6075 Lisp_Object x
, Lisp_Object y
, Time t
)
6077 /* Is it a scroll bar movement? */
6078 if (frame
&& ! NILP (bar_window
))
6080 Lisp_Object part_sym
;
6082 part_sym
= *scroll_bar_parts
[(int) part
];
6083 return Fcons (Qscroll_bar_movement
,
6084 Fcons (list5 (bar_window
,
6085 Qvertical_scroll_bar
,
6091 /* Or is it an ordinary mouse movement? */
6094 Lisp_Object position
;
6095 position
= make_lispy_position (frame
, x
, y
, t
);
6096 return list2 (Qmouse_movement
, position
);
6100 #endif /* HAVE_MOUSE || HAVE GPM */
6102 /* Construct a switch frame event. */
6104 make_lispy_switch_frame (Lisp_Object frame
)
6106 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6109 /* Manipulating modifiers. */
6111 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6113 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6114 SYMBOL's name of the end of the modifiers; the string from this
6115 position is the unmodified symbol name.
6117 This doesn't use any caches. */
6120 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6126 CHECK_SYMBOL (symbol
);
6129 name
= SYMBOL_NAME (symbol
);
6131 for (i
= 0; i
< SBYTES (name
) - 1; )
6133 ptrdiff_t this_mod_end
= 0;
6136 /* See if the name continues with a modifier word.
6137 Check that the word appears, but don't check what follows it.
6138 Set this_mod and this_mod_end to record what we find. */
6140 switch (SREF (name
, i
))
6142 #define SINGLE_LETTER_MOD(BIT) \
6143 (this_mod_end = i + 1, this_mod = BIT)
6146 SINGLE_LETTER_MOD (alt_modifier
);
6150 SINGLE_LETTER_MOD (ctrl_modifier
);
6154 SINGLE_LETTER_MOD (hyper_modifier
);
6158 SINGLE_LETTER_MOD (meta_modifier
);
6162 SINGLE_LETTER_MOD (shift_modifier
);
6166 SINGLE_LETTER_MOD (super_modifier
);
6169 #undef SINGLE_LETTER_MOD
6171 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6172 if (i + LEN + 1 <= SBYTES (name) \
6173 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6175 this_mod_end = i + LEN; \
6180 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6181 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6182 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6186 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6188 #undef MULTI_LETTER_MOD
6192 /* If we found no modifier, stop looking for them. */
6193 if (this_mod_end
== 0)
6196 /* Check there is a dash after the modifier, so that it
6197 really is a modifier. */
6198 if (this_mod_end
>= SBYTES (name
)
6199 || SREF (name
, this_mod_end
) != '-')
6202 /* This modifier is real; look for another. */
6203 modifiers
|= this_mod
;
6204 i
= this_mod_end
+ 1;
6207 /* Should we include the `click' modifier? */
6208 if (! (modifiers
& (down_modifier
| drag_modifier
6209 | double_modifier
| triple_modifier
))
6210 && i
+ 7 == SBYTES (name
)
6211 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6212 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6213 modifiers
|= click_modifier
;
6215 if (! (modifiers
& (double_modifier
| triple_modifier
))
6216 && i
+ 6 < SBYTES (name
)
6217 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6218 modifiers
|= click_modifier
;
6226 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6227 prepended to the string BASE[0..BASE_LEN-1].
6228 This doesn't use any caches. */
6230 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6232 /* Since BASE could contain nulls, we can't use intern here; we have
6233 to use Fintern, which expects a genuine Lisp_String, and keeps a
6235 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6241 /* Only the event queue may use the `up' modifier; it should always
6242 be turned into a click or drag event before presented to lisp code. */
6243 if (modifiers
& up_modifier
)
6246 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6247 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6248 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6249 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6250 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6251 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6252 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6253 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6254 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6255 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6256 /* The click modifier is denoted by the absence of other modifiers. */
6260 mod_len
= p
- new_mods
;
6264 Lisp_Object new_name
;
6266 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6267 mod_len
+ base_len_byte
);
6268 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6269 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6271 return Fintern (new_name
, Qnil
);
6276 static const char *const modifier_names
[] =
6278 "up", "down", "drag", "click", "double", "triple", 0, 0,
6279 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6280 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6282 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6284 static Lisp_Object modifier_symbols
;
6286 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6288 lispy_modifier_list (int modifiers
)
6290 Lisp_Object modifier_list
;
6293 modifier_list
= Qnil
;
6294 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6295 if (modifiers
& (1<<i
))
6296 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6299 return modifier_list
;
6303 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6304 where UNMODIFIED is the unmodified form of SYMBOL,
6305 MASK is the set of modifiers present in SYMBOL's name.
6306 This is similar to parse_modifiers_uncached, but uses the cache in
6307 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6308 Qevent_symbol_elements property. */
6310 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6313 parse_modifiers (Lisp_Object symbol
)
6315 Lisp_Object elements
;
6317 if (INTEGERP (symbol
))
6318 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6319 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6321 else if (!SYMBOLP (symbol
))
6324 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6325 if (CONSP (elements
))
6330 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6331 Lisp_Object unmodified
;
6334 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6335 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6338 if (modifiers
& ~INTMASK
)
6340 XSETFASTINT (mask
, modifiers
);
6341 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6343 /* Cache the parsing results on SYMBOL. */
6344 Fput (symbol
, Qevent_symbol_element_mask
,
6346 Fput (symbol
, Qevent_symbol_elements
,
6347 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6349 /* Since we know that SYMBOL is modifiers applied to unmodified,
6350 it would be nice to put that in unmodified's cache.
6351 But we can't, since we're not sure that parse_modifiers is
6358 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6359 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6360 doc
: /* Parse the event symbol. For internal use. */)
6361 (Lisp_Object symbol
)
6363 /* Fill the cache if needed. */
6364 parse_modifiers (symbol
);
6365 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6366 and use the Lispier representation stored on Qevent_symbol_elements
6368 return Fget (symbol
, Qevent_symbol_elements
);
6371 /* Apply the modifiers MODIFIERS to the symbol BASE.
6372 BASE must be unmodified.
6374 This is like apply_modifiers_uncached, but uses BASE's
6375 Qmodifier_cache property, if present. It also builds
6376 Qevent_symbol_elements properties, since it has that info anyway.
6378 apply_modifiers copies the value of BASE's Qevent_kind property to
6379 the modified symbol. */
6381 apply_modifiers (int modifiers
, Lisp_Object base
)
6383 Lisp_Object cache
, idx
, entry
, new_symbol
;
6385 /* Mask out upper bits. We don't know where this value's been. */
6386 modifiers
&= INTMASK
;
6388 if (INTEGERP (base
))
6389 return make_number (XINT (base
) | modifiers
);
6391 /* The click modifier never figures into cache indices. */
6392 cache
= Fget (base
, Qmodifier_cache
);
6393 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6394 entry
= assq_no_quit (idx
, cache
);
6397 new_symbol
= XCDR (entry
);
6400 /* We have to create the symbol ourselves. */
6401 new_symbol
= apply_modifiers_uncached (modifiers
,
6402 SSDATA (SYMBOL_NAME (base
)),
6403 SCHARS (SYMBOL_NAME (base
)),
6404 SBYTES (SYMBOL_NAME (base
)));
6406 /* Add the new symbol to the base's cache. */
6407 entry
= Fcons (idx
, new_symbol
);
6408 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6410 /* We have the parsing info now for free, so we could add it to
6412 XSETFASTINT (idx, modifiers);
6413 Fput (new_symbol, Qevent_symbol_element_mask,
6414 Fcons (base, Fcons (idx, Qnil)));
6415 Fput (new_symbol, Qevent_symbol_elements,
6416 Fcons (base, lispy_modifier_list (modifiers)));
6417 Sadly, this is only correct if `base' is indeed a base event,
6418 which is not necessarily the case. -stef */
6421 /* Make sure this symbol is of the same kind as BASE.
6423 You'd think we could just set this once and for all when we
6424 intern the symbol above, but reorder_modifiers may call us when
6425 BASE's property isn't set right; we can't assume that just
6426 because it has a Qmodifier_cache property it must have its
6427 Qevent_kind set right as well. */
6428 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6432 kind
= Fget (base
, Qevent_kind
);
6434 Fput (new_symbol
, Qevent_kind
, kind
);
6441 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6442 return a symbol with the modifiers placed in the canonical order.
6443 Canonical order is alphabetical, except for down and drag, which
6444 always come last. The 'click' modifier is never written out.
6446 Fdefine_key calls this to make sure that (for example) C-M-foo
6447 and M-C-foo end up being equivalent in the keymap. */
6450 reorder_modifiers (Lisp_Object symbol
)
6452 /* It's hopefully okay to write the code this way, since everything
6453 will soon be in caches, and no consing will be done at all. */
6456 parsed
= parse_modifiers (symbol
);
6457 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6462 /* For handling events, we often want to produce a symbol whose name
6463 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6464 to some base, like the name of a function key or mouse button.
6465 modify_event_symbol produces symbols of this sort.
6467 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6468 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6471 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6472 into symbol names, or a string specifying a name stem used to
6473 construct a symbol name or the form `STEM-N', where N is the decimal
6474 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6475 non-nil; otherwise NAME_TABLE is used.
6477 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6478 persist between calls to modify_event_symbol that it can use to
6479 store a cache of the symbols it's generated for this NAME_TABLE
6480 before. The object stored there may be a vector or an alist.
6482 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6484 MODIFIERS is a set of modifier bits (as given in struct input_events)
6485 whose prefixes should be applied to the symbol name.
6487 SYMBOL_KIND is the value to be placed in the event_kind property of
6488 the returned symbol.
6490 The symbols we create are supposed to have an
6491 `event-symbol-elements' property, which lists the modifiers present
6492 in the symbol's name. */
6495 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6496 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6497 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6500 Lisp_Object symbol_int
;
6502 /* Get rid of the "vendor-specific" bit here. */
6503 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6505 /* Is this a request for a valid symbol? */
6506 if (symbol_num
< 0 || symbol_num
>= table_size
)
6509 if (CONSP (*symbol_table
))
6510 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6512 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6513 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6514 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6515 we've never used that symbol before. */
6518 if (! VECTORP (*symbol_table
)
6519 || ASIZE (*symbol_table
) != table_size
)
6523 XSETFASTINT (size
, table_size
);
6524 *symbol_table
= Fmake_vector (size
, Qnil
);
6527 value
= AREF (*symbol_table
, symbol_num
);
6530 /* Have we already used this symbol before? */
6533 /* No; let's create it. */
6534 if (CONSP (name_alist_or_stem
))
6535 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6536 else if (STRINGP (name_alist_or_stem
))
6539 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6540 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6542 buf
= SAFE_ALLOCA (len
);
6543 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6544 XINT (symbol_int
) + 1);
6545 value
= intern (buf
);
6548 else if (name_table
!= 0 && name_table
[symbol_num
])
6549 value
= intern (name_table
[symbol_num
]);
6551 #ifdef HAVE_WINDOW_SYSTEM
6554 char *name
= x_get_keysym_name (symbol_num
);
6556 value
= intern (name
);
6562 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6563 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6564 value
= intern (buf
);
6567 if (CONSP (*symbol_table
))
6568 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6570 ASET (*symbol_table
, symbol_num
, value
);
6572 /* Fill in the cache entries for this symbol; this also
6573 builds the Qevent_symbol_elements property, which the user
6575 apply_modifiers (modifiers
& click_modifier
, value
);
6576 Fput (value
, Qevent_kind
, symbol_kind
);
6579 /* Apply modifiers to that symbol. */
6580 return apply_modifiers (modifiers
, value
);
6583 /* Convert a list that represents an event type,
6584 such as (ctrl meta backspace), into the usual representation of that
6585 event type as a number or a symbol. */
6587 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6588 doc
: /* Convert the event description list EVENT-DESC to an event type.
6589 EVENT-DESC should contain one base event type (a character or symbol)
6590 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6591 drag, down, double or triple). The base must be last.
6592 The return value is an event type (a character or symbol) which
6593 has the same base event type and all the specified modifiers. */)
6594 (Lisp_Object event_desc
)
6602 while (CONSP (rest
))
6610 /* Given a symbol, see if it is a modifier name. */
6611 if (SYMBOLP (elt
) && CONSP (rest
))
6612 this = parse_solitary_modifier (elt
);
6616 else if (!NILP (base
))
6617 error ("Two bases given in one event");
6623 /* Let the symbol A refer to the character A. */
6624 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6625 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6627 if (INTEGERP (base
))
6629 /* Turn (shift a) into A. */
6630 if ((modifiers
& shift_modifier
) != 0
6631 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6633 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6634 modifiers
&= ~shift_modifier
;
6637 /* Turn (control a) into C-a. */
6638 if (modifiers
& ctrl_modifier
)
6639 return make_number ((modifiers
& ~ctrl_modifier
)
6640 | make_ctrl_char (XINT (base
)));
6642 return make_number (modifiers
| XINT (base
));
6644 else if (SYMBOLP (base
))
6645 return apply_modifiers (modifiers
, base
);
6648 error ("Invalid base event");
6653 /* Try to recognize SYMBOL as a modifier name.
6654 Return the modifier flag bit, or 0 if not recognized. */
6657 parse_solitary_modifier (Lisp_Object symbol
)
6659 Lisp_Object name
= SYMBOL_NAME (symbol
);
6661 switch (SREF (name
, 0))
6663 #define SINGLE_LETTER_MOD(BIT) \
6664 if (SBYTES (name) == 1) \
6667 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6668 if (LEN == SBYTES (name) \
6669 && ! memcmp (SDATA (name), NAME, LEN)) \
6673 SINGLE_LETTER_MOD (alt_modifier
);
6677 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6681 SINGLE_LETTER_MOD (ctrl_modifier
);
6685 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6686 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6690 SINGLE_LETTER_MOD (hyper_modifier
);
6694 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6698 SINGLE_LETTER_MOD (meta_modifier
);
6702 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6706 SINGLE_LETTER_MOD (shift_modifier
);
6710 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6711 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6712 SINGLE_LETTER_MOD (super_modifier
);
6716 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6717 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6718 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6722 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6725 #undef SINGLE_LETTER_MOD
6726 #undef MULTI_LETTER_MOD
6732 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6733 Such a list is not valid as an event,
6734 but it can be a Lucid-style event type list. */
6737 lucid_event_type_list_p (Lisp_Object object
)
6741 if (! CONSP (object
))
6744 if (EQ (XCAR (object
), Qhelp_echo
)
6745 || EQ (XCAR (object
), Qvertical_line
)
6746 || EQ (XCAR (object
), Qmode_line
)
6747 || EQ (XCAR (object
), Qheader_line
))
6750 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6754 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6761 /* Store into *addr a value nonzero if terminal input chars are available.
6762 Serves the purpose of ioctl (0, FIONREAD, addr)
6763 but works even if FIONREAD does not exist.
6764 (In fact, this may actually read some input.)
6766 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6767 timer events that are ripe.
6768 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6769 events (FOCUS_IN_EVENT).
6770 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6771 movements and toolkit scroll bar thumb drags. */
6774 get_input_pending (int *addr
, int flags
)
6776 /* First of all, have we already counted some input? */
6777 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6779 /* If input is being read as it arrives, and we have none, there is none. */
6780 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6783 /* Try to read some input and see how much we get. */
6785 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6788 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6791 gobble_input (int expected
)
6794 if (interrupt_input
)
6797 mask
= sigblock (sigmask (SIGIO
));
6798 read_avail_input (expected
);
6802 #ifdef POLL_FOR_INPUT
6803 /* XXX This condition was (read_socket_hook && !interrupt_input),
6804 but read_socket_hook is not global anymore. Let's pretend that
6806 if (!interrupt_input
&& poll_suppress_count
== 0)
6809 mask
= sigblock (sigmask (SIGALRM
));
6810 read_avail_input (expected
);
6816 read_avail_input (expected
);
6819 /* Put a BUFFER_SWITCH_EVENT in the buffer
6820 so that read_key_sequence will notice the new current buffer. */
6823 record_asynch_buffer_change (void)
6825 struct input_event event
;
6829 event
.kind
= BUFFER_SWITCH_EVENT
;
6830 event
.frame_or_window
= Qnil
;
6833 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6834 The purpose of the event is to make read_key_sequence look up the
6835 keymaps again. If we aren't in read_key_sequence, we don't need one,
6836 and the event could cause trouble by messing up (input-pending-p).
6837 Note: Fwaiting_for_user_input_p always returns nil when async
6838 subprocesses aren't supported. */
6839 tem
= Fwaiting_for_user_input_p ();
6843 /* Make sure no interrupt happens while storing the event. */
6845 if (interrupt_input
)
6848 mask
= sigblock (sigmask (SIGIO
));
6849 kbd_buffer_store_event (&event
);
6856 kbd_buffer_store_event (&event
);
6861 /* Read any terminal input already buffered up by the system
6862 into the kbd_buffer, but do not wait.
6864 EXPECTED should be nonzero if the caller knows there is some input.
6866 Returns the number of keyboard chars read, or -1 meaning
6867 this is a bad time to try to read input. */
6870 read_avail_input (int expected
)
6876 /* Store pending user signal events, if any. */
6877 if (store_user_signal_events ())
6880 /* Loop through the available terminals, and call their input hooks. */
6884 struct terminal
*next
= t
->next_terminal
;
6886 if (t
->read_socket_hook
)
6889 struct input_event hold_quit
;
6891 EVENT_INIT (hold_quit
);
6892 hold_quit
.kind
= NO_EVENT
;
6894 /* No need for FIONREAD or fcntl; just say don't wait. */
6895 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6901 if (nr
== -1) /* Not OK to read input now. */
6905 else if (nr
== -2) /* Non-transient error. */
6907 /* The terminal device terminated; it should be closed. */
6909 /* Kill Emacs if this was our last terminal. */
6910 if (!terminal_list
->next_terminal
)
6911 /* Formerly simply reported no input, but that
6912 sometimes led to a failure of Emacs to terminate.
6913 SIGHUP seems appropriate if we can't reach the
6915 /* ??? Is it really right to send the signal just to
6916 this process rather than to the whole process
6917 group? Perhaps on systems with FIONREAD Emacs is
6918 alone in its group. */
6919 kill (getpid (), SIGHUP
);
6921 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6924 XSETTERMINAL (tmp
, t
);
6925 Fdelete_terminal (tmp
, Qnoelisp
);
6929 if (hold_quit
.kind
!= NO_EVENT
)
6930 kbd_buffer_store_event (&hold_quit
);
6939 frame_make_pointer_visible ();
6945 decode_keyboard_code (struct tty_display_info
*tty
,
6946 struct coding_system
*coding
,
6947 unsigned char *buf
, int nbytes
)
6949 unsigned char *src
= buf
;
6950 const unsigned char *p
;
6955 if (tty
->meta_key
!= 2)
6956 for (i
= 0; i
< nbytes
; i
++)
6958 if (coding
->carryover_bytes
> 0)
6960 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6961 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6962 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6963 nbytes
+= coding
->carryover_bytes
;
6965 coding
->destination
= alloca (nbytes
* 4);
6966 coding
->dst_bytes
= nbytes
* 4;
6967 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6968 if (coding
->produced_char
== 0)
6970 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6972 struct input_event event_buf
;
6974 EVENT_INIT (event_buf
);
6975 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6977 (ASCII_CHAR_P (event_buf
.code
)
6978 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6979 /* See the comment in tty_read_avail_input. */
6980 event_buf
.frame_or_window
= tty
->top_frame
;
6981 event_buf
.arg
= Qnil
;
6982 kbd_buffer_store_event (&event_buf
);
6986 /* This is the tty way of reading available input.
6988 Note that each terminal device has its own `struct terminal' object,
6989 and so this function is called once for each individual termcap
6990 terminal. The first parameter indicates which terminal to read from. */
6993 tty_read_avail_input (struct terminal
*terminal
,
6995 struct input_event
*hold_quit
)
6997 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6998 the kbd_buffer can really hold. That may prevent loss
6999 of characters on some systems when input is stuffed at us. */
7000 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7002 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7005 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7007 if (kbd_on_hold_p () || buffer_free
<= 0)
7009 #endif /* subprocesses */
7011 if (!terminal
->name
) /* Don't read from a dead terminal. */
7014 if (terminal
->type
!= output_termcap
7015 && terminal
->type
!= output_msdos_raw
)
7018 /* XXX I think the following code should be moved to separate hook
7019 functions in system-dependent files. */
7022 #else /* not WINDOWSNT */
7023 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7027 return 0; /* The terminal is suspended. */
7030 n_to_read
= dos_keysns ();
7034 cbuf
[0] = dos_keyread ();
7037 #else /* not MSDOS */
7042 struct input_event gpm_hold_quit
;
7043 int gpm
, fd
= gpm_fd
;
7045 EVENT_INIT (gpm_hold_quit
);
7046 gpm_hold_quit
.kind
= NO_EVENT
;
7048 /* gpm==1 if event received.
7049 gpm==0 if the GPM daemon has closed the connection, in which case
7050 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7051 we save it in `fd' so close_gpm can remove it from the
7053 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7054 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7055 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7058 /* Presumably the GPM daemon has closed the connection. */
7060 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7061 kbd_buffer_store_event (&gpm_hold_quit
);
7065 #endif /* HAVE_GPM */
7067 /* Determine how many characters we should *try* to read. */
7069 /* Find out how much input is available. */
7070 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7072 if (! noninteractive
)
7073 return -2; /* Close this terminal. */
7079 if (n_to_read
> sizeof cbuf
)
7080 n_to_read
= sizeof cbuf
;
7081 #else /* no FIONREAD */
7082 #if defined (USG) || defined (CYGWIN)
7083 /* Read some input if available, but don't wait. */
7084 n_to_read
= sizeof cbuf
;
7085 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7092 /* Don't read more than we can store. */
7093 if (n_to_read
> buffer_free
)
7094 n_to_read
= buffer_free
;
7095 #endif /* subprocesses */
7097 /* Now read; for one reason or another, this will not block.
7098 NREAD is set to the number of chars read. */
7101 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7102 /* POSIX infers that processes which are not in the session leader's
7103 process group won't get SIGHUP's at logout time. BSDI adheres to
7104 this part standard and returns -1 from read (0) with errno==EIO
7105 when the control tty is taken away.
7106 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7107 if (nread
== -1 && errno
== EIO
)
7108 return -2; /* Close this terminal. */
7109 #if defined (AIX) && defined (_BSD)
7110 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7111 This looks incorrect, but it isn't, because _BSD causes
7112 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7113 and that causes a value other than 0 when there is no input. */
7115 return -2; /* Close this terminal. */
7119 /* We used to retry the read if it was interrupted.
7120 But this does the wrong thing when O_NDELAY causes
7121 an EAGAIN error. Does anybody know of a situation
7122 where a retry is actually needed? */
7124 nread
< 0 && (errno
== EAGAIN
7138 #if defined (USG) || defined (CYGWIN)
7139 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7140 #endif /* USG or CYGWIN */
7141 #endif /* no FIONREAD */
7146 #endif /* not MSDOS */
7147 #endif /* not WINDOWSNT */
7149 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7150 & CODING_REQUIRE_DECODING_MASK
)
7152 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7155 /* Decode the key sequence except for those with meta
7157 for (i
= from
= 0; ; i
++)
7158 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7160 struct input_event buf
;
7162 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7167 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7168 buf
.modifiers
= meta_modifier
;
7169 buf
.code
= cbuf
[i
] & ~0x80;
7170 /* See the comment below. */
7171 buf
.frame_or_window
= tty
->top_frame
;
7173 kbd_buffer_store_event (&buf
);
7179 for (i
= 0; i
< nread
; i
++)
7181 struct input_event buf
;
7183 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7185 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7186 buf
.modifiers
= meta_modifier
;
7187 if (tty
->meta_key
!= 2)
7191 /* Set the frame corresponding to the active tty. Note that the
7192 value of selected_frame is not reliable here, redisplay tends
7193 to temporarily change it. */
7194 buf
.frame_or_window
= tty
->top_frame
;
7197 kbd_buffer_store_event (&buf
);
7198 /* Don't look at input that follows a C-g too closely.
7199 This reduces lossage due to autorepeat on C-g. */
7200 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7201 && buf
.code
== quit_char
)
7208 #if defined SYNC_INPUT || defined SIGIO
7210 handle_async_input (void)
7212 interrupt_input_pending
= 0;
7214 pending_signals
= pending_atimers
;
7216 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7217 doing anything dangerous. */
7224 nread
= read_avail_input (1);
7225 /* -1 means it's not ok to read the input now.
7226 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7227 0 means there was no keyboard input available. */
7235 #endif /* SYNC_INPUT || SIGIO */
7239 process_pending_signals (void)
7241 if (interrupt_input_pending
)
7242 handle_async_input ();
7243 do_pending_atimers ();
7247 #ifdef SIGIO /* for entire page */
7248 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7251 input_available_signal (int signo
)
7253 /* Must preserve main program's value of errno. */
7254 int old_errno
= errno
;
7255 SIGNAL_THREAD_CHECK (signo
);
7258 interrupt_input_pending
= 1;
7259 pending_signals
= 1;
7262 if (input_available_clear_time
)
7263 *input_available_clear_time
= make_emacs_time (0, 0);
7266 handle_async_input ();
7273 /* Send ourselves a SIGIO.
7275 This function exists so that the UNBLOCK_INPUT macro in
7276 blockinput.h can have some way to take care of input we put off
7277 dealing with, without assuming that every file which uses
7278 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7280 reinvoke_input_signal (void)
7283 handle_async_input ();
7289 /* User signal events. */
7291 struct user_signal_info
7293 /* Signal number. */
7296 /* Name of the signal. */
7299 /* Number of pending signals. */
7302 struct user_signal_info
*next
;
7305 /* List of user signals. */
7306 static struct user_signal_info
*user_signals
= NULL
;
7309 add_user_signal (int sig
, const char *name
)
7311 struct user_signal_info
*p
;
7313 for (p
= user_signals
; p
; p
= p
->next
)
7315 /* Already added. */
7318 p
= xmalloc (sizeof *p
);
7320 p
->name
= xstrdup (name
);
7322 p
->next
= user_signals
;
7325 signal (sig
, handle_user_signal
);
7329 handle_user_signal (int sig
)
7331 int old_errno
= errno
;
7332 struct user_signal_info
*p
;
7333 const char *special_event_name
= NULL
;
7335 SIGNAL_THREAD_CHECK (sig
);
7337 if (SYMBOLP (Vdebug_on_event
))
7338 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7340 for (p
= user_signals
; p
; p
= p
->next
)
7343 if (special_event_name
7344 && strcmp (special_event_name
, p
->name
) == 0)
7346 /* Enter the debugger in many ways. */
7347 debug_on_next_call
= 1;
7350 Vinhibit_quit
= Qnil
;
7352 /* Eat the event. */
7358 if (interrupt_input
)
7359 kill (getpid (), SIGIO
);
7363 /* Tell wait_reading_process_output that it needs to wake
7364 up and look around. */
7365 if (input_available_clear_time
)
7366 *input_available_clear_time
= make_emacs_time (0, 0);
7375 find_user_signal_name (int sig
)
7377 struct user_signal_info
*p
;
7379 for (p
= user_signals
; p
; p
= p
->next
)
7387 store_user_signal_events (void)
7389 struct user_signal_info
*p
;
7390 struct input_event buf
;
7393 for (p
= user_signals
; p
; p
= p
->next
)
7394 if (p
->npending
> 0)
7400 memset (&buf
, 0, sizeof buf
);
7401 buf
.kind
= USER_SIGNAL_EVENT
;
7402 buf
.frame_or_window
= selected_frame
;
7404 nstored
+= p
->npending
;
7406 mask
= sigblock (sigmask (p
->sig
));
7410 kbd_buffer_store_event (&buf
);
7413 while (p
->npending
> 0);
7421 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7422 static Lisp_Object menu_bar_one_keymap_changed_items
;
7424 /* These variables hold the vector under construction within
7425 menu_bar_items and its subroutines, and the current index
7426 for storing into that vector. */
7427 static Lisp_Object menu_bar_items_vector
;
7428 static int menu_bar_items_index
;
7431 static const char* separator_names
[] = {
7436 "single-dashed-line",
7437 "double-dashed-line",
7439 "shadow-etched-out",
7440 "shadow-etched-in-dash",
7441 "shadow-etched-out-dash",
7442 "shadow-double-etched-in",
7443 "shadow-double-etched-out",
7444 "shadow-double-etched-in-dash",
7445 "shadow-double-etched-out-dash",
7449 /* Return non-zero if LABEL specifies a separator. */
7452 menu_separator_name_p (const char *label
)
7456 else if (strlen (label
) > 3
7457 && memcmp (label
, "--", 2) == 0
7462 for (i
= 0; separator_names
[i
]; ++i
)
7463 if (strcmp (label
, separator_names
[i
]) == 0)
7468 /* It's a separator if it contains only dashes. */
7469 while (*label
== '-')
7471 return (*label
== 0);
7478 /* Return a vector of menu items for a menu bar, appropriate
7479 to the current buffer. Each item has three elements in the vector:
7482 OLD is an old vector we can optionally reuse, or nil. */
7485 menu_bar_items (Lisp_Object old
)
7487 /* The number of keymaps we're scanning right now, and the number of
7488 keymaps we have allocated space for. */
7491 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7492 in the current keymaps, or nil where it is not a prefix. */
7495 Lisp_Object def
, tail
;
7500 /* In order to build the menus, we need to call the keymap
7501 accessors. They all call QUIT. But this function is called
7502 during redisplay, during which a quit is fatal. So inhibit
7503 quitting while building the menus.
7504 We do this instead of specbind because (1) errors will clear it anyway
7505 and (2) this avoids risk of specpdl overflow. */
7506 oquit
= Vinhibit_quit
;
7510 menu_bar_items_vector
= old
;
7512 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7513 menu_bar_items_index
= 0;
7515 /* Build our list of keymaps.
7516 If we recognize a function key and replace its escape sequence in
7517 keybuf with its symbol, or if the sequence starts with a mouse
7518 click and we need to switch buffers, we jump back here to rebuild
7519 the initial keymaps from the current buffer. */
7523 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7524 if (!NILP (Voverriding_local_map_menu_flag
))
7526 /* Yes, use them (if non-nil) as well as the global map. */
7527 maps
= alloca (3 * sizeof (maps
[0]));
7529 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7530 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7531 if (!NILP (Voverriding_local_map
))
7532 maps
[nmaps
++] = Voverriding_local_map
;
7536 /* No, so use major and minor mode keymaps and keymap property.
7537 Note that menu-bar bindings in the local-map and keymap
7538 properties may not work reliable, as they are only
7539 recognized when the menu-bar (or mode-line) is updated,
7540 which does not normally happen after every command. */
7543 nminor
= current_minor_maps (NULL
, &tmaps
);
7544 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7546 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7547 maps
[nmaps
++] = tem
;
7548 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7550 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7552 maps
[nmaps
++] = current_global_map
;
7555 /* Look up in each map the dummy prefix key `menu-bar'. */
7557 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7558 if (!NILP (maps
[mapno
]))
7560 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7564 menu_bar_one_keymap_changed_items
= Qnil
;
7565 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7569 /* Move to the end those items that should be at the end. */
7571 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7574 int end
= menu_bar_items_index
;
7576 for (i
= 0; i
< end
; i
+= 4)
7577 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7579 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7580 /* Move the item at index I to the end,
7581 shifting all the others forward. */
7582 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7583 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7584 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7585 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7587 memmove (aref_addr (menu_bar_items_vector
, i
),
7588 aref_addr (menu_bar_items_vector
, i
+ 4),
7589 (end
- i
- 4) * word_size
);
7590 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7591 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7592 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7593 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7598 /* Add nil, nil, nil, nil at the end. */
7600 int i
= menu_bar_items_index
;
7601 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7602 menu_bar_items_vector
=
7603 larger_vector (menu_bar_items_vector
, 4, -1);
7604 /* Add this item. */
7605 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7606 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7607 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7608 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7609 menu_bar_items_index
= i
;
7612 Vinhibit_quit
= oquit
;
7613 return menu_bar_items_vector
;
7616 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7617 If there's already an item for KEY, add this DEF to it. */
7619 Lisp_Object item_properties
;
7622 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7624 struct gcpro gcpro1
;
7628 if (EQ (item
, Qundefined
))
7630 /* If a map has an explicit `undefined' as definition,
7631 discard any previously made menu bar item. */
7633 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7634 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7636 if (menu_bar_items_index
> i
+ 4)
7637 memmove (aref_addr (menu_bar_items_vector
, i
),
7638 aref_addr (menu_bar_items_vector
, i
+ 4),
7639 (menu_bar_items_index
- i
- 4) * word_size
);
7640 menu_bar_items_index
-= 4;
7644 /* If this keymap has already contributed to this KEY,
7645 don't contribute to it a second time. */
7646 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7647 if (!NILP (tem
) || NILP (item
))
7650 menu_bar_one_keymap_changed_items
7651 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7653 /* We add to menu_bar_one_keymap_changed_items before doing the
7654 parse_menu_item, so that if it turns out it wasn't a menu item,
7655 it still correctly hides any further menu item. */
7657 i
= parse_menu_item (item
, 1);
7662 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7664 /* Find any existing item for this KEY. */
7665 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7666 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7669 /* If we did not find this KEY, add it at the end. */
7670 if (i
== menu_bar_items_index
)
7672 /* If vector is too small, get a bigger one. */
7673 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7674 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7675 /* Add this item. */
7676 ASET (menu_bar_items_vector
, i
, key
); i
++;
7677 ASET (menu_bar_items_vector
, i
,
7678 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7679 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7680 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7681 menu_bar_items_index
= i
;
7683 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7687 old
= AREF (menu_bar_items_vector
, i
+ 2);
7688 /* If the new and the old items are not both keymaps,
7689 the lookup will only find `item'. */
7690 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7691 ASET (menu_bar_items_vector
, i
+ 2, item
);
7695 /* This is used as the handler when calling menu_item_eval_property. */
7697 menu_item_eval_property_1 (Lisp_Object arg
)
7699 /* If we got a quit from within the menu computation,
7700 quit all the way out of it. This takes care of C-] in the debugger. */
7701 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7702 Fsignal (Qquit
, Qnil
);
7708 eval_dyn (Lisp_Object form
)
7710 return Feval (form
, Qnil
);
7713 /* Evaluate an expression and return the result (or nil if something
7714 went wrong). Used to evaluate dynamic parts of menu items. */
7716 menu_item_eval_property (Lisp_Object sexpr
)
7718 ptrdiff_t count
= SPECPDL_INDEX ();
7720 specbind (Qinhibit_redisplay
, Qt
);
7721 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7722 menu_item_eval_property_1
);
7723 return unbind_to (count
, val
);
7726 /* This function parses a menu item and leaves the result in the
7727 vector item_properties.
7728 ITEM is a key binding, a possible menu item.
7729 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7731 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7732 parse_menu_item returns true if the item is a menu item and false
7736 parse_menu_item (Lisp_Object item
, int inmenubar
)
7738 Lisp_Object def
, tem
, item_string
, start
;
7740 Lisp_Object keyhint
;
7749 /* Create item_properties vector if necessary. */
7750 if (NILP (item_properties
))
7752 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7754 /* Initialize optional entries. */
7755 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7756 ASET (item_properties
, i
, Qnil
);
7757 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7759 /* Save the item here to protect it from GC. */
7760 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7762 item_string
= XCAR (item
);
7766 if (STRINGP (item_string
))
7768 /* Old format menu item. */
7769 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7771 /* Maybe help string. */
7772 if (CONSP (item
) && STRINGP (XCAR (item
)))
7774 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7779 /* Maybe an obsolete key binding cache. */
7780 if (CONSP (item
) && CONSP (XCAR (item
))
7781 && (NILP (XCAR (XCAR (item
)))
7782 || VECTORP (XCAR (XCAR (item
)))))
7785 /* This is the real definition--the function to run. */
7786 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7788 /* Get enable property, if any. */
7791 tem
= Fget (item
, Qmenu_enable
);
7792 if (!NILP (Venable_disabled_menus_and_buttons
))
7793 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7794 else if (!NILP (tem
))
7795 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7798 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7800 /* New format menu item. */
7801 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7802 start
= XCDR (item
);
7805 /* We have a real binding. */
7806 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7808 item
= XCDR (start
);
7809 /* Is there an obsolete cache list with key equivalences. */
7810 if (CONSP (item
) && CONSP (XCAR (item
)))
7813 /* Parse properties. */
7814 while (CONSP (item
) && CONSP (XCDR (item
)))
7819 if (EQ (tem
, QCenable
))
7821 if (!NILP (Venable_disabled_menus_and_buttons
))
7822 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7824 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7826 else if (EQ (tem
, QCvisible
))
7828 /* If got a visible property and that evaluates to nil
7829 then ignore this item. */
7830 tem
= menu_item_eval_property (XCAR (item
));
7834 else if (EQ (tem
, QChelp
))
7835 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7836 else if (EQ (tem
, QCfilter
))
7838 else if (EQ (tem
, QCkey_sequence
))
7841 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7842 /* Be GC protected. Set keyhint to item instead of tem. */
7845 else if (EQ (tem
, QCkeys
))
7848 if (CONSP (tem
) || STRINGP (tem
))
7849 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7851 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7856 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7858 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7860 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7866 else if (inmenubar
|| !NILP (start
))
7870 return 0; /* not a menu item */
7872 /* If item string is not a string, evaluate it to get string.
7873 If we don't get a string, skip this item. */
7874 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7875 if (!(STRINGP (item_string
)))
7877 item_string
= menu_item_eval_property (item_string
);
7878 if (!STRINGP (item_string
))
7880 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7883 /* If got a filter apply it on definition. */
7884 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7887 def
= menu_item_eval_property (list2 (XCAR (filter
),
7888 list2 (Qquote
, def
)));
7890 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7893 /* Enable or disable selection of item. */
7894 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7897 tem
= menu_item_eval_property (tem
);
7898 if (inmenubar
&& NILP (tem
))
7899 return 0; /* Ignore disabled items in menu bar. */
7900 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7903 /* If we got no definition, this item is just unselectable text which
7904 is OK in a submenu but not in the menubar. */
7906 return (!inmenubar
);
7908 /* See if this is a separate pane or a submenu. */
7909 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7910 tem
= get_keymap (def
, 0, 1);
7911 /* For a subkeymap, just record its details and exit. */
7914 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7915 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7919 /* At the top level in the menu bar, do likewise for commands also.
7920 The menu bar does not display equivalent key bindings anyway.
7921 ITEM_PROPERTY_DEF is already set up properly. */
7925 { /* This is a command. See if there is an equivalent key binding. */
7926 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7928 /* The previous code preferred :key-sequence to :keys, so we
7929 preserve this behavior. */
7930 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7931 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7934 Lisp_Object prefix
= keyeq
;
7935 Lisp_Object keys
= Qnil
;
7939 def
= XCAR (prefix
);
7940 prefix
= XCDR (prefix
);
7943 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7945 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7947 keys
= XCAR (keyhint
);
7948 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7950 /* We have a suggested key. Is it bound to the command? */
7953 /* If the command is an alias for another
7954 (such as lmenu.el set it up), check if the
7955 original command matches the cached command. */
7957 && EQ (tem
, XSYMBOL (def
)->function
))))
7962 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7966 tem
= Fkey_description (keys
, Qnil
);
7969 if (STRINGP (XCAR (prefix
)))
7970 tem
= concat2 (XCAR (prefix
), tem
);
7971 if (STRINGP (XCDR (prefix
)))
7972 tem
= concat2 (tem
, XCDR (prefix
));
7974 keyeq
= concat2 (build_string (" "), tem
);
7975 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7981 /* If we have an equivalent key binding, use that. */
7982 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7985 /* Include this when menu help is implemented.
7986 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7987 if (!(NILP (tem) || STRINGP (tem)))
7989 tem = menu_item_eval_property (tem);
7992 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7996 /* Handle radio buttons or toggle boxes. */
7997 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7999 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8000 menu_item_eval_property (tem
));
8007 /***********************************************************************
8009 ***********************************************************************/
8011 /* A vector holding tool bar items while they are parsed in function
8012 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8015 static Lisp_Object tool_bar_items_vector
;
8017 /* A vector holding the result of parse_tool_bar_item. Layout is like
8018 the one for a single item in tool_bar_items_vector. */
8020 static Lisp_Object tool_bar_item_properties
;
8022 /* Next free index in tool_bar_items_vector. */
8024 static int ntool_bar_items
;
8026 /* The symbols `:image' and `:rtl'. */
8028 static Lisp_Object QCimage
;
8029 static Lisp_Object QCrtl
;
8031 /* Function prototypes. */
8033 static void init_tool_bar_items (Lisp_Object
);
8034 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8035 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8036 static void append_tool_bar_item (void);
8039 /* Return a vector of tool bar items for keymaps currently in effect.
8040 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8041 tool bar items found. */
8044 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8053 /* In order to build the menus, we need to call the keymap
8054 accessors. They all call QUIT. But this function is called
8055 during redisplay, during which a quit is fatal. So inhibit
8056 quitting while building the menus. We do this instead of
8057 specbind because (1) errors will clear it anyway and (2) this
8058 avoids risk of specpdl overflow. */
8059 oquit
= Vinhibit_quit
;
8062 /* Initialize tool_bar_items_vector and protect it from GC. */
8063 init_tool_bar_items (reuse
);
8065 /* Build list of keymaps in maps. Set nmaps to the number of maps
8068 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8069 if (!NILP (Voverriding_local_map_menu_flag
))
8071 /* Yes, use them (if non-nil) as well as the global map. */
8072 maps
= alloca (3 * sizeof *maps
);
8074 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8075 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8076 if (!NILP (Voverriding_local_map
))
8077 maps
[nmaps
++] = Voverriding_local_map
;
8081 /* No, so use major and minor mode keymaps and keymap property.
8082 Note that tool-bar bindings in the local-map and keymap
8083 properties may not work reliable, as they are only
8084 recognized when the tool-bar (or mode-line) is updated,
8085 which does not normally happen after every command. */
8088 nminor
= current_minor_maps (NULL
, &tmaps
);
8089 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8091 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8092 maps
[nmaps
++] = tem
;
8093 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8095 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8098 /* Add global keymap at the end. */
8099 maps
[nmaps
++] = current_global_map
;
8101 /* Process maps in reverse order and look up in each map the prefix
8103 for (i
= nmaps
- 1; i
>= 0; --i
)
8104 if (!NILP (maps
[i
]))
8108 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8110 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8113 Vinhibit_quit
= oquit
;
8114 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8115 return tool_bar_items_vector
;
8119 /* Process the definition of KEY which is DEF. */
8122 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8125 struct gcpro gcpro1
, gcpro2
;
8127 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8131 if (EQ (def
, Qundefined
))
8133 /* If a map has an explicit `undefined' as definition,
8134 discard any previously made item. */
8135 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8137 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8139 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8141 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8142 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8143 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8145 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8150 else if (parse_tool_bar_item (key
, def
))
8151 /* Append a new tool bar item to tool_bar_items_vector. Accept
8152 more than one definition for the same key. */
8153 append_tool_bar_item ();
8158 /* Access slot with index IDX of vector tool_bar_item_properties. */
8159 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8161 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8163 ASET (tool_bar_item_properties
, idx
, val
);
8167 /* Parse a tool bar item specification ITEM for key KEY and return the
8168 result in tool_bar_item_properties. Value is zero if ITEM is
8171 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8173 CAPTION is the caption of the item, If it's not a string, it is
8174 evaluated to get a string.
8176 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8177 as binding are currently ignored.
8179 The following properties are recognized:
8183 FORM is evaluated and specifies whether the tool bar item is
8184 enabled or disabled.
8188 FORM is evaluated and specifies whether the tool bar item is visible.
8190 - `:filter FUNCTION'
8192 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8193 result is stored as the new binding.
8195 - `:button (TYPE SELECTED)'
8197 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8198 and specifies whether the button is selected (pressed) or not.
8202 IMAGES is either a single image specification or a vector of four
8203 image specifications. See enum tool_bar_item_images.
8205 - `:help HELP-STRING'.
8207 Gives a help string to display for the tool bar item.
8209 - `:label LABEL-STRING'.
8211 A text label to show with the tool bar button if labels are enabled. */
8214 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8216 Lisp_Object filter
= Qnil
;
8217 Lisp_Object caption
;
8218 int i
, have_label
= 0;
8220 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8221 Rule out items that aren't lists, don't start with
8222 `menu-item' or whose rest following `tool-bar-item' is not a
8227 /* As an exception, allow old-style menu separators. */
8228 if (STRINGP (XCAR (item
)))
8229 item
= Fcons (XCAR (item
), Qnil
);
8230 else if (!EQ (XCAR (item
), Qmenu_item
)
8231 || (item
= XCDR (item
), !CONSP (item
)))
8234 /* Create tool_bar_item_properties vector if necessary. Reset it to
8236 if (VECTORP (tool_bar_item_properties
))
8238 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8242 tool_bar_item_properties
8243 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8246 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8247 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8249 /* Get the caption of the item. If the caption is not a string,
8250 evaluate it to get a string. If we don't get a string, skip this
8252 caption
= XCAR (item
);
8253 if (!STRINGP (caption
))
8255 caption
= menu_item_eval_property (caption
);
8256 if (!STRINGP (caption
))
8259 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8261 /* If the rest following the caption is not a list, the menu item is
8262 either a separator, or invalid. */
8266 if (menu_separator_name_p (SSDATA (caption
)))
8268 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8269 #if !defined (USE_GTK) && !defined (HAVE_NS)
8270 /* If we use build_desired_tool_bar_string to render the
8271 tool bar, the separator is rendered as an image. */
8272 PROP (TOOL_BAR_ITEM_IMAGES
)
8273 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8274 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8275 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8276 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8283 /* Store the binding. */
8284 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8287 /* Ignore cached key binding, if any. */
8288 if (CONSP (item
) && CONSP (XCAR (item
)))
8291 /* Process the rest of the properties. */
8292 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8294 Lisp_Object ikey
, value
;
8297 value
= XCAR (XCDR (item
));
8299 if (EQ (ikey
, QCenable
))
8301 /* `:enable FORM'. */
8302 if (!NILP (Venable_disabled_menus_and_buttons
))
8303 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8305 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8307 else if (EQ (ikey
, QCvisible
))
8309 /* `:visible FORM'. If got a visible property and that
8310 evaluates to nil then ignore this item. */
8311 if (NILP (menu_item_eval_property (value
)))
8314 else if (EQ (ikey
, QChelp
))
8315 /* `:help HELP-STRING'. */
8316 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8317 else if (EQ (ikey
, QCvert_only
))
8318 /* `:vert-only t/nil'. */
8319 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8320 else if (EQ (ikey
, QClabel
))
8322 const char *bad_label
= "!!?GARBLED ITEM?!!";
8323 /* `:label LABEL-STRING'. */
8324 set_prop (TOOL_BAR_ITEM_LABEL
,
8325 STRINGP (value
) ? value
: build_string (bad_label
));
8328 else if (EQ (ikey
, QCfilter
))
8329 /* ':filter FORM'. */
8331 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8333 /* `:button (TYPE . SELECTED)'. */
8334 Lisp_Object type
, selected
;
8336 type
= XCAR (value
);
8337 selected
= XCDR (value
);
8338 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8340 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8341 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8344 else if (EQ (ikey
, QCimage
)
8346 || (VECTORP (value
) && ASIZE (value
) == 4)))
8347 /* Value is either a single image specification or a vector
8348 of 4 such specifications for the different button states. */
8349 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8350 else if (EQ (ikey
, QCrtl
))
8352 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8358 /* Try to make one from caption and key. */
8359 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8360 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8361 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8362 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8364 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8365 char *buf
= xmalloc (max_lbl
+ 1);
8366 Lisp_Object new_lbl
;
8367 ptrdiff_t caption_len
= strlen (capt
);
8369 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8372 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8374 buf
[caption_len
] = '\0';
8378 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8382 strcpy (buf
, label
);
8384 for (j
= 0; buf
[j
] != '\0'; ++j
)
8392 new_lbl
= Fupcase_initials (build_string (label
));
8393 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8394 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8396 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8400 /* If got a filter apply it on binding. */
8402 set_prop (TOOL_BAR_ITEM_BINDING
,
8403 (menu_item_eval_property
8406 PROP (TOOL_BAR_ITEM_BINDING
))))));
8408 /* See if the binding is a keymap. Give up if it is. */
8409 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8412 /* Enable or disable selection of item. */
8413 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8414 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8415 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8417 /* Handle radio buttons or toggle boxes. */
8418 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8419 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8420 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8428 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8429 that can be reused. */
8432 init_tool_bar_items (Lisp_Object reuse
)
8434 if (VECTORP (reuse
))
8435 tool_bar_items_vector
= reuse
;
8437 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8438 ntool_bar_items
= 0;
8442 /* Append parsed tool bar item properties from
8443 tool_bar_item_properties */
8446 append_tool_bar_item (void)
8450 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8452 /* Enlarge tool_bar_items_vector if necessary. */
8454 tool_bar_items_vector
8455 = larger_vector (tool_bar_items_vector
, incr
, -1);
8457 /* Append entries from tool_bar_item_properties to the end of
8458 tool_bar_items_vector. */
8459 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8460 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8461 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8468 /* Read a character using menus based on maps in the array MAPS.
8469 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8470 Return t if we displayed a menu but the user rejected it.
8472 PREV_EVENT is the previous input event, or nil if we are reading
8473 the first event of a key sequence.
8475 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8476 if we used a mouse menu to read the input, or zero otherwise. If
8477 USED_MOUSE_MENU is null, we don't dereference it.
8479 The prompting is done based on the prompt-string of the map
8480 and the strings associated with various map elements.
8482 This can be done with X menus or with menus put in the minibuf.
8483 These are done in different ways, depending on how the input will be read.
8484 Menus using X are done after auto-saving in read-char, getting the input
8485 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8486 and do auto-saving in the inner call of read_char. */
8489 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8490 Lisp_Object prev_event
, int *used_mouse_menu
)
8496 if (used_mouse_menu
)
8497 *used_mouse_menu
= 0;
8499 /* Use local over global Menu maps */
8501 if (! menu_prompting
)
8504 /* Optionally disregard all but the global map. */
8505 if (inhibit_local_menu_bar_menus
)
8507 maps
+= (nmaps
- 1);
8512 /* If we got to this point via a mouse click,
8513 use a real menu for mouse selection. */
8514 if (EVENT_HAS_PARAMETERS (prev_event
)
8515 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8516 && !EQ (XCAR (prev_event
), Qtool_bar
))
8518 /* Display the menu and get the selection. */
8519 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8521 ptrdiff_t nmaps1
= 0;
8523 /* Use the maps that are not nil. */
8524 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8525 if (!NILP (maps
[mapno
]))
8526 realmaps
[nmaps1
++] = maps
[mapno
];
8528 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8533 record_menu_key (XCAR (value
));
8535 /* If we got multiple events, unread all but
8537 There is no way to prevent those unread events
8538 from showing up later in last_nonmenu_event.
8539 So turn symbol and integer events into lists,
8540 to indicate that they came from a mouse menu,
8541 so that when present in last_nonmenu_event
8542 they won't confuse things. */
8543 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8545 record_menu_key (XCAR (tem
));
8546 if (SYMBOLP (XCAR (tem
))
8547 || INTEGERP (XCAR (tem
)))
8548 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8551 /* If we got more than one event, put all but the first
8552 onto this list to be read later.
8553 Return just the first event now. */
8554 Vunread_command_events
8555 = nconc2 (XCDR (value
), Vunread_command_events
);
8556 value
= XCAR (value
);
8558 else if (NILP (value
))
8560 if (used_mouse_menu
)
8561 *used_mouse_menu
= 1;
8564 #endif /* HAVE_MENUS */
8568 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8569 We make this bigger when necessary, and never free it. */
8570 static char *read_char_minibuf_menu_text
;
8571 /* Size of that buffer. */
8572 static ptrdiff_t read_char_minibuf_menu_width
;
8575 read_char_minibuf_menu_prompt (int commandflag
,
8576 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8579 register Lisp_Object name
;
8581 /* FIXME: Use the minibuffer's frame width. */
8582 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8585 Lisp_Object rest
, vector
;
8591 if (! menu_prompting
)
8594 /* Get the menu name from the first map that has one (a prompt string). */
8595 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8597 name
= Fkeymap_prompt (maps
[mapno
]);
8602 /* If we don't have any menus, just read a character normally. */
8603 if (!STRINGP (name
))
8606 /* Make sure we have a big enough buffer for the menu text. */
8607 width
= max (width
, SBYTES (name
));
8608 if (STRING_BYTES_BOUND
- 4 < width
)
8609 memory_full (SIZE_MAX
);
8610 if (width
+ 4 > read_char_minibuf_menu_width
)
8612 read_char_minibuf_menu_text
8613 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8614 read_char_minibuf_menu_width
= width
+ 4;
8616 menu
= read_char_minibuf_menu_text
;
8618 /* Prompt string always starts with map's prompt, and a space. */
8619 strcpy (menu
, SSDATA (name
));
8620 nlength
= SBYTES (name
);
8621 menu
[nlength
++] = ':';
8622 menu
[nlength
++] = ' ';
8625 /* Start prompting at start of first map. */
8629 /* Present the documented bindings, a line at a time. */
8633 ptrdiff_t i
= nlength
;
8635 Lisp_Object orig_defn_macro
;
8637 /* Loop over elements of map. */
8642 /* If reached end of map, start at beginning of next map. */
8646 /* At end of last map, wrap around to first map if just starting,
8647 or end this line if already have something on it. */
8651 if (notfirst
|| nobindings
) break;
8656 /* Look at the next element of the map. */
8658 elt
= AREF (vector
, idx
);
8660 elt
= Fcar_safe (rest
);
8662 if (idx
< 0 && VECTORP (elt
))
8664 /* If we found a dense table in the keymap,
8665 advanced past it, but start scanning its contents. */
8666 rest
= Fcdr_safe (rest
);
8672 /* An ordinary element. */
8673 Lisp_Object event
, tem
;
8677 event
= Fcar_safe (elt
); /* alist */
8678 elt
= Fcdr_safe (elt
);
8682 XSETINT (event
, idx
); /* vector */
8685 /* Ignore the element if it has no prompt string. */
8686 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8688 /* 1 if the char to type matches the string. */
8690 Lisp_Object upcased_event
, downcased_event
;
8691 Lisp_Object desc
= Qnil
;
8693 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8695 upcased_event
= Fupcase (event
);
8696 downcased_event
= Fdowncase (event
);
8697 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8698 || XINT (downcased_event
) == SREF (s
, 0));
8700 desc
= Fsingle_key_description (event
, Qnil
);
8702 #if 0 /* It is redundant to list the equivalent key bindings because
8703 the prefix is what the user has already typed. */
8705 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8707 /* Insert equivalent keybinding. */
8708 s
= concat2 (s
, tem
);
8711 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8712 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8714 /* Insert button prefix. */
8715 Lisp_Object selected
8716 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8717 if (EQ (tem
, QCradio
))
8718 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8720 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8721 s
= concat2 (tem
, s
);
8725 /* If we have room for the prompt string, add it to this line.
8726 If this is the first on the line, always add it. */
8727 if ((SCHARS (s
) + i
+ 2
8728 + (char_matches
? 0 : SCHARS (desc
) + 3))
8732 ptrdiff_t thiswidth
;
8734 /* Punctuate between strings. */
8737 strcpy (menu
+ i
, ", ");
8743 /* If the char to type doesn't match the string's
8744 first char, explicitly show what char to type. */
8747 /* Add as much of string as fits. */
8748 thiswidth
= min (SCHARS (desc
), width
- i
);
8749 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8751 strcpy (menu
+ i
, " = ");
8755 /* Add as much of string as fits. */
8756 thiswidth
= min (SCHARS (s
), width
- i
);
8757 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8763 /* If this element does not fit, end the line now,
8764 and save the element for the next line. */
8765 strcpy (menu
+ i
, "...");
8770 /* Move past this element. */
8771 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8772 /* Handle reaching end of dense table. */
8777 rest
= Fcdr_safe (rest
);
8781 /* Prompt with that and read response. */
8782 message2_nolog (menu
, strlen (menu
),
8783 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8785 /* Make believe its not a keyboard macro in case the help char
8786 is pressed. Help characters are not recorded because menu prompting
8787 is not used on replay.
8789 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8790 kset_defining_kbd_macro (current_kboard
, Qnil
);
8792 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8793 while (BUFFERP (obj
));
8794 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8796 if (!INTEGERP (obj
))
8798 else if (XINT (obj
) == -2)
8801 if (! EQ (obj
, menu_prompt_more_char
)
8802 && (!INTEGERP (menu_prompt_more_char
)
8803 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8805 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8806 store_kbd_macro_char (obj
);
8809 /* Help char - go round again */
8813 /* Reading key sequences. */
8815 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8816 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8817 keymap, or nil otherwise. Return the index of the first keymap in
8818 which KEY has any binding, or NMAPS if no map has a binding.
8820 If KEY is a meta ASCII character, treat it like meta-prefix-char
8821 followed by the corresponding non-meta character. Keymaps in
8822 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8825 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8828 NEXT may be the same array as CURRENT. */
8831 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8832 Lisp_Object
*defs
, Lisp_Object
*next
)
8834 ptrdiff_t i
, first_binding
;
8836 first_binding
= nmaps
;
8837 for (i
= nmaps
- 1; i
>= 0; i
--)
8839 if (! NILP (current
[i
]))
8841 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8842 if (! NILP (defs
[i
]))
8849 /* Given the set of bindings we've found, produce the next set of maps. */
8850 if (first_binding
< nmaps
)
8851 for (i
= 0; i
< nmaps
; i
++)
8852 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8854 return first_binding
;
8857 /* Structure used to keep track of partial application of key remapping
8858 such as Vfunction_key_map and Vkey_translation_map. */
8859 typedef struct keyremap
8861 /* This is the map originally specified for this use. */
8863 /* This is a submap reached by looking up, in PARENT,
8864 the events from START to END. */
8866 /* Positions [START, END) in the key sequence buffer
8867 are the key that we have scanned so far.
8868 Those events are the ones that we will replace
8869 if PARENT maps them into a key sequence. */
8873 /* Lookup KEY in MAP.
8874 MAP is a keymap mapping keys to key vectors or functions.
8875 If the mapping is a function and DO_FUNCTION is non-zero, then
8876 the function is called with PROMPT as parameter and its return
8877 value is used as the return value of this function (after checking
8878 that it is indeed a vector). */
8881 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8886 next
= access_keymap (map
, key
, 1, 0, 1);
8888 /* Handle a symbol whose function definition is a keymap
8890 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8891 && (ARRAYP (XSYMBOL (next
)->function
)
8892 || KEYMAPP (XSYMBOL (next
)->function
)))
8893 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8895 /* If the keymap gives a function, not an
8896 array, then call the function with one arg and use
8897 its value instead. */
8898 if (do_funcall
&& FUNCTIONP (next
))
8903 next
= call1 (next
, prompt
);
8904 /* If the function returned something invalid,
8905 barf--don't ignore it.
8906 (To ignore it safely, we would need to gcpro a bunch of
8907 other variables.) */
8908 if (! (VECTORP (next
) || STRINGP (next
)))
8909 error ("Function %s returns invalid key sequence",
8910 SSDATA (SYMBOL_NAME (tem
)));
8915 /* Do one step of the key remapping used for function-key-map and
8916 key-translation-map:
8917 KEYBUF is the buffer holding the input events.
8918 BUFSIZE is its maximum size.
8919 FKEY is a pointer to the keyremap structure to use.
8920 INPUT is the index of the last element in KEYBUF.
8921 DOIT if non-zero says that the remapping can actually take place.
8922 DIFF is used to return the number of keys added/removed by the remapping.
8923 PARENT is the root of the keymap.
8924 PROMPT is the prompt to use if the remapping happens through a function.
8925 The return value is non-zero if the remapping actually took place. */
8928 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8929 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8931 Lisp_Object next
, key
;
8933 key
= keybuf
[fkey
->end
++];
8935 if (KEYMAPP (fkey
->parent
))
8936 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8940 /* If keybuf[fkey->start..fkey->end] is bound in the
8941 map and we're in a position to do the key remapping, replace it with
8942 the binding and restart with fkey->start at the end. */
8943 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8945 int len
= XFASTINT (Flength (next
));
8948 *diff
= len
- (fkey
->end
- fkey
->start
);
8950 if (bufsize
- input
<= *diff
)
8951 error ("Key sequence too long");
8953 /* Shift the keys that follow fkey->end. */
8955 for (i
= fkey
->end
; i
< input
; i
++)
8956 keybuf
[i
+ *diff
] = keybuf
[i
];
8958 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8959 keybuf
[i
+ *diff
] = keybuf
[i
];
8960 /* Overwrite the old keys with the new ones. */
8961 for (i
= 0; i
< len
; i
++)
8962 keybuf
[fkey
->start
+ i
]
8963 = Faref (next
, make_number (i
));
8965 fkey
->start
= fkey
->end
+= *diff
;
8966 fkey
->map
= fkey
->parent
;
8971 fkey
->map
= get_keymap (next
, 0, 1);
8973 /* If we no longer have a bound suffix, try a new position for
8975 if (!CONSP (fkey
->map
))
8977 fkey
->end
= ++fkey
->start
;
8978 fkey
->map
= fkey
->parent
;
8984 test_undefined (Lisp_Object binding
)
8986 return (EQ (binding
, Qundefined
)
8987 || (!NILP (binding
) && SYMBOLP (binding
)
8988 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8991 /* Read a sequence of keys that ends with a non prefix character,
8992 storing it in KEYBUF, a buffer of size BUFSIZE.
8994 Return the length of the key sequence stored.
8995 Return -1 if the user rejected a command menu.
8997 Echo starting immediately unless `prompt' is 0.
8999 Where a key sequence ends depends on the currently active keymaps.
9000 These include any minor mode keymaps active in the current buffer,
9001 the current buffer's local map, and the global map.
9003 If a key sequence has no other bindings, we check Vfunction_key_map
9004 to see if some trailing subsequence might be the beginning of a
9005 function key's sequence. If so, we try to read the whole function
9006 key, and substitute its symbolic name into the key sequence.
9008 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9009 `double-' events into similar click events, if that would make them
9010 bound. We try to turn `triple-' events first into `double-' events,
9013 If we get a mouse click in a mode line, vertical divider, or other
9014 non-text area, we treat the click as if it were prefixed by the
9015 symbol denoting that area - `mode-line', `vertical-line', or
9018 If the sequence starts with a mouse click, we read the key sequence
9019 with respect to the buffer clicked on, not the current buffer.
9021 If the user switches frames in the midst of a key sequence, we put
9022 off the switch-frame event until later; the next call to
9023 read_char will return it.
9025 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9026 from the selected window's buffer. */
9029 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9030 int dont_downcase_last
, int can_return_switch_frame
,
9031 int fix_current_buffer
)
9033 Lisp_Object from_string
;
9034 ptrdiff_t count
= SPECPDL_INDEX ();
9036 /* How many keys there are in the current key sequence. */
9039 /* The length of the echo buffer when we started reading, and
9040 the length of this_command_keys when we started reading. */
9041 ptrdiff_t echo_start
IF_LINT (= 0);
9042 ptrdiff_t keys_start
;
9044 /* The number of keymaps we're scanning right now, and the number of
9045 keymaps we have allocated space for. */
9047 ptrdiff_t nmaps_allocated
= 0;
9049 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9050 the current keymaps. */
9051 Lisp_Object
*defs
= NULL
;
9053 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9054 in the current keymaps, or nil where it is not a prefix. */
9055 Lisp_Object
*submaps
= NULL
;
9057 /* The local map to start out with at start of key sequence. */
9058 Lisp_Object orig_local_map
;
9060 /* The map from the `keymap' property to start out with at start of
9062 Lisp_Object orig_keymap
;
9064 /* 1 if we have already considered switching to the local-map property
9065 of the place where a mouse click occurred. */
9066 int localized_local_map
= 0;
9068 /* The index in submaps[] of the first keymap that has a binding for
9069 this key sequence. In other words, the lowest i such that
9070 submaps[i] is non-nil. */
9071 ptrdiff_t first_binding
;
9072 /* Index of the first key that has no binding.
9073 It is useless to try fkey.start larger than that. */
9076 /* If t < mock_input, then KEYBUF[t] should be read as the next
9079 We use this to recover after recognizing a function key. Once we
9080 realize that a suffix of the current key sequence is actually a
9081 function key's escape sequence, we replace the suffix with the
9082 function key's binding from Vfunction_key_map. Now keybuf
9083 contains a new and different key sequence, so the echo area,
9084 this_command_keys, and the submaps and defs arrays are wrong. In
9085 this situation, we set mock_input to t, set t to 0, and jump to
9086 restart_sequence; the loop will read keys from keybuf up until
9087 mock_input, thus rebuilding the state; and then it will resume
9088 reading characters from the keyboard. */
9091 /* If the sequence is unbound in submaps[], then
9092 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9093 and fkey.map is its binding.
9095 These might be > t, indicating that all function key scanning
9096 should hold off until t reaches them. We do this when we've just
9097 recognized a function key, to avoid searching for the function
9098 key's again in Vfunction_key_map. */
9101 /* Likewise, for key_translation_map and input-decode-map. */
9102 keyremap keytran
, indec
;
9104 /* Non-zero if we are trying to map a key by changing an upper-case
9105 letter to lower case, or a shifted function key to an unshifted
9107 int shift_translated
= 0;
9109 /* If we receive a `switch-frame' or `select-window' event in the middle of
9110 a key sequence, we put it off for later.
9111 While we're reading, we keep the event here. */
9112 Lisp_Object delayed_switch_frame
;
9114 /* See the comment below... */
9115 #if defined (GOBBLE_FIRST_EVENT)
9116 Lisp_Object first_event
;
9119 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9120 int original_uppercase_position
= -1;
9122 /* Gets around Microsoft compiler limitations. */
9125 struct buffer
*starting_buffer
;
9127 /* List of events for which a fake prefix key has been generated. */
9128 Lisp_Object fake_prefixed_keys
= Qnil
;
9130 #if defined (GOBBLE_FIRST_EVENT)
9134 struct gcpro gcpro1
;
9136 GCPRO1 (fake_prefixed_keys
);
9137 raw_keybuf_count
= 0;
9139 last_nonmenu_event
= Qnil
;
9141 delayed_switch_frame
= Qnil
;
9147 /* Install the string STR as the beginning of the string of
9148 echoing, so that it serves as a prompt for the next
9150 kset_echo_string (current_kboard
, prompt
);
9151 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9154 else if (cursor_in_echo_area
9155 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9156 && NILP (Fzerop (Vecho_keystrokes
)))
9157 /* This doesn't put in a dash if the echo buffer is empty, so
9158 you don't always see a dash hanging out in the minibuffer. */
9162 /* Record the initial state of the echo area and this_command_keys;
9163 we will need to restore them if we replay a key sequence. */
9165 echo_start
= echo_length ();
9166 keys_start
= this_command_key_count
;
9167 this_single_command_key_start
= keys_start
;
9169 #if defined (GOBBLE_FIRST_EVENT)
9170 /* This doesn't quite work, because some of the things that read_char
9171 does cannot safely be bypassed. It seems too risky to try to make
9174 /* Read the first char of the sequence specially, before setting
9175 up any keymaps, in case a filter runs and switches buffers on us. */
9176 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9178 #endif /* GOBBLE_FIRST_EVENT */
9180 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9181 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9184 /* We jump here when we need to reinitialize fkey and keytran; this
9185 happens if we switch keyboards between rescans. */
9186 replay_entire_sequence
:
9188 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9189 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9190 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9191 indec
.start
= indec
.end
= 0;
9192 fkey
.start
= fkey
.end
= 0;
9193 keytran
.start
= keytran
.end
= 0;
9195 /* We jump here when the key sequence has been thoroughly changed, and
9196 we need to rescan it starting from the beginning. When we jump here,
9197 keybuf[0..mock_input] holds the sequence we should reread. */
9200 starting_buffer
= current_buffer
;
9201 first_unbound
= bufsize
+ 1;
9203 /* Build our list of keymaps.
9204 If we recognize a function key and replace its escape sequence in
9205 keybuf with its symbol, or if the sequence starts with a mouse
9206 click and we need to switch buffers, we jump back here to rebuild
9207 the initial keymaps from the current buffer. */
9210 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9212 if (2 > nmaps_allocated
)
9214 submaps
= alloca (2 * sizeof *submaps
);
9215 defs
= alloca (2 * sizeof *defs
);
9216 nmaps_allocated
= 2;
9218 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9220 else if (!NILP (Voverriding_local_map
))
9222 if (2 > nmaps_allocated
)
9224 submaps
= alloca (2 * sizeof *submaps
);
9225 defs
= alloca (2 * sizeof *defs
);
9226 nmaps_allocated
= 2;
9228 submaps
[nmaps
++] = Voverriding_local_map
;
9236 nminor
= current_minor_maps (0, &maps
);
9237 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9239 if (total
> nmaps_allocated
)
9241 submaps
= alloca (total
* sizeof *submaps
);
9242 defs
= alloca (total
* sizeof *defs
);
9243 nmaps_allocated
= total
;
9246 if (!NILP (orig_keymap
))
9247 submaps
[nmaps
++] = orig_keymap
;
9249 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9253 submaps
[nmaps
++] = orig_local_map
;
9255 submaps
[nmaps
++] = current_global_map
;
9257 /* Find an accurate initial value for first_binding. */
9258 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9259 if (! NILP (submaps
[first_binding
]))
9262 /* Start from the beginning in keybuf. */
9265 /* These are no-ops the first time through, but if we restart, they
9266 revert the echo area and this_command_keys to their original state. */
9267 this_command_key_count
= keys_start
;
9268 if (INTERACTIVE
&& t
< mock_input
)
9269 echo_truncate (echo_start
);
9271 /* If the best binding for the current key sequence is a keymap, or
9272 we may be looking at a function key's escape sequence, keep on
9274 while (first_binding
< nmaps
9275 /* Keep reading as long as there's a prefix binding. */
9276 ? !NILP (submaps
[first_binding
])
9277 /* Don't return in the middle of a possible function key sequence,
9278 if the only bindings we found were via case conversion.
9279 Thus, if ESC O a has a function-key-map translation
9280 and ESC o has a binding, don't return after ESC O,
9281 so that we can translate ESC O plus the next character. */
9282 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9285 int used_mouse_menu
= 0;
9287 /* Where the last real key started. If we need to throw away a
9288 key that has expanded into more than one element of keybuf
9289 (say, a mouse click on the mode line which is being treated
9290 as [mode-line (mouse-...)], then we backtrack to this point
9292 int last_real_key_start
;
9294 /* These variables are analogous to echo_start and keys_start;
9295 while those allow us to restart the entire key sequence,
9296 echo_local_start and keys_local_start allow us to throw away
9298 ptrdiff_t echo_local_start
IF_LINT (= 0);
9299 int keys_local_start
;
9300 ptrdiff_t local_first_binding
;
9302 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9303 eassert (indec
.start
<= indec
.end
);
9304 eassert (fkey
.start
<= fkey
.end
);
9305 eassert (keytran
.start
<= keytran
.end
);
9306 /* key-translation-map is applied *after* function-key-map
9307 which is itself applied *after* input-decode-map. */
9308 eassert (fkey
.end
<= indec
.start
);
9309 eassert (keytran
.end
<= fkey
.start
);
9311 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9312 first_unbound
< keytran
.start
)
9313 { /* The prefix upto first_unbound has no binding and has
9314 no translation left to do either, so we know it's unbound.
9315 If we don't stop now, we risk staying here indefinitely
9316 (if the user keeps entering fkey or keytran prefixes
9317 like C-c ESC ESC ESC ESC ...) */
9319 for (i
= first_unbound
+ 1; i
< t
; i
++)
9320 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9321 mock_input
= t
- first_unbound
- 1;
9322 indec
.end
= indec
.start
-= first_unbound
+ 1;
9323 indec
.map
= indec
.parent
;
9324 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9325 fkey
.map
= fkey
.parent
;
9326 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9327 keytran
.map
= keytran
.parent
;
9328 goto replay_sequence
;
9332 error ("Key sequence too long");
9335 echo_local_start
= echo_length ();
9336 keys_local_start
= this_command_key_count
;
9337 local_first_binding
= first_binding
;
9340 /* These are no-ops, unless we throw away a keystroke below and
9341 jumped back up to replay_key; in that case, these restore the
9342 variables to their original state, allowing us to replay the
9344 if (INTERACTIVE
&& t
< mock_input
)
9345 echo_truncate (echo_local_start
);
9346 this_command_key_count
= keys_local_start
;
9347 first_binding
= local_first_binding
;
9349 /* By default, assume each event is "real". */
9350 last_real_key_start
= t
;
9352 /* Does mock_input indicate that we are re-reading a key sequence? */
9356 add_command_key (key
);
9357 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9358 && NILP (Fzerop (Vecho_keystrokes
)))
9362 /* If not, we should actually read a character. */
9366 KBOARD
*interrupted_kboard
= current_kboard
;
9367 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9368 key
= read_char (NILP (prompt
), nmaps
,
9369 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9370 &used_mouse_menu
, NULL
);
9371 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9372 /* When switching to a new tty (with a new keyboard),
9373 read_char returns the new buffer, rather than -2
9374 (Bug#5095). This is because `terminal-init-xterm'
9375 calls read-char, which eats the wrong_kboard_jmpbuf
9376 return. Any better way to fix this? -- cyd */
9377 || (interrupted_kboard
!= current_kboard
))
9382 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9383 if (k
== interrupted_kboard
)
9388 /* Don't touch interrupted_kboard when it's been
9390 delayed_switch_frame
= Qnil
;
9391 goto replay_entire_sequence
;
9394 if (!NILP (delayed_switch_frame
))
9397 (interrupted_kboard
,
9398 Fcons (delayed_switch_frame
,
9399 KVAR (interrupted_kboard
, kbd_queue
)));
9400 delayed_switch_frame
= Qnil
;
9405 (interrupted_kboard
,
9406 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9408 /* If the side queue is non-empty, ensure it begins with a
9409 switch-frame, so we'll replay it in the right context. */
9410 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9411 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9412 !(EVENT_HAS_PARAMETERS (key
)
9413 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9417 XSETFRAME (frame
, interrupted_frame
);
9419 (interrupted_kboard
,
9420 Fcons (make_lispy_switch_frame (frame
),
9421 KVAR (interrupted_kboard
, kbd_queue
)));
9424 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9425 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9426 goto replay_entire_sequence
;
9430 /* read_char returns t when it shows a menu and the user rejects it.
9434 unbind_to (count
, Qnil
);
9439 /* read_char returns -1 at the end of a macro.
9440 Emacs 18 handles this by returning immediately with a
9441 zero, so that's what we'll do. */
9442 if (INTEGERP (key
) && XINT (key
) == -1)
9445 /* The Microsoft C compiler can't handle the goto that
9451 /* If the current buffer has been changed from under us, the
9452 keymap may have changed, so replay the sequence. */
9455 timer_resume_idle ();
9458 /* Reset the current buffer from the selected window
9459 in case something changed the former and not the latter.
9460 This is to be more consistent with the behavior
9461 of the command_loop_1. */
9462 if (fix_current_buffer
)
9464 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9466 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9467 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9470 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9471 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9472 goto replay_sequence
;
9475 /* If we have a quit that was typed in another frame, and
9476 quit_throw_to_read_char switched buffers,
9477 replay to get the right keymap. */
9479 && XINT (key
) == quit_char
9480 && current_buffer
!= starting_buffer
)
9483 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9488 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9489 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9490 goto replay_sequence
;
9495 if (EVENT_HAS_PARAMETERS (key
)
9496 /* Either a `switch-frame' or a `select-window' event. */
9497 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9499 /* If we're at the beginning of a key sequence, and the caller
9500 says it's okay, go ahead and return this event. If we're
9501 in the midst of a key sequence, delay it until the end. */
9502 if (t
> 0 || !can_return_switch_frame
)
9504 delayed_switch_frame
= key
;
9510 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9514 /* Clicks in non-text areas get prefixed by the symbol
9515 in their CHAR-ADDRESS field. For example, a click on
9516 the mode line is prefixed by the symbol `mode-line'.
9518 Furthermore, key sequences beginning with mouse clicks
9519 are read using the keymaps of the buffer clicked on, not
9520 the current buffer. So we may have to switch the buffer
9523 When we turn one event into two events, we must make sure
9524 that neither of the two looks like the original--so that,
9525 if we replay the events, they won't be expanded again.
9526 If not for this, such reexpansion could happen either here
9527 or when user programs play with this-command-keys. */
9528 if (EVENT_HAS_PARAMETERS (key
))
9533 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9534 if (EQ (kind
, Qmouse_click
))
9536 Lisp_Object window
, posn
;
9538 window
= POSN_WINDOW (EVENT_START (key
));
9539 posn
= POSN_POSN (EVENT_START (key
));
9542 || (!NILP (fake_prefixed_keys
)
9543 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9545 /* We're looking a second time at an event for which
9546 we generated a fake prefix key. Set
9547 last_real_key_start appropriately. */
9549 last_real_key_start
= t
- 1;
9552 if (last_real_key_start
== 0)
9554 /* Key sequences beginning with mouse clicks are
9555 read using the keymaps in the buffer clicked on,
9556 not the current buffer. If we're at the
9557 beginning of a key sequence, switch buffers. */
9558 if (WINDOWP (window
)
9559 && BUFFERP (XWINDOW (window
)->buffer
)
9560 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9562 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9567 /* Arrange to go back to the original buffer once we're
9568 done reading the key sequence. Note that we can't
9569 use save_excursion_{save,restore} here, because they
9570 save point as well as the current buffer; we don't
9571 want to save point, because redisplay may change it,
9572 to accommodate a Fset_window_start or something. We
9573 don't want to do this at the top of the function,
9574 because we may get input from a subprocess which
9575 wants to change the selected window and stuff (say,
9577 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9579 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9581 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9582 orig_local_map
= get_local_map (PT
, current_buffer
,
9584 orig_keymap
= get_local_map (PT
, current_buffer
,
9586 goto replay_sequence
;
9589 /* For a mouse click, get the local text-property keymap
9590 of the place clicked on, rather than point. */
9591 if (CONSP (XCDR (key
))
9592 && ! localized_local_map
)
9594 Lisp_Object map_here
, start
, pos
;
9596 localized_local_map
= 1;
9597 start
= EVENT_START (key
);
9599 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9601 pos
= POSN_BUFFER_POSN (start
);
9603 && XINT (pos
) >= BEGV
9604 && XINT (pos
) <= ZV
)
9606 map_here
= get_local_map (XINT (pos
),
9609 if (!EQ (map_here
, orig_local_map
))
9611 orig_local_map
= map_here
;
9612 ++localized_local_map
;
9615 map_here
= get_local_map (XINT (pos
),
9618 if (!EQ (map_here
, orig_keymap
))
9620 orig_keymap
= map_here
;
9621 ++localized_local_map
;
9624 if (localized_local_map
> 1)
9629 goto replay_sequence
;
9636 /* Expand mode-line and scroll-bar events into two events:
9637 use posn as a fake prefix key. */
9639 && (NILP (fake_prefixed_keys
)
9640 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9642 if (bufsize
- t
<= 1)
9643 error ("Key sequence too long");
9646 keybuf
[t
+ 1] = key
;
9649 /* Record that a fake prefix key has been generated
9650 for KEY. Don't modify the event; this would
9651 prevent proper action when the event is pushed
9652 back into unread-command-events. */
9653 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9655 /* If on a mode line string with a local keymap,
9656 reconsider the key sequence with that keymap. */
9657 if (string
= POSN_STRING (EVENT_START (key
)),
9658 (CONSP (string
) && STRINGP (XCAR (string
))))
9660 Lisp_Object pos
, map
, map2
;
9662 pos
= XCDR (string
);
9663 string
= XCAR (string
);
9665 && XINT (pos
) < SCHARS (string
))
9667 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9669 orig_local_map
= map
;
9670 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9673 if (!NILP (map
) || !NILP (map2
))
9674 goto replay_sequence
;
9680 else if (NILP (from_string
)
9681 && (string
= POSN_STRING (EVENT_START (key
)),
9682 (CONSP (string
) && STRINGP (XCAR (string
)))))
9684 /* For a click on a string, i.e. overlay string or a
9685 string displayed via the `display' property,
9686 consider `local-map' and `keymap' properties of
9688 Lisp_Object pos
, map
, map2
;
9690 pos
= XCDR (string
);
9691 string
= XCAR (string
);
9693 && XINT (pos
) < SCHARS (string
))
9695 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9697 orig_local_map
= map
;
9698 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9702 if (!NILP (map
) || !NILP (map2
))
9704 from_string
= string
;
9707 goto replay_sequence
;
9712 else if (CONSP (XCDR (key
))
9713 && CONSP (EVENT_START (key
))
9714 && CONSP (XCDR (EVENT_START (key
))))
9718 posn
= POSN_POSN (EVENT_START (key
));
9719 /* Handle menu-bar events:
9720 insert the dummy prefix event `menu-bar'. */
9721 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9723 if (bufsize
- t
<= 1)
9724 error ("Key sequence too long");
9728 /* Zap the position in key, so we know that we've
9729 expanded it, and don't try to do so again. */
9730 POSN_SET_POSN (EVENT_START (key
),
9731 Fcons (posn
, Qnil
));
9734 goto replay_sequence
;
9736 else if (CONSP (posn
))
9738 /* We're looking at the second event of a
9739 sequence which we expanded before. Set
9740 last_real_key_start appropriately. */
9741 if (last_real_key_start
== t
&& t
> 0)
9742 last_real_key_start
= t
- 1;
9747 /* We have finally decided that KEY is something we might want
9749 first_binding
= (follow_key (key
,
9750 nmaps
- first_binding
,
9751 submaps
+ first_binding
,
9752 defs
+ first_binding
,
9753 submaps
+ first_binding
)
9756 /* If KEY wasn't bound, we'll try some fallbacks. */
9757 if (first_binding
< nmaps
)
9758 /* This is needed for the following scenario:
9759 event 0: a down-event that gets dropped by calling replay_key.
9760 event 1: some normal prefix like C-h.
9761 After event 0, first_unbound is 0, after event 1 indec.start,
9762 fkey.start, and keytran.start are all 1, so when we see that
9763 C-h is bound, we need to update first_unbound. */
9764 first_unbound
= max (t
+ 1, first_unbound
);
9769 /* Remember the position to put an upper bound on indec.start. */
9770 first_unbound
= min (t
, first_unbound
);
9772 head
= EVENT_HEAD (key
);
9773 if (help_char_p (head
) && t
> 0)
9775 read_key_sequence_cmd
= Vprefix_help_command
;
9777 last_nonmenu_event
= key
;
9778 /* The Microsoft C compiler can't handle the goto that
9786 Lisp_Object breakdown
;
9789 breakdown
= parse_modifiers (head
);
9790 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9791 /* Attempt to reduce an unbound mouse event to a simpler
9792 event that is bound:
9793 Drags reduce to clicks.
9794 Double-clicks reduce to clicks.
9795 Triple-clicks reduce to double-clicks, then to clicks.
9796 Down-clicks are eliminated.
9797 Double-downs reduce to downs, then are eliminated.
9798 Triple-downs reduce to double-downs, then to downs,
9799 then are eliminated. */
9800 if (modifiers
& (down_modifier
| drag_modifier
9801 | double_modifier
| triple_modifier
))
9803 while (modifiers
& (down_modifier
| drag_modifier
9804 | double_modifier
| triple_modifier
))
9806 Lisp_Object new_head
, new_click
;
9807 if (modifiers
& triple_modifier
)
9808 modifiers
^= (double_modifier
| triple_modifier
);
9809 else if (modifiers
& double_modifier
)
9810 modifiers
&= ~double_modifier
;
9811 else if (modifiers
& drag_modifier
)
9812 modifiers
&= ~drag_modifier
;
9815 /* Dispose of this `down' event by simply jumping
9816 back to replay_key, to get another event.
9818 Note that if this event came from mock input,
9819 then just jumping back to replay_key will just
9820 hand it to us again. So we have to wipe out any
9823 We could delete keybuf[t] and shift everything
9824 after that to the left by one spot, but we'd also
9825 have to fix up any variable that points into
9826 keybuf, and shifting isn't really necessary
9829 Adding prefixes for non-textual mouse clicks
9830 creates two characters of mock input, and both
9831 must be thrown away. If we're only looking at
9832 the prefix now, we can just jump back to
9833 replay_key. On the other hand, if we've already
9834 processed the prefix, and now the actual click
9835 itself is giving us trouble, then we've lost the
9836 state of the keymaps we want to backtrack to, and
9837 we need to replay the whole sequence to rebuild
9840 Beyond that, only function key expansion could
9841 create more than two keys, but that should never
9842 generate mouse events, so it's okay to zero
9843 mock_input in that case too.
9845 FIXME: The above paragraph seems just plain
9846 wrong, if you consider things like
9847 xterm-mouse-mode. -stef
9849 Isn't this just the most wonderful code ever? */
9851 /* If mock_input > t + 1, the above simplification
9852 will actually end up dropping keys on the floor.
9853 This is probably OK for now, but even
9854 if mock_input <= t + 1, we need to adjust indec,
9856 Typical case [header-line down-mouse-N]:
9857 mock_input = 2, t = 1, fkey.end = 1,
9858 last_real_key_start = 0. */
9859 if (indec
.end
> last_real_key_start
)
9861 indec
.end
= indec
.start
9862 = min (last_real_key_start
, indec
.start
);
9863 indec
.map
= indec
.parent
;
9864 if (fkey
.end
> last_real_key_start
)
9866 fkey
.end
= fkey
.start
9867 = min (last_real_key_start
, fkey
.start
);
9868 fkey
.map
= fkey
.parent
;
9869 if (keytran
.end
> last_real_key_start
)
9871 keytran
.end
= keytran
.start
9872 = min (last_real_key_start
, keytran
.start
);
9873 keytran
.map
= keytran
.parent
;
9877 if (t
== last_real_key_start
)
9884 mock_input
= last_real_key_start
;
9885 goto replay_sequence
;
9890 = apply_modifiers (modifiers
, XCAR (breakdown
));
9892 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9894 /* Look for a binding for this new key. follow_key
9895 promises that it didn't munge submaps the
9896 last time we called it, since key was unbound. */
9898 = (follow_key (new_click
,
9899 nmaps
- local_first_binding
,
9900 submaps
+ local_first_binding
,
9901 defs
+ local_first_binding
,
9902 submaps
+ local_first_binding
)
9903 + local_first_binding
);
9905 /* If that click is bound, go for it. */
9906 if (first_binding
< nmaps
)
9911 /* Otherwise, we'll leave key set to the drag event. */
9918 /* Normally, last_nonmenu_event gets the previous key we read.
9919 But when a mouse popup menu is being used,
9920 we don't update last_nonmenu_event; it continues to hold the mouse
9921 event that preceded the first level of menu. */
9922 if (!used_mouse_menu
)
9923 last_nonmenu_event
= key
;
9925 /* Record what part of this_command_keys is the current key sequence. */
9926 this_single_command_key_start
= this_command_key_count
- t
;
9928 /* Look for this sequence in input-decode-map.
9929 Scan from indec.end until we find a bound suffix. */
9930 while (indec
.end
< t
)
9932 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9935 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9936 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9941 mock_input
= diff
+ max (t
, mock_input
);
9942 goto replay_sequence
;
9946 if (first_binding
< nmaps
9947 && NILP (submaps
[first_binding
])
9948 && !test_undefined (defs
[first_binding
])
9949 && indec
.start
>= t
)
9950 /* There is a binding and it's not a prefix.
9951 (and it doesn't have any input-decode-map translation pending).
9952 There is thus no function-key in this sequence.
9953 Moving fkey.start is important in this case to allow keytran.start
9954 to go over the sequence before we return (since we keep the
9955 invariant that keytran.end <= fkey.start). */
9958 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9961 /* If the sequence is unbound, see if we can hang a function key
9962 off the end of it. */
9963 /* Continue scan from fkey.end until we find a bound suffix. */
9964 while (fkey
.end
< indec
.start
)
9966 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9969 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9970 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9971 max (t
, mock_input
),
9972 /* If there's a binding (i.e.
9973 first_binding >= nmaps) we don't want
9974 to apply this function-key-mapping. */
9976 && (first_binding
>= nmaps
9977 || test_undefined (defs
[first_binding
])),
9982 mock_input
= diff
+ max (t
, mock_input
);
9983 /* Adjust the input-decode-map counters. */
9985 indec
.start
+= diff
;
9987 goto replay_sequence
;
9991 /* Look for this sequence in key-translation-map.
9992 Scan from keytran.end until we find a bound suffix. */
9993 while (keytran
.end
< fkey
.start
)
9995 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9998 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9999 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10004 mock_input
= diff
+ max (t
, mock_input
);
10005 /* Adjust the function-key-map and input-decode-map counters. */
10007 indec
.start
+= diff
;
10009 fkey
.start
+= diff
;
10011 goto replay_sequence
;
10015 /* If KEY is not defined in any of the keymaps,
10016 and cannot be part of a function key or translation,
10017 and is an upper case letter
10018 use the corresponding lower-case letter instead. */
10019 if (first_binding
>= nmaps
10020 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10022 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10023 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10024 || (XINT (key
) & shift_modifier
)))
10026 Lisp_Object new_key
;
10028 original_uppercase
= key
;
10029 original_uppercase_position
= t
- 1;
10031 if (XINT (key
) & shift_modifier
)
10032 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10034 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10035 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10037 /* We have to do this unconditionally, regardless of whether
10038 the lower-case char is defined in the keymaps, because they
10039 might get translated through function-key-map. */
10040 keybuf
[t
- 1] = new_key
;
10041 mock_input
= max (t
, mock_input
);
10042 shift_translated
= 1;
10044 goto replay_sequence
;
10046 /* If KEY is not defined in any of the keymaps,
10047 and cannot be part of a function key or translation,
10048 and is a shifted function key,
10049 use the corresponding unshifted function key instead. */
10050 if (first_binding
>= nmaps
10051 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10053 Lisp_Object breakdown
= parse_modifiers (key
);
10055 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10057 if (modifiers
& shift_modifier
10058 /* Treat uppercase keys as shifted. */
10060 && (KEY_TO_CHAR (key
)
10061 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10062 && uppercasep (KEY_TO_CHAR (key
))))
10064 Lisp_Object new_key
10065 = (modifiers
& shift_modifier
10066 ? apply_modifiers (modifiers
& ~shift_modifier
,
10068 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10070 original_uppercase
= key
;
10071 original_uppercase_position
= t
- 1;
10073 /* We have to do this unconditionally, regardless of whether
10074 the lower-case char is defined in the keymaps, because they
10075 might get translated through function-key-map. */
10076 keybuf
[t
- 1] = new_key
;
10077 mock_input
= max (t
, mock_input
);
10078 /* Reset fkey (and consequently keytran) to apply
10079 function-key-map on the result, so that S-backspace is
10080 correctly mapped to DEL (via backspace). OTOH,
10081 input-decode-map doesn't need to go through it again. */
10082 fkey
.start
= fkey
.end
= 0;
10083 keytran
.start
= keytran
.end
= 0;
10084 shift_translated
= 1;
10086 goto replay_sequence
;
10091 read_key_sequence_cmd
= (first_binding
< nmaps
10092 ? defs
[first_binding
]
10094 read_key_sequence_remapped
10095 /* Remap command through active keymaps.
10096 Do the remapping here, before the unbind_to so it uses the keymaps
10097 of the appropriate buffer. */
10098 = SYMBOLP (read_key_sequence_cmd
)
10099 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10102 unread_switch_frame
= delayed_switch_frame
;
10103 unbind_to (count
, Qnil
);
10105 /* Don't downcase the last character if the caller says don't.
10106 Don't downcase it if the result is undefined, either. */
10107 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10109 && t
- 1 == original_uppercase_position
)
10111 keybuf
[t
- 1] = original_uppercase
;
10112 shift_translated
= 0;
10115 if (shift_translated
)
10116 Vthis_command_keys_shift_translated
= Qt
;
10118 /* Occasionally we fabricate events, perhaps by expanding something
10119 according to function-key-map, or by adding a prefix symbol to a
10120 mouse click in the scroll bar or modeline. In this cases, return
10121 the entire generated key sequence, even if we hit an unbound
10122 prefix or a definition before the end. This means that you will
10123 be able to push back the event properly, and also means that
10124 read-key-sequence will always return a logical unit.
10127 for (; t
< mock_input
; t
++)
10129 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10130 && NILP (Fzerop (Vecho_keystrokes
)))
10131 echo_char (keybuf
[t
]);
10132 add_command_key (keybuf
[t
]);
10139 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10140 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10141 The sequence is sufficient to specify a non-prefix command in the
10142 current local and global maps.
10144 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10145 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10146 as a continuation of the previous key.
10148 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10149 convert the last event to lower case. (Normally any upper case event
10150 is converted to lower case if the original event is undefined and the lower
10151 case equivalent is defined.) A non-nil value is appropriate for reading
10152 a key sequence to be defined.
10154 A C-g typed while in this function is treated like any other character,
10155 and `quit-flag' is not set.
10157 If the key sequence starts with a mouse click, then the sequence is read
10158 using the keymaps of the buffer of the window clicked in, not the buffer
10159 of the selected window as normal.
10161 `read-key-sequence' drops unbound button-down events, since you normally
10162 only care about the click or drag events which follow them. If a drag
10163 or multi-click event is unbound, but the corresponding click event would
10164 be bound, `read-key-sequence' turns the event into a click event at the
10165 drag's starting position. This means that you don't have to distinguish
10166 between click and drag, double, or triple events unless you want to.
10168 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10169 lines separating windows, and scroll bars with imaginary keys
10170 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10172 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10173 function will process a switch-frame event if the user switches frames
10174 before typing anything. If the user switches frames in the middle of a
10175 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10176 is nil, then the event will be put off until after the current key sequence.
10178 `read-key-sequence' checks `function-key-map' for function key
10179 sequences, where they wouldn't conflict with ordinary bindings. See
10180 `function-key-map' for more details.
10182 The optional fifth argument CMD-LOOP, if non-nil, means
10183 that this key sequence is being read by something that will
10184 read commands one after another. It should be nil if the caller
10185 will read just one key sequence. */)
10186 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10188 Lisp_Object keybuf
[30];
10190 struct gcpro gcpro1
;
10191 ptrdiff_t count
= SPECPDL_INDEX ();
10193 if (!NILP (prompt
))
10194 CHECK_STRING (prompt
);
10197 specbind (Qinput_method_exit_on_first_char
,
10198 (NILP (cmd_loop
) ? Qt
: Qnil
));
10199 specbind (Qinput_method_use_echo_area
,
10200 (NILP (cmd_loop
) ? Qt
: Qnil
));
10202 memset (keybuf
, 0, sizeof keybuf
);
10203 GCPRO1 (keybuf
[0]);
10204 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10206 if (NILP (continue_echo
))
10208 this_command_key_count
= 0;
10209 this_command_key_count_reset
= 0;
10210 this_single_command_key_start
= 0;
10213 #ifdef HAVE_WINDOW_SYSTEM
10214 if (display_hourglass_p
)
10215 cancel_hourglass ();
10218 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10219 prompt
, ! NILP (dont_downcase_last
),
10220 ! NILP (can_return_switch_frame
), 0);
10222 #if 0 /* The following is fine for code reading a key sequence and
10223 then proceeding with a lengthy computation, but it's not good
10224 for code reading keys in a loop, like an input method. */
10225 #ifdef HAVE_WINDOW_SYSTEM
10226 if (display_hourglass_p
)
10227 start_hourglass ();
10237 return unbind_to (count
, make_event_array (i
, keybuf
));
10240 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10241 Sread_key_sequence_vector
, 1, 5, 0,
10242 doc
: /* Like `read-key-sequence' but always return a vector. */)
10243 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10245 Lisp_Object keybuf
[30];
10247 struct gcpro gcpro1
;
10248 ptrdiff_t count
= SPECPDL_INDEX ();
10250 if (!NILP (prompt
))
10251 CHECK_STRING (prompt
);
10254 specbind (Qinput_method_exit_on_first_char
,
10255 (NILP (cmd_loop
) ? Qt
: Qnil
));
10256 specbind (Qinput_method_use_echo_area
,
10257 (NILP (cmd_loop
) ? Qt
: Qnil
));
10259 memset (keybuf
, 0, sizeof keybuf
);
10260 GCPRO1 (keybuf
[0]);
10261 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10263 if (NILP (continue_echo
))
10265 this_command_key_count
= 0;
10266 this_command_key_count_reset
= 0;
10267 this_single_command_key_start
= 0;
10270 #ifdef HAVE_WINDOW_SYSTEM
10271 if (display_hourglass_p
)
10272 cancel_hourglass ();
10275 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10276 prompt
, ! NILP (dont_downcase_last
),
10277 ! NILP (can_return_switch_frame
), 0);
10279 #ifdef HAVE_WINDOW_SYSTEM
10280 if (display_hourglass_p
)
10281 start_hourglass ();
10290 return unbind_to (count
, Fvector (i
, keybuf
));
10293 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10294 doc
: /* Execute CMD as an editor command.
10295 CMD must be a symbol that satisfies the `commandp' predicate.
10296 Optional second arg RECORD-FLAG non-nil
10297 means unconditionally put this command in `command-history'.
10298 Otherwise, that is done only if an arg is read using the minibuffer.
10299 The argument KEYS specifies the value to use instead of (this-command-keys)
10300 when reading the arguments; if it is nil, (this-command-keys) is used.
10301 The argument SPECIAL, if non-nil, means that this command is executing
10302 a special event, so ignore the prefix argument and don't clear it. */)
10303 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10305 register Lisp_Object final
;
10306 register Lisp_Object tem
;
10307 Lisp_Object prefixarg
;
10309 debug_on_next_call
= 0;
10311 if (NILP (special
))
10313 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10314 Vcurrent_prefix_arg
= prefixarg
;
10315 kset_prefix_arg (current_kboard
, Qnil
);
10322 tem
= Fget (cmd
, Qdisabled
);
10325 tem
= Fsymbol_value (Qdisabled_command_function
);
10327 return Frun_hooks (1, &Qdisabled_command_function
);
10333 final
= Findirect_function (cmd
, Qnil
);
10335 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10337 struct gcpro gcpro1
, gcpro2
;
10339 GCPRO2 (cmd
, prefixarg
);
10340 Fautoload_do_load (final
, cmd
, Qnil
);
10347 if (STRINGP (final
) || VECTORP (final
))
10349 /* If requested, place the macro in the command history. For
10350 other sorts of commands, call-interactively takes care of
10352 if (!NILP (record_flag
))
10355 = Fcons (Fcons (Qexecute_kbd_macro
,
10356 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10359 /* Don't keep command history around forever. */
10360 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10362 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10364 XSETCDR (tem
, Qnil
);
10368 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10371 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10372 /* Don't call Fcall_interactively directly because we want to make
10373 sure the backtrace has an entry for `call-interactively'.
10374 For the same reason, pass `cmd' rather than `final'. */
10375 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10382 /* Return nonzero if input events are pending. */
10385 detect_input_pending (void)
10387 if (!input_pending
)
10388 get_input_pending (&input_pending
, 0);
10390 return input_pending
;
10393 /* Return nonzero if input events other than mouse movements are
10397 detect_input_pending_ignore_squeezables (void)
10399 if (!input_pending
)
10400 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10402 return input_pending
;
10405 /* Return nonzero if input events are pending, and run any pending timers. */
10408 detect_input_pending_run_timers (int do_display
)
10410 int old_timers_run
= timers_run
;
10412 if (!input_pending
)
10413 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10415 if (old_timers_run
!= timers_run
&& do_display
)
10417 redisplay_preserve_echo_area (8);
10418 /* The following fixes a bug when using lazy-lock with
10419 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10420 from an idle timer function. The symptom of the bug is that
10421 the cursor sometimes doesn't become visible until the next X
10422 event is processed. --gerd. */
10424 Lisp_Object tail
, frame
;
10425 FOR_EACH_FRAME (tail
, frame
)
10426 if (FRAME_RIF (XFRAME (frame
)))
10427 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10431 return input_pending
;
10434 /* This is called in some cases before a possible quit.
10435 It cases the next call to detect_input_pending to recompute input_pending.
10436 So calling this function unnecessarily can't do any harm. */
10439 clear_input_pending (void)
10444 /* Return nonzero if there are pending requeued events.
10445 This isn't used yet. The hope is to make wait_reading_process_output
10446 call it, and return if it runs Lisp code that unreads something.
10447 The problem is, kbd_buffer_get_event needs to be fixed to know what
10448 to do in that case. It isn't trivial. */
10451 requeued_events_pending_p (void)
10453 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10457 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10458 doc
: /* Return t if command input is currently available with no wait.
10459 Actually, the value is nil only if we can be sure that no input is available;
10460 if there is a doubt, the value is t. */)
10463 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10464 || !NILP (Vunread_post_input_method_events
)
10465 || !NILP (Vunread_input_method_events
))
10468 /* Process non-user-visible events (Bug#10195). */
10469 process_special_events ();
10471 get_input_pending (&input_pending
,
10472 READABLE_EVENTS_DO_TIMERS_NOW
10473 | READABLE_EVENTS_FILTER_EVENTS
);
10474 return input_pending
> 0 ? Qt
: Qnil
;
10477 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10478 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10481 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10484 if (total_keys
< NUM_RECENT_KEYS
)
10485 return Fvector (total_keys
, keys
);
10488 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10489 vcopy (val
, 0, keys
+ recent_keys_index
,
10490 NUM_RECENT_KEYS
- recent_keys_index
);
10491 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10492 keys
, recent_keys_index
);
10497 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10498 doc
: /* Return the key sequence that invoked this command.
10499 However, if the command has called `read-key-sequence', it returns
10500 the last key sequence that has been read.
10501 The value is a string or a vector.
10503 See also `this-command-keys-vector'. */)
10506 return make_event_array (this_command_key_count
,
10507 XVECTOR (this_command_keys
)->contents
);
10510 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10511 doc
: /* Return the key sequence that invoked this command, as a vector.
10512 However, if the command has called `read-key-sequence', it returns
10513 the last key sequence that has been read.
10515 See also `this-command-keys'. */)
10518 return Fvector (this_command_key_count
,
10519 XVECTOR (this_command_keys
)->contents
);
10522 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10523 Sthis_single_command_keys
, 0, 0, 0,
10524 doc
: /* Return the key sequence that invoked this command.
10525 More generally, it returns the last key sequence read, either by
10526 the command loop or by `read-key-sequence'.
10527 Unlike `this-command-keys', this function's value
10528 does not include prefix arguments.
10529 The value is always a vector. */)
10532 return Fvector (this_command_key_count
10533 - this_single_command_key_start
,
10534 (XVECTOR (this_command_keys
)->contents
10535 + this_single_command_key_start
));
10538 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10539 Sthis_single_command_raw_keys
, 0, 0, 0,
10540 doc
: /* Return the raw events that were read for this command.
10541 More generally, it returns the last key sequence read, either by
10542 the command loop or by `read-key-sequence'.
10543 Unlike `this-single-command-keys', this function's value
10544 shows the events before all translations (except for input methods).
10545 The value is always a vector. */)
10548 return Fvector (raw_keybuf_count
,
10549 (XVECTOR (raw_keybuf
)->contents
));
10552 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10553 Sreset_this_command_lengths
, 0, 0, 0,
10554 doc
: /* Make the unread events replace the last command and echo.
10555 Used in `universal-argument-other-key'.
10557 `universal-argument-other-key' rereads the event just typed.
10558 It then gets translated through `function-key-map'.
10559 The translated event has to replace the real events,
10560 both in the value of (this-command-keys) and in echoing.
10561 To achieve this, `universal-argument-other-key' calls
10562 `reset-this-command-lengths', which discards the record of reading
10563 these events the first time. */)
10566 this_command_key_count
= before_command_key_count
;
10567 if (this_command_key_count
< this_single_command_key_start
)
10568 this_single_command_key_start
= this_command_key_count
;
10570 echo_truncate (before_command_echo_length
);
10572 /* Cause whatever we put into unread-command-events
10573 to echo as if it were being freshly read from the keyboard. */
10574 this_command_key_count_reset
= 1;
10579 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10580 Sclear_this_command_keys
, 0, 1, 0,
10581 doc
: /* Clear out the vector that `this-command-keys' returns.
10582 Also clear the record of the last 100 events, unless optional arg
10583 KEEP-RECORD is non-nil. */)
10584 (Lisp_Object keep_record
)
10588 this_command_key_count
= 0;
10589 this_command_key_count_reset
= 0;
10591 if (NILP (keep_record
))
10593 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10594 ASET (recent_keys
, i
, Qnil
);
10596 recent_keys_index
= 0;
10601 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10602 doc
: /* Return the current depth in recursive edits. */)
10606 /* Wrap around reliably on integer overflow. */
10607 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10608 XSETINT (temp
, sum
);
10612 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10613 "FOpen dribble file: ",
10614 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10615 If FILE is nil, close any open dribble file.
10616 The file will be closed when Emacs exits. */)
10628 file
= Fexpand_file_name (file
, Qnil
);
10629 dribble
= fopen (SSDATA (file
), "w");
10631 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10636 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10637 doc
: /* Discard the contents of the terminal input buffer.
10638 Also end any kbd macro being defined. */)
10641 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10643 /* Discard the last command from the macro. */
10644 Fcancel_kbd_macro_events ();
10648 update_mode_lines
++;
10650 Vunread_command_events
= Qnil
;
10651 unread_command_char
= -1;
10653 discard_tty_input ();
10655 kbd_fetch_ptr
= kbd_store_ptr
;
10661 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10662 doc
: /* Stop Emacs and return to superior process. You can resume later.
10663 If `cannot-suspend' is non-nil, or if the system doesn't support job
10664 control, run a subshell instead.
10666 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10667 to be read as terminal input by Emacs's parent, after suspension.
10669 Before suspending, run the normal hook `suspend-hook'.
10670 After resumption run the normal hook `suspend-resume-hook'.
10672 Some operating systems cannot stop the Emacs process and resume it later.
10673 On such systems, Emacs starts a subshell instead of suspending. */)
10674 (Lisp_Object stuffstring
)
10676 ptrdiff_t count
= SPECPDL_INDEX ();
10677 int old_height
, old_width
;
10679 struct gcpro gcpro1
;
10682 if (tty_list
&& tty_list
->next
)
10683 error ("There are other tty frames open; close them before suspending Emacs");
10685 if (!NILP (stuffstring
))
10686 CHECK_STRING (stuffstring
);
10688 /* Run the functions in suspend-hook. */
10689 hook
= intern ("suspend-hook");
10690 Frun_hooks (1, &hook
);
10692 GCPRO1 (stuffstring
);
10693 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10694 reset_all_sys_modes ();
10695 /* sys_suspend can get an error if it tries to fork a subshell
10696 and the system resources aren't available for that. */
10697 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10699 stuff_buffered_input (stuffstring
);
10700 if (cannot_suspend
)
10704 unbind_to (count
, Qnil
);
10706 /* Check if terminal/window size has changed.
10707 Note that this is not useful when we are running directly
10708 with a window system; but suspend should be disabled in that case. */
10709 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10710 if (width
!= old_width
|| height
!= old_height
)
10711 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10713 /* Run suspend-resume-hook. */
10714 hook
= intern ("suspend-resume-hook");
10715 Frun_hooks (1, &hook
);
10721 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10722 Then in any case stuff anything Emacs has read ahead and not used. */
10725 stuff_buffered_input (Lisp_Object stuffstring
)
10727 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10728 register unsigned char *p
;
10730 if (STRINGP (stuffstring
))
10732 register ptrdiff_t count
;
10734 p
= SDATA (stuffstring
);
10735 count
= SBYTES (stuffstring
);
10736 while (count
-- > 0)
10741 /* Anything we have read ahead, put back for the shell to read. */
10742 /* ?? What should this do when we have multiple keyboards??
10743 Should we ignore anything that was typed in at the "wrong" kboard?
10745 rms: we should stuff everything back into the kboard
10747 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10750 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10751 kbd_fetch_ptr
= kbd_buffer
;
10752 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10753 stuff_char (kbd_fetch_ptr
->code
);
10755 clear_event (kbd_fetch_ptr
);
10759 #endif /* SIGTSTP */
10763 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10765 input_available_clear_time
= time_to_clear
;
10767 /* Tell handle_interrupt to throw back to read_char, */
10768 waiting_for_input
= 1;
10770 /* If handle_interrupt was called before and buffered a C-g,
10771 make it run again now, to avoid timing error. */
10772 if (!NILP (Vquit_flag
))
10773 quit_throw_to_read_char (0);
10777 clear_waiting_for_input (void)
10779 /* Tell handle_interrupt not to throw back to read_char, */
10780 waiting_for_input
= 0;
10781 input_available_clear_time
= 0;
10784 /* The SIGINT handler.
10786 If we have a frame on the controlling tty, we assume that the
10787 SIGINT was generated by C-g, so we call handle_interrupt.
10788 Otherwise, tell QUIT to kill Emacs. */
10791 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10792 /* compilers complain in signal calls. */
10794 /* Must preserve main program's value of errno. */
10795 int old_errno
= errno
;
10796 struct terminal
*terminal
;
10798 SIGNAL_THREAD_CHECK (signalnum
);
10800 /* See if we have an active terminal on our controlling tty. */
10801 terminal
= get_named_tty ("/dev/tty");
10804 /* If there are no frames there, let's pretend that we are a
10805 well-behaving UN*X program and quit. We must not call Lisp
10806 in a signal handler, so tell QUIT to exit when it is
10808 Vquit_flag
= Qkill_emacs
;
10812 /* Otherwise, the SIGINT was probably generated by C-g. */
10814 /* Set internal_last_event_frame to the top frame of the
10815 controlling tty, if we have a frame there. We disable the
10816 interrupt key on secondary ttys, so the SIGINT must have come
10817 from the controlling tty. */
10818 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10820 handle_interrupt ();
10826 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10827 of the number of times C-g has been requested. If C-g is pressed
10828 enough times, then quit anyway. See bug#6585. */
10829 static int force_quit_count
;
10831 /* This routine is called at interrupt level in response to C-g.
10833 It is called from the SIGINT handler or kbd_buffer_store_event.
10835 If `waiting_for_input' is non zero, then unless `echoing' is
10836 nonzero, immediately throw back to read_char.
10838 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10839 eval to throw, when it gets a chance. If quit-flag is already
10840 non-nil, it stops the job right away. */
10843 handle_interrupt (void)
10849 /* XXX This code needs to be revised for multi-tty support. */
10850 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10852 /* If SIGINT isn't blocked, don't let us be interrupted by
10853 another SIGINT, it might be harmful due to non-reentrancy
10854 in I/O functions. */
10855 sigblock (sigmask (SIGINT
));
10858 reset_all_sys_modes ();
10860 #ifdef SIGTSTP /* Support possible in later USG versions */
10862 * On systems which can suspend the current process and return to the original
10863 * shell, this command causes the user to end up back at the shell.
10864 * The "Auto-save" and "Abort" questions are not asked until
10865 * the user elects to return to emacs, at which point he can save the current
10866 * job and either dump core or continue.
10870 /* Perhaps should really fork an inferior shell?
10871 But that would not provide any way to get back
10872 to the original shell, ever. */
10873 printf ("No support for stopping a process on this operating system;\n");
10874 printf ("you can continue or abort.\n");
10875 #endif /* not SIGTSTP */
10877 /* We must remain inside the screen area when the internal terminal
10878 is used. Note that [Enter] is not echoed by dos. */
10879 cursor_to (SELECTED_FRAME (), 0, 0);
10881 /* It doesn't work to autosave while GC is in progress;
10882 the code used for auto-saving doesn't cope with the mark bit. */
10883 if (!gc_in_progress
)
10885 printf ("Auto-save? (y or n) ");
10887 if (((c
= getchar ()) & ~040) == 'Y')
10889 Fdo_auto_save (Qt
, Qnil
);
10891 printf ("\r\nAuto-save done");
10892 #else /* not MSDOS */
10893 printf ("Auto-save done\n");
10894 #endif /* not MSDOS */
10896 while (c
!= '\n') c
= getchar ();
10900 /* During GC, it must be safe to reenable quitting again. */
10901 Vinhibit_quit
= Qnil
;
10904 #endif /* not MSDOS */
10905 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10906 printf ("but will instead do a real quit after garbage collection ends\r\n");
10911 printf ("\r\nAbort? (y or n) ");
10912 #else /* not MSDOS */
10913 printf ("Abort (and dump core)? (y or n) ");
10914 #endif /* not MSDOS */
10916 if (((c
= getchar ()) & ~040) == 'Y')
10918 while (c
!= '\n') c
= getchar ();
10920 printf ("\r\nContinuing...\r\n");
10921 #else /* not MSDOS */
10922 printf ("Continuing...\n");
10923 #endif /* not MSDOS */
10925 init_all_sys_modes ();
10930 /* If executing a function that wants to be interrupted out of
10931 and the user has not deferred quitting by binding `inhibit-quit'
10932 then quit right away. */
10933 if (immediate_quit
&& NILP (Vinhibit_quit
))
10935 struct gl_state_s saved
;
10936 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10938 immediate_quit
= 0;
10941 GCPRO4 (saved
.object
, saved
.global_code
,
10942 saved
.current_syntax_table
, saved
.old_prop
);
10943 Fsignal (Qquit
, Qnil
);
10944 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10949 { /* Else request quit when it's safe. */
10950 if (NILP (Vquit_flag
))
10951 force_quit_count
= 0;
10952 if (++force_quit_count
== 3)
10954 immediate_quit
= 1;
10955 Vinhibit_quit
= Qnil
;
10961 /* TODO: The longjmp in this call throws the NS event loop integration off,
10962 and it seems to do fine without this. Probably some attention
10963 needs to be paid to the setting of waiting_for_input in
10964 wait_reading_process_output() under HAVE_NS because of the call
10965 to ns_select there (needed because otherwise events aren't picked up
10966 outside of polling since we don't get SIGIO like X and we don't have a
10967 separate event loop thread like W32. */
10969 if (waiting_for_input
&& !echoing
)
10970 quit_throw_to_read_char (1);
10974 /* Handle a C-g by making read_char return C-g. */
10977 quit_throw_to_read_char (int from_signal
)
10979 /* When not called from a signal handler it is safe to call
10981 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10982 Fkill_emacs (Qnil
);
10985 /* Prevent another signal from doing this before we finish. */
10986 clear_waiting_for_input ();
10989 Vunread_command_events
= Qnil
;
10990 unread_command_char
= -1;
10992 #if 0 /* Currently, sit_for is called from read_char without turning
10993 off polling. And that can call set_waiting_for_input.
10994 It seems to be harmless. */
10995 #ifdef POLL_FOR_INPUT
10996 /* May be > 1 if in recursive minibuffer. */
10997 if (poll_suppress_count
== 0)
11001 if (FRAMEP (internal_last_event_frame
)
11002 && !EQ (internal_last_event_frame
, selected_frame
))
11003 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11006 _longjmp (getcjmp
, 1);
11009 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
11010 Sset_input_interrupt_mode
, 1, 1, 0,
11011 doc
: /* Set interrupt mode of reading keyboard input.
11012 If INTERRUPT is non-nil, Emacs will use input interrupts;
11013 otherwise Emacs uses CBREAK mode.
11015 See also `current-input-mode'. */)
11016 (Lisp_Object interrupt
)
11018 int new_interrupt_input
;
11020 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11021 #ifdef HAVE_X_WINDOWS
11022 if (x_display_list
!= NULL
)
11024 /* When using X, don't give the user a real choice,
11025 because we haven't implemented the mechanisms to support it. */
11026 new_interrupt_input
= 1;
11029 #endif /* HAVE_X_WINDOWS */
11030 new_interrupt_input
= !NILP (interrupt
);
11031 #else /* not SIGIO */
11032 new_interrupt_input
= 0;
11033 #endif /* not SIGIO */
11035 if (new_interrupt_input
!= interrupt_input
)
11037 #ifdef POLL_FOR_INPUT
11041 /* this causes startup screen to be restored and messes with the mouse */
11042 reset_all_sys_modes ();
11043 interrupt_input
= new_interrupt_input
;
11044 init_all_sys_modes ();
11046 interrupt_input
= new_interrupt_input
;
11049 #ifdef POLL_FOR_INPUT
11050 poll_suppress_count
= 1;
11057 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11058 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11059 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11060 C-q in key sequences.
11062 This setting only has an effect on tty terminals and only when
11063 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11065 See also `current-input-mode'. */)
11066 (Lisp_Object flow
, Lisp_Object terminal
)
11068 struct terminal
*t
= get_terminal (terminal
, 1);
11069 struct tty_display_info
*tty
;
11070 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11072 tty
= t
->display_info
.tty
;
11074 if (tty
->flow_control
!= !NILP (flow
))
11077 /* this causes startup screen to be restored and messes with the mouse */
11078 reset_sys_modes (tty
);
11081 tty
->flow_control
= !NILP (flow
);
11084 init_sys_modes (tty
);
11090 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11091 doc
: /* Enable or disable 8-bit input on TERMINAL.
11092 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11093 bit as the Meta modifier.
11095 If META is nil, Emacs will ignore the top bit, on the assumption it is
11098 Otherwise, Emacs will accept and pass through 8-bit input without
11099 specially interpreting the top bit.
11101 This setting only has an effect on tty terminal devices.
11103 Optional parameter TERMINAL specifies the tty terminal device to use.
11104 It may be a terminal object, a frame, or nil for the terminal used by
11105 the currently selected frame.
11107 See also `current-input-mode'. */)
11108 (Lisp_Object meta
, Lisp_Object terminal
)
11110 struct terminal
*t
= get_terminal (terminal
, 1);
11111 struct tty_display_info
*tty
;
11114 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11116 tty
= t
->display_info
.tty
;
11120 else if (EQ (meta
, Qt
))
11125 if (tty
->meta_key
!= new_meta
)
11128 /* this causes startup screen to be restored and messes with the mouse */
11129 reset_sys_modes (tty
);
11132 tty
->meta_key
= new_meta
;
11135 init_sys_modes (tty
);
11141 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11142 doc
: /* Specify character used for quitting.
11143 QUIT must be an ASCII character.
11145 This function only has an effect on the controlling tty of the Emacs
11148 See also `current-input-mode'. */)
11151 struct terminal
*t
= get_named_tty ("/dev/tty");
11152 struct tty_display_info
*tty
;
11153 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11155 tty
= t
->display_info
.tty
;
11157 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11158 error ("QUIT must be an ASCII character");
11161 /* this causes startup screen to be restored and messes with the mouse */
11162 reset_sys_modes (tty
);
11165 /* Don't let this value be out of range. */
11166 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11169 init_sys_modes (tty
);
11175 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11176 doc
: /* Set mode of reading keyboard input.
11177 First arg INTERRUPT non-nil means use input interrupts;
11178 nil means use CBREAK mode.
11179 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11180 (no effect except in CBREAK mode).
11181 Third arg META t means accept 8-bit input (for a Meta key).
11182 META nil means ignore the top bit, on the assumption it is parity.
11183 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11184 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11185 See also `current-input-mode'. */)
11186 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11188 Fset_input_interrupt_mode (interrupt
);
11189 Fset_output_flow_control (flow
, Qnil
);
11190 Fset_input_meta_mode (meta
, Qnil
);
11192 Fset_quit_char (quit
);
11196 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11197 doc
: /* Return information about the way Emacs currently reads keyboard input.
11198 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11199 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11200 nil, Emacs is using CBREAK mode.
11201 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11202 terminal; this does not apply if Emacs uses interrupt-driven input.
11203 META is t if accepting 8-bit input with 8th bit as Meta flag.
11204 META nil means ignoring the top bit, on the assumption it is parity.
11205 META is neither t nor nil if accepting 8-bit input and using
11206 all 8 bits as the character code.
11207 QUIT is the character Emacs currently uses to quit.
11208 The elements of this list correspond to the arguments of
11209 `set-input-mode'. */)
11212 Lisp_Object val
[4];
11213 struct frame
*sf
= XFRAME (selected_frame
);
11215 val
[0] = interrupt_input
? Qt
: Qnil
;
11216 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11218 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11219 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11221 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11228 XSETFASTINT (val
[3], quit_char
);
11230 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11233 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11234 doc
: /* Return position information for pixel coordinates X and Y.
11235 By default, X and Y are relative to text area of the selected window.
11236 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11237 If optional fourth arg WHOLE is non-nil, X is relative to the left
11238 edge of the window.
11240 The return value is similar to a mouse click position:
11241 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11242 IMAGE (DX . DY) (WIDTH . HEIGHT))
11243 The `posn-' functions access elements of such lists. */)
11244 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11249 if (NILP (frame_or_window
))
11250 frame_or_window
= selected_window
;
11252 if (WINDOWP (frame_or_window
))
11254 struct window
*w
= decode_valid_window (frame_or_window
);
11256 XSETINT (x
, (XINT (x
)
11257 + WINDOW_LEFT_EDGE_X (w
)
11259 ? window_box_left_offset (w
, TEXT_AREA
)
11261 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11262 frame_or_window
= w
->frame
;
11265 CHECK_LIVE_FRAME (frame_or_window
);
11267 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11270 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11271 doc
: /* Return position information for buffer POS in WINDOW.
11272 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11274 Return nil if position is not visible in window. Otherwise,
11275 the return value is similar to that returned by `event-start' for
11276 a mouse click at the upper left corner of the glyph corresponding
11277 to the given buffer position:
11278 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11279 IMAGE (DX . DY) (WIDTH . HEIGHT))
11280 The `posn-' functions access elements of such lists. */)
11281 (Lisp_Object pos
, Lisp_Object window
)
11286 window
= selected_window
;
11288 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11291 Lisp_Object x
= XCAR (tem
);
11292 Lisp_Object y
= XCAR (XCDR (tem
));
11294 /* Point invisible due to hscrolling? */
11297 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11305 * Set up a new kboard object with reasonable initial values.
11308 init_kboard (KBOARD
*kb
)
11310 kset_overriding_terminal_local_map (kb
, Qnil
);
11311 kset_last_command (kb
, Qnil
);
11312 kset_real_last_command (kb
, Qnil
);
11313 kset_keyboard_translate_table (kb
, Qnil
);
11314 kset_last_repeatable_command (kb
, Qnil
);
11315 kset_prefix_arg (kb
, Qnil
);
11316 kset_last_prefix_arg (kb
, Qnil
);
11317 kset_kbd_queue (kb
, Qnil
);
11318 kb
->kbd_queue_has_data
= 0;
11319 kb
->immediate_echo
= 0;
11320 kset_echo_string (kb
, Qnil
);
11321 kb
->echo_after_prompt
= -1;
11322 kb
->kbd_macro_buffer
= 0;
11323 kb
->kbd_macro_bufsize
= 0;
11324 kset_defining_kbd_macro (kb
, Qnil
);
11325 kset_last_kbd_macro (kb
, Qnil
);
11326 kb
->reference_count
= 0;
11327 kset_system_key_alist (kb
, Qnil
);
11328 kset_system_key_syms (kb
, Qnil
);
11329 kset_window_system (kb
, Qt
); /* Unset. */
11330 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11331 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11332 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11333 kset_default_minibuffer_frame (kb
, Qnil
);
11337 * Destroy the contents of a kboard object, but not the object itself.
11338 * We use this just before deleting it, or if we're going to initialize
11339 * it a second time.
11342 wipe_kboard (KBOARD
*kb
)
11344 xfree (kb
->kbd_macro_buffer
);
11347 /* Free KB and memory referenced from it. */
11350 delete_kboard (KBOARD
*kb
)
11354 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11357 *kbp
= kb
->next_kboard
;
11359 /* Prevent a dangling reference to KB. */
11360 if (kb
== current_kboard
11361 && FRAMEP (selected_frame
)
11362 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11364 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11366 if (current_kboard
== kb
)
11375 init_keyboard (void)
11377 /* This is correct before outermost invocation of the editor loop */
11378 command_loop_level
= -1;
11379 immediate_quit
= 0;
11380 quit_char
= Ctl ('g');
11381 Vunread_command_events
= Qnil
;
11382 unread_command_char
= -1;
11383 timer_idleness_start_time
= invalid_emacs_time ();
11385 recent_keys_index
= 0;
11386 kbd_fetch_ptr
= kbd_buffer
;
11387 kbd_store_ptr
= kbd_buffer
;
11388 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11389 do_mouse_tracking
= Qnil
;
11392 interrupt_input_blocked
= 0;
11393 interrupt_input_pending
= 0;
11395 pending_signals
= 0;
11398 /* This means that command_loop_1 won't try to select anything the first
11400 internal_last_event_frame
= Qnil
;
11401 Vlast_event_frame
= internal_last_event_frame
;
11403 current_kboard
= initial_kboard
;
11404 /* Re-initialize the keyboard again. */
11405 wipe_kboard (current_kboard
);
11406 init_kboard (current_kboard
);
11407 /* A value of nil for Vwindow_system normally means a tty, but we also use
11408 it for the initial terminal since there is no window system there. */
11409 kset_window_system (current_kboard
, Qnil
);
11411 if (!noninteractive
)
11413 /* Before multi-tty support, these handlers used to be installed
11414 only if the current session was a tty session. Now an Emacs
11415 session may have multiple display types, so we always handle
11416 SIGINT. There is special code in interrupt_signal to exit
11417 Emacs on SIGINT when there are no termcap frames on the
11418 controlling terminal. */
11419 signal (SIGINT
, interrupt_signal
);
11421 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11422 SIGQUIT and we can't tell which one it will give us. */
11423 signal (SIGQUIT
, interrupt_signal
);
11424 #endif /* not DOS_NT */
11426 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11428 if (!noninteractive
)
11429 signal (SIGIO
, input_available_signal
);
11432 /* Use interrupt input by default, if it works and noninterrupt input
11433 has deficiencies. */
11435 #ifdef INTERRUPT_INPUT
11436 interrupt_input
= 1;
11438 interrupt_input
= 0;
11444 if (keyboard_init_hook
)
11445 (*keyboard_init_hook
) ();
11447 #ifdef POLL_FOR_INPUT
11449 poll_suppress_count
= 1;
11454 /* This type's only use is in syms_of_keyboard, to initialize the
11455 event header symbols and put properties on them. */
11456 struct event_head
{
11462 static const struct event_head head_table
[] = {
11463 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11464 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11465 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11466 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11467 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11468 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11469 /* `select-window' should be handled just like `switch-frame'
11470 in read_key_sequence. */
11471 {&Qselect_window
, "select-window", &Qswitch_frame
}
11475 syms_of_keyboard (void)
11477 pending_funcalls
= Qnil
;
11478 staticpro (&pending_funcalls
);
11480 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11481 staticpro (&Vlispy_mouse_stem
);
11484 DEFSYM (QCimage
, ":image");
11485 DEFSYM (Qhelp_echo
, "help-echo");
11486 DEFSYM (QCrtl
, ":rtl");
11488 staticpro (&item_properties
);
11489 item_properties
= Qnil
;
11491 staticpro (&tool_bar_item_properties
);
11492 tool_bar_item_properties
= Qnil
;
11493 staticpro (&tool_bar_items_vector
);
11494 tool_bar_items_vector
= Qnil
;
11496 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11497 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11498 DEFSYM (Qself_insert_command
, "self-insert-command");
11499 DEFSYM (Qforward_char
, "forward-char");
11500 DEFSYM (Qbackward_char
, "backward-char");
11501 DEFSYM (Qdisabled
, "disabled");
11502 DEFSYM (Qundefined
, "undefined");
11503 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11504 DEFSYM (Qpost_command_hook
, "post-command-hook");
11505 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11506 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11507 DEFSYM (Qfunction_key
, "function-key");
11508 DEFSYM (Qmouse_click
, "mouse-click");
11509 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11510 DEFSYM (Qsave_session
, "save-session");
11511 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11512 DEFSYM (Qmenu_enable
, "menu-enable");
11514 #if defined (WINDOWSNT)
11515 DEFSYM (Qlanguage_change
, "language-change");
11519 DEFSYM (Qdbus_event
, "dbus-event");
11522 DEFSYM (QCenable
, ":enable");
11523 DEFSYM (QCvisible
, ":visible");
11524 DEFSYM (QChelp
, ":help");
11525 DEFSYM (QCfilter
, ":filter");
11526 DEFSYM (QCbutton
, ":button");
11527 DEFSYM (QCkeys
, ":keys");
11528 DEFSYM (QCkey_sequence
, ":key-sequence");
11529 DEFSYM (QCtoggle
, ":toggle");
11530 DEFSYM (QCradio
, ":radio");
11531 DEFSYM (QClabel
, ":label");
11532 DEFSYM (QCvert_only
, ":vert-only");
11534 DEFSYM (Qmode_line
, "mode-line");
11535 DEFSYM (Qvertical_line
, "vertical-line");
11536 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11537 DEFSYM (Qmenu_bar
, "menu-bar");
11539 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11540 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11543 DEFSYM (Qabove_handle
, "above-handle");
11544 DEFSYM (Qhandle
, "handle");
11545 DEFSYM (Qbelow_handle
, "below-handle");
11546 DEFSYM (Qup
, "up");
11547 DEFSYM (Qdown
, "down");
11548 DEFSYM (Qtop
, "top");
11549 DEFSYM (Qbottom
, "bottom");
11550 DEFSYM (Qend_scroll
, "end-scroll");
11551 DEFSYM (Qratio
, "ratio");
11553 DEFSYM (Qevent_kind
, "event-kind");
11554 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11555 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11556 DEFSYM (Qmodifier_cache
, "modifier-cache");
11558 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11559 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11561 DEFSYM (Qpolling_period
, "polling-period");
11563 DEFSYM (Qx_set_selection
, "x-set-selection");
11564 DEFSYM (QPRIMARY
, "PRIMARY");
11565 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11566 DEFSYM (Qhandle_select_window
, "handle-select-window");
11568 DEFSYM (Qinput_method_function
, "input-method-function");
11569 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11570 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11572 DEFSYM (Qhelp_form_show
, "help-form-show");
11574 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11575 Fset (Qinput_method_use_echo_area
, Qnil
);
11577 last_point_position_buffer
= Qnil
;
11578 last_point_position_window
= Qnil
;
11582 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11584 for (i
= 0; i
< len
; i
++)
11586 const struct event_head
*p
= &head_table
[i
];
11587 *p
->var
= intern_c_string (p
->name
);
11588 staticpro (p
->var
);
11589 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11590 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11594 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11595 staticpro (&button_down_location
);
11596 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11597 staticpro (&mouse_syms
);
11598 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11599 / sizeof (lispy_wheel_names
[0])),
11601 staticpro (&wheel_syms
);
11605 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11607 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11608 for (i
= 0; i
< len
; i
++)
11609 if (modifier_names
[i
])
11610 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11611 staticpro (&modifier_symbols
);
11614 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11615 staticpro (&recent_keys
);
11617 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11618 staticpro (&this_command_keys
);
11620 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11621 staticpro (&raw_keybuf
);
11623 DEFSYM (Qextended_command_history
, "extended-command-history");
11624 Fset (Qextended_command_history
, Qnil
);
11626 accent_key_syms
= Qnil
;
11627 staticpro (&accent_key_syms
);
11629 func_key_syms
= Qnil
;
11630 staticpro (&func_key_syms
);
11632 drag_n_drop_syms
= Qnil
;
11633 staticpro (&drag_n_drop_syms
);
11635 unread_switch_frame
= Qnil
;
11636 staticpro (&unread_switch_frame
);
11638 internal_last_event_frame
= Qnil
;
11639 staticpro (&internal_last_event_frame
);
11641 read_key_sequence_cmd
= Qnil
;
11642 staticpro (&read_key_sequence_cmd
);
11643 read_key_sequence_remapped
= Qnil
;
11644 staticpro (&read_key_sequence_remapped
);
11646 menu_bar_one_keymap_changed_items
= Qnil
;
11647 staticpro (&menu_bar_one_keymap_changed_items
);
11649 menu_bar_items_vector
= Qnil
;
11650 staticpro (&menu_bar_items_vector
);
11652 help_form_saved_window_configs
= Qnil
;
11653 staticpro (&help_form_saved_window_configs
);
11655 defsubr (&Scurrent_idle_time
);
11656 defsubr (&Sevent_symbol_parse_modifiers
);
11657 defsubr (&Sevent_convert_list
);
11658 defsubr (&Sread_key_sequence
);
11659 defsubr (&Sread_key_sequence_vector
);
11660 defsubr (&Srecursive_edit
);
11661 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11662 defsubr (&Strack_mouse
);
11664 defsubr (&Sinput_pending_p
);
11665 defsubr (&Scommand_execute
);
11666 defsubr (&Srecent_keys
);
11667 defsubr (&Sthis_command_keys
);
11668 defsubr (&Sthis_command_keys_vector
);
11669 defsubr (&Sthis_single_command_keys
);
11670 defsubr (&Sthis_single_command_raw_keys
);
11671 defsubr (&Sreset_this_command_lengths
);
11672 defsubr (&Sclear_this_command_keys
);
11673 defsubr (&Ssuspend_emacs
);
11674 defsubr (&Sabort_recursive_edit
);
11675 defsubr (&Sexit_recursive_edit
);
11676 defsubr (&Srecursion_depth
);
11677 defsubr (&Stop_level
);
11678 defsubr (&Sdiscard_input
);
11679 defsubr (&Sopen_dribble_file
);
11680 defsubr (&Sset_input_interrupt_mode
);
11681 defsubr (&Sset_output_flow_control
);
11682 defsubr (&Sset_input_meta_mode
);
11683 defsubr (&Sset_quit_char
);
11684 defsubr (&Sset_input_mode
);
11685 defsubr (&Scurrent_input_mode
);
11686 defsubr (&Sposn_at_point
);
11687 defsubr (&Sposn_at_x_y
);
11689 DEFVAR_LISP ("last-command-event", last_command_event
,
11690 doc
: /* Last input event that was part of a command. */);
11692 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11693 doc
: /* Last input event in a command, except for mouse menu events.
11694 Mouse menus give back keys that don't look like mouse events;
11695 this variable holds the actual mouse event that led to the menu,
11696 so that you can determine whether the command was run by mouse or not. */);
11698 DEFVAR_LISP ("last-input-event", last_input_event
,
11699 doc
: /* Last input event. */);
11701 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11702 doc
: /* List of events to be read as the command input.
11703 These events are processed first, before actual keyboard input.
11704 Events read from this list are not normally added to `this-command-keys',
11705 as they will already have been added once as they were read for the first time.
11706 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11707 Vunread_command_events
= Qnil
;
11709 DEFVAR_INT ("unread-command-char", unread_command_char
,
11710 doc
: /* If not -1, an object to be read as next command input event. */);
11712 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11713 doc
: /* List of events to be processed as input by input methods.
11714 These events are processed before `unread-command-events'
11715 and actual keyboard input, but are not given to `input-method-function'. */);
11716 Vunread_post_input_method_events
= Qnil
;
11718 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11719 doc
: /* List of events to be processed as input by input methods.
11720 These events are processed after `unread-command-events', but
11721 before actual keyboard input.
11722 If there's an active input method, the events are given to
11723 `input-method-function'. */);
11724 Vunread_input_method_events
= Qnil
;
11726 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11727 doc
: /* Meta-prefix character code.
11728 Meta-foo as command input turns into this character followed by foo. */);
11729 XSETINT (meta_prefix_char
, 033);
11731 DEFVAR_KBOARD ("last-command", Vlast_command
,
11732 doc
: /* The last command executed.
11733 Normally a symbol with a function definition, but can be whatever was found
11734 in the keymap, or whatever the variable `this-command' was set to by that
11737 The value `mode-exit' is special; it means that the previous command
11738 read an event that told it to exit, and it did so and unread that event.
11739 In other words, the present command is the event that made the previous
11742 The value `kill-region' is special; it means that the previous command
11743 was a kill command.
11745 `last-command' has a separate binding for each terminal device.
11746 See Info node `(elisp)Multiple Terminals'. */);
11748 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11749 doc
: /* Same as `last-command', but never altered by Lisp code.
11750 Taken from the previous value of `real-this-command'. */);
11752 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11753 doc
: /* Last command that may be repeated.
11754 The last command executed that was not bound to an input event.
11755 This is the command `repeat' will try to repeat.
11756 Taken from a previous value of `real-this-command'. */);
11758 DEFVAR_LISP ("this-command", Vthis_command
,
11759 doc
: /* The command now being executed.
11760 The command can set this variable; whatever is put here
11761 will be in `last-command' during the following command. */);
11762 Vthis_command
= Qnil
;
11764 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11765 doc
: /* This is like `this-command', except that commands should never modify it. */);
11766 Vreal_this_command
= Qnil
;
11768 DEFVAR_LISP ("this-command-keys-shift-translated",
11769 Vthis_command_keys_shift_translated
,
11770 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11771 Shift-translation occurs when there is no binding for the key sequence
11772 as entered, but a binding was found by changing an upper-case letter
11773 to lower-case, or a shifted function key to an unshifted one. */);
11774 Vthis_command_keys_shift_translated
= Qnil
;
11776 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11777 doc
: /* The command bound to the current key sequence before remapping.
11778 It equals `this-command' if the original command was not remapped through
11779 any of the active keymaps. Otherwise, the value of `this-command' is the
11780 result of looking up the original command in the active keymaps. */);
11781 Vthis_original_command
= Qnil
;
11783 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11784 doc
: /* Number of input events between auto-saves.
11785 Zero means disable autosaving due to number of characters typed. */);
11786 auto_save_interval
= 300;
11788 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11789 doc
: /* Number of seconds idle time before auto-save.
11790 Zero or nil means disable auto-saving due to idleness.
11791 After auto-saving due to this many seconds of idle time,
11792 Emacs also does a garbage collection if that seems to be warranted. */);
11793 XSETFASTINT (Vauto_save_timeout
, 30);
11795 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11796 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11797 The value may be integer or floating point.
11798 If the value is zero, don't echo at all. */);
11799 Vecho_keystrokes
= make_number (1);
11801 DEFVAR_INT ("polling-period", polling_period
,
11802 doc
: /* Interval between polling for input during Lisp execution.
11803 The reason for polling is to make C-g work to stop a running program.
11804 Polling is needed only when using X windows and SIGIO does not work.
11805 Polling is automatically disabled in all other cases. */);
11806 polling_period
= 2;
11808 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11809 doc
: /* Maximum time between mouse clicks to make a double-click.
11810 Measured in milliseconds. The value nil means disable double-click
11811 recognition; t means double-clicks have no time limit and are detected
11812 by position only. */);
11813 Vdouble_click_time
= make_number (500);
11815 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11816 doc
: /* Maximum mouse movement between clicks to make a double-click.
11817 On window-system frames, value is the number of pixels the mouse may have
11818 moved horizontally or vertically between two clicks to make a double-click.
11819 On non window-system frames, value is interpreted in units of 1/8 characters
11822 This variable is also the threshold for motion of the mouse
11823 to count as a drag. */);
11824 double_click_fuzz
= 3;
11826 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11827 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11828 inhibit_local_menu_bar_menus
= 0;
11830 DEFVAR_INT ("num-input-keys", num_input_keys
,
11831 doc
: /* Number of complete key sequences read as input so far.
11832 This includes key sequences read from keyboard macros.
11833 The number is effectively the number of interactive command invocations. */);
11834 num_input_keys
= 0;
11836 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11837 doc
: /* Number of input events read from the keyboard so far.
11838 This does not include events generated by keyboard macros. */);
11839 num_nonmacro_input_events
= 0;
11841 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11842 doc
: /* The frame in which the most recently read event occurred.
11843 If the last event came from a keyboard macro, this is set to `macro'. */);
11844 Vlast_event_frame
= Qnil
;
11846 /* This variable is set up in sysdep.c. */
11847 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11848 doc
: /* The ERASE character as set by the user with stty. */);
11850 DEFVAR_LISP ("help-char", Vhelp_char
,
11851 doc
: /* Character to recognize as meaning Help.
11852 When it is read, do `(eval help-form)', and display result if it's a string.
11853 If the value of `help-form' is nil, this char can be read normally. */);
11854 XSETINT (Vhelp_char
, Ctl ('H'));
11856 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11857 doc
: /* List of input events to recognize as meaning Help.
11858 These work just like the value of `help-char' (see that). */);
11859 Vhelp_event_list
= Qnil
;
11861 DEFVAR_LISP ("help-form", Vhelp_form
,
11862 doc
: /* Form to execute when character `help-char' is read.
11863 If the form returns a string, that string is displayed.
11864 If `help-form' is nil, the help char is not recognized. */);
11867 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11868 doc
: /* Command to run when `help-char' character follows a prefix key.
11869 This command is used only when there is no actual binding
11870 for that character after that prefix key. */);
11871 Vprefix_help_command
= Qnil
;
11873 DEFVAR_LISP ("top-level", Vtop_level
,
11874 doc
: /* Form to evaluate when Emacs starts up.
11875 Useful to set before you dump a modified Emacs. */);
11878 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11879 doc
: /* Translate table for local keyboard input, or nil.
11880 If non-nil, the value should be a char-table. Each character read
11881 from the keyboard is looked up in this char-table. If the value found
11882 there is non-nil, then it is used instead of the actual input character.
11884 The value can also be a string or vector, but this is considered obsolete.
11885 If it is a string or vector of length N, character codes N and up are left
11886 untranslated. In a vector, an element which is nil means "no translation".
11888 This is applied to the characters supplied to input methods, not their
11889 output. See also `translation-table-for-input'.
11891 This variable has a separate binding for each terminal.
11892 See Info node `(elisp)Multiple Terminals'. */);
11894 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11895 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11896 \(Even if the operating system has support for stopping a process.\) */);
11897 cannot_suspend
= 0;
11899 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11900 doc
: /* Non-nil means prompt with menus when appropriate.
11901 This is done when reading from a keymap that has a prompt string,
11902 for elements that have prompt strings.
11903 The menu is displayed on the screen
11904 if X menus were enabled at configuration
11905 time and the previous event was a mouse click prefix key.
11906 Otherwise, menu prompting uses the echo area. */);
11907 menu_prompting
= 1;
11909 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11910 doc
: /* Character to see next line of menu prompt.
11911 Type this character while in a menu prompt to rotate around the lines of it. */);
11912 XSETINT (menu_prompt_more_char
, ' ');
11914 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11915 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11916 Emacs applies the modifiers of the character stored here to each keyboard
11917 character it reads. For example, after evaluating the expression
11918 (setq extra-keyboard-modifiers ?\\C-x)
11919 all input characters will have the control modifier applied to them.
11921 Note that the character ?\\C-@, equivalent to the integer zero, does
11922 not count as a control character; rather, it counts as a character
11923 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11924 cancels any modification. */);
11925 extra_keyboard_modifiers
= 0;
11927 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11928 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11929 The command loop sets this to nil before each command,
11930 and tests the value when the command returns.
11931 Buffer modification stores t in this variable. */);
11932 Vdeactivate_mark
= Qnil
;
11933 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11935 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11936 doc
: /* Normal hook run before each command is executed.
11937 If an unhandled error happens in running this hook,
11938 the function in which the error occurred is unconditionally removed, since
11939 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11940 Vpre_command_hook
= Qnil
;
11942 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11943 doc
: /* Normal hook run after each command is executed.
11944 If an unhandled error happens in running this hook,
11945 the function in which the error occurred is unconditionally removed, since
11946 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11947 Vpost_command_hook
= Qnil
;
11950 DEFVAR_LISP ("echo-area-clear-hook", ...,
11951 doc
: /* Normal hook run when clearing the echo area. */);
11953 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11954 Fset (Qecho_area_clear_hook
, Qnil
);
11956 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11957 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11958 Vlucid_menu_bar_dirty_flag
= Qnil
;
11960 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11961 doc
: /* List of menu bar items to move to the end of the menu bar.
11962 The elements of the list are event types that may have menu bar bindings. */);
11963 Vmenu_bar_final_items
= Qnil
;
11965 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11966 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11967 This is used internally by graphical displays that do not render
11968 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11969 Vtool_bar_separator_image_expression
= Qnil
;
11971 DEFVAR_KBOARD ("overriding-terminal-local-map",
11972 Voverriding_terminal_local_map
,
11973 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11974 If this variable is non-nil, it is used as a keymap instead of the
11975 buffer's local map, and the minor mode keymaps and text property keymaps.
11976 It also replaces `overriding-local-map'.
11978 This variable is intended to let commands such as `universal-argument'
11979 set up a different keymap for reading the next command.
11981 `overriding-terminal-local-map' has a separate binding for each
11983 See Info node `(elisp)Multiple Terminals'. */);
11985 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11986 doc
: /* Keymap that overrides all other local keymaps.
11987 If this variable is non-nil, it is used as a keymap--replacing the
11988 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11989 Voverriding_local_map
= Qnil
;
11991 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11992 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11993 Otherwise, the menu bar continues to reflect the buffer's local map
11994 and the minor mode maps regardless of `overriding-local-map'. */);
11995 Voverriding_local_map_menu_flag
= Qnil
;
11997 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11998 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11999 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12001 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
12002 doc
: /* Non-nil means generate motion events for mouse motion. */);
12004 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12005 doc
: /* Alist of system-specific X windows key symbols.
12006 Each element should have the form (N . SYMBOL) where N is the
12007 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12008 and SYMBOL is its name.
12010 `system-key-alist' has a separate binding for each terminal device.
12011 See Info node `(elisp)Multiple Terminals'. */);
12013 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12014 doc
: /* Keymap that translates key sequences to key sequences during input.
12015 This is used mainly for mapping key sequences into some preferred
12016 key events (symbols).
12018 The `read-key-sequence' function replaces any subsequence bound by
12019 `local-function-key-map' with its binding. More precisely, when the
12020 active keymaps have no binding for the current key sequence but
12021 `local-function-key-map' binds a suffix of the sequence to a vector or
12022 string, `read-key-sequence' replaces the matching suffix with its
12023 binding, and continues with the new sequence.
12025 If the binding is a function, it is called with one argument (the prompt)
12026 and its return value (a key sequence) is used.
12028 The events that come from bindings in `local-function-key-map' are not
12029 themselves looked up in `local-function-key-map'.
12031 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12032 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12033 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12034 typing `ESC O P x' would return [f1 x].
12036 `local-function-key-map' has a separate binding for each terminal
12037 device. See Info node `(elisp)Multiple Terminals'. If you need to
12038 define a binding on all terminals, change `function-key-map'
12039 instead. Initially, `local-function-key-map' is an empty keymap that
12040 has `function-key-map' as its parent on all terminal devices. */);
12042 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12043 doc
: /* Keymap that decodes input escape sequences.
12044 This is used mainly for mapping ASCII function key sequences into
12045 real Emacs function key events (symbols).
12047 The `read-key-sequence' function replaces any subsequence bound by
12048 `input-decode-map' with its binding. Contrary to `function-key-map',
12049 this map applies its rebinding regardless of the presence of an ordinary
12050 binding. So it is more like `key-translation-map' except that it applies
12051 before `function-key-map' rather than after.
12053 If the binding is a function, it is called with one argument (the prompt)
12054 and its return value (a key sequence) is used.
12056 The events that come from bindings in `input-decode-map' are not
12057 themselves looked up in `input-decode-map'.
12059 This variable is keyboard-local. */);
12061 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12062 doc
: /* The parent keymap of all `local-function-key-map' instances.
12063 Function key definitions that apply to all terminal devices should go
12064 here. If a mapping is defined in both the current
12065 `local-function-key-map' binding and this variable, then the local
12066 definition will take precedence. */);
12067 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12069 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12070 doc
: /* Keymap of key translations that can override keymaps.
12071 This keymap works like `function-key-map', but comes after that,
12072 and its non-prefix bindings override ordinary bindings.
12073 Another difference is that it is global rather than keyboard-local. */);
12074 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12076 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12077 doc
: /* List of deferred actions to be performed at a later time.
12078 The precise format isn't relevant here; we just check whether it is nil. */);
12079 Vdeferred_action_list
= Qnil
;
12081 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12082 doc
: /* Function to call to handle deferred actions, after each command.
12083 This function is called with no arguments after each command
12084 whenever `deferred-action-list' is non-nil. */);
12085 Vdeferred_action_function
= Qnil
;
12087 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12088 doc
: /* List of warnings to be displayed after this command.
12089 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12090 as per the args of `display-warning' (which see).
12091 If this variable is non-nil, `delayed-warnings-hook' will be run
12092 immediately after running `post-command-hook'. */);
12093 Vdelayed_warnings_list
= Qnil
;
12095 DEFVAR_LISP ("timer-list", Vtimer_list
,
12096 doc
: /* List of active absolute time timers in order of increasing time. */);
12097 Vtimer_list
= Qnil
;
12099 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12100 doc
: /* List of active idle-time timers in order of increasing time. */);
12101 Vtimer_idle_list
= Qnil
;
12103 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12104 doc
: /* If non-nil, the function that implements the current input method.
12105 It's called with one argument, a printing character that was just read.
12106 \(That means a character with code 040...0176.)
12107 Typically this function uses `read-event' to read additional events.
12108 When it does so, it should first bind `input-method-function' to nil
12109 so it will not be called recursively.
12111 The function should return a list of zero or more events
12112 to be used as input. If it wants to put back some events
12113 to be reconsidered, separately, by the input method,
12114 it can add them to the beginning of `unread-command-events'.
12116 The input method function can find in `input-method-previous-message'
12117 the previous echo area message.
12119 The input method function should refer to the variables
12120 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12121 for guidance on what to do. */);
12122 Vinput_method_function
= Qnil
;
12124 DEFVAR_LISP ("input-method-previous-message",
12125 Vinput_method_previous_message
,
12126 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12127 This variable exists because `read-event' clears the echo area
12128 before running the input method. It is nil if there was no message. */);
12129 Vinput_method_previous_message
= Qnil
;
12131 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12132 doc
: /* If non-nil, the function that implements the display of help.
12133 It's called with one argument, the help string to display. */);
12134 Vshow_help_function
= Qnil
;
12136 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12137 doc
: /* If non-nil, suppress point adjustment after executing a command.
12139 After a command is executed, if point is moved into a region that has
12140 special properties (e.g. composition, display), we adjust point to
12141 the boundary of the region. But, when a command sets this variable to
12142 non-nil, we suppress the point adjustment.
12144 This variable is set to nil before reading a command, and is checked
12145 just after executing the command. */);
12146 Vdisable_point_adjustment
= Qnil
;
12148 DEFVAR_LISP ("global-disable-point-adjustment",
12149 Vglobal_disable_point_adjustment
,
12150 doc
: /* If non-nil, always suppress point adjustment.
12152 The default value is nil, in which case, point adjustment are
12153 suppressed only after special commands that set
12154 `disable-point-adjustment' (which see) to non-nil. */);
12155 Vglobal_disable_point_adjustment
= Qnil
;
12157 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12158 doc
: /* How long to display an echo-area message when the minibuffer is active.
12159 If the value is not a number, such messages don't time out. */);
12160 Vminibuffer_message_timeout
= make_number (2);
12162 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12163 doc
: /* If non-nil, any keyboard input throws to this symbol.
12164 The value of that variable is passed to `quit-flag' and later causes a
12165 peculiar kind of quitting. */);
12166 Vthrow_on_input
= Qnil
;
12168 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12169 doc
: /* If non-nil, function to output error messages.
12170 The arguments are the error data, a list of the form
12171 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12172 such as just as `condition-case' would bind its variable to,
12173 the context (a string which normally goes at the start of the message),
12174 and the Lisp function within which the error was signaled. */);
12175 Vcommand_error_function
= Qnil
;
12177 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12178 Venable_disabled_menus_and_buttons
,
12179 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12181 Help functions bind this to allow help on disabled menu items
12182 and tool-bar buttons. */);
12183 Venable_disabled_menus_and_buttons
= Qnil
;
12185 DEFVAR_LISP ("select-active-regions",
12186 Vselect_active_regions
,
12187 doc
: /* If non-nil, an active region automatically sets the primary selection.
12188 If the value is `only', only temporarily active regions (usually made
12189 by mouse-dragging or shift-selection) set the window selection.
12191 This takes effect only when Transient Mark mode is enabled. */);
12192 Vselect_active_regions
= Qt
;
12194 DEFVAR_LISP ("saved-region-selection",
12195 Vsaved_region_selection
,
12196 doc
: /* Contents of active region prior to buffer modification.
12197 If `select-active-regions' is non-nil, Emacs sets this to the
12198 text in the region before modifying the buffer. The next
12199 `deactivate-mark' call uses this to set the window selection. */);
12200 Vsaved_region_selection
= Qnil
;
12202 DEFVAR_LISP ("selection-inhibit-update-commands",
12203 Vselection_inhibit_update_commands
,
12204 doc
: /* List of commands which should not update the selection.
12205 Normally, if `select-active-regions' is non-nil and the mark remains
12206 active after a command (i.e. the mark was not deactivated), the Emacs
12207 command loop sets the selection to the text in the region. However,
12208 if the command is in this list, the selection is not updated. */);
12209 Vselection_inhibit_update_commands
12210 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12212 DEFVAR_LISP ("debug-on-event",
12214 doc
: /* Enter debugger on this event. When Emacs
12215 receives the special event specified by this variable, it will try to
12216 break into the debugger as soon as possible instead of processing the
12217 event normally through `special-event-map'.
12219 Currently, the only supported values for this
12220 variable are `sigusr1' and `sigusr2'. */);
12221 Vdebug_on_event
= intern_c_string ("sigusr2");
12223 /* Create the initial keyboard. */
12224 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12225 init_kboard (initial_kboard
);
12226 /* Vwindow_system is left at t for now. */
12227 initial_kboard
->next_kboard
= all_kboards
;
12228 all_kboards
= initial_kboard
;
12232 keys_of_keyboard (void)
12234 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12235 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12236 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12237 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12238 initial_define_key (meta_map
, 'x', "execute-extended-command");
12240 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12241 "handle-delete-frame");
12242 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12243 "ns-put-working-text");
12244 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12245 "ns-unput-working-text");
12246 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12247 current-prefix-arg, as is done in `handle-switch-frame'.
12248 But `handle-switch-frame is not run from the special-map.
12249 Commands from that map are run in a special way that automatically
12250 preserves the prefix-arg. Restoring the prefix arg here is not just
12251 redundant but harmful:
12253 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12254 - after the first prompt, the exit-minibuffer-hook is run which may
12255 iconify a frame and thus push a `iconify-frame' event.
12256 - after running exit-minibuffer-hook, current-prefix-arg is
12257 restored to the non-nil value it had before the prompt.
12258 - we enter the second prompt.
12259 current-prefix-arg is non-nil, prefix-arg is nil.
12260 - before running the first real event, we run the special iconify-frame
12261 event, but we pass the `special' arg to execute-command so
12262 current-prefix-arg and prefix-arg are left untouched.
12263 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12264 - the next key event will have a spuriously non-nil current-prefix-arg. */
12265 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12267 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12269 /* Handling it at such a low-level causes read_key_sequence to get
12270 * confused because it doesn't realize that the current_buffer was
12271 * changed by read_char.
12273 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12274 * "handle-select-window"); */
12275 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12276 "handle-save-session");
12279 /* Define a special event which is raised for dbus callback
12281 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12282 "dbus-handle-event");
12285 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12287 #if defined (WINDOWSNT)
12288 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12293 /* Mark the pointers in the kboard objects.
12294 Called by Fgarbage_collect. */
12296 mark_kboards (void)
12300 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12302 if (kb
->kbd_macro_buffer
)
12303 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12305 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12306 mark_object (KVAR (kb
, Vlast_command
));
12307 mark_object (KVAR (kb
, Vreal_last_command
));
12308 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12309 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12310 mark_object (KVAR (kb
, Vprefix_arg
));
12311 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12312 mark_object (KVAR (kb
, kbd_queue
));
12313 mark_object (KVAR (kb
, defining_kbd_macro
));
12314 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12315 mark_object (KVAR (kb
, Vsystem_key_alist
));
12316 mark_object (KVAR (kb
, system_key_syms
));
12317 mark_object (KVAR (kb
, Vwindow_system
));
12318 mark_object (KVAR (kb
, Vinput_decode_map
));
12319 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12320 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12321 mark_object (KVAR (kb
, echo_string
));
12324 struct input_event
*event
;
12325 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12327 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12328 event
= kbd_buffer
;
12329 if (event
->kind
!= SELECTION_REQUEST_EVENT
12330 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12332 mark_object (event
->x
);
12333 mark_object (event
->y
);
12335 mark_object (event
->frame_or_window
);
12336 mark_object (event
->arg
);